#12779

Committed 09 Jul 2024 08:56PM UTC coverage: 88.703% (+0.8%) from 87.936%

Build Type

push

Committed by

Commit Message

Merge 0774d2850 into 1755665fb

Run Details

6599 of 7901 branches covered (83.52%)

Branch coverage included in aggregate %.

1011 of 1143 new or added lines in 29 files covered. (88.45%)

24 existing lines in 5 files now uncovered.

9434 of 10174 relevant lines covered (92.73%)

1670.1 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

72.73

/src/lsp/worker/WorkerThreadProject.ts

import * as EventEmitter from 'eventemitter3';
import { Worker } from 'worker_threads';
import type { WorkerMessage } from './MessageHandler';
import { MessageHandler } from './MessageHandler';
import util from '../../util';
import type { LspDiagnostic, ActivateResponse, ProjectConfig } from '../LspProject';
import { type LspProject } from '../LspProject';
import { isMainThread, parentPort } from 'worker_threads';
import { WorkerThreadProjectRunner } from './WorkerThreadProjectRunner';
import { WorkerPool } from './WorkerPool';
import type { Hover, MaybePromise, SemanticToken } from '../../interfaces';
import type { DocumentAction, DocumentActionWithStatus } from '../DocumentManager';
import { Deferred } from '../../deferred';
import type { FileTranspileResult, SignatureInfoObj } from '../../Program';
import type { Position, Range, Location, DocumentSymbol, WorkspaceSymbol, CodeAction, CompletionList } from 'vscode-languageserver-protocol';
import type { Logger } from '../../logging';
import { LogLevel, createLogger } from '../../logging';
import { Trace } from '../../common/Decorators';

export const workerPool = new WorkerPool(() => {
    return new Worker(
        __filename,
        {
            //wire up ts-node if we're running in ts-node
            execArgv: /\.ts$/i.test(__filename)
                ? ['--require', 'ts-node/register']
                /* istanbul ignore next */
                : undefined
        }
    );
});

//if this script is running in a Worker, start the project runner
/* istanbul ignore next */
if (!isMainThread) {
    const runner = new WorkerThreadProjectRunner();
    runner.run(parentPort);
}

@Trace(LogLevel.debug)
export class WorkerThreadProject implements LspProject {
    public constructor(
        options?: {
            logger?: Logger;
        }
    ) {
        this.logger = options?.logger ?? createLogger();
    }

    public async activate(options: ProjectConfig) {
        this.activateOptions = options;
        this.projectPath = options.projectPath ? util.standardizePath(options.projectPath) : options.projectPath;
        this.workspaceFolder = options.workspaceFolder ? util.standardizePath(options.workspaceFolder) : options.workspaceFolder;
        this.projectNumber = options.projectNumber;
        this.bsconfigPath = options.bsconfigPath ? util.standardizePath(options.bsconfigPath) : options.bsconfigPath;

        // start a new worker thread or get an unused existing thread
        this.worker = workerPool.getWorker();
        this.messageHandler = new MessageHandler<LspProject>({
            name: 'MainThread',
            port: this.worker,
            onRequest: this.processRequest.bind(this),
            onUpdate: this.processUpdate.bind(this)
        });
        this.disposables.push(this.messageHandler);

        const activateResponse = await this.messageHandler.sendRequest<ActivateResponse>('activate', { data: [options] });
        this.bsconfigPath = activateResponse.data.bsconfigPath;
        this.rootDir = activateResponse.data.rootDir;
        this.filePatterns = activateResponse.data.filePatterns;
        this.logger.logLevel = activateResponse.data.logLevel;

        this.activationDeferred.resolve();
        return activateResponse.data;
    }

    public logger: Logger;

    private activationDeferred = new Deferred();

    /**
     * Options used to activate this project
     */
    public activateOptions: ProjectConfig;

    /**
     * The root directory of the project
     */
    public rootDir: string;

    /**
     * The file patterns from bsconfig.json that were used to find all files for this project
     */
    public filePatterns: string[];

    /**
     * Path to a bsconfig.json file that will be used for this project
     */
    public bsconfigPath?: string;

