fix(nxls): clean up connection & ipc channel when shutting down nxls …

…to prevent it from staying open (#2353)

apps/nxls-e2e/src/nxls-wrapper.ts

@@ -11,8 +11,8 @@ import {
   StreamMessageWriter,
 } from 'vscode-languageserver/node';
 
-import { killTree } from '@nx-console/shared/utils';
 import { defaultVersion } from './utils';
+import { killGroup } from '@nx-console/shared/utils';
 
 export class NxlsWrapper {
   private cwd?: string;
@@ -147,7 +147,7 @@ export class NxlsWrapper {
 
     if (this.process?.pid) {
       try {
-        killTree(this.process.pid, 'SIGKILL');
+        killGroup(this.process.pid);
       } catch (e) {
         console.log(`NXLS WRAPPER: ${e}`);
       }

apps/nxls/src/main.ts

@@ -2,7 +2,6 @@ import {
   completionHandler,
   configureSchemaForProject,
   configureSchemas,
-  getCompletionItems,
   projectSchemaIsRegistered,
   resetInferencePluginsCompletionCache,
 } from '@nx-console/language-server/capabilities/code-completion';
@@ -44,7 +43,6 @@ import {
   getJsonLanguageService,
   getLanguageModelCache,
   lspLogger,
-  mergeArrays,
   setLspLogger,
 } from '@nx-console/language-server/utils';
 import {
@@ -80,13 +78,8 @@ import {
 } from '@nx-console/language-server/workspace';
 import { GeneratorSchema } from '@nx-console/shared/generate-ui-types';
 import { NxWorkspace } from '@nx-console/shared/types';
-import { formatError, killTree } from '@nx-console/shared/utils';
-import { dirname, relative } from 'node:path';
-import {
-  ClientCapabilities,
-  CompletionList,
-  TextDocument,
-} from 'vscode-json-languageservice';
+import { formatError, killGroup } from '@nx-console/shared/utils';
+import { ClientCapabilities, TextDocument } from 'vscode-json-languageservice';
 import {
   CreateFilesParams,
   DeleteFilesParams,
@@ -148,7 +141,6 @@ connection.onInitialize(async (params) => {
     CLIENT_CAPABILITIES = params.capabilities;
 
     await configureSchemas(WORKING_PATH, CLIENT_CAPABILITIES);
-
     unregisterFileWatcher = await languageServerWatcher(
       WORKING_PATH,
       async () => {
@@ -300,11 +292,6 @@ connection.onShutdown(async () => {
   jsonDocumentMapper.dispose();
 });
 
-connection.onExit(() => {
-  connection.dispose();
-  killTree(process.pid);
-});
-
 connection.onRequest(NxStopDaemonRequest, async () => {
   if (!WORKING_PATH) {
     return new ResponseError(1000, 'Unable to get Nx info: no workspace path');
@@ -663,4 +650,23 @@ function getJsonDocument(document: TextDocument) {
 }
 
 ensureOnlyJsonRpcStdout();
+
+const exitHandler = () => {
+  process.off('SIGTERM', exitHandler);
+
+  try {
+    connection.dispose();
+  } catch (e) {
+    // noop
+  }
+
+  if (process.connected) {
+    process.disconnect();
+  }
+
+  killGroup(process.pid);
+};
+process.on('SIGTERM', exitHandler);
+
+connection.onExit(exitHandler);
 connection.listen();

apps/vscode/src/main.ts

@@ -13,7 +13,7 @@ import {
 
 import {
   checkIsNxWorkspace,
-  killTree,
+  killGroup,
   withTimeout,
 } from '@nx-console/shared/utils';
 import {
@@ -137,12 +137,12 @@ export async function deactivate() {
 
   const nxlsPid = getNxlsClient()?.getNxlsPid();
   if (nxlsPid) {
-    killTree(nxlsPid, 'SIGINT');
+    killGroup(nxlsPid);
   }
 
   getTelemetry().logUsage('extension-deactivate');
 
-  killTree(process.pid, 'SIGTERM');
+  killGroup(process.pid);
 }
 
 // -----------------------------------------------------------------------------

libs/shared/utils/src/index.ts

@@ -4,6 +4,6 @@ export { checkIsNxWorkspace } from './lib/check-is-nx-workspace';
 export { getNxExecutionCommand } from './lib/get-nx-execution-command';
 export * from './lib/parse-target-string';
 export * from './lib/utils';
-export * from './lib/kill-tree';
 export * from './lib/cipe';
 export * from './lib/package-manager-command';
+export * from './lib/kill-group';

libs/shared/utils/src/lib/kill-group.ts

@@ -0,0 +1,17 @@
+import { execSync } from 'child_process';
+
+export function killGroup(pid: number, signal: NodeJS.Signals = 'SIGTERM') {
+  if (process.platform === 'win32') {
+    try {
+      execSync('taskkill /pid ' + pid + ' /T /F', {
+        windowsHide: true,
+      });
+    } catch (err: any) {
+      if (err?.status !== 128) {
+        throw err;
+      }
+    }
+  } else {
+    process.kill(-pid, signal);
+  }
+}

libs/vscode/lsp-client/src/lib/nxls-client.ts

@@ -4,7 +4,6 @@ import {
   NxWorkspaceRefreshNotification,
   NxWorkspaceRefreshStartedNotification,
 } from '@nx-console/language-server/types';
-import { killTree } from '@nx-console/shared/utils';
 import {
   getNxlsOutputChannel,
   getOutputChannel,
@@ -25,6 +24,7 @@ import {
 } from 'vscode-languageclient/node';
 import { createActor, fromPromise, waitFor } from 'xstate';
 import { nxlsClientStateMachine } from './nxls-client-state-machine';
+import { killGroup } from '@nx-console/shared/utils';
 
 let _nxlsClient: NxlsClient | undefined;
 
@@ -296,7 +296,7 @@ export class NxlsClient {
         // timeout, kill the process forcefully instead
         const pid = this.actor.getSnapshot().context.nxlsPid;
         if (pid) {
-          killTree(pid, 'SIGTERM');
+          killGroup(pid);
         }
       }
     }