redhat-developer
diff --git a/‎docs/LSPSupport.md
Copy file name to clipboard
+9Lines changed: 9 additions & 0 deletions b/‎docs/LSPSupport.md
Copy file name to clipboard
+9Lines changed: 9 additions & 0 deletions
diff --git a/‎docs/UserGuide.md
Copy file name to clipboard
+9-1Lines changed: 9 additions & 1 deletion b/‎docs/UserGuide.md
Copy file name to clipboard
+9-1Lines changed: 9 additions & 1 deletion
diff --git a/‎src/main/java/com/redhat/devtools/lsp4ij/DocumentContentSynchronizer.java
Copy file name to clipboard
+114-12Lines changed: 114 additions & 12 deletions b/‎src/main/java/com/redhat/devtools/lsp4ij/DocumentContentSynchronizer.java
Copy file name to clipboard
+114-12Lines changed: 114 additions & 12 deletions
diff --git a/‎src/main/java/com/redhat/devtools/lsp4ij/LSPFileListener.java
Copy file name to clipboard
+1Lines changed: 1 addition & 0 deletions b/‎src/main/java/com/redhat/devtools/lsp4ij/LSPFileListener.java
Copy file name to clipboard
+1Lines changed: 1 addition & 0 deletions
diff --git a/‎src/main/java/com/redhat/devtools/lsp4ij/LSPRequestConstants.java
Copy file name to clipboard
+1Lines changed: 1 addition & 0 deletions b/‎src/main/java/com/redhat/devtools/lsp4ij/LSPRequestConstants.java
Copy file name to clipboard
+1Lines changed: 1 addition & 0 deletions
diff --git a/‎src/main/java/com/redhat/devtools/lsp4ij/LanguageServerWrapper.java
Copy file name to clipboard
+9-6Lines changed: 9 additions & 6 deletions b/‎src/main/java/com/redhat/devtools/lsp4ij/LanguageServerWrapper.java
Copy file name to clipboard
+9-6Lines changed: 9 additions & 6 deletions
diff --git a/‎src/main/java/com/redhat/devtools/lsp4ij/client/LanguageClientImpl.java
Copy file name to clipboard
+32-6Lines changed: 32 additions & 6 deletions b/‎src/main/java/com/redhat/devtools/lsp4ij/client/LanguageClientImpl.java
Copy file name to clipboard
+32-6Lines changed: 32 additions & 6 deletions
@@ -30,6 +30,7 @@ Current state of [Language Features]( https://microsoft.github.io/language-serve
  * ✅ [textDocument/definition](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_definition) (see [implementation details](#go-to-definition))
  * ✅ [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))
  * ✅ [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))
@@ -422,6 +423,14 @@ Here is an example with the [Qute language server](https://github.com/redhat-dev
 
 ![textDocument/publishDiagnostics](./images/lsp-support/textDocument_publishDiagnostics.png)
 
+### Pull Diagnostics
+
+[textDocument/diagnostic](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_pullDiagnostics) 
+is consumed after a [textDocument/didOpen](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_didOpen) and [textDocument/didChange](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_didChange)
+with debounce and refresh the LSP diagnostics  `externalAnnotator`.
+
+It doesn't support the related documents.
+
 ### Code Action
 
 Here is an example featuring the [Clojure LSP](./user-defined-ls/clojure-lsp.md), which offers code actions:
 
@@ -108,7 +108,15 @@ that you can select in the left panel via the checkboxes:
 
 ![LSP Semantic Tokens Inspector](./images/LSPSemanticTokensInspector.png)
 
-### Troubleshooting
+## Inspections
+
+You can click on `Inspect Code` hyperlink available on the `Project Errors` from the `Problems` view to 
+show all LSP diagnostics errors of your project:
+
+ - from opened files.
+ - from closed files, if your language server support it. 
+
+## Troubleshooting
 
 If the `Semantic Tokens` doesn't show the expected result, please check that:
 
 
@@ -10,19 +10,24 @@
  ******************************************************************************/
 package com.redhat.devtools.lsp4ij;
 
+import com.intellij.codeInsight.daemon.DaemonCodeAnalyzer;
+import com.intellij.openapi.Disposable;
 import com.intellij.openapi.application.ApplicationManager;
 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.Project;
 import com.intellij.openapi.vfs.VirtualFile;
 import com.intellij.psi.PsiDocumentManager;
+import com.intellij.util.Alarm;
 import org.eclipse.lsp4j.*;
 import org.eclipse.lsp4j.jsonrpc.messages.Either;
+import org.eclipse.lsp4j.services.LanguageServer;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.TimeUnit;
@@ -31,7 +36,7 @@
  * Synchronize IntelliJ document (open, content changed, close, save)
  * with LSP notifications (didOpen, didChanged, didClose, didSave).
  */
-public class DocumentContentSynchronizer implements DocumentListener {
+public class DocumentContentSynchronizer implements DocumentListener, Disposable {
 
     private static final long WAIT_AFTER_SENDING_DID_OPEN = 500L;
 
@@ -45,7 +50,11 @@ public class DocumentContentSynchronizer implements DocumentListener {
 
     private int version = 0;
     private final List<TextDocumentContentChangeEvent> changeEvents;
-    @NotNull private CompletableFuture<Void> didOpenFuture;
+    @NotNull
+    private CompletableFuture<LanguageServer> didOpenFuture;
+
+    private volatile Alarm debouncePullDiagnosticsAlarm = null;
+    private boolean diagnosticNotPulledOnDidOpen;
 
     public DocumentContentSynchronizer(@NotNull LanguageServerWrapper languageServerWrapper,
                                        @NotNull String fileUri,
@@ -66,14 +75,14 @@ public DocumentContentSynchronizer(@NotNull LanguageServerWrapper languageServer
         changeEvents = new ArrayList<>();
     }
 
-    public @NotNull CompletableFuture<Void> getDidOpenFuture() {
+    public @NotNull CompletableFuture<LanguageServer> getDidOpenFuture() {
         if (didOpenFuture != null) {
             return didOpenFuture;
         }
         return getDidOpenFutureSync();
     }
 
-    private synchronized @NotNull CompletableFuture<Void> getDidOpenFutureSync() {
+    private synchronized @NotNull CompletableFuture<LanguageServer> getDidOpenFutureSync() {
         if (didOpenFuture != null) {
             return didOpenFuture;
         }
@@ -88,12 +97,14 @@ public DocumentContentSynchronizer(@NotNull LanguageServerWrapper languageServer
         textDocument.setVersion(++version);
         didOpenFuture = languageServerWrapper
                 .getInitializedServer()
-                .thenAcceptAsync(ls -> ls.getTextDocumentService()
-                        .didOpen(new DidOpenTextDocumentParams(textDocument)))
-                .thenCompose(result ->
-                        CompletableFuture.runAsync(() -> {
+                .thenApplyAsync(ls -> {
+                    ls.getTextDocumentService()
+                            .didOpen(new DidOpenTextDocumentParams(textDocument));
+                    return ls;
+                })
+                .thenCompose(ls ->
+                        CompletableFuture.supplyAsync(() -> {
                             if (ApplicationManager.getApplication().isUnitTestMode()) {
-                                return;
                             }
                             try {
                                 // Wait 500ms after sending didOpen notification
@@ -103,8 +114,10 @@ public DocumentContentSynchronizer(@NotNull LanguageServerWrapper languageServer
                             } catch (InterruptedException e) {
                                 Thread.currentThread().interrupt();
                             }
+                            return ls;
                         })
                 );
+        processPullDiagnosticIfNeeded(didOpenFuture, version);
         return didOpenFuture;
     }
 
@@ -141,10 +154,16 @@ private void sendDidChangeEvents() {
             changeEvents.clear();
         }
 
+        final int version = ++this.version;
+        // send 'textDocument/didChange' notification
         DidChangeTextDocumentParams changeParamsToSend = new DidChangeTextDocumentParams(new VersionedTextDocumentIdentifier(), events);
         changeParamsToSend.getTextDocument().setUri(fileUri);
-        changeParamsToSend.getTextDocument().setVersion(++version);
-        languageServerWrapper.sendNotification(ls -> ls.getTextDocumentService().didChange(changeParamsToSend));
+        changeParamsToSend.getTextDocument().setVersion(version);
+        var didChange = languageServerWrapper.sendNotification(ls -> {
+            ls.getTextDocumentService().didChange(changeParamsToSend);
+            return ls;
+        });
+        processPullDiagnosticIfNeeded(didChange, version);
     }
 
     @Override
@@ -210,7 +229,10 @@ public void documentClosed() {
         if (languageServerWrapper.isActive()) {
             TextDocumentIdentifier identifier = new TextDocumentIdentifier(fileUri);
             DidCloseTextDocumentParams params = new DidCloseTextDocumentParams(identifier);
-            languageServerWrapper.sendNotification(ls -> ls.getTextDocumentService().didClose(params));
+            languageServerWrapper.sendNotification(ls -> {
+                ls.getTextDocumentService().didClose(params);
+                return ls;
+            });
         }
     }
 
@@ -241,4 +263,84 @@ int getVersion() {
         return version;
     }
 
+    @Override
+    public void dispose() {
+        documentClosed();
+    }
+
+    public void forcePullDiagnosticIfNeeded() {
+        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.
+     */
+    private void processPullDiagnosticIfNeeded(@NotNull CompletableFuture<LanguageServer> didFuture, int version) {
+        if (!isPullDiagnosticsSupported()) {
+            // The language server doesn't support pull diagnostics.
+            diagnosticNotPulledOnDidOpen = didFuture == didOpenFuture;
+            return;
+        }
+        // Initialize the Alarm which consumes 'textDocument/diagnostic' with debounce mode.
+        if (debouncePullDiagnosticsAlarm == null) {
+            debouncePullDiagnosticsAlarm = getDebouncePullDiagnosticsAlarm();
+        } else {
+            debouncePullDiagnosticsAlarm.cancelAllRequests();
+        }
+        didFuture
+                .thenApply(ls -> {
+                    // didOpen, didChange notification has been sent, consume 'textDocument/diagnostic' with debounce mode.
+                    debouncePullDiagnosticsAlarm.addRequest(() -> {
+                        if (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 -> {
+                                    // 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.
+                                        DaemonCodeAnalyzer.getInstance(languageServerWrapper.getProject()).restart(LSPIJUtils.getPsiFile(file, languageServerWrapper.getProject()));
+                                    } else if (diagnosticReport.isRight()) {
+                                        RelatedUnchangedDocumentDiagnosticReport relatedUnchangedDocumentDiagnosticReport = diagnosticReport.getRight();
+
+                                    }
+                                });
+                    }, 500);
+                    return ls;
+                });
+    }
+
+    public boolean isPullDiagnosticsSupported() {
+        return languageServerWrapper.getClientFeatures().getDiagnosticFeature().isDiagnosticSupported(file);
+    }
+
+    private Alarm getDebouncePullDiagnosticsAlarm() {
+        if (debouncePullDiagnosticsAlarm == null) {
+            synchronized (this) {
+                if (debouncePullDiagnosticsAlarm == null) {
+                    debouncePullDiagnosticsAlarm = new Alarm(Alarm.ThreadToUse.POOLED_THREAD, this);
+                }
+            }
+        }
+        return debouncePullDiagnosticsAlarm;
+    }
+
+    public boolean isDiagnosticNotPulledOnDidOpen() {
+        return diagnosticNotPulledOnDidOpen;
+    }
 }
@@ -189,6 +189,7 @@ private void didChangeWatchedFiles(FileEvent... changes) {
             DidChangeWatchedFilesParams params = new DidChangeWatchedFilesParams(Arrays.asList(changes));
             ls.getWorkspaceService()
                     .didChangeWatchedFiles(params);
+            return ls;
         });
     }
 
 
@@ -26,6 +26,7 @@ public class LSPRequestConstants {
 
     public static final String TEXT_DOCUMENT_DECLARATION = "textDocument/declaration";
     public static final String TEXT_DOCUMENT_DEFINITION = "textDocument/definition";
+    public static final String TEXT_DOCUMENT_DIAGNOSTIC = "textDocument/diagnostic";
     public static final String TEXT_DOCUMENT_DOCUMENT_LINK = "textDocument/documentLink";
     public static final String TEXT_DOCUMENT_FOLDING_RANGE = "textDocument/foldingRange";
     public static final String TEXT_DOCUMENT_SELECTION_RANGE = "textDocument/selectionRange";
 
@@ -55,7 +55,7 @@
 import java.util.concurrent.*;
 import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.concurrent.atomic.AtomicInteger;
-import java.util.function.Consumer;
+import java.util.function.Function;
 import java.util.function.UnaryOperator;
 
 import static com.redhat.devtools.lsp4ij.internal.CancellationSupport.showNotificationError;
@@ -227,6 +227,7 @@ private synchronized void stopAndRefreshEditorFeature(boolean refreshEditorFeatu
      */
     public synchronized void restart() {
         numberOfRestartAttempts = 0;
+        serverError = null;
         setEnabled(true);
         stop();
         // start the language server
@@ -785,7 +786,7 @@ private CompletableFuture<LanguageServer> getLanguageServerWhenDidOpen(@Nullable
         return null;
     }
 
-    private CompletableFuture<LanguageServer> getLanguageServerWhenDidOpen(CompletableFuture<Void> didOpenFuture) {
+    private CompletableFuture<LanguageServer> getLanguageServerWhenDidOpen(@NotNull CompletableFuture<LanguageServer> didOpenFuture) {
         if (didOpenFuture.isDone()) {
             // The didOpen has happened, no need to wait for the didOpen
             // to return the language server
@@ -830,7 +831,7 @@ void disconnect(@Nullable URI fileUri, boolean stopIfNoOpenedFiles) {
             // Remove the listener from the old document stored in synchronizer
             DocumentContentSynchronizer synchronizer = data.getSynchronizer();
             synchronizer.getDocument().removeDocumentListener(synchronizer);
-            synchronizer.documentClosed();
+            synchronizer.dispose();
         }
         if (stopIfNoOpenedFiles) {
             maybeShutdown();
@@ -883,7 +884,7 @@ public boolean isConnectedTo(URI fileUri) {
      *
      * @return all LSP files connected to this language server.
      */
-    public Collection<OpenedDocument> getOpenedFiles() {
+    public Collection<OpenedDocument> getOpenedDocuments() {
         // Create a new array list to avoid ConcurrentModificationException
         return new ArrayList<>(openedDocuments.values());
     }
@@ -952,12 +953,14 @@ public CompletableFuture<LanguageServer> getInitializedServer() {
      * Sends a notification to the wrapped language server
      *
      * @param fn LS notification to send
+     * @return
      */
-    public void sendNotification(@NotNull Consumer<LanguageServer> fn) {
+    public CompletableFuture<LanguageServer> sendNotification(@NotNull Function<LanguageServer, LanguageServer> fn) {
         // Enqueues a notification on the dispatch thread associated with the wrapped language server. This
         // ensures the interleaving of document updates and other requests in the UI is mirrored in the
         // order in which they get dispatched to the server
-        getInitializedServer().thenAcceptAsync(fn, this.dispatcher);
+        return getInitializedServer()
+                .thenApplyAsync(fn, this.dispatcher);
     }
 
     /**
 
@@ -150,8 +150,8 @@ public CompletableFuture<Void> refreshCodeLenses() {
     }
 
     private void refreshCodeLensForAllOpenedFiles() {
-        for (var fileData : wrapper.getOpenedFiles()) {
-            VirtualFile file = fileData.getFile();
+        for (var openedDocument : wrapper.getOpenedDocuments()) {
+            VirtualFile file = openedDocument.getFile();
             EditorFeatureManager.getInstance(getProject())
                     .refreshEditorFeature(file, EditorFeatureType.CODE_VISION, true);
         }
@@ -168,8 +168,8 @@ public CompletableFuture<Void> refreshInlayHints() {
     }
 
     private void refreshInlayHintsForAllOpenedFiles() {
-        for (var fileData : wrapper.getOpenedFiles()) {
-            VirtualFile file = fileData.getFile();
+        for (var openedDocument : wrapper.getOpenedDocuments()) {
+            VirtualFile file = openedDocument.getFile();
             EditorFeatureManager efm = EditorFeatureManager.getInstance(getProject());
             efm.refreshEditorFeature(file, EditorFeatureType.INLAY_HINT, true);
             efm.refreshEditorFeature(file, EditorFeatureType.DECLARATIVE_INLAY_HINT, true);
@@ -189,8 +189,8 @@ public CompletableFuture<Void> refreshSemanticTokens() {
     private void refreshSemanticTokensForAllOpenedFiles() {
         // Received request 'workspace/semanticTokens/refresh
         ReadAction.nonBlocking((Callable<Void>) () -> {
-                    for (var fileData : wrapper.getOpenedFiles()) {
-                        VirtualFile file = fileData.getFile();
+                    for (var openedDocument : wrapper.getOpenedDocuments()) {
+                        VirtualFile file = openedDocument.getFile();
                         PsiFile psiFile = LSPIJUtils.getPsiFile(file, project);
                         if (psiFile != null) {
                             // Evict the semantic tokens cache
@@ -204,6 +204,32 @@ private void refreshSemanticTokensForAllOpenedFiles() {
                 .submit(AppExecutorUtil.getAppExecutorService());
     }
 
+    @Override
+    public CompletableFuture<Void> refreshDiagnostics() {
+        return CompletableFuture.runAsync(() -> {
+            if (wrapper == null) {
+                return;
+            }
+            refreshDiagnosticsForAllOpenedFiles();
+        });
+    }
+
+    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());
+    }
+
     @Override
     public CompletableFuture<Void> createProgress(WorkDoneProgressCreateParams params) {
         return progressManager.createProgress(params);
Original file line number	Diff line number	Diff line change
`@@ -189,6 +189,7 @@ private void didChangeWatchedFiles(FileEvent... changes) {`
`189`	`189`	`DidChangeWatchedFilesParams params = new DidChangeWatchedFilesParams(Arrays.asList(changes));`
`190`	`190`	`ls.getWorkspaceService()`
`191`	`191`	`.didChangeWatchedFiles(params);`
	`192`	`+ return ls;`
`192`	`193`	`});`
`193`	`194`	`}`
`194`	`195`