    /**
     * The worker thread where the actual project will execute
     */
    private worker: Worker;

    /**
     * The path to where the project resides
     */
    public projectPath: string;

    /**
     * A unique number for this project, generated during this current language server session. Mostly used so we can identify which project is doing logging
     */
    public projectNumber: number;

    /**
     * The path to the workspace where this project resides. A workspace can have multiple projects (by adding a bsconfig.json to each folder).
     * Defaults to `.projectPath` if not set
     */
    public workspaceFolder: string;

    /**
     * Promise that resolves when the project finishes activating
     * @returns a promise that resolves when the project finishes activating
     */
    public whenActivated() {
        return this.activationDeferred.promise;
    }


    /**
     * Validate the project. This will trigger a full validation on any scopes that were changed since the last validation,
     * and will also eventually emit a new 'diagnostics' event that includes all diagnostics for the project
     */
    public async validate() {
        const response = await this.messageHandler.sendRequest<void>('validate');
        return response.data;
    }

    /**
     * Cancel any active validation that's running
     */
    public async cancelValidate() {
        const response = await this.messageHandler.sendRequest<void>('cancelValidate');
        return response.data;
    }

    public async getDiagnostics() {
        const response = await this.messageHandler.sendRequest<LspDiagnostic[]>('getDiagnostics');
        return response.data;
    }

    /**
     * Apply a series of file changes to the project. This is safe to call any time. Changes will be queued and flushed at the correct times
     * during the program's lifecycle flow
     */
    public async applyFileChanges(documentActions: DocumentAction[]): Promise<DocumentActionWithStatus[]> {
        const response = await this.messageHandler.sendRequest<DocumentActionWithStatus[]>('applyFileChanges', {
            data: [documentActions]
        });
        return response.data;
    }

    /**
     * Send a request with the standard structure
     * @param name the name of the request
     * @param data the array of data to send
     * @returns the response from the request
     */
    private async sendStandardRequest<T>(name: string, ...data: any[]) {
        const response = await this.messageHandler.sendRequest<T>(name as any, {
            data: data
        });
        return response.data;
    }

    /**
     * Get the full list of semantic tokens for the given file path
     */
    public async getSemanticTokens(options: { srcPath: string }) {
        return this.sendStandardRequest<SemanticToken[]>('getSemanticTokens', options);
    }

    public async transpileFile(options: { srcPath: string }) {
        return this.sendStandardRequest<FileTranspileResult>('transpileFile', options);
    }

    public async getHover(options: { srcPath: string; position: Position }): Promise<Hover[]> {
        return this.sendStandardRequest<Hover[]>('getHover', options);
    }

    public async getDefinition(options: { srcPath: string; position: Position }): Promise<Location[]> {
        return this.sendStandardRequest<Location[]>('getDefinition', options);
    }

    public async getSignatureHelp(options: { srcPath: string; position: Position }): Promise<SignatureInfoObj[]> {
        return this.sendStandardRequest<SignatureInfoObj[]>('getSignatureHelp', options);
    }

    public async getDocumentSymbol(options: { srcPath: string }): Promise<DocumentSymbol[]> {
        return this.sendStandardRequest<DocumentSymbol[]>('getDocumentSymbol', options);
    }

    public async getWorkspaceSymbol(): Promise<WorkspaceSymbol[]> {
        return this.sendStandardRequest<WorkspaceSymbol[]>('getWorkspaceSymbol');
    }

    public async getReferences(options: { srcPath: string; position: Position }): Promise<Location[]> {
        return this.sendStandardRequest<Location[]>('getReferences', options);
    }

    public async getCodeActions(options: { srcPath: string; range: Range }): Promise<CodeAction[]> {
        return this.sendStandardRequest<CodeAction[]>('getCodeActions', options);
    }

    public async getCompletions(options: { srcPath: string; position: Position }): Promise<CompletionList> {
        return this.sendStandardRequest<CompletionList>('getCompletions', options);
    }

    /**
     * Handles request/response/update messages from the worker thread
     */
    private messageHandler: MessageHandler<LspProject>;

    private processRequest(request: WorkerMessage) {

    }

