client: setting to indicate detached server max lifetime

- Allows the client to configure a ServerOptions setting
that sets the max lifetime of the detached language server
after the parent/client has terminated.

- Additionally, this exposes some utils from the language server
  so that they can be reused in tests. Otherwise we'd have to duplicate
  code and reduce code coverage

Signed-off-by: nkomonen-amazon <[email protected]>

Author: nkomonen-amazon

client-node-tests/src/integration.test.ts

@@ -1979,7 +1979,7 @@ suite('Server tests', () => {
 			};
 			const client = new lsclient.LanguageClient('test svr', serverOptions, {});
 			const res = await client.sendRequest(IsDetachedRequest);
-			assert.strictEqual(res, false);
+			assert.deepStrictEqual(res, { detached: false });
 		});
 
 		[lsclient.TransportKind.stdio, lsclient.TransportKind.ipc, lsclient.TransportKind.pipe].forEach((transport) => {
@@ -1988,12 +1988,13 @@ suite('Server tests', () => {
 					module: detachedServerModule,
 					transport,
 					options: {
-						detached: true
+						detached: true,
+						detachedTimeout: 1000
 					}
 				};
 				const client = new lsclient.LanguageClient('test svr', serverOptions, {});
 				const res = await client.sendRequest(IsDetachedRequest);
-				assert.strictEqual(res, true);
+				assert.deepStrictEqual(res, { detached: true, timeout: 1000 });
 			});
 		});
 
@@ -2004,12 +2005,13 @@ suite('Server tests', () => {
 					args: [detachedServerModule],
 					transport,
 					options: {
-						detached: true
+						detached: true,
+						detachedTimeout: 1001
 					}
 				};
 				const client = new lsclient.LanguageClient('test svr', serverOptions, {});
 				const res = await client.sendRequest(IsDetachedRequest);
-				assert.strictEqual(res, true);
+				assert.deepStrictEqual(res, { detached: true, timeout: 1001 });
 			});
 		});
 

client-node-tests/src/servers/detachedServer.ts

@@ -9,11 +9,15 @@
 
 import { createConnection, ProposedFeatures } from 'vscode-languageserver/node';
 import { IsDetachedRequest } from './types';
+import { parseCliOpts } from 'vscode-languageserver/utils';
 
 const connection = createConnection(ProposedFeatures.all);
 
 connection.onRequest(IsDetachedRequest, () => {
-	return process.argv.includes('--detached');
+	const args = parseCliOpts(process.argv);
+	const detached = Object.keys(args).includes('detached');
+	const timeout = args['detached'];
+	return { detached, timeout };
 });
 
 // Initialize the language server connection

client-node-tests/src/servers/types.ts

@@ -5,4 +5,4 @@
 
 import { RequestType0 } from 'vscode-languageserver';
 
-export const IsDetachedRequest = new RequestType0('isDetached');
+export const IsDetachedRequest = new RequestType0<{detached: boolean; timeout: number }, void>('isDetached');

client/src/node/main.ts

@@ -57,10 +57,18 @@ namespace Transport {
 	}
 }
 
-export interface ExecutableOptions {
+export interface DetachedOptions {
+	detached?: boolean;
+	/**
+	 * Maximum milliseconds to keep the server alive after the parent/client terminates.
+	 * If undefined it will never terminate.
+	 */
+	detachedTimeout?: number;
+}
+
+export interface ExecutableOptions extends DetachedOptions {
 	cwd?: string;
 	env?: any;
-	detached?: boolean;
 	shell?: boolean;
 }
 
@@ -77,12 +85,11 @@ namespace Executable {
 	}
 }
 
-export interface ForkOptions {
+export interface ForkOptions extends DetachedOptions {
 	cwd?: string;
 	env?: any;
 	encoding?: string;
 	execArgv?: string[];
-	detached?: boolean;
 }
 
 export interface NodeModule {
@@ -354,6 +361,9 @@ export class LanguageClient extends BaseLanguageClient {
 					}
 					if (node.options?.detached) {
 						args.push('--detached');
+						if (node.options.detachedTimeout) {
+							args.push(node.options.detachedTimeout.toString());
+						}
 					}
 					args.push(`--clientProcessId=${process.pid.toString()}`);
 					if (transport === TransportKind.ipc || transport === TransportKind.stdio) {
@@ -416,6 +426,9 @@ export class LanguageClient extends BaseLanguageClient {
 						args.push(`--clientProcessId=${process.pid.toString()}`);
 						if (node.options?.detached) {
 							args.push('--detached');
+							if (node.options.detachedTimeout) {
+								args.push(node.options.detachedTimeout.toString());
+							}
 						}
 						const options: cp.ForkOptions = node.options ?? Object.create(null);
 						options.env = getEnvironment(options.env, true);
@@ -478,6 +491,9 @@ export class LanguageClient extends BaseLanguageClient {
 				}
 				if (command.options?.detached) {
 					args.push('--detached');
+					if (command.options.detachedTimeout) {
+						args.push(command.options.detachedTimeout.toString());
+					}
 				}
 				const options = Object.assign({}, command.options);
 				options.cwd = options.cwd || serverWorkingDir;

server/package.json

@@ -24,6 +24,10 @@
 		"./browser": {
 			"types": "./lib/browser/main.d.ts",
 			"browser": "./lib/browser/main.js"
+		},
+		"./utils": {
+			"types": "./lib/common/utils/main.d.ts",
+			"default": "./lib/common/utils/main.js"
 		}
 	},
 	"bin": {

server/src/common/utils/main.ts

@@ -0,0 +1,6 @@
+/* --------------------------------------------------------------------------------------------
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ * ------------------------------------------------------------------------------------------ */
+
+export * from './process';