#469 Delete Editorial bot comments when violations are fixed

Author: ayagmar

src/main/java/io/quarkus/bot/CheckIssueEditorialRules.java

@@ -1,25 +1,23 @@
 package io.quarkus.bot;
 
-import java.io.IOException;
-
-import jakarta.inject.Inject;
-
-import org.jboss.logging.Logger;
-import org.kohsuke.github.GHEventPayload;
-import org.kohsuke.github.GHIssue;
-
 import io.quarkiverse.githubapp.ConfigFile;
 import io.quarkiverse.githubapp.event.Issue;
 import io.quarkus.bot.config.Feature;
 import io.quarkus.bot.config.QuarkusGitHubBotConfig;
 import io.quarkus.bot.config.QuarkusGitHubBotConfigFile;
 import io.quarkus.bot.util.Strings;
+import jakarta.inject.Inject;
+import org.jboss.logging.Logger;
+import org.kohsuke.github.GHEventPayload;
+import org.kohsuke.github.GHIssue;
+
+import java.io.IOException;
 
 public class CheckIssueEditorialRules {
     private static final Logger LOG = Logger.getLogger(CheckIssueEditorialRules.class);
 
     private static final String ZULIP_URL = "https://quarkusio.zulipchat.com/";
-    public static final String ZULIP_WARNING = Strings.commentByBot(
+    public static final String ZULIP_WARNING = Strings.editorialCommentByBot(
             "You added a link to a Zulip discussion, please make sure the description of the issue is comprehensive and doesn't require accessing Zulip");
 
     @Inject

src/main/java/io/quarkus/bot/CheckPullRequestEditorialRules.java

@@ -1,19 +1,5 @@
 package io.quarkus.bot;
 
-import java.io.IOException;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.Collections;
-import java.util.List;
-import java.util.Locale;
-import java.util.regex.Pattern;
-
-import jakarta.inject.Inject;
-
-import org.jboss.logging.Logger;
-import org.kohsuke.github.GHEventPayload;
-import org.kohsuke.github.GHPullRequest;
-
 import io.quarkiverse.githubapp.ConfigFile;
 import io.quarkiverse.githubapp.event.PullRequest;
 import io.quarkus.bot.config.Feature;
@@ -22,6 +8,22 @@
 import io.quarkus.bot.util.GHPullRequests;
 import io.quarkus.bot.util.PullRequestFilesMatcher;
 import io.quarkus.bot.util.Strings;
+import jakarta.inject.Inject;
+import org.jboss.logging.Logger;
+import org.kohsuke.github.GHEventPayload;
+import org.kohsuke.github.GHIssueComment;
+import org.kohsuke.github.GHPullRequest;
+
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+import java.util.Locale;
+import java.util.Optional;
+import java.util.regex.Pattern;
+
+import static io.quarkus.bot.util.Strings.EDITORIAL_RULES_COMMENT_MARKER;
 
 class CheckPullRequestEditorialRules {
 
@@ -80,12 +82,30 @@ void checkPullRequestEditorialRules(@PullRequest.Opened GHEventPayload.PullReque
         }
 
         if (!quarkusBotConfig.isDryRun()) {
-            pullRequest.comment(Strings.commentByBot(comment.toString()));
+            pullRequest.comment(Strings.editorialCommentByBot(comment.toString()));
         } else {
             LOG.info("Pull request #" + pullRequest.getNumber() + " - Add comment " + comment.toString());
         }
     }
 
+    void checkPullRequestEditorialRulesOnEdit(@PullRequest.Edited GHEventPayload.PullRequest pullRequestPayload,
+                                              @ConfigFile("quarkus-github-bot.yml") QuarkusGitHubBotConfigFile quarkusBotConfigFile) throws IOException {
+        if (!Feature.CHECK_EDITORIAL_RULES.isEnabled(quarkusBotConfigFile)) {
+            return;
+        }
+        var pullRequest = pullRequestPayload.getPullRequest();
+
+        var titleErrorMessages = getTitleErrorMessages(pullRequest.getTitle());
+        var bodyErrorMessages = getBodyErrorMessages(pullRequest.getBody(), pullRequest);
+
+        if (titleErrorMessages.isEmpty() && bodyErrorMessages.isEmpty()) {
+            removeBotComment(pullRequest);
+        } else {
+            LOG.debug("Pull request #" + pullRequest.getNumber() + " - Violations still exist. No action taken");
+        }
+        // Note: We could potentially update the comment if some rules are fixed but others remain..
+    }
+
     private static List<String> getTitleErrorMessages(String title) {
         List<String> errorMessages = new ArrayList<>();
 
@@ -166,4 +186,34 @@ private static boolean isMeaningfulPullRequest(GHPullRequest pullRequest) throws
 
         return true;
     }
+
+    private Optional<GHIssueComment> findBotComment(GHPullRequest pullRequest) throws IOException {
+        List<GHIssueComment> comments = pullRequest.getComments();
+        if (comments == null || comments.isEmpty()) {
+            return Optional.empty();
+        }
+
+        return comments.stream()
+                .filter(comment -> comment.getBody() != null)
+                .filter(comment -> comment.getBody().contains(EDITORIAL_RULES_COMMENT_MARKER))
+                .findFirst();
+    }
+
+    private void removeBotComment(GHPullRequest pullRequest) throws IOException {
+        Optional<GHIssueComment> commentToDeleteOpt = findBotComment(pullRequest);
+        if (commentToDeleteOpt.isPresent()) {
+            GHIssueComment commentToDelete = commentToDeleteOpt.get();
+            if (!quarkusBotConfig.isDryRun()) {
+                try {
+                    commentToDelete.delete();
+                } catch (IOException e) {
+                    LOG.error(String.format("Pull Request # %s - Failed to delete comment %d", pullRequest.getNumber(),
+                            commentToDelete.getId()), e);
+                }
+            } else {
+                LOG.info(String.format("Pull Request # %s - Delete comment %d", pullRequest.getNumber(),
+                        commentToDelete.getId()));
+            }
+        }
+    }
 }

src/main/java/io/quarkus/bot/util/Strings.java

@@ -1,6 +1,7 @@
 package io.quarkus.bot.util;
 
 public class Strings {
+    public static final String EDITORIAL_RULES_COMMENT_MARKER = "\n<!-- Quarkus-Bot-Editor-Rules -->";
 
     public static boolean isNotBlank(String string) {
         return string != null && !string.trim().isEmpty();
@@ -19,6 +20,10 @@ public static String commentByBot(String originalComment) {
         return sb.toString();
     }
 
+    public static String editorialCommentByBot(String originalComment) {
+        return commentByBot(originalComment) + EDITORIAL_RULES_COMMENT_MARKER;
+    }
+
     private Strings() {
     }
 }