Fixed Pull Request comments automatic deletion

1.Extend parsing of Bitbucket comments and tasks from REST response
2.Add API for deletion of Bitbucket tasks
3.Delete Bitbucket tasks and sub-comments recursively before removing a comment

Author: Peijie Liu

src/main/java/se/bjurr/violations/comments/bitbucketserver/lib/BitbucketServerCommentsProvider.java

@@ -10,12 +10,17 @@
 import com.google.common.annotations.VisibleForTesting;
 import com.google.common.cache.CacheLoader;
 import com.google.common.cache.LoadingCache;
+import java.util.ArrayDeque;
 import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Deque;
+import java.util.Iterator;
 import java.util.List;
 import se.bjurr.violations.comments.bitbucketserver.lib.client.BitbucketServerClient;
 import se.bjurr.violations.comments.bitbucketserver.lib.client.model.BitbucketServerComment;
 import se.bjurr.violations.comments.bitbucketserver.lib.client.model.BitbucketServerDiff;
 import se.bjurr.violations.comments.bitbucketserver.lib.client.model.BitbucketServerDiffResponse;
+import se.bjurr.violations.comments.bitbucketserver.lib.client.model.BitbucketServerTask;
 import se.bjurr.violations.comments.bitbucketserver.lib.client.model.DiffDestination;
 import se.bjurr.violations.comments.bitbucketserver.lib.client.model.DiffHunk;
 import se.bjurr.violations.comments.bitbucketserver.lib.client.model.Line;
