Cleanup old diagnostics for deleted files (#705)

Fixes #671

Author: DavyLandman

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

@@ -39,10 +39,12 @@
 import org.apache.logging.log4j.Logger;
 import org.checkerframework.checker.nullness.qual.Nullable;
 import org.eclipse.lsp4j.ClientCapabilities;
+import org.eclipse.lsp4j.DeleteFilesParams;
 import org.eclipse.lsp4j.DidChangeConfigurationParams;
 import org.eclipse.lsp4j.DidChangeWatchedFilesParams;
 import org.eclipse.lsp4j.DidChangeWorkspaceFoldersParams;
 import org.eclipse.lsp4j.ExecuteCommandParams;
+import org.eclipse.lsp4j.FileDelete;
 import org.eclipse.lsp4j.FileOperationFilter;
 import org.eclipse.lsp4j.FileOperationOptions;
 import org.eclipse.lsp4j.FileOperationPattern;
@@ -69,10 +71,13 @@ public class BaseWorkspaceService implements WorkspaceService, LanguageClientAwa
     private final IBaseTextDocumentService documentService;
     private final CopyOnWriteArrayList<WorkspaceFolder> workspaceFolders = new CopyOnWriteArrayList<>();
 
+    private final List<FileOperationPattern> interestedInFiles;
 
-    protected BaseWorkspaceService(ExecutorService exec, IBaseTextDocumentService documentService) {
+
+    protected BaseWorkspaceService(ExecutorService exec, IBaseTextDocumentService documentService, List<FileOperationPattern> interestedInFiles) {
         this.documentService = documentService;
         this.ownExecuter = exec;
+        this.interestedInFiles = interestedInFiles;
     }
 
 
@@ -93,10 +98,21 @@ public void initialize(ClientCapabilities clientCap, @Nullable List<WorkspaceFol
                 workspaceCapabilities.setWorkspaceFolders(folderOptions);
             }
 
+            var fileOperationCapabilities = new FileOperationsServerCapabilities();
+            var whichFiles = new FileOperationOptions(interestedInFiles.stream()
+                .map(FileOperationFilter::new)
+                .collect(Collectors.toList())
+            );
+            boolean watchesSet = false;
             if (clientWorkspaceCap.getFileOperations().getDidRename()) {
-                var fileOperationCapabilities = new FileOperationsServerCapabilities();
-                fileOperationCapabilities.setDidRename(new FileOperationOptions(
-                    List.of(new FileOperationFilter(new FileOperationPattern("**")))));
+                fileOperationCapabilities.setDidRename(whichFiles);
+                watchesSet = true;
+            }
+            if (clientWorkspaceCap.getFileOperations().getDidDelete()) {
+                fileOperationCapabilities.setDidDelete(whichFiles);
+                watchesSet = true;
+            }
+            if (watchesSet) {
                 workspaceCapabilities.setFileOperations(fileOperationCapabilities);
             }
         }
@@ -139,9 +155,26 @@ public void didChangeWorkspaceFolders(DidChangeWorkspaceFoldersParams params) {
     public void didRenameFiles(RenameFilesParams params) {
         logger.debug("workspace/didRenameFiles: {}", params.getFiles());
 
-        CompletableFuture.supplyAsync(() -> {
+        ownExecuter.submit(() -> {
             documentService.didRenameFiles(params, workspaceFolders());
-            return null; // Void return type requires a return.
+        });
+
+        ownExecuter.submit(() -> {
+            // cleanup the old files (we do not get a `didDelete` event)
+            var oldFiles = params.getFiles().stream()
+                .map(f -> f.getOldUri())
+                .map(FileDelete::new)
+                .collect(Collectors.toList());
+            documentService.didDeleteFiles(new DeleteFilesParams(oldFiles));
+        });
+    }
+
+    @Override
+    public void didDeleteFiles(DeleteFilesParams params) {
+        logger.debug("workspace/didDeleteFiles: {}", params.getFiles());
+
+        ownExecuter.submit(() -> {
+            documentService.didDeleteFiles(params);
         });
     }
 
@@ -153,7 +186,7 @@ public CompletableFuture<Object> executeCommand(ExecuteCommandParams params) {
             return documentService.executeCommand(languageName, command).thenApply(v -> v);
         }
 
-        return CompletableFuture.supplyAsync(() -> params.getCommand() + " was ignored.");
+        return CompletableFuture.supplyAsync(() -> params.getCommand() + " was ignored.", ownExecuter);
     }
 
 

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

@@ -30,6 +30,7 @@
 import java.util.List;
 import java.util.concurrent.CompletableFuture;
 
+import org.eclipse.lsp4j.DeleteFilesParams;
 import org.eclipse.lsp4j.RenameFilesParams;
 import org.eclipse.lsp4j.ServerCapabilities;
 import org.eclipse.lsp4j.WorkspaceFolder;
@@ -57,6 +58,7 @@ public interface IBaseTextDocumentService extends TextDocumentService {
 
     boolean isManagingFile(ISourceLocation file);
 
-    default void didRenameFiles(RenameFilesParams params, List<WorkspaceFolder> workspaceFolders) {}
+    void didRenameFiles(RenameFilesParams params, List<WorkspaceFolder> workspaceFolders);
+    void didDeleteFiles(DeleteFilesParams params);
     void cancelProgress(String progressId);
 }

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

@@ -56,6 +56,7 @@
 import org.eclipse.lsp4j.CodeLensParams;
 import org.eclipse.lsp4j.Command;
 import org.eclipse.lsp4j.DefinitionParams;
+import org.eclipse.lsp4j.DeleteFilesParams;
 import org.eclipse.lsp4j.Diagnostic;
 import org.eclipse.lsp4j.DidChangeTextDocumentParams;
 import org.eclipse.lsp4j.DidCloseTextDocumentParams;
@@ -81,6 +82,7 @@
 import org.eclipse.lsp4j.PrepareRenameDefaultBehavior;
 import org.eclipse.lsp4j.PrepareRenameParams;
 import org.eclipse.lsp4j.PrepareRenameResult;
+import org.eclipse.lsp4j.PublishDiagnosticsParams;
 import org.eclipse.lsp4j.Range;
 import org.eclipse.lsp4j.ReferenceParams;
 import org.eclipse.lsp4j.RenameFilesParams;
@@ -295,6 +297,19 @@ public void didClose(DidCloseTextDocumentParams params) {
         facts(params.getTextDocument()).close(Locations.toLoc(params.getTextDocument()));
     }
 
+    @Override
+    public void didDeleteFiles(DeleteFilesParams params) {
+        ownExecuter.submit(() -> {
+            // if a file is deleted, and we were tracking it, we remove our diagnostics
+            for (var f : params.getFiles()) {
+                if (registeredExtensions.containsKey(extension(f.getUri()))) {
+                    client.publishDiagnostics(new PublishDiagnosticsParams(f.getUri(), List.of()));
+                }
+            }
+        });
+    }
+
+
     private void triggerAnalyzer(TextDocumentItem doc, Duration delay) {
         triggerAnalyzer(new VersionedTextDocumentIdentifier(doc.getUri(), doc.getVersion()), delay);
     }

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

@@ -26,13 +26,15 @@
  */
 package org.rascalmpl.vscode.lsp.parametric;
 
+import java.util.List;
 import java.util.concurrent.ExecutorService;
 
+import org.eclipse.lsp4j.FileOperationPattern;
 import org.rascalmpl.vscode.lsp.BaseWorkspaceService;
 import org.rascalmpl.vscode.lsp.IBaseTextDocumentService;
 
 public class ParametricWorkspaceService extends BaseWorkspaceService {
     ParametricWorkspaceService(ExecutorService exec, IBaseTextDocumentService docService) {
-        super(exec, docService);
+        super(exec, docService, List.of(new FileOperationPattern("**/*")));
     }
 }

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

@@ -52,6 +52,7 @@
 import org.eclipse.lsp4j.CodeLensParams;
 import org.eclipse.lsp4j.Command;
 import org.eclipse.lsp4j.DefinitionParams;
+import org.eclipse.lsp4j.DeleteFilesParams;
 import org.eclipse.lsp4j.Diagnostic;
 import org.eclipse.lsp4j.DidChangeTextDocumentParams;
 import org.eclipse.lsp4j.DidCloseTextDocumentParams;
@@ -73,6 +74,7 @@
 import org.eclipse.lsp4j.PrepareRenameDefaultBehavior;
 import org.eclipse.lsp4j.PrepareRenameParams;
 import org.eclipse.lsp4j.PrepareRenameResult;
+import org.eclipse.lsp4j.PublishDiagnosticsParams;
 import org.eclipse.lsp4j.Range;
 import org.eclipse.lsp4j.RenameFilesParams;
 import org.eclipse.lsp4j.RenameOptions;
@@ -237,6 +239,16 @@ public void didClose(DidCloseTextDocumentParams params) {
         }
     }
 
+    @Override
+    public void didDeleteFiles(DeleteFilesParams params) {
+        ownExecuter.submit(() -> {
+            // if a file is deleted, we remove our diagnostics
+            for (var f : params.getFiles()) {
+                client.publishDiagnostics(new PublishDiagnosticsParams(f.getUri(), List.of()));
+            }
+        });
+    }
+
     @Override
     public void didSave(DidSaveTextDocumentParams params) {
         logger.debug("Save: {}", params.getTextDocument());

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

@@ -26,9 +26,11 @@
  */
 package org.rascalmpl.vscode.lsp.rascal;
 
+import java.util.List;
 import java.util.concurrent.ExecutorService;
 
 import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
+import org.eclipse.lsp4j.FileOperationPattern;
 import org.eclipse.lsp4j.services.LanguageClient;
 import org.rascalmpl.vscode.lsp.BaseWorkspaceService;
 import org.rascalmpl.vscode.lsp.IBaseTextDocumentService;
@@ -37,7 +39,7 @@ public class RascalWorkspaceService extends BaseWorkspaceService {
     private @MonotonicNonNull LanguageClient client;
 
     RascalWorkspaceService(ExecutorService exec, IBaseTextDocumentService documentService) {
-        super(exec, documentService);
+        super(exec, documentService, List.of(new FileOperationPattern("**/*.rsc")));
     }
 
     @Override