    private processUpdate(update: WorkerMessage) {
        //for now, all updates are treated like "events"
        this.emit(update.name as any, update.data);
    }

    public on(eventName: 'critical-failure', handler: (data: { message: string }) => void);
    public on(eventName: 'diagnostics', handler: (data: { diagnostics: LspDiagnostic[] }) => MaybePromise<void>);
    public on(eventName: 'all', handler: (eventName: string, data: any) => MaybePromise<void>);
    public on(eventName: string, handler: (...args: any[]) => MaybePromise<void>) {
        this.emitter.on(eventName, handler as any);
        return () => {
            this.emitter.removeListener(eventName, handler as any);
        };
    }

    private emit(eventName: 'critical-failure', data: { message: string });
    private emit(eventName: 'diagnostics', data: { diagnostics: LspDiagnostic[] });
    private async emit(eventName: string, data?) {
        //emit these events on next tick, otherwise they will be processed immediately which could cause issues
        await util.sleep(0);
        this.emitter.emit(eventName, data);
        //emit the 'all' event
        this.emitter.emit('all', eventName, data);
    }
    private emitter = new EventEmitter();

    public disposables: LspProject['disposables'] = [];

    public dispose() {
        for (let disposable of this.disposables ?? []) {
            disposable?.dispose?.();
        }
        this.disposables = [];

        //move the worker back to the pool so it can be used again
        if (this.worker) {
            workerPool.releaseWorker(this.worker);
        }
        this.emitter?.removeAllListeners();
    }
}