@@ -136,6 +141,11 @@ public void removeComments(final List<Comment> comments) {
       try {
         commentId = Integer.valueOf(comment.getIdentifier());
         commentVersion = Integer.valueOf(comment.getSpecifics().get(0));
+
+        BitbucketServerComment bitbucketServerComment = client.pullRequestComment((long) commentId);
+        removeAllSubCommentsAndTasksOfComment(bitbucketServerComment);
+
+        removeAllTasksOfComment(bitbucketServerComment);
         client.pullRequestRemoveComment(commentId, commentVersion);
       } catch (final Exception e) {
         violationsLogger.log(
@@ -212,4 +222,34 @@ public Optional<String> findCommentTemplate() {
   public boolean shouldKeepOldComments() {
     return violationCommentsToBitbucketApi.getShouldKeepOldComments();
   }
+
+  private void removeAllTasksOfComment(final BitbucketServerComment bitbucketServerComment) {
+    List<BitbucketServerTask> bitbucketServerTasks = bitbucketServerComment.getTasks();
+
+    for (BitbucketServerTask bitbucketServerTask : bitbucketServerTasks) {
+      client.removeTask(bitbucketServerTask);
+    }
+  }
+
+  private void removeAllSubCommentsAndTasksOfComment(
+      final BitbucketServerComment bitbucketServerComment) {
+    final Deque<BitbucketServerComment> commentStack = new ArrayDeque<>();
+    Collection<BitbucketServerComment> subComments = bitbucketServerComment.getComments();
+    while (subComments != null && !subComments.isEmpty()) {
+      commentStack.addAll(subComments);
+      final Collection<BitbucketServerComment> currentSubComments = subComments;
+
+      subComments = new ArrayList<>();
+      for (final BitbucketServerComment subComment : currentSubComments) {
+        subComments.addAll(subComment.getComments());
+      }
+    }
+
+    final Iterator<BitbucketServerComment> commentIt = commentStack.descendingIterator();
+    while (commentIt.hasNext()) {
+      final BitbucketServerComment comment = commentIt.next();
+      removeAllTasksOfComment(comment);
+      client.pullRequestRemoveComment(comment.getId(), comment.getVersion());
+    }
+  }
 }

src/main/java/se/bjurr/violations/comments/bitbucketserver/lib/client/BitbucketServerClient.java

@@ -11,11 +11,14 @@
 import com.jayway.jsonpath.JsonPath;
 import java.io.File;
 import java.io.UnsupportedEncodingException;
+import java.util.ArrayList;
 import java.util.LinkedHashMap;
 import java.util.List;
+import net.minidev.json.JSONArray;
 import se.bjurr.violations.comments.bitbucketserver.lib.client.BitbucketServerInvoker.Method;
 import se.bjurr.violations.comments.bitbucketserver.lib.client.model.BitbucketServerComment;
 import se.bjurr.violations.comments.bitbucketserver.lib.client.model.BitbucketServerDiffResponse;
+import se.bjurr.violations.comments.bitbucketserver.lib.client.model.BitbucketServerTask;
 import se.bjurr.violations.comments.lib.ViolationsLogger;
 
 public class BitbucketServerClient {
@@ -171,6 +174,15 @@ public BitbucketServerComment pullRequestComment(
     return toBitbucketServerComment(parsed);
   }
 
+  public BitbucketServerComment pullRequestComment(final Long commentId) {
+    String url = getBitbucketServerPullRequestBase() + "/comments/" + commentId;
+
+    final LinkedHashMap<?, ?> parsed =
+        invokeAndParse(url, BitbucketServerInvoker.Method.GET, null, "$");
+
+    return toBitbucketServerComment(parsed);
+  }
+
   public List<BitbucketServerComment> pullRequestComments(final String changedFile) {
     try {
       final String encodedChangedFile = encode(changedFile, UTF_8.name());
@@ -228,6 +240,13 @@ public void pullRequestRemoveComment(final Integer commentId, final Integer comm
         null);
   }
 
+  public void removeTask(final BitbucketServerTask task) {
+    doInvokeUrl(
+        getBitbucketServerApiBase() + "/tasks/" + task.getId(),
+        BitbucketServerInvoker.Method.DELETE,
+        null);
+  }
+
   public void commentCreateTask(
       final BitbucketServerComment comment, String changedFile, int line) {
     final String changedFileName = new File(changedFile).getName();
@@ -263,6 +282,47 @@ private BitbucketServerComment toBitbucketServerComment(LinkedHashMap<?, ?> pars
     final String text = (String) parsed.get("text");
     final Integer id = (Integer) parsed.get("id");
 
-    return new BitbucketServerComment(version, text, id);
+    final JSONArray jsonArrayTasks = (JSONArray) parsed.get("tasks");
+    final JSONArray jsonArraySubComments = (JSONArray) parsed.get("comments");
+
+    List<LinkedHashMap<?, ?>> tasks = new ArrayList<>();
+    List<LinkedHashMap<?, ?>> subComments = new ArrayList<>();
+
+    for (Object jsonArrayTask : jsonArrayTasks) {
+      LinkedHashMap<?, ?> linkedHashMap = (LinkedHashMap<?, ?>) jsonArrayTask;
+      tasks.add(linkedHashMap);
+    }
+
+    for (Object jsonArraySubComment : jsonArraySubComments) {
+      LinkedHashMap<?, ?> linkedHashMap = (LinkedHashMap<?, ?>) jsonArraySubComment;
+      subComments.add(linkedHashMap);
+    }
+
+    final List<BitbucketServerTask> bitbucketServerTasks = toBitbucketServerTasks(tasks);
+    final List<BitbucketServerComment> bitbucketServerSubComments =
+        toBitbucketServerComments(subComments);
+
+    BitbucketServerComment constructedComment = new BitbucketServerComment(version, text, id);
+
+    constructedComment.setTasks(bitbucketServerTasks);
+    constructedComment.setComments(bitbucketServerSubComments);
+
+    return constructedComment;
+  }
+
+  private BitbucketServerTask toBitbucketServerTask(LinkedHashMap<?, ?> parsed) {
+    final Integer id = (Integer) parsed.get("id");
+    final String text = (String) parsed.get("text");
+    return new BitbucketServerTask(id, text);
+  }
+
+  private List<BitbucketServerTask> toBitbucketServerTasks(List<LinkedHashMap<?, ?>> parsed) {
+    List<BitbucketServerTask> bitbucketServerTasks = new ArrayList<>();
+
+    for (LinkedHashMap<?, ?> parsedTask : parsed) {
+      bitbucketServerTasks.add(toBitbucketServerTask(parsedTask));
+    }
+
+    return bitbucketServerTasks;
   }
 }

src/main/java/se/bjurr/violations/comments/bitbucketserver/lib/client/model/BitbucketServerComment.java

@@ -1,21 +1,30 @@
 package se.bjurr.violations.comments.bitbucketserver.lib.client.model;
 
+import java.util.ArrayList;
+import java.util.List;
+
 public class BitbucketServerComment {
 
   private final Integer id;
   private final String text;
   private final Integer version;
+  private List<BitbucketServerTask> tasks;
+  private List<BitbucketServerComment> comments;
 
   public BitbucketServerComment() {
     this.id = null;
     this.text = null;
     this.version = null;
+    this.tasks = null;
+    this.comments = null;
   }
 
   public BitbucketServerComment(Integer version, String text, Integer id) {
     this.version = version;
     this.text = text;
     this.id = id;
+    this.tasks = new ArrayList<>();
+    this.comments = new ArrayList<>();
   }
 
   public Integer getId() {
@@ -29,4 +38,20 @@ public String getText() {
   public Integer getVersion() {
     return this.version;
   }
+
+  public List<BitbucketServerTask> getTasks() {
+    return tasks;
+  }
+
+  public List<BitbucketServerComment> getComments() {
+    return comments;
+  }
+
+  public void setTasks(List<BitbucketServerTask> tasks) {
+    this.tasks = tasks;
+  }
+
+  public void setComments(List<BitbucketServerComment> comments) {
+    this.comments = comments;
+  }
 }

src/main/java/se/bjurr/violations/comments/bitbucketserver/lib/client/model/BitbucketServerTask.java

@@ -0,0 +1,20 @@
+package se.bjurr.violations.comments.bitbucketserver.lib.client.model;
+
+public class BitbucketServerTask {
+  private final Integer id;
+
+  private final String text;
+
+  public BitbucketServerTask(Integer id, String text) {
+    this.text = text;
+    this.id = id;
+  }
+
+  public Integer getId() {
+    return id;
+  }
+
+  public String getText() {
+    return text;
+  }
+}