Merge pull request #653 from SeeSharpSoft/main

Release 3.2.3

Author: SeeSharpSoft

CHANGELOG

@@ -1,3 +1,9 @@
+3.2.3
+Nov 05, 2023
+
+NEW: Prevent github issue submitter spam
+FIX: Improve issue duplicate finder
+
 3.2.2
 Oct 14, 2023
 

build.gradle

@@ -75,7 +75,7 @@ var final DEFAULT_VERSION = '2022.2.1' //'LATEST-EAP-SNAPSHOT' //
 var idea_version = System.getenv().getOrDefault('IDEA_VERSION', DEFAULT_VERSION)
 var build_version = idea_version == EAP_VERSION ? EAP_BUILD : idea_version.substring(2, 4) + idea_version.charAt(5) // extract e.g. '221' from '2022.1.1'
 
-version '3.2.2-' + build_version
+version '3.2.3-' + build_version
 
 apply plugin: 'org.jetbrains.intellij'
 intellij {
@@ -96,10 +96,8 @@ patchPluginXml {
     sinceBuild = build_version
 
     changeNotes = """<pre style="font-family: sans-serif">
-FIX: NullPointerException: Cannot invoke "getSelectedColumn()" because "tblEditor" is null #519
-FIX: IllegalStateException: Attempt to modify PSI for non-committed Document! #516
-FIX: StringIndexOutOfBoundsException: begin 0, end -1, length 5995 #511
-FIX: ArrayIndexOutOfBoundsException: 12 >= 12 #482
+NEW: Prevent github issue submitter spam
+FIX: Improve issue duplicate finder
 </pre>"""
 }
 publishPlugin {

src/main/java/net/seesharpsoft/intellij/plugins/csv/CsvGithubIssueSubmitter.java

@@ -25,6 +25,10 @@
 import java.awt.*;
 import java.io.IOException;
 import java.util.Collections;
+import java.util.concurrent.Executors;
+import java.util.concurrent.ScheduledExecutorService;
+import java.util.concurrent.ScheduledFuture;
+import java.util.concurrent.TimeUnit;
 
 public class CsvGithubIssueSubmitter extends ErrorReportSubmitter {
 
@@ -34,6 +38,9 @@ public class CsvGithubIssueSubmitter extends ErrorReportSubmitter {
     public static final String GIT_REPO = "intellij-csv-validator";
     public static final GHRepositoryPath GITHUB_FULL_PATH = new GHRepositoryPath(GIT_USER, GIT_REPO);
 
+    private static ScheduledFuture recentlySentReport = null;
+    private static ScheduledExecutorService executorService = Executors.newSingleThreadScheduledExecutor();
+
     private static class CsvGithubSubmitException extends RuntimeException {
         CsvGithubSubmitException(Throwable exception) {
             super(exception);
@@ -47,7 +54,9 @@ public String getReportActionText() {
     }
 
     @Override
-    public boolean submit(IdeaLoggingEvent @NotNull [] events, @Nullable String additionalInfo, @NotNull Component parentComponent, @NotNull Consumer<? super SubmittedReportInfo> consumer) {
+    public synchronized boolean submit(IdeaLoggingEvent @NotNull [] events, @Nullable String additionalInfo, @NotNull Component parentComponent, @NotNull Consumer<? super SubmittedReportInfo> consumer) {
+        if (reportWasRecentlySent()) return true;
+
         final DataContext dataContext = DataManager.getInstance().getDataContext(parentComponent);
         final Project project = CommonDataKeys.PROJECT.getData(dataContext);
 
@@ -56,9 +65,19 @@ public boolean submit(IdeaLoggingEvent @NotNull [] events, @Nullable String addi
                 return false;
             }
         }
+
+        reportWasSent();
         return true;
     }
 
+    protected void reportWasSent() {
+        recentlySentReport = executorService.schedule(() -> { recentlySentReport = null; }, 15, TimeUnit.MINUTES);
+    }
+
+    protected boolean reportWasRecentlySent() {
+        return recentlySentReport != null;
+    }
+
     protected boolean submit(IdeaLoggingEvent event, String additionalInfo, Project project, Consumer<? super SubmittedReportInfo> consumer) {
         GithubAuthenticationManager githubAuthManager = GithubAuthenticationManager.getInstance();
         if (!githubAuthManager.ensureHasAccounts(project)) {
@@ -172,7 +191,8 @@ protected int getIssueTitleCutIndex(String throwableTextArg) {
     protected String getIssueTitle(IdeaLoggingEvent event) {
         String throwableText = event.getThrowableText();
         int index = getIssueTitleCutIndex(throwableText);
-        return "[Automated Report] " + event.getThrowableText().substring(0, index);
+        String issueTitle = throwableText.substring(0, index).replaceAll("@[0-9a-fA-F]+", "");
+        return "[Automated Report] " + issueTitle;
     }
 
     protected String getIssueDetails(IdeaLoggingEvent event, String additionalInfo) {

src/test/java/net/seesharpsoft/intellij/plugins/csv/CsvGithubIssueSubmitterTest.java

@@ -0,0 +1,43 @@
+package net.seesharpsoft.intellij.plugins.csv;
+
+import com.intellij.openapi.diagnostic.IdeaLoggingEvent;
+import com.intellij.testFramework.UsefulTestCase;
+
+import java.io.PrintStream;
+import java.io.PrintWriter;
+
+public class CsvGithubIssueSubmitterTest extends UsefulTestCase {
+
+    // for accessing protected methods during test
+    class CsvGithubIssueSubmitterSubClass extends CsvGithubIssueSubmitter {
+    }
+
+    class DummyException extends Throwable {
+        public DummyException(String message) {
+            super(message);
+        }
+
+        public void printStackTrace(PrintStream stream) {
+            stream.println(this.getMessage());
+        }
+
+        public void printStackTrace(PrintWriter writer) {
+            writer.println(this.getMessage());
+        }
+    }
+
+    private CsvGithubIssueSubmitterSubClass classUnderTest = new CsvGithubIssueSubmitterSubClass();
+
+    public void testGetIssueTitle() {
+        assertEquals("[Automated Report] Test", classUnderTest.getIssueTitle(new IdeaLoggingEvent("Test", new DummyException("Test"))));
+        assertEquals("[Automated Report] Unhandled exception in [CoroutineName(com.intellij.openapi.fileEditor.impl.PsiAwareFileEditorManagerImpl), StandaloneCoroutine{Cancelling}, Dispatchers.Default]", classUnderTest.getIssueTitle(new IdeaLoggingEvent("Test", new DummyException("Unhandled exception in [CoroutineName(com.intellij.openapi.fileEditor.impl.PsiAwareFileEditorManagerImpl), StandaloneCoroutine{Cancelling}@5cfe3e69, Dispatchers.Default]"))));
+        assertEquals("[Automated Report] An invalid state was detected that occurs if the key's equals or hashCode was modified while it resided in the cache. This violation of the Map contract can lead to non-deterministic behavior (key: com.intellij.psi.impl.ElementBase$ElementIconRequest, key type: ElementIconRequest, node type: PSMS, cache type: SSMS).",
+                classUnderTest.getIssueTitle(new IdeaLoggingEvent("", new DummyException("An invalid state was detected that occurs if the key's equals or hashCode was modified while it resided in the cache. This violation of the Map contract can lead to non-deterministic behavior (key: com.intellij.psi.impl.ElementBase$ElementIconRequest@e2330a, key type: ElementIconRequest, node type: PSMS, cache type: SSMS)."))));
+    }
+
+    public void testRecentSent() {
+        assertEquals(false, classUnderTest.reportWasRecentlySent());
+        classUnderTest.reportWasSent();
+        assertEquals(true, classUnderTest.reportWasRecentlySent());
+    }
+}