User-interruptible evaluator jobs (#674)

* User-interruptible evaluator futures for Rascal.

* Only allow cancelling interruptible futures.

* Remove progress bars with nested jobs properly.

* Replace generic wildcard.

* User-interruptible evaluator futures for DSLs.

* Document new methods.

* Factor out `cancelProgress` to the monitor.

* Use intermediate variable for thread-safety.

Author: toinehartman

rascal-lsp/src/main/java/org/rascalmpl/vscode/lsp/BaseLanguageServer.java

@@ -51,6 +51,7 @@
 import org.eclipse.lsp4j.InitializeResult;
 import org.eclipse.lsp4j.ServerCapabilities;
 import org.eclipse.lsp4j.SetTraceParams;
+import org.eclipse.lsp4j.WorkDoneProgressCancelParams;
 import org.eclipse.lsp4j.jsonrpc.Launcher;
 import org.eclipse.lsp4j.jsonrpc.messages.Tuple.Two;
 import org.eclipse.lsp4j.services.LanguageClient;
@@ -366,5 +367,10 @@ public void connect(LanguageClient client) {
         public void registerVFS(VFSRegister registration) {
             VSCodeVFSClient.buildAndRegister(registration.getPort());
         }
+
+        @Override
+        public void cancelProgress(WorkDoneProgressCancelParams params) {
+            lspDocumentService.cancelProgress(params.getToken().getLeft());
+        }
     }
 }

rascal-lsp/src/main/java/org/rascalmpl/vscode/lsp/IBaseTextDocumentService.java

@@ -57,4 +57,5 @@ public interface IBaseTextDocumentService extends TextDocumentService {
     boolean isManagingFile(ISourceLocation file);
 
     default void didRenameFiles(RenameFilesParams params, Set<ISourceLocation> workspaceFolders) {}
+    void cancelProgress(String progressId);
 }

rascal-lsp/src/main/java/org/rascalmpl/vscode/lsp/LSPIDEServices.java

@@ -26,7 +26,6 @@
  */
 package org.rascalmpl.vscode.lsp;
 
-import java.io.IOException;
 import java.io.PrintWriter;
 import java.net.URI;
 import java.net.URISyntaxException;
@@ -196,4 +195,8 @@ public void warning(String message, ISourceLocation src) {
         monitor.warning(message, src);
     }
 
+    public IRascalMonitor getMonitor() {
+        return monitor;
+    }
+
 }

rascal-lsp/src/main/java/org/rascalmpl/vscode/lsp/RascalLSPMonitor.java

@@ -26,9 +26,13 @@
  */
 package org.rascalmpl.vscode.lsp;
 
+import java.util.Map;
 import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.ConcurrentHashMap;
 import java.util.function.Function;
+
 import org.apache.logging.log4j.Logger;
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.eclipse.lsp4j.ProgressParams;
 import org.eclipse.lsp4j.WorkDoneProgressBegin;
 import org.eclipse.lsp4j.WorkDoneProgressCreateParams;
@@ -37,6 +41,8 @@
 import org.eclipse.lsp4j.WorkDoneProgressReport;
 import org.eclipse.lsp4j.jsonrpc.messages.Either;
 import org.rascalmpl.debug.IRascalMonitor;
