feat: Support for workspace/diagnostic/refresh

angelozerr · angelozerr · commit 2ecdd9ba522b · 2025-03-31T16:27:11.000+02:00
Signed-off-by: azerr &lt;azerr@redhat.com&gt;
diff --git a/docs/LSPSupport.md b/docs/LSPSupport.md
@@ -31,6 +31,7 @@ Current state of [Language Features]( https://microsoft.github.io/language-serve
  * ✅ [textDocument/documentHighlight](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_documentHighlight) (see [implementation details](#document-highlight))
  * ✅ [textDocument/publishDiagnostics](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_publishDiagnostics) (see [implementation details](#publish-diagnostics))
  * ✅ [textDocument/diagnostic](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_pullDiagnostics) (see [implementation details](#pull-diagnostics))
+ * ✅ [workspace/diagnostic/refresh](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#diagnostic_refresh) 
  * ✅ [textDocument/documentLink](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_documentLink) (see [implementation details](#document-link))
  * ❌ [documentLink/resolve](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#documentLink_resolve).
  * ✅ [textDocument/hover](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_hover) (see [implementation details](#hover))
diff --git a/src/main/java/com/redhat/devtools/lsp4ij/DocumentContentSynchronizer.java b/src/main/java/com/redhat/devtools/lsp4ij/DocumentContentSynchronizer.java
@@ -43,6 +43,11 @@
  */
 public class DocumentContentSynchronizer implements DocumentListener, Disposable {
 
+    public enum RefreshPullDiagnosticOrigin {
+        ON_REGISTER_CAPABILITY,
+        ON_WORKSPACE_REFRESH
+    }
+
     private static final long WAIT_AFTER_SENDING_DID_OPEN = 500L;
 
     private final @NotNull LanguageServerWrapper languageServerWrapper;
@@ -273,11 +278,27 @@ public void dispose() {
         documentClosed();
     }
 
-    public void forcePullDiagnosticIfNeeded() {
-        if (!diagnosticNotPulledOnDidOpen) {
-            return;
+    /**
+     * Refresh pull diagnostic according the given origin.
+     *
+     * @param origin the origin (call by 'textDocument/diagnostic' by dynamic registerCapability or by 'workspace/diagnostic/refresh')
+     */
+    public void refreshPullDiagnostic(@NotNull RefreshPullDiagnosticOrigin origin) {
+        int currentVersion = version;
+        if (origin == RefreshPullDiagnosticOrigin.ON_REGISTER_CAPABILITY) {
+            // called by 'textDocument/diagnostic' by dynamic registerCapability
+            // we need to consume the 'textDocument/diagnostic' if when didOpen has occurred, the pull diagnostic
+            // capability was not enabled.
+            if (!diagnosticNotPulledOnDidOpen) {
+                // the didOpen have already consumed the 'textDocument/diagnostic', do nothing
+                return;
+            }
+        } else if (origin == RefreshPullDiagnosticOrigin.ON_WORKSPACE_REFRESH) {
+            // called by 'workspace/diagnostic/refresh'
+            // Set version to -1 to force the call of the pull diagnostic even if version has not changed.
+            currentVersion = -1;
         }
-        processPullDiagnosticIfNeeded(didOpenFuture, version);
+        processPullDiagnosticIfNeeded(null, currentVersion);
     }
 
     /**
@@ -286,12 +307,28 @@ public void forcePullDiagnosticIfNeeded() {
      * @param didFuture the didOpen, didChange future.
      * @param version   the current document version.
      */
-    private void processPullDiagnosticIfNeeded(@NotNull CompletableFuture<LanguageServer> didFuture, int version) {
+    private void processPullDiagnosticIfNeeded(@Nullable CompletableFuture<LanguageServer> didFuture, int version) {
+        boolean debounceValidation = didFuture != null;
         if (!isPullDiagnosticsSupported()) {
             // The language server doesn't support pull diagnostics.
-            diagnosticNotPulledOnDidOpen = didFuture == didOpenFuture;
+            diagnosticNotPulledOnDidOpen = didFuture != null && didFuture == didOpenFuture;
+            return;
+        }
+        if (!debounceValidation) {
+            // Refresh pull diagnostic without debounce
+            if (version != -1 && version != this.version) {
+                // The document has changed, do nothing
+                return;
+            }
+            var ls = didOpenFuture.getNow(null);
+            if (ls == null) {
+                // The didOpen is not finished, ignore the pull diagnostic
+                return;
+            }
+            refreshPullDiagnostic(version, ls);
             return;
         }
+        // Refresh pull diagnostic with debounce (after a didOpen , didChange).
         // Initialize the Alarm which consumes 'textDocument/diagnostic' with debounce mode.
         if (debouncePullDiagnosticsAlarm == null) {
             debouncePullDiagnosticsAlarm = getDebouncePullDiagnosticsAlarm();
@@ -302,44 +339,47 @@ private void processPullDiagnosticIfNeeded(@NotNull CompletableFuture<LanguageSe
                 .thenApply(ls -> {
                     // didOpen, didChange notification has been sent, consume 'textDocument/diagnostic' with debounce mode.
                     debouncePullDiagnosticsAlarm.addRequest(() -> {
-                        if (version != this.version) {
+                        if (version != -1 && version != this.version) {
                             // The document has changed, do nothing
                             return;
                         }
-
-                        // Consume 'textDocument/diagnostic'
-                        DocumentDiagnosticParams params = new DocumentDiagnosticParams();
-                        params.setTextDocument(new TextDocumentIdentifier(fileUri));
-                        ls.getTextDocumentService()
-                                .diagnostic(params)
-                                .thenAcceptAsync(diagnosticReport -> {
-                                    if (version != this.version) {
-                                        // The document has changed, do nothing
-                                        return;
-                                    }
-                                    // Update the diagnostics cache from the opened file and refresh UI to process LSPDiagnosticAnnotator.
-                                    if (diagnosticReport.isLeft()) {
-                                        RelatedFullDocumentDiagnosticReport fullDocumentDiagnosticReport = diagnosticReport.getLeft();
-                                        var items = fullDocumentDiagnosticReport.getItems();
-                                        // Update the diagnostics cache from the opened file
-                                        var openedDocument = languageServerWrapper.getOpenedDocument(LSPIJUtils.toUri(file));
-                                        openedDocument.updateDiagnostics(items != null ? items : Collections.emptyList());
-                                        // Refresh UI to process LSPDiagnosticAnnotator.
-                                        refreshLSPDiagnostics();
-                                    } else if (diagnosticReport.isRight()) {
-                                        RelatedUnchangedDocumentDiagnosticReport relatedUnchangedDocumentDiagnosticReport = diagnosticReport.getRight();
-
-                                    }
-
-                                });
+                        refreshPullDiagnostic(version, ls);
                     }, 500);
                     return ls;
                 });
     }
 
+    private void refreshPullDiagnostic(int version, LanguageServer ls) {
+        // Consume 'textDocument/diagnostic'
+        DocumentDiagnosticParams params = new DocumentDiagnosticParams();
+        params.setTextDocument(new TextDocumentIdentifier(fileUri));
+        ls.getTextDocumentService()
+                .diagnostic(params)
+                .thenAcceptAsync(diagnosticReport -> {
+                    if (version != -1 && version != this.version) {
+                        // The document has changed, do nothing
+                        return;
+                    }
+                    // Update the diagnostics cache from the opened file and refresh UI to process LSPDiagnosticAnnotator.
+                    if (diagnosticReport.isLeft()) {
+                        RelatedFullDocumentDiagnosticReport fullDocumentDiagnosticReport = diagnosticReport.getLeft();
+                        var items = fullDocumentDiagnosticReport.getItems();
+                        // Update the diagnostics cache from the opened file
+                        var openedDocument = languageServerWrapper.getOpenedDocument(LSPIJUtils.toUri(file));
+                        openedDocument.updateDiagnostics(items != null ? items : Collections.emptyList());
+                        // Refresh UI to process LSPDiagnosticAnnotator.
+                        refreshLSPDiagnostics();
+                    } else if (diagnosticReport.isRight()) {
+                        // TODO ...
+                        RelatedUnchangedDocumentDiagnosticReport relatedUnchangedDocumentDiagnosticReport = diagnosticReport.getRight();
+                    }
+
+                });
+    }
+
     private void refreshLSPDiagnostics() {
         var project = languageServerWrapper.getProject();
-        var coalesceBy = new CoalesceByKey("textDocument/diagnostics", fileUri);
+        var coalesceBy = new CoalesceByKey("textDocument/diagnostic", fileUri);
         var executeInSmartMode = DumbService.getInstance(project).isDumb();
         var action = ReadAction.nonBlocking((Callable<Void>) () -> {
                     var psiFile = LSPIJUtils.getPsiFile(file, project);
diff --git a/src/main/java/com/redhat/devtools/lsp4ij/client/LanguageClientImpl.java b/src/main/java/com/redhat/devtools/lsp4ij/client/LanguageClientImpl.java
@@ -216,18 +216,9 @@ public CompletableFuture<Void> refreshDiagnostics() {
 
     private void refreshDiagnosticsForAllOpenedFiles() {
         // Received request 'workspace/diagnostic/refresh
-        ReadAction.nonBlocking((Callable<Void>) () -> {
-                    for (var openedDocument : wrapper.getOpenedDocuments()) {
-                        VirtualFile file = openedDocument.getFile();
-                        PsiFile psiFile = LSPIJUtils.getPsiFile(file, project);
-                        if (psiFile != null) {
-                            // Refresh the UI
-                            DaemonCodeAnalyzer.getInstance(psiFile.getProject()).restart(psiFile);
-                        }
-                    }
-                    return null;
-                }).coalesceBy(this)
-                .submit(AppExecutorUtil.getAppExecutorService());
+        for (var openedDocument : wrapper.getOpenedDocuments()) {
+            openedDocument.getSynchronizer().refreshPullDiagnostic(DocumentContentSynchronizer.RefreshPullDiagnosticOrigin.ON_WORKSPACE_REFRESH);
+        }
     }
 
     @Override
diff --git a/src/main/java/com/redhat/devtools/lsp4ij/internal/ClientCapabilitiesFactory.java b/src/main/java/com/redhat/devtools/lsp4ij/internal/ClientCapabilitiesFactory.java
@@ -119,7 +119,7 @@ private static GeneralClientCapabilities getGeneralClientCapabilities() {
         // Support for 'textDocument/diagnostic'
         final var diagnosticCapabilities = new DiagnosticCapabilities();
         diagnosticCapabilities.setDynamicRegistration(Boolean.TRUE);
-        diagnosticCapabilities.setRelatedDocumentSupport(Boolean.FALSE);
+        diagnosticCapabilities.setRelatedDocumentSupport(Boolean.TRUE);
         textDocumentClientCapabilities.setDiagnostic(diagnosticCapabilities);
 
         // Code Action support
diff --git a/src/main/java/com/redhat/devtools/lsp4ij/server/capabilities/DiagnosticCapabilityRegistry.java b/src/main/java/com/redhat/devtools/lsp4ij/server/capabilities/DiagnosticCapabilityRegistry.java
@@ -13,6 +13,7 @@
 import com.google.gson.JsonObject;
 import com.intellij.openapi.vfs.VirtualFile;
 import com.intellij.psi.PsiFile;
+import com.redhat.devtools.lsp4ij.DocumentContentSynchronizer;
 import com.redhat.devtools.lsp4ij.JSONUtils;
 import com.redhat.devtools.lsp4ij.client.features.LSPClientFeatures;
 import org.eclipse.lsp4j.DiagnosticRegistrationOptions;
@@ -81,7 +82,7 @@ public boolean isDiagnosticSupported(@NotNull VirtualFile file) {
         // - didOpen have not processed pull diagnostic
         // - and if language server support it for now if textDocument/diagnostic has been dynamically registered.
         for (var openedDocument :  getClientFeatures().getServerWrapper().getOpenedDocuments()) {
-            openedDocument.getSynchronizer().forcePullDiagnosticIfNeeded();
+            openedDocument.getSynchronizer().refreshPullDiagnostic(DocumentContentSynchronizer.RefreshPullDiagnosticOrigin.ON_REGISTER_CAPABILITY);
         }
         return options;
     }
