Added more convenient constants naming, added labels support, added user info to comment.

Author: RamSaw

src/main/java/org/jetbrains/research/groups/ml_methods/error_reporting/AnonymousFeedback.java

@@ -11,19 +11,18 @@
 import org.jetbrains.research.groups.ml_methods.utils.ArchitectureReloadedBundle;
 
 import javax.annotation.Nullable;
-import java.io.IOException;
 import java.util.*;
 import java.util.Map.Entry;
 
 /**
  * Provides functionality to create and send GitHub issues when an exception is thrown by a plugin.
  */
 class AnonymousFeedback {
-    private final static String tokenFile = "errorReporterToken";
-    private final static String gitRepoUser = "ml-in-programming";
-    private final static String gitRepo = "ArchitectureReloaded";
-
-    private final static String issueLabel = "auto-generated";
+    private final static String TOKEN_FILE = "errorReporterToken";
+    private final static String GIT_REPO_USER = "ml-in-programming";
+    private final static String GIT_REPO = "ArchitectureReloaded";
+    private final static String ISSUE_LABEL_BUG = "bug";
+    private final static String ISSUE_LABEL_AUTO_GENERATED = "auto-generated";
 
     private AnonymousFeedback() {
     }
@@ -40,11 +39,11 @@ static SubmittedReportInfo sendFeedback(LinkedHashMap<String, String> environmen
 
         final SubmittedReportInfo result;
         try {
-            final String gitAccessToken = GitHubAccessTokenScrambler.decrypt(AnonymousFeedback.class.getResourceAsStream(tokenFile));
+            final String gitAccessToken = GitHubAccessTokenScrambler.decrypt(AnonymousFeedback.class.getResourceAsStream(TOKEN_FILE));
 
             GitHubClient client = new GitHubClient();
             client.setOAuth2Token(gitAccessToken);
-            RepositoryId repoID = new RepositoryId(gitRepoUser, gitRepo);
+            RepositoryId repoID = new RepositoryId(GIT_REPO_USER, GIT_REPO);
             IssueService issueService = new IssueService(client);
 
             String errorDescription = environmentDetails.get("error.description");
@@ -53,7 +52,9 @@ static SubmittedReportInfo sendFeedback(LinkedHashMap<String, String> environmen
             Issue duplicate = findFirstDuplicate(newGibHubIssue.getTitle(), issueService, repoID);
             boolean isNewIssue = true;
             if (duplicate != null) {
-                errorDescription = errorDescription == null ? "Me too!" : errorDescription;
+                // TODO: fix error description doesn't prints, implement enums
+                errorDescription = errorDescription == null ? "Me too! \n" : "";
+                errorDescription += generateGitHubIssueBody(environmentDetails, true);
                 issueService.createComment(repoID, duplicate.getNumber(), errorDescription);
                 newGibHubIssue = duplicate;
                 isNewIssue = false;
@@ -81,10 +82,9 @@ static SubmittedReportInfo sendFeedback(LinkedHashMap<String, String> environmen
      * @param service     Issue-service of the GitHub lib that lets you access all issues
      * @param repo        The repository that should be used
      * @return The duplicate if one is found or null
-     * @throws IOException Problems when connecting to GitHub
      */
     @Nullable
-    private static Issue findFirstDuplicate(String uniqueTitle, final IssueService service, RepositoryId repo) throws IOException {
+    private static Issue findFirstDuplicate(String uniqueTitle, final IssueService service, RepositoryId repo) {
         Map<String, String> searchParameters = new HashMap<>(2);
         searchParameters.put(IssueService.FILTER_STATE, IssueService.STATE_OPEN);
         final PageIterator<Issue> pages = service.pageIssues(repo, searchParameters);
@@ -119,12 +119,14 @@ private static Issue createNewGibHubIssue(LinkedHashMap<String, String> details)
         details.remove("error.hash");
 
         final Issue gitHubIssue = new Issue();
-        final String body = generateGitHubIssueBody(details);
+        final String body = generateGitHubIssueBody(details, false);
         gitHubIssue.setTitle(ArchitectureReloadedBundle.message("git.issue.title", errorHash, errorMessage));
         gitHubIssue.setBody(body);
-        Label label = new Label();
-        label.setName(issueLabel);
-        gitHubIssue.setLabels(Collections.singletonList(label));
+        Label bugLabel = new Label();
+        bugLabel.setName(ISSUE_LABEL_BUG);
+        Label autoGeneratedLabel = new Label();
+        autoGeneratedLabel.setName(ISSUE_LABEL_AUTO_GENERATED);
+        gitHubIssue.setLabels(Arrays.asList(autoGeneratedLabel, bugLabel));
         return gitHubIssue;
     }
 
@@ -135,7 +137,7 @@ private static Issue createNewGibHubIssue(LinkedHashMap<String, String> details)
      * @param details Details provided by {@link IdeaInformationProxy}
      * @return A markdown string representing the GitHub issue body.
      */
-    private static String generateGitHubIssueBody(LinkedHashMap<String, String> details) {
+    private static String generateGitHubIssueBody(LinkedHashMap<String, String> details, boolean onlyUserInfo) {
         String errorDescription = details.get("error.description");
         if (errorDescription == null) {
             errorDescription = "";
@@ -164,9 +166,11 @@ private static String generateGitHubIssueBody(LinkedHashMap<String, String> deta
             result.append("\n");
         }
 
-        result.append("\n```\n");
-        result.append(stackTrace);
-        result.append("\n```\n");
+        if (!onlyUserInfo) {
+            result.append("\n```\n");
+            result.append(stackTrace);
+            result.append("\n```\n");
+        }
 
         return result.toString();
     }

src/main/java/org/jetbrains/research/groups/ml_methods/error_reporting/GitHubErrorReporter.java

@@ -76,7 +76,11 @@ private static boolean doSubmit(final IdeaLoggingEvent event,
 
         final CallbackWithNotification notifyingCallback = new CallbackWithNotification(callback, project);
         AnonymousFeedbackTask task =
-                new AnonymousFeedbackTask(project, ArchitectureReloadedBundle.message("report.error.progress.dialog.text"), true, reportValues, notifyingCallback);
+                new AnonymousFeedbackTask(project,
+                        ArchitectureReloadedBundle.message("report.error.progress.dialog.text"),
+                        true,
+                        reportValues,
+                        notifyingCallback);
         if (project == null) {
             task.run(new EmptyProgressIndicator());
         } else {

src/main/resources/ArchitectureReloadedBundle.properties

@@ -39,6 +39,5 @@ report.error.to.plugin.vendor = Report error to plugin vendor
 report.error.progress.dialog.text = Submitting error report...
 report.error.connection.failure = Could not communicate with GitHub
 git.issue.title = [auto-generated:{0}] {1}
-git.issue.label = auto-generated
 git.issue.text = <a href="{0}">Created issue {1}</a>. Thank you for your feedback!
 git.issue.duplicate.text = <a href="{0}">A similar issues was already reported (#{1})</a>. Thank you for your feedback!