Async calls to reduce server workload

SSlinky · SSlinky · commit eee77246a696 · 2024-05-24T20:49:17.000+08:00
diff --git a/server/src/project/document.ts b/server/src/project/document.ts
@@ -1,4 +1,4 @@
-import { Diagnostic, SemanticTokens, SymbolInformation, SymbolKind } from 'vscode-languageserver';
+import { CancellationToken, Diagnostic, LSPErrorCodes, ResponseError, SemanticTokens, SymbolInformation, SymbolKind } from 'vscode-languageserver';
 import { Workspace } from './workspace';
 import { FoldableElement } from './elements/special';
 import { BaseSyntaxElement, HasAttribute, HasSemanticToken, HasSymbolInformation } from './elements/base';
@@ -9,17 +9,7 @@ import { SemanticTokensManager } from '../capabilities/semanticTokens';
 import { sleep } from '../utils/helpers';
 
 
-export interface ProjectDocument {
-	name: string;
-	textDocument: TextDocument;
-	languageServerSemanticTokens: (range?: Range) => SemanticTokens | null;
-	languageServerSymbolInformationAsync(): Promise<SymbolInformation[]>;
-	get foldableElements(): FoldingRange[];
-	parseAsync(): Promise<void>;
-}
-
-
-export abstract class BaseProjectDocument implements ProjectDocument {
+export abstract class BaseProjectDocument {
 	readonly workspace: Workspace;
 	readonly textDocument: TextDocument;
 	readonly name: string;
@@ -36,13 +26,8 @@ export abstract class BaseProjectDocument implements ProjectDocument {
 	protected _semanticTokens: SemanticTokensManager = new SemanticTokensManager();
 	
 	isBusy = false;
-	private _requestId = 0;
 	abstract symbolKind: SymbolKind
 
-	get foldableElements() {
-		return this._foldableElements;
-	}
-
 	get activeAttributeElement() {
 		return this._attributeElements?.at(-1);
 	}
@@ -53,7 +38,7 @@ export abstract class BaseProjectDocument implements ProjectDocument {
 		this.name = name;
 	}
 
-	static create(workspace: Workspace, document: TextDocument): VbaClassDocument | VbaModuleDocument {
+	static create(workspace: Workspace, document: TextDocument): BaseProjectDocument {
 		const slashParts = document.uri.split('/').at(-1);
 		const dotParts = slashParts?.split('.');
 		const extension = dotParts?.at(-1);
@@ -77,24 +62,21 @@ export abstract class BaseProjectDocument implements ProjectDocument {
 		return this._semanticTokens.getSemanticTokens(range);
 	};
 
-	async languageServerSymbolInformationAsync(): Promise<SymbolInformation[]> {
-		this._requestId += 1;
-		const requestId = this._requestId;
+	async languageServerSymbolInformationAsync(token: CancellationToken): Promise<SymbolInformation[]> {
 		while (this.isBusy) {
 			await sleep(5);
-			if (requestId < this._requestId) {
+			if (token.isCancellationRequested) {
 				return [];
 			}
 		}
-		this._requestId = 0;
 		return this._symbolInformations;
 	}
 
-	parseAsync = async (): Promise<void> => {
+	parseAsync = async (token: CancellationToken): Promise<void> => {
 		this.isBusy = true;
-		console.log('Parsing document');
-		await (new SyntaxParser()).parseAsync(this);
-		this.isBusy = false;
+		if (await (new SyntaxParser()).parseAsync(this, token)) {
+			this.isBusy = false;
+		}
 	};
 
 	registerNamedElementDeclaration(element: any) {
@@ -177,6 +159,18 @@ export abstract class BaseProjectDocument implements ProjectDocument {
 	registerSymbolInformation = (element: HasSymbolInformation): number => {
 		return this._symbolInformations.push(element.symbolInformation);
 	};
+
+	/** Get document information */
+	async getFoldingRanges(token: CancellationToken): Promise<FoldingRange[]> {
+		while (this.isBusy) {
+			await sleep(5);
+			if (token.isCancellationRequested) {
+				return [];
+			}
+		}
+		this.workspace.connection.console.info('Processing request for Folding Range');
+		return this._foldableElements;
+	}
 }
 
 
diff --git a/server/src/project/elements/module.ts b/server/src/project/elements/module.ts
@@ -22,7 +22,6 @@ export class ModuleElement extends BaseContextSyntaxElement implements HasSymbol
 	}
 
 	get symbolInformation(): SymbolInformation {
-		console.warn(`Creating symbol with name ${this._name}`);
 		return SymbolInformationFactory.create(
 			this, this.symbolKind
 		);
diff --git a/server/src/project/parser/vbaSyntaxParser.ts b/server/src/project/parser/vbaSyntaxParser.ts
@@ -14,6 +14,7 @@ import { FoldableElement } from '../elements/special';
 import { ConstDeclarationsElement, EnumBlockDeclarationElement, EnumMemberDeclarationElement, MethodBlockDeclarationElement, VariableDeclarationsElement } from '../elements/memory';
 import { ModuleElement } from '../elements/module';
 import { sleep } from '../../utils/helpers';
+import { CancellationToken } from 'vscode-languageserver';
 
 export class SyntaxParser {
     private static _lockIdentifier = 0;
@@ -31,25 +32,34 @@ export class SyntaxParser {
         this._lockIdentifier = 0;
     }
 
-    async parseAsync(document: VbaClassDocument | VbaModuleDocument) {
+    async parseAsync(document: VbaClassDocument | VbaModuleDocument, token: CancellationToken): Promise<boolean> {
+        // token.onCancellationRequested(e => {
+        //     throw new Error("No");
+        // });
+
         // Refuse to do anything that seems like too much work.
         if (document.textDocument.lineCount > 1000) {
             // TODO: Make this an option that people can increase or decrease.
             console.log(`Document oversize: ${document.textDocument.lineCount} lines.`);
             console.warn(`Syntax parsing has been disabled to prevent crashing.`);
-            return;
+            return false;
         }
 
         // Wait a few seconds to see if any other input has ocurred.
         const lock = SyntaxParser._acquireLock();
         await sleep(1000);
         if (!SyntaxParser._hasLock(lock)) {
             console.info('Newer lock detected. Cancelling parse.');
-            return;
+            return false;
         }
         SyntaxParser._releaseLock();
 
         // Parse the document.
+        this.parse(document);
+        return true;
+    }
+
+    parse(document: VbaClassDocument | VbaModuleDocument) {
         console.info('Parsing the document.');
         const listener = new VbaTreeWalkListener(document);
         const parser = this.createParser(document.textDocument);
diff --git a/server/src/project/workspace.ts b/server/src/project/workspace.ts
@@ -1,5 +1,5 @@
-import { CompletionItem, CompletionParams, DidChangeConfigurationNotification, DidChangeConfigurationParams, DidChangeWatchedFilesParams, DocumentSymbolParams, FoldingRange, FoldingRangeParams, Hover, HoverParams, SemanticTokensParams, SemanticTokensRangeParams, SymbolInformation, TextDocuments, WorkspaceFoldersChangeEvent, _Connection } from 'vscode-languageserver';
-import { BaseProjectDocument, ProjectDocument } from './document';
+import { CancellationToken, CancellationTokenSource, CompletionItem, CompletionParams, DidChangeConfigurationNotification, DidChangeConfigurationParams, DidChangeWatchedFilesParams, DocumentSymbolParams, FoldingRange, FoldingRangeParams, Hover, HoverParams, SemanticTokensParams, SemanticTokensRangeParams, SymbolInformation, TextDocuments, WorkspaceFoldersChangeEvent, _Connection } from 'vscode-languageserver';
+import { BaseProjectDocument } from './document';
 import { LanguageServerConfiguration } from '../server';
 import { hasConfigurationCapability } from '../capabilities/workspaceFolder';
 import { TextDocument } from 'vscode-languageserver-textdocument';
@@ -11,13 +11,13 @@ import { TextDocument } from 'vscode-languageserver-textdocument';
  */
 export class Workspace {
 	private _events: WorkspaceEvents;
-	private _documents: ProjectDocument[] = [];
-	private _activeDocument?: ProjectDocument;
+	private _documents: BaseProjectDocument[] = [];
+	private _activeDocument?: BaseProjectDocument;
 	private _publicScopeDeclarations: Map<string, any> = new Map();
 	
 	readonly connection: _Connection;
 
-	activateDocument(document: ProjectDocument) {
+	activateDocument(document: BaseProjectDocument) {
 		this._activeDocument = document;
 	}
 
@@ -59,8 +59,9 @@ class WorkspaceEvents {
 	private readonly _workspace: Workspace;
 	private readonly _documents: TextDocuments<TextDocument>;
 	private readonly _configuration: LanguageServerConfiguration;
+	private _parseCancellationToken?: CancellationTokenSource;
 
-	activeDocument?: ProjectDocument;
+	activeDocument?: BaseProjectDocument;
 
 	constructor(params: {connection: _Connection, workspace: Workspace, configuration: LanguageServerConfiguration}) {
 		this._workspace = params.workspace;
@@ -72,17 +73,16 @@ class WorkspaceEvents {
 	}
 
 	private initialiseConnectionEvents(connection: _Connection) {
-		console.log('Initialising connection events...');
 		connection.onInitialized(() => this.onInitialized());
 		connection.onCompletion(params => this.onCompletion(params));
 		connection.onCompletionResolve(item => this.onCompletionResolve(item));
 		connection.onDidChangeConfiguration(params => this.onDidChangeConfiguration(params));
 		connection.onDidChangeWatchedFiles(params => this.onDidChangeWatchedFiles(params));
-		connection.onDocumentSymbol(async (params) => await this.onDocumentSymbolAsync(params));
+		connection.onDocumentSymbol(async (params, token) => await this.onDocumentSymbolAsync(params, token));
 		connection.onHover(params => this.onHover(params));
 
 		if (hasConfigurationCapability(this._configuration)) {
-			connection.onFoldingRanges((params) => this.onFoldingRanges(params));
+			connection.onFoldingRanges(async (params, token) => this.onFoldingRanges(params, token));
 		}
 
 		connection.onRequest((method: string, params: object | object[] | any) => {
@@ -101,19 +101,16 @@ class WorkspaceEvents {
 	}
 
 	private initialiseDocumentsEvents() {
-		console.log('Initialising documents events...');
 		this._documents.onDidChangeContent(async (e) => await this.onDidChangeContentAsync(e.document));
 	}
 
 	/** Connection event handlers */
 
 	private onCompletion(params: CompletionParams): never[] {
-		console.log(`onCompletion: ${params}`);
 		return [];
 	}
 
 	private onCompletionResolve(item: CompletionItem): CompletionItem {
-		console.log(`onCompletionResolve: ${item.label}`);
 		return item;
 	}
 
@@ -127,16 +124,15 @@ class WorkspaceEvents {
 
 	// TODO: Should trigger a full workspace refresh.
 	private onDidChangeWorkspaceFolders(e: WorkspaceFoldersChangeEvent) {
-		console.log(`onDidChangeWorkspaceFolders: ${e}`);
 		this._workspace.connection.console.log(`Workspace folder change event received.\n${e}`);
 	}
 
-	private async onDocumentSymbolAsync(params: DocumentSymbolParams): Promise<SymbolInformation[]> {
-		return await this.activeDocument?.languageServerSymbolInformationAsync() ?? [];
+	private async onDocumentSymbolAsync(params: DocumentSymbolParams, token: CancellationToken): Promise<SymbolInformation[]> {
+		return await this.activeDocument?.languageServerSymbolInformationAsync(token) ?? [];
 	}
 
-	private onFoldingRanges(params: FoldingRangeParams): FoldingRange[] {
-		return this._workspace.activeDocument?.foldableElements ?? [];
+	private async onFoldingRanges(params: FoldingRangeParams, token: CancellationToken): Promise<FoldingRange[]> {
+		return await this._workspace.activeDocument?.getFoldingRanges(token) ?? [];
 	}
 
 	private onHover(params: HoverParams): Hover {
@@ -163,9 +159,13 @@ class WorkspaceEvents {
 	 * @param doc The document that changed.
 	 */
 	async onDidChangeContentAsync(doc: TextDocument) {
+		// this._parseCancellationToken?.cancel();
+		// this._parseCancellationToken?.dispose();
+
 		this.activeDocument = BaseProjectDocument.create(this._workspace, doc);
-		await this.activeDocument.parseAsync();
+		this._parseCancellationToken = new CancellationTokenSource();
+		await this.activeDocument.parseAsync(this._parseCancellationToken.token);
+		this._parseCancellationToken = undefined;
 		this._workspace.activateDocument(this.activeDocument);
 	}
-
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,6 @@ export class ModuleElement extends BaseContextSyntaxElement implements HasSymbol`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`get symbolInformation(): SymbolInformation {`
`25`		- console.warn(`Creating symbol with name ${this._name}`);
`26`	`25`	`return SymbolInformationFactory.create(`
`27`	`26`	`this, this.symbolKind`
`28`	`27`	`);`