1	import * as EventEmitter from 'eventemitter3';	1✔
2	import { Worker } from 'worker_threads';	1✔
3	import type { WorkerMessage } from './MessageHandler';
4	import { MessageHandler } from './MessageHandler';	1✔
5	import util from '../../util';	1✔
6	import type { LspDiagnostic, ActivateResponse, ProjectConfig } from '../LspProject';
7	import { type LspProject } from '../LspProject';
8	import { isMainThread, parentPort } from 'worker_threads';	1✔
9	import { WorkerThreadProjectRunner } from './WorkerThreadProjectRunner';	1✔
10	import { WorkerPool } from './WorkerPool';	1✔
11	import type { Hover, MaybePromise, SemanticToken } from '../../interfaces';
12	import type { DocumentAction, DocumentActionWithStatus } from '../DocumentManager';
13	import { Deferred } from '../../deferred';	1✔
14	import type { FileTranspileResult, SignatureInfoObj } from '../../Program';
15	import type { Position, Range, Location, DocumentSymbol, WorkspaceSymbol, CodeAction, CompletionList } from 'vscode-languageserver-protocol';
16	import type { Logger } from '../../logging';
17	import { LogLevel, createLogger } from '../../logging';	1✔
18	import { Trace } from '../../common/Decorators';	1✔
19
20	export const workerPool = new WorkerPool(() => {	1✔
21	return new Worker(	1✔
22	__filename,
23	{
24	//wire up ts-node if we're running in ts-node
25	execArgv: /\.ts$/i.test(__filename)
26	? ['--require', 'ts-node/register']	1✔
27	/* istanbul ignore next */
28	: undefined
29	}
30	);
31	});
32
33	//if this script is running in a Worker, start the project runner
34	/* istanbul ignore next */
35	if (!isMainThread) {
36	const runner = new WorkerThreadProjectRunner();
37	runner.run(parentPort);
38	}
39
40	@Trace(LogLevel.debug)
41	export class WorkerThreadProject implements LspProject {	1✔
42	public constructor(
43	options?: {
44	logger?: Logger;
45	}
46	) {
47	this.logger = options?.logger ?? createLogger();	3✔
48	}
49
50	public async activate(options: ProjectConfig) {
51	this.activateOptions = options;	3✔
52	this.projectPath = options.projectPath ? util.standardizePath(options.projectPath) : options.projectPath;	3!
53	this.workspaceFolder = options.workspaceFolder ? util.standardizePath(options.workspaceFolder) : options.workspaceFolder;	3✔
54	this.projectNumber = options.projectNumber;	3✔
55	this.bsconfigPath = options.bsconfigPath ? util.standardizePath(options.bsconfigPath) : options.bsconfigPath;	3!
56
57	// start a new worker thread or get an unused existing thread
58	this.worker = workerPool.getWorker();	3✔
59	this.messageHandler = new MessageHandler<LspProject>({	3✔
60	name: 'MainThread',
61	port: this.worker,
62	onRequest: this.processRequest.bind(this),
63	onUpdate: this.processUpdate.bind(this)
64	});
65	this.disposables.push(this.messageHandler);	3✔
66
67	const activateResponse = await this.messageHandler.sendRequest<ActivateResponse>('activate', { data: [options] });	3✔
68	this.bsconfigPath = activateResponse.data.bsconfigPath;	3✔
69	this.rootDir = activateResponse.data.rootDir;	3✔
70	this.filePatterns = activateResponse.data.filePatterns;	3✔
71	this.logger.logLevel = activateResponse.data.logLevel;	3✔
72
73	this.activationDeferred.resolve();	3✔
74	return activateResponse.data;	3✔
75	}
76
77	public logger: Logger;
78
79	private activationDeferred = new Deferred();	3✔
80
81	/**
82	* Options used to activate this project
83	*/
84	public activateOptions: ProjectConfig;
85
86	/**
87	* The root directory of the project
88	*/
89	public rootDir: string;
90
91	/**
92	* The file patterns from bsconfig.json that were used to find all files for this project
93	*/
94	public filePatterns: string[];
95
96	/**
97	* Path to a bsconfig.json file that will be used for this project
98	*/
99	public bsconfigPath?: string;
100
101	/**
102	* The worker thread where the actual project will execute
103	*/
104	private worker: Worker;
105
106	/**
107	* The path to where the project resides
108	*/
109	public projectPath: string;
110
111	/**
112	* A unique number for this project, generated during this current language server session. Mostly used so we can identify which project is doing logging
113	*/
114	public projectNumber: number;
115
116	/**
117	* The path to the workspace where this project resides. A workspace can have multiple projects (by adding a bsconfig.json to each folder).
118	* Defaults to `.projectPath` if not set
119	*/
120	public workspaceFolder: string;
121
122	/**
123	* Promise that resolves when the project finishes activating
124	* @returns a promise that resolves when the project finishes activating
125	*/
126	public whenActivated() {
NEW 127	return this.activationDeferred.promise;	×
128	}
129
130
131	/**
132	* Validate the project. This will trigger a full validation on any scopes that were changed since the last validation,
133	* and will also eventually emit a new 'diagnostics' event that includes all diagnostics for the project
134	*/
135	public async validate() {
NEW 136	const response = await this.messageHandler.sendRequest<void>('validate');	×
NEW 137	return response.data;	×
138	}
139
140	/**
141	* Cancel any active validation that's running
142	*/
143	public async cancelValidate() {
NEW 144	const response = await this.messageHandler.sendRequest<void>('cancelValidate');	×
NEW 145	return response.data;	×
146	}
147
148	public async getDiagnostics() {
149	const response = await this.messageHandler.sendRequest<LspDiagnostic[]>('getDiagnostics');	1✔
150	return response.data;	1✔
151	}
152
153	/**
154	* Apply a series of file changes to the project. This is safe to call any time. Changes will be queued and flushed at the correct times
155	* during the program's lifecycle flow
156	*/
157	public async applyFileChanges(documentActions: DocumentAction[]): Promise<DocumentActionWithStatus[]> {
NEW 158	const response = await this.messageHandler.sendRequest<DocumentActionWithStatus[]>('applyFileChanges', {	×
159	data: [documentActions]
160	});
NEW 161	return response.data;	×
162	}
163
164	/**
165	* Send a request with the standard structure
166	* @param name the name of the request
167	* @param data the array of data to send
168	* @returns the response from the request
169	*/
170	private async sendStandardRequest<T>(name: string, ...data: any[]) {
NEW 171	const response = await this.messageHandler.sendRequest<T>(name as any, {	×
172	data: data
173	});
NEW 174	return response.data;	×
175	}
176
177	/**
178	* Get the full list of semantic tokens for the given file path
179	*/
180	public async getSemanticTokens(options: { srcPath: string }) {
NEW 181	return this.sendStandardRequest<SemanticToken[]>('getSemanticTokens', options);	×
182	}
183
184	public async transpileFile(options: { srcPath: string }) {
NEW 185	return this.sendStandardRequest<FileTranspileResult>('transpileFile', options);	×
186	}
187
188	public async getHover(options: { srcPath: string; position: Position }): Promise<Hover[]> {
NEW 189	return this.sendStandardRequest<Hover[]>('getHover', options);	×
190	}
191
192	public async getDefinition(options: { srcPath: string; position: Position }): Promise<Location[]> {
NEW 193	return this.sendStandardRequest<Location[]>('getDefinition', options);	×
194	}
195
196	public async getSignatureHelp(options: { srcPath: string; position: Position }): Promise<SignatureInfoObj[]> {
NEW 197	return this.sendStandardRequest<SignatureInfoObj[]>('getSignatureHelp', options);	×
198	}
199
200	public async getDocumentSymbol(options: { srcPath: string }): Promise<DocumentSymbol[]> {
NEW 201	return this.sendStandardRequest<DocumentSymbol[]>('getDocumentSymbol', options);	×
202	}
203
204	public async getWorkspaceSymbol(): Promise<WorkspaceSymbol[]> {
NEW 205	return this.sendStandardRequest<WorkspaceSymbol[]>('getWorkspaceSymbol');	×
206	}
207
208	public async getReferences(options: { srcPath: string; position: Position }): Promise<Location[]> {
NEW 209	return this.sendStandardRequest<Location[]>('getReferences', options);	×
210	}
211
212	public async getCodeActions(options: { srcPath: string; range: Range }): Promise<CodeAction[]> {
NEW 213	return this.sendStandardRequest<CodeAction[]>('getCodeActions', options);	×
214	}
215
216	public async getCompletions(options: { srcPath: string; position: Position }): Promise<CompletionList> {
NEW 217	return this.sendStandardRequest<CompletionList>('getCompletions', options);	×
218	}
219
220	/**
221	* Handles request/response/update messages from the worker thread
222	*/
223	private messageHandler: MessageHandler<LspProject>;
224
225	private processRequest(request: WorkerMessage) {
226
227	}
228
229	private processUpdate(update: WorkerMessage) {
230	//for now, all updates are treated like "events"
231	this.emit(update.name as any, update.data);	9✔
232	}
233
234	public on(eventName: 'critical-failure', handler: (data: { message: string }) => void);
235	public on(eventName: 'diagnostics', handler: (data: { diagnostics: LspDiagnostic[] }) => MaybePromise<void>);
236	public on(eventName: 'all', handler: (eventName: string, data: any) => MaybePromise<void>);
237	public on(eventName: string, handler: (...args: any[]) => MaybePromise<void>) {
238	this.emitter.on(eventName, handler as any);	1✔
239	return () => {	1✔
NEW 240	this.emitter.removeListener(eventName, handler as any);	×
241	};
242	}
243
244	private emit(eventName: 'critical-failure', data: { message: string });
245	private emit(eventName: 'diagnostics', data: { diagnostics: LspDiagnostic[] });
246	private async emit(eventName: string, data?) {
247	//emit these events on next tick, otherwise they will be processed immediately which could cause issues
248	await util.sleep(0);	9✔
249	this.emitter.emit(eventName, data);	9✔
250	//emit the 'all' event
251	this.emitter.emit('all', eventName, data);	9✔
252	}
253	private emitter = new EventEmitter();	3✔
254
255	public disposables: LspProject['disposables'] = [];	3✔
256
257	public dispose() {
258	for (let disposable of this.disposables ?? []) {	3!
259	disposable?.dispose?.();	4!
260	}
261	this.disposables = [];	3✔
262
263	//move the worker back to the pool so it can be used again
264	if (this.worker) {	3!
265	workerPool.releaseWorker(this.worker);	3✔
266	}
267	this.emitter?.removeAllListeners();	3!
268	}
269	}

rokucommunity / brighterscript / #12779

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous