[v3] async patch

[RayGuo-ergou]

Hi @johnsoncodehk

I was playing around with v3 in neovim and I face a block that almost make it unusable.

The problem is that in neovim there's async and lsp handlers are ui-blocking which means to be able to return the body to tsserverRequest command the only way is to wait/sleep. It results in random pause when moving cursor around, especially in large projects that will take time for tsserver to return the data.

I was trying to make my own patch to solve it by using a global map and a new command when start the lsp. e.g.

	const commandMap = new Map<string, any>()
	const receiveCommandPlugin: LanguageServicePlugin = {
		name: 'vue-receive',
		capabilities: {
			executeCommandProvider: {
				commands: ['vue.vue-receive-command'],
			},
		},
		create() {
			return {
				executeCommand(_command, [id, data]) {
					return commandMap.set(id, data)
				},
			};
		},
	// instead of waiting for response, checking the global map for the data
	function sendTsRequest<T>(command: string, args: any): Promise<T | null> {
		const id = createRandomString(16)
		args.id = id
		connection.sendRequest<T>(options.typescript.tsserverRequestCommand!, [command, args]);
		return new Promise((resolve, reject) =>{
			let i = 1;
			const intervalId = setInterval(() => {
				i++;
				writeLog(`Attempt ${i}: checking for ID ${id}`);

				const result = commandMap.get(id);
				if (result != null) {
					writeLog(`Result received for ID ${id}: ${JSON.stringify(result)}`);
					resolve(result);
					clearInterval(intervalId);
					return;
				}
				if (i > 5) {
					writeLog(`Timeout waiting for ID ${id}`);
					reject(new Error('Timeout'));
					clearInterval(intervalId);
				}
			}, 200);

		})
	}

however i found that the even first command projectInfo fails, the new command i added not even triggered. My guess is that the plugins will resister after getLanguageService and the projectInfo is called in getLanguageService (I might be wrong).

Can you give some advice/comment to how do i make that work? Thanks in advance. And here's the full patch.

diff --git a/packages/language-server/node.ts b/packages/language-server/node.ts
index 0f69537ab..97c1def9f 100644
--- a/packages/language-server/node.ts
+++ b/packages/language-server/node.ts
@@ -1,3 +1,5 @@
+import * as fs from 'fs';
+import * as path from 'path';
 import type { LanguageServer } from '@volar/language-server';
 import { createLanguageServiceEnvironment } from '@volar/language-server/lib/project/simpleProject';
 import { createConnection, createServer, loadTsdkByPath } from '@volar/language-server/node';
@@ -5,14 +7,49 @@ import { createLanguage, createParsedCommandLine, createVueLanguagePlugin, getDe
 import { createLanguageService, createUriMap, getHybridModeLanguageServicePlugins, type LanguageService } from '@vue/language-service';
 import type * as ts from 'typescript';
 import { URI } from 'vscode-uri';
-import type { VueInitializationOptions } from './lib/types';
+import type { LanguageServicePlugin, VueInitializationOptions } from './lib/types';
 
 const connection = createConnection();
 const server = createServer(connection);
 
 connection.listen();
+function writeLog(message: string) {
+	const logPath = path.resolve(__dirname, 'debug-log.txt');
+	fs.appendFileSync(logPath, `[${new Date().toISOString()}] ${message}\n`);
+}
 
 connection.onInitialize(params => {
+
+	function createRandomString(length: number) {
+		const chars = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
+		let result = "";
+		for (let i = 0; i < length; i++) {
+			result += chars.charAt(Math.floor(Math.random() * chars.length));
+		}
+		return result;
+	}
+	const commandMap = new Map<string, any>()
+	const receiveCommandPlugin: LanguageServicePlugin = {
+		name: 'vue-receive',
+		capabilities: {
+			executeCommandProvider: {
+				commands: ['vue.vue-receive-command'],
+			},
+		},
+		create() {
+			writeLog(`create customer plugin`, );
+			return {
+				executeCommand(_command, [id, data]) {
+					writeLog(`received ${_command}`, );
+					writeLog(`received ${id}` );
+					writeLog(`received ${JSON.stringify(data)}`);
+
+					return commandMap.set(id, data)
+				},
+			};
+		},
+	}
+
 	const options: VueInitializationOptions = params.initializationOptions;
 
 	if (!options.typescript?.tsdk) {
@@ -38,56 +75,7 @@ connection.onInitialize(params => {
 	});
 
 	let simpleLs: LanguageService | undefined;
-
-	return server.initialize(
-		params,
-		{
-			setup() { },
-			async getLanguageService(uri) {
-				if (uri.scheme === 'file' && options.typescript.tsserverRequestCommand) {
-					const fileName = uri.fsPath.replace(/\\/g, '/');
-					let projectInfoPromise = file2ProjectInfo.get(fileName);
-					if (!projectInfoPromise) {
-						projectInfoPromise = sendTsRequest<ts.server.protocol.ProjectInfo>(
-							ts.server.protocol.CommandTypes.ProjectInfo,
-							{
-								file: fileName,
-								needFileNameList: false,
-							} satisfies ts.server.protocol.ProjectInfoRequestArgs
-						);
-						file2ProjectInfo.set(fileName, projectInfoPromise);
-					}
-					const projectInfo = await projectInfoPromise;
-					if (projectInfo) {
-						const { configFileName } = projectInfo;
-						let ls = tsconfigProjects.get(URI.file(configFileName));
-						if (!ls) {
-							ls = createLs(server, configFileName);
-							tsconfigProjects.set(URI.file(configFileName), ls);
-						}
-						return ls;
-					}
-				}
-				return simpleLs ??= createLs(server, undefined);
-			},
-			getExistingLanguageServices() {
-				return Promise.all([
-					...tsconfigProjects.values(),
-					simpleLs,
-				].filter(promise => !!promise));
-			},
-			reload() {
-				for (const ls of [
-					...tsconfigProjects.values(),
-					simpleLs,
-				]) {
-					ls?.dispose();
-				}
-				tsconfigProjects.clear();
-				simpleLs = undefined;
-			},
-		},
-		getHybridModeLanguageServicePlugins(ts, options.typescript.tsserverRequestCommand ? {
+	const plugins = 		getHybridModeLanguageServicePlugins(ts, options.typescript.tsserverRequestCommand ? {
 			collectExtractProps(...args) {
 				return sendTsRequest('vue:collectExtractProps', args);
 			},
@@ -137,10 +125,88 @@ connection.onInitialize(params => {
 				return ts.displayPartsToString(result?.displayParts ?? []);
 			},
 		} : undefined)
+
+	plugins.push(receiveCommandPlugin)
+	writeLog(`Initializing with plugins: ${plugins.map(p => p.name).join(', ')}`);
+
+
+	return server.initialize(
+		params,
+		{
+			setup() { },
+			async getLanguageService(uri) {
+				if (uri.scheme === 'file' && options.typescript.tsserverRequestCommand) {
+					const fileName = uri.fsPath.replace(/\\/g, '/');
+					let projectInfoPromise = file2ProjectInfo.get(fileName);
+					if (!projectInfoPromise) {
+						projectInfoPromise = sendTsRequest<ts.server.protocol.ProjectInfo>(
+							ts.server.protocol.CommandTypes.ProjectInfo,
+							{
+								file: fileName,
+								needFileNameList: false,
+							} satisfies ts.server.protocol.ProjectInfoRequestArgs
+						);
+						file2ProjectInfo.set(fileName, projectInfoPromise);
+					}
+					const projectInfo = await projectInfoPromise;
+					if (projectInfo) {
+						const { configFileName } = projectInfo;
+						let ls = tsconfigProjects.get(URI.file(configFileName));
+						if (!ls) {
+							ls = createLs(server, configFileName);
+							tsconfigProjects.set(URI.file(configFileName), ls);
+						}
+						return ls;
+					}
+				}
+				return simpleLs ??= createLs(server, undefined);
+			},
+			getExistingLanguageServices() {
+				return Promise.all([
+					...tsconfigProjects.values(),
+					simpleLs,
+				].filter(promise => !!promise));
+			},
+			reload() {
+				for (const ls of [
+					...tsconfigProjects.values(),
+					simpleLs,
+				]) {
+					ls?.dispose();
+				}
+				tsconfigProjects.clear();
+				simpleLs = undefined;
+			},
+		},
+		plugins
+
 	);
 
 	function sendTsRequest<T>(command: string, args: any): Promise<T | null> {
-		return connection.sendRequest<T>(options.typescript.tsserverRequestCommand!, [command, args]);
+		const id = createRandomString(16)
+		args.id = id
+		connection.sendRequest<T>(options.typescript.tsserverRequestCommand!, [command, args]);
+		return new Promise((resolve, reject) =>{
+			let i = 1;
+			const intervalId = setInterval(() => {
+				i++;
+				writeLog(`Attempt ${i}: checking for ID ${id}`);
+
+				const result = commandMap.get(id);
+				if (result != null) {
+					writeLog(`Result received for ID ${id}: ${JSON.stringify(result)}`);
+					resolve(result);
+					clearInterval(intervalId);
+					return;
+				}
+				if (i > 5) {
+					writeLog(`Timeout waiting for ID ${id}`);
+					reject(new Error('Timeout'));
+					clearInterval(intervalId);
+				}
+			}, 200);
+
+		})
 	}
 
 	function createLs(server: LanguageServer, tsconfig: string | undefined) {
@@ -181,6 +247,9 @@ connection.onInitialize(params => {
 		);
 	}
 });
+connection.onRequest('workspace/executeCommand', (params) => {
+	writeLog(`Received workspace/executeCommand: ${JSON.stringify(params)}`);
+});
 
 connection.onInitialized(server.initialized);