fix: Closing one module window doesn't shutdown the running LS instances

Fixes #1069

Signed-off-by: azerr <[email protected]>

src/main/java/com/redhat/devtools/intellij/lsp4ij/ConnectDocumentToLanguageServerSetupParticipant.java

@@ -33,7 +33,7 @@ public void projectOpened(@NotNull Project project) {
     @Override
     public void projectClosing(@NotNull Project project) {
         LanguageServerLifecycleManager.getInstance(project).dispose();
-        LanguageServiceAccessor.getInstance(project).shutdownAllDispatchers();
+        LanguageServiceAccessor.getInstance(project).projectClosing(project);
     }
 
     @Override

src/main/java/com/redhat/devtools/intellij/lsp4ij/LSPVirtualFileWrapper.java

@@ -14,6 +14,9 @@
  *******************************************************************************/
 package com.redhat.devtools.intellij.lsp4ij;
 
+import com.intellij.openapi.Disposable;
+import com.intellij.openapi.module.Module;
+import com.intellij.openapi.util.Disposer;
 import com.intellij.openapi.util.Key;
 import com.intellij.openapi.vfs.VirtualFile;
 import com.redhat.devtools.intellij.lsp4ij.operations.diagnostics.LSPDiagnosticsForServer;
@@ -35,7 +38,7 @@
  *
  * @author Angelo ZERR
  */
-public class LSPVirtualFileWrapper {
+public class LSPVirtualFileWrapper implements Disposable {
 
     private static final Key<LSPVirtualFileWrapper> KEY = new Key<>(LSPVirtualFileWrapper.class.getName());
 
@@ -46,6 +49,10 @@ public class LSPVirtualFileWrapper {
     LSPVirtualFileWrapper(VirtualFile file) {
         this.file = file;
         this.dataPerServer = new HashMap<>();
+        Module project = LSPIJUtils.getProject(file);
+        if (project != null) {
+            Disposer.register(project, this);
+        }
     }
 
     public VirtualFile getFile() {
@@ -129,7 +136,9 @@ private <T> Collection<T> getData(Function<LSPVirtualFileData, ? extends T> mapp
 
     // ------------------------ Static accessor
 
+    @Override
     public void dispose() {
+        file.putUserData(KEY, null);
         this.dataPerServer.clear();
     }
 
@@ -165,7 +174,6 @@ public static void dispose(VirtualFile file) {
         LSPVirtualFileWrapper wrapper = file.getUserData(KEY);
         if (wrapper != null) {
             wrapper.dispose();
-            file.putUserData(KEY, null);
         }
     }
 }

src/main/java/com/redhat/devtools/intellij/lsp4ij/LanguageServerWrapper.java

@@ -16,6 +16,7 @@
 import com.intellij.AppTopics;
 import com.intellij.ProjectTopics;
 import com.intellij.lang.Language;
+import com.intellij.openapi.Disposable;
 import com.intellij.openapi.application.ApplicationInfo;
 import com.intellij.openapi.application.ApplicationManager;
 import com.intellij.openapi.editor.Document;
@@ -29,6 +30,7 @@
 import com.intellij.openapi.module.Module;
 import com.intellij.openapi.project.ModuleListener;
 import com.intellij.openapi.project.Project;
+import com.intellij.openapi.util.Disposer;
 import com.intellij.openapi.vfs.VirtualFile;
 import com.intellij.util.messages.MessageBusConnection;
 import com.redhat.devtools.intellij.lsp4ij.client.LanguageClientImpl;
@@ -60,12 +62,14 @@
 /**
  * Language server wrapper.
  */
-public class LanguageServerWrapper {
+public class LanguageServerWrapper implements Disposable {
+
     private static final Logger LOGGER = LoggerFactory.getLogger(LanguageServerWrapper.class);//$NON-NLS-1$
     private static final String CLIENT_NAME = "IntelliJ";
     private static final int MAX_NUMBER_OF_RESTART_ATTEMPTS = 20; // TODO move this max value in settings
 
     class Listener implements DocumentListener, FileDocumentManagerListener, FileEditorManagerListener {
+
         @Override
         public void documentChanged(@NotNull DocumentEvent event) {
             URI uri = LSPIJUtils.toUri(event.getDocument());
@@ -86,7 +90,6 @@ public void beforeDocumentSaving(@NotNull Document document) {
             }*/
         }
 
-
         @Override
         public void fileClosed(@NotNull FileEditorManager source, @NotNull VirtualFile file) {
             URI uri = LSPIJUtils.toUri(file);
@@ -95,7 +98,7 @@ public void fileClosed(@NotNull FileEditorManager source, @NotNull VirtualFile f
                     // Remove the cached file wrapper if needed
                     LSPVirtualFileWrapper.dispose(file);
                     // Disconnect the given file from all language servers
-                    disconnect(uri);
+                    disconnect(uri, isDisposed());
                 } catch (Exception e) {
                     LOGGER.warn("Error while disconnecting the file '" + uri + "' from all language servers", e);
                 }
@@ -131,6 +134,8 @@ public void fileClosed(@NotNull FileEditorManager source, @NotNull VirtualFile f
 
     private ServerStatus serverStatus;
 
+    private boolean disposed;
+
     private LanguageServerException serverError;
 
     private Long currentProcessId;
@@ -179,6 +184,12 @@ private LanguageServerWrapper(@Nullable Module project, @Nonnull LanguageServers
         this.listener = Executors
                 .newCachedThreadPool(new ThreadFactoryBuilder().setNameFormat(listenerThreadNameFormat).build());
         udateStatus(ServerStatus.none);
+        if (project != null) {
+            // When project is disposed, we dispose the language server
+            // But the language server should be disposed before because when project is closing
+            // We do that to be sure that language server is disposed.
+            Disposer.register(project, this);
+        }
     }
 
     @Nonnull
@@ -469,6 +480,17 @@ public boolean isActive() {
         return this.launcherFuture != null && !this.launcherFuture.isDone() && !this.launcherFuture.isCancelled();
     }
 
+    @Override
+    public void dispose() {
+        this.disposed= true;
+        stop();
+        stopDispatcher();
+    }
+
+    public boolean isDisposed() {
+        return disposed;
+    }
+
     /**
      * Returns true if the language server is stopping and false otherwise.
      *
@@ -504,48 +526,24 @@ public synchronized void stop(boolean alreadyStopping) {
             this.serverCapabilities = null;
             this.dynamicRegistrations.clear();
 
-            // We need to shutdown, kill and stop the process in a thread to avoid for instance
-            // stopping the new process created with a new start.
-            final Future<?> serverFuture = this.launcherFuture;
-            final StreamConnectionProvider provider = this.lspStreamProvider;
-            final LanguageServer languageServerInstance = this.languageServer;
-
-            Runnable shutdownKillAndStopFutureAndProvider = () -> {
-                if (languageServerInstance != null && provider != null && provider.isAlive()) {
-                    // The LSP language server instance and the process which starts the language server is alive. Process
-                    // - shutdown
-                    // - exit
-
-                    // shutdown the language server
-                    try {
-                        shutdownLanguageServerInstance(languageServerInstance);
-                    } catch (Exception ex) {
-                        getLanguageServerLifecycleManager().onError(this, ex);
-                    }
-
-                    // exit the language server
-                    // Consume language server exit() before cancelling launcher future (serverFuture.cancel())
-                    // to avoid having error like "The pipe is being closed".
-                    try {
-                        exitLanguageServerInstance(languageServerInstance);
-                    } catch (Exception ex) {
-                        getLanguageServerLifecycleManager().onError(this, ex);
-                    }
-                }
-
-                if (serverFuture != null) {
-                    serverFuture.cancel(true);
-                }
-
-                if (provider != null) {
-                    provider.stop();
-                }
-                this.stopping.set(false);
-                udateStatus(ServerStatus.stopped);
-                getLanguageServerLifecycleManager().onStatusChanged(this);
-            };
-
-            CompletableFuture.runAsync(shutdownKillAndStopFutureAndProvider);
+            if (isDisposed()) {
+                // When project is closing we shutdown everything in synch mode
+                shutdownAll(languageServer, lspStreamProvider, launcherFuture);
+            } else {
+                // We need to shutdown, kill and stop the process in a thread to avoid for instance
+                // stopping the new process created with a new start.
+                final Future<?> serverFuture = this.launcherFuture;
+                final StreamConnectionProvider provider = this.lspStreamProvider;
+                final LanguageServer languageServerInstance = this.languageServer;
+
+                Runnable shutdownKillAndStopFutureAndProvider = () -> {
+                    shutdownAll(languageServerInstance, provider, serverFuture);
+                    this.stopping.set(false);
+                    udateStatus(ServerStatus.stopped);
+                    getLanguageServerLifecycleManager().onStatusChanged(this);
+                };
+                CompletableFuture.runAsync(shutdownKillAndStopFutureAndProvider);
+            }
         } finally {
             this.launcherFuture = null;
             this.lspStreamProvider = null;
@@ -563,6 +561,38 @@ public synchronized void stop(boolean alreadyStopping) {
         }
     }
 
+    private void shutdownAll(LanguageServer languageServerInstance, StreamConnectionProvider provider, Future<?> serverFuture) {
+        if (languageServerInstance != null && provider != null && provider.isAlive()) {
+            // The LSP language server instance and the process which starts the language server is alive. Process
+            // - shutdown
+            // - exit
+
+            // shutdown the language server
+            try {
+                shutdownLanguageServerInstance(languageServerInstance);
+            } catch (Exception ex) {
+                getLanguageServerLifecycleManager().onError(this, ex);
+            }
+
+            // exit the language server
+            // Consume language server exit() before cancelling launcher future (serverFuture.cancel())
+            // to avoid having error like "The pipe is being closed".
+            try {
+                exitLanguageServerInstance(languageServerInstance);
+            } catch (Exception ex) {
+                getLanguageServerLifecycleManager().onError(this, ex);
+            }
+        }
+
+        if (serverFuture != null) {
+            serverFuture.cancel(true);
+        }
+
+        if (provider != null) {
+            provider.stop();
+        }
+    }
+
     private void shutdownLanguageServerInstance(LanguageServer languageServerInstance) throws Exception {
         CompletableFuture<Object> shutdown = languageServerInstance.shutdown();
         try {

src/main/java/com/redhat/devtools/intellij/lsp4ij/LanguageServiceAccessor.java

@@ -79,6 +79,15 @@ void shutdownAllDispatchers() {
         startedServers.forEach(LanguageServerWrapper::stopDispatcher);
     }
 
+    public void projectClosing(Project project) {
+        // On project closing, we dispose all language servers
+        startedServers.forEach(ls -> {
+            if (project.equals(ls.getProject())) {
+                ls.dispose();
+            }
+        });
+    }
+
     /**
      * A bean storing association of a Document/File with a language server.
      */

src/main/java/com/redhat/devtools/intellij/lsp4ij/client/IndexAwareLanguageClient.java

@@ -11,10 +11,9 @@
 package com.redhat.devtools.intellij.lsp4ij.client;
 
 import com.intellij.openapi.module.Module;
-import com.intellij.openapi.progress.*;
+import com.intellij.openapi.progress.ProgressIndicator;
 import com.intellij.openapi.project.Project;
 import com.intellij.openapi.roots.ModuleRootManager;
-import com.intellij.openapi.util.Disposer;
 import com.intellij.openapi.vfs.VfsUtil;
 import com.intellij.openapi.vfs.VirtualFile;
 import com.redhat.devtools.intellij.lsp4ij.LSPIJUtils;
@@ -29,7 +28,6 @@ public class IndexAwareLanguageClient extends LanguageClientImpl {
 
     public IndexAwareLanguageClient(Project project) {
         super(project);
-        Disposer.register(project, this);
     }
 
     /**

src/main/java/com/redhat/devtools/intellij/lsp4ij/client/LanguageClientImpl.java

@@ -4,6 +4,7 @@
 import com.intellij.openapi.application.ApplicationManager;
 import com.intellij.openapi.module.Module;
 import com.intellij.openapi.project.Project;
+import com.intellij.openapi.util.Disposer;
 import com.redhat.devtools.intellij.lsp4ij.LSPIJUtils;
 import com.redhat.devtools.intellij.lsp4ij.LanguageServerWrapper;
 import com.redhat.devtools.intellij.lsp4ij.ServerMessageHandler;
@@ -30,6 +31,7 @@ public class LanguageClientImpl implements LanguageClient, Disposable {
 
     public LanguageClientImpl(Project project) {
         this.project = project;
+        Disposer.register(project, this);
     }
 
     public Project getProject() {