fix: ensure ReadAction when pull diagnostics must be refreshed

angelozerr · angelozerr · commit f286abf3f4a2 · 2025-03-31T13:15:49.000+02:00
Signed-off-by: azerr &lt;azerr@redhat.com&gt;
diff --git a/src/main/java/com/redhat/devtools/lsp4ij/DocumentContentSynchronizer.java b/src/main/java/com/redhat/devtools/lsp4ij/DocumentContentSynchronizer.java
@@ -13,13 +13,17 @@
 import com.intellij.codeInsight.daemon.DaemonCodeAnalyzer;
 import com.intellij.openapi.Disposable;
 import com.intellij.openapi.application.ApplicationManager;
+import com.intellij.openapi.application.ReadAction;
 import com.intellij.openapi.editor.Document;
 import com.intellij.openapi.editor.event.DocumentEvent;
 import com.intellij.openapi.editor.event.DocumentListener;
+import com.intellij.openapi.project.DumbService;
 import com.intellij.openapi.project.Project;
 import com.intellij.openapi.vfs.VirtualFile;
 import com.intellij.psi.PsiDocumentManager;
 import com.intellij.util.Alarm;
+import com.intellij.util.concurrency.AppExecutorUtil;
+import com.redhat.devtools.lsp4ij.client.CoalesceByKey;
 import org.eclipse.lsp4j.*;
 import org.eclipse.lsp4j.jsonrpc.messages.Either;
 import org.eclipse.lsp4j.services.LanguageServer;
@@ -29,6 +33,7 @@
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
+import java.util.concurrent.Callable;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.TimeUnit;
 
@@ -269,16 +274,17 @@ public void dispose() {
     }
 
     public void forcePullDiagnosticIfNeeded() {
-        if(!diagnosticNotPulledOnDidOpen) {
+        if (!diagnosticNotPulledOnDidOpen) {
             return;
         }
         processPullDiagnosticIfNeeded(didOpenFuture, version);
     }
 
     /**
      * Process LSP pull diagnostic if the language server supports it.
+     *
      * @param didFuture the didOpen, didChange future.
-     * @param version the current document version.
+     * @param version   the current document version.
      */
     private void processPullDiagnosticIfNeeded(@NotNull CompletableFuture<LanguageServer> didFuture, int version) {
         if (!isPullDiagnosticsSupported()) {
@@ -300,12 +306,17 @@ private void processPullDiagnosticIfNeeded(@NotNull CompletableFuture<LanguageSe
                             // 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();
@@ -314,17 +325,37 @@ private void processPullDiagnosticIfNeeded(@NotNull CompletableFuture<LanguageSe
                                         var openedDocument = languageServerWrapper.getOpenedDocument(LSPIJUtils.toUri(file));
                                         openedDocument.updateDiagnostics(items != null ? items : Collections.emptyList());
                                         // Refresh UI to process LSPDiagnosticAnnotator.
-                                        DaemonCodeAnalyzer.getInstance(languageServerWrapper.getProject()).restart(LSPIJUtils.getPsiFile(file, languageServerWrapper.getProject()));
+                                        refreshLSPDiagnostics();
                                     } else if (diagnosticReport.isRight()) {
                                         RelatedUnchangedDocumentDiagnosticReport relatedUnchangedDocumentDiagnosticReport = diagnosticReport.getRight();
 
                                     }
+
                                 });
                     }, 500);
                     return ls;
                 });
     }
 
+    private void refreshLSPDiagnostics() {
+        var project = languageServerWrapper.getProject();
+        var coalesceBy = new CoalesceByKey("textDocument/diagnostics", fileUri);
+        var executeInSmartMode = DumbService.getInstance(project).isDumb();
+        var action = ReadAction.nonBlocking((Callable<Void>) () -> {
+                    var psiFile = LSPIJUtils.getPsiFile(file, project);
+                    if (psiFile == null) {
+                        return null;
+                    }
+                    DaemonCodeAnalyzer.getInstance(project).restart(psiFile);
+                    return null;
+                }).expireWith(languageServerWrapper)
+                .coalesceBy(coalesceBy);
+        if (executeInSmartMode) {
+            action.inSmartMode(project);
+        }
+        action.submit(AppExecutorUtil.getAppExecutorService());
+    }
+
     public boolean isPullDiagnosticsSupported() {
         return languageServerWrapper.getClientFeatures().getDiagnosticFeature().isDiagnosticSupported(file);
     }
