fix: avoid unnecessary remove request if instrument already finished

ref: sourceplusplus/sourceplusplus#470

Author: BFergerson

plugin/src/main/kotlin/spp/jetbrains/sourcemarker/command/status/ui/BreakpointStatusBar.java

@@ -42,6 +42,7 @@
 import spp.jetbrains.plugin.LiveStatusBarManager;
 import spp.jetbrains.sourcemarker.command.status.ui.config.LiveBreakpointConfigurationPanel;
 import spp.jetbrains.sourcemarker.command.util.ExpressionUtils;
+import spp.jetbrains.sourcemarker.instrument.InstrumentEventWindowService;
 import spp.jetbrains.state.LiveStateBar;
 import spp.protocol.instrument.LiveBreakpoint;
 import spp.protocol.instrument.LiveInstrument;
@@ -59,6 +60,7 @@
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
+import java.util.Objects;
 import java.util.concurrent.atomic.AtomicLong;
 
 import static spp.jetbrains.PluginBundle.message;
@@ -332,13 +334,12 @@ public void dispose() {
         if (groupedMarks != null) groupedMarks.forEach(SourceMark::dispose);
 
         if (liveBreakpoint != null) {
-            UserData.liveInstrumentService(inlayMark.getProject()).removeLiveInstrument(liveBreakpoint.getId()).onComplete(it -> {
-                if (it.succeeded()) {
-                    LiveStatusBarManager.getInstance(inlayMark.getProject()).removeActiveLiveInstrument(liveBreakpoint);
-                } else {
-                    it.cause().printStackTrace();
-                }
-            });
+            String instrumentId = Objects.requireNonNull(liveBreakpoint.getId());
+            if (!InstrumentEventWindowService.getInstance(inlayMark.getProject()).isFinished(instrumentId)) {
+                UserData.liveInstrumentService(inlayMark.getProject()).removeLiveInstrument(instrumentId)
+                        .onSuccess(it -> LiveStatusBarManager.getInstance(inlayMark.getProject()).removeActiveLiveInstrument(liveBreakpoint))
+                        .onFailure(Throwable::printStackTrace);
+            }
         }
     }
 

plugin/src/main/kotlin/spp/jetbrains/sourcemarker/command/status/ui/LogStatusBar.java

@@ -38,6 +38,7 @@
 import spp.jetbrains.sourcemarker.command.status.ui.config.LiveLogConfigurationPanel;
 import spp.jetbrains.sourcemarker.command.util.AutocompleteField;
 import spp.jetbrains.sourcemarker.command.util.AutocompleteFieldRow;
+import spp.jetbrains.sourcemarker.instrument.InstrumentEventWindowService;
 import spp.jetbrains.sourcemarker.instrument.log.VariableParser;
 import spp.jetbrains.state.LiveStateBar;
 import spp.protocol.artifact.log.Log;
@@ -67,6 +68,7 @@
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
+import java.util.Objects;
 import java.util.concurrent.atomic.AtomicLong;
 import java.util.function.Function;
 import java.util.regex.Matcher;
@@ -642,13 +644,12 @@ public void dispose() {
 
         if (liveLog != null) {
             LiveStatusBarManager.getInstance(inlayMark.getProject()).removeLogData(inlayMark);
-            UserData.liveInstrumentService(inlayMark.getProject()).removeLiveInstrument(liveLog.getId()).onComplete(it -> {
-                if (it.succeeded()) {
-                    LiveStatusBarManager.getInstance(inlayMark.getProject()).removeActiveLiveInstrument(liveLog);
-                } else {
-                    it.cause().printStackTrace();
-                }
-            });
+            String instrumentId = Objects.requireNonNull(liveLog.getId());
+            if (!InstrumentEventWindowService.getInstance(inlayMark.getProject()).isFinished(instrumentId)) {
+                UserData.liveInstrumentService(inlayMark.getProject()).removeLiveInstrument(instrumentId)
+                        .onSuccess(it -> LiveStatusBarManager.getInstance(inlayMark.getProject()).removeActiveLiveInstrument(liveLog))
+                        .onFailure(Throwable::printStackTrace);
+            }
         }
         inlayMark.dispose();
     }

plugin/src/main/kotlin/spp/jetbrains/sourcemarker/instrument/InstrumentEventWindowService.kt

@@ -53,6 +53,7 @@ class InstrumentEventWindowService(
 ) : Disposable, ContentManagerListener {
 
     companion object {
+        @JvmStatic
         fun getInstance(project: Project): InstrumentEventWindowService {
             return project.getService(InstrumentEventWindowService::class.java)
         }
@@ -256,5 +257,9 @@ class InstrumentEventWindowService(
         }
     }
 
+    fun isFinished(id: String): Boolean {
+        return overviewTab.model.items.find { it.instrumentId == id }?.isFinished ?: false
+    }
+
     override fun dispose() = Unit
 }

plugin/src/main/kotlin/spp/jetbrains/sourcemarker/instrument/InstrumentNavigationHandler.kt

@@ -55,12 +55,14 @@ class InstrumentNavigationHandler(
             if (canRemove) {
                 actions.add(object : AnAction("Remove Instrument") {
                     override fun actionPerformed(e: AnActionEvent) {
+                        if (InstrumentEventWindowService.getInstance(gutterMark.project).isFinished(instrumentId)) {
+                            gutterMark.dispose()
+                            return
+                        }
+
                         UserData.liveInstrumentService(gutterMark.project)?.removeLiveInstrument(instrumentId)
-                            ?.onSuccess {
-                                gutterMark.dispose()
-                            }?.onFailure {
-                                log.error("Failed to remove live instrument", it)
-                            }
+                            ?.onSuccess { gutterMark.dispose() }
+                            ?.onFailure { log.error("Failed to remove live instrument", it) }
                     }
                 })
             }