+import org.rascalmpl.vscode.lsp.util.concurrent.InterruptibleFuture;
+
 import io.usethesource.vallang.ISourceLocation;
 
 /**
@@ -78,7 +84,7 @@ public LSPProgressBar(String rootName, String progressId) {
 
             var msg = new WorkDoneProgressBegin();
             msg.setTitle(progressPrefix + rootName);
-            msg.setCancellable(false);
+            msg.setCancellable(activeFutures.containsKey(progressId));
             notifyProgress(msg);
         }
 
@@ -90,7 +96,7 @@ private void notifyProgress(WorkDoneProgressNotification value) {
         public void progress(String message) {
             var msg = new WorkDoneProgressReport();
             msg.setMessage(message);
-            msg.setCancellable(false);
+            msg.setCancellable(activeFutures.containsKey(progressId));
             notifyProgress(msg);
         }
 
@@ -126,6 +132,26 @@ private CompletableFuture<Void> retry(Throwable first, int retry, String id) {
     }
 
     private final ThreadLocal<LSPProgressBar> activeProgress = new ThreadLocal<>();
+    private final Map<String, InterruptibleFuture<? extends Object>> activeFutures = new ConcurrentHashMap<>();
+
+    /**
+     * Register a running {@link InterruptibleFuture}, so it can be interrupted later.
+     * Must be called from the same thread as the corresponding {@link jobStarted}.
+     * @param name The task name, equal to the one used for {@link jobStarted}.
+     * @param future The future doing the work.
+     */
+    public void registerActiveFuture(String name, InterruptibleFuture<?> future) {
+        activeFutures.put(generateProgressId(name), future);
+    }
+
+    /**
+     * Unregister an {@link InterruptibleFuture} that has finished.
+     * Must be called from the same thread as the corresponding {@link jobEnded}.
+     * @param name The task name, equal to the one used for {@link jobEnded}.
+     */
+    public void unregisterActiveFuture(String name) {
+        activeFutures.remove(generateProgressId(name));
+    }
 
     @Override
     public void jobStart(String name, int workShare, int totalWork) {
@@ -147,7 +173,6 @@ public void jobStart(String name, int workShare, int totalWork) {
     private static String generateProgressId(String topLevelName) {
         Thread t = Thread.currentThread();
         return "T" + Integer.toHexString(t.hashCode()) + "" + Long.toHexString(t.getId()) + "" + Integer.toHexString(System.identityHashCode(topLevelName));
-
     }
 
 
@@ -206,4 +231,15 @@ public boolean jobIsCanceled(String name) {
     public void warning(String message, ISourceLocation src) {
         logger.warn("{} : {}", src, message);
     }
+
+    /**
+     * Cancel the running {@link InterruptibleFuture} corresponding to a specific progress bar.
+     * @param progressId The identifier of the progress bar.
+     */
+    public void cancelProgress(String progressId) {
+        var future = activeFutures.get(progressId);
+        if (future != null) {
+            future.interrupt();
+        }
+    }
 }

rascal-lsp/src/main/java/org/rascalmpl/vscode/lsp/parametric/ILanguageContributions.java

@@ -117,6 +117,8 @@ public static interface ScheduledCalculator extends BiFunction<ISourceLocation,
      * `references`, and `implementations` as parameter.
      */
     public static interface OnDemandFocusToSetCalculator extends Function<IList, InterruptibleFuture<ISet>> { }
+
+    public void cancelProgress(String progressId);
 }
 
 /*package*/ class EmptySummary {

rascal-lsp/src/main/java/org/rascalmpl/vscode/lsp/parametric/InterpretedLanguageContributions.java

@@ -107,6 +107,7 @@ public class InterpretedLanguageContributions implements ILanguageContributions
     private final CompletableFuture<SummaryConfig> builderSummaryConfig;
     private final CompletableFuture<SummaryConfig> ondemandSummaryConfig;
     private final IBaseLanguageClient client;
+    private final RascalLSPMonitor monitor;
 
     public InterpretedLanguageContributions(LanguageParameter lang, IBaseTextDocumentService docService, BaseWorkspaceService workspaceService, IBaseLanguageClient client, ExecutorService exec) {
         this.client = client;
@@ -118,7 +119,7 @@ public InterpretedLanguageContributions(LanguageParameter lang, IBaseTextDocumen
             var pcfg = new PathConfig().parse(lang.getPathConfig());
             pcfg = EvaluatorUtil.addLSPSources(pcfg, false);
 
-            var monitor = new RascalLSPMonitor(client, LogManager.getLogger(logger.getName() + "[" + lang.getName() + "]"), lang.getName() + ": ");
+            monitor = new RascalLSPMonitor(client, LogManager.getLogger(logger.getName() + "[" + lang.getName() + "]"), lang.getName() + ": ");
 
             this.eval = EvaluatorUtil.makeFutureEvaluator(new LSPContext(exec, docService, workspaceService, client),
                 "evaluator for " + lang.getName(), monitor, pcfg, lang.getMainModule());
@@ -460,4 +461,9 @@ private <T> InterruptibleFuture<T> execFunction(String name, CompletableFuture<@
             }),
             exec);
     }
+
+    @Override
+    public void cancelProgress(String progressId) {
+        monitor.cancelProgress(progressId);
+    }
 }

rascal-lsp/src/main/java/org/rascalmpl/vscode/lsp/parametric/LanguageContributionsMultiplexer.java

@@ -369,4 +369,9 @@ public CompletableFuture<SummaryConfig> getBuilderSummaryConfig() {
     public CompletableFuture<SummaryConfig> getOndemandSummaryConfig() {
         return ondemandSummaryConfig;
     }
+
+    @Override
+    public void cancelProgress(String progressId) {
+        contributions.forEach(klc -> klc.contrib.cancelProgress(progressId));
+    }
 }

rascal-lsp/src/main/java/org/rascalmpl/vscode/lsp/parametric/ParametricTextDocumentService.java

@@ -671,4 +671,11 @@ public boolean isManagingFile(ISourceLocation file) {
     public TextDocumentState getDocumentState(ISourceLocation file) {
         return files.get(file.top());
     }
+
+    @Override
+    public void cancelProgress(String progressId) {
+        contributions.values().forEach(plex -> {
+            plex.cancelProgress(progressId);
+        });
+    }
 }

rascal-lsp/src/main/java/org/rascalmpl/vscode/lsp/parametric/ParserOnlyContribution.java

@@ -251,4 +251,9 @@ public CompletableFuture<SummaryConfig> getOndemandSummaryConfig() {
         return CompletableFuture.completedFuture(SummaryConfig.FALSY);
     }
 
+    @Override
+    public void cancelProgress(String progressId) {
+        // empty, since this contribution does not have any running tasks nor a monitor
+    }
+
 }

rascal-lsp/src/main/java/org/rascalmpl/vscode/lsp/rascal/RascalLanguageServices.java

@@ -112,12 +112,13 @@ public class RascalLanguageServices {
     private final IBaseLanguageClient client;
     private final RascalTextDocumentService rascalTextDocumentService;
     private final BaseWorkspaceService workspaceService;
+    private final RascalLSPMonitor monitor;
 
     public RascalLanguageServices(RascalTextDocumentService docService, BaseWorkspaceService workspaceService, IBaseLanguageClient client, ExecutorService exec) {
         this.client = client;
         this.exec = exec;
 
-        var monitor = new RascalLSPMonitor(client, logger);
+        monitor = new RascalLSPMonitor(client, logger);
 
         var pcfg = EvaluatorUtil.addLSPSources(new PathConfig(URIUtil.rootLocation("cwd")), true);
         var compilerPcfg = EvaluatorUtil.addRascalCompilerSources(pcfg);
@@ -411,4 +412,8 @@ public InterruptibleFuture<IList> codeActions(IList focus, PathConfig pcfg) {
         },
         VF.list(), exec, false, client);
     }
+
+    public void cancelProgress(String progressId) {
+        monitor.cancelProgress(progressId);
+    }
 }