Record the trigger context of completion request (#3272)

Author: testforstephen

src/TracingLanguageClient.ts

@@ -19,12 +19,12 @@ export class TracingLanguageClient extends LanguageClient {
 		const startAt: number = performance.now();
 		return super.start().then(value => {
 			if (isFirstTimeStart) {
-				this.fireTraceEvent("initialize", startAt, undefined);
+				this.fireSuccessTraceEvent("initialize", startAt, undefined);
 			}
 			return value;
 		}, reason => {
 			if (isFirstTimeStart) {
-				this.fireTraceEvent("initialize", startAt, undefined, reason);
+				this.fireFailureTraceEvent("initialize", startAt, reason);
 			}
 			throw reason;
 		});
@@ -44,11 +44,18 @@ export class TracingLanguageClient extends LanguageClient {
 	sendRequest(method: any, ...args) {
 		const startAt: number = performance.now();
 		const requestType: string = this.getRequestType(method, ...args);
+		let data: any;
+		if (args?.[0]?.context?.triggerKind) {
+			data = {
+				triggerKind: args[0].context.triggerKind,
+				triggerCharacter: args[0].context.triggerCharacter,
+			};
+		}
 		return this.sendRequest0(method, ...args).then(value => {
-			this.fireTraceEvent(requestType, startAt, this.getResultLength(value));
+			this.fireSuccessTraceEvent(requestType, startAt, this.getResultLength(value), data);
 			return value;
 		}, reason => {
-			this.fireTraceEvent(requestType, startAt, undefined, reason);
+			this.fireFailureTraceEvent(requestType, startAt, reason, data);
 			throw reason;
 		});
 	}
@@ -88,13 +95,23 @@ export class TracingLanguageClient extends LanguageClient {
 		return requestType;
 	}
 
-	private fireTraceEvent(type: string, startAt: number, resultLength: number | undefined, reason?: any): void {
+	private fireSuccessTraceEvent(type: string, startAt: number, resultLength: number | undefined, data?: any): void {
 		const duration: number = performance.now() - startAt;
 		requestEventEmitter.fire({
 			type,
 			duration,
-			error: reason,
 			resultLength,
+			data,
+		});
+	}
+
+	private fireFailureTraceEvent(type: string, startAt: number, error: any, data?: any): void {
+		const duration: number = performance.now() - startAt;
+		requestEventEmitter.fire({
+			type,
+			duration,
+			error,
+			data,
 		});
 	}
 

src/extension.api.ts

@@ -90,6 +90,10 @@ export interface TraceEvent {
 	 * The number of results returned by a response.
 	 */
 	resultLength?: number | undefined;
+	/**
+	 * Additional data properties, such as the completion trigger context.
+	 */
+	data?: any;
 }
 
 export interface SourceInvalidatedEvent {
@@ -103,7 +107,7 @@ export interface SourceInvalidatedEvent {
 	affectedEditorDocuments?: Uri[];
 }
 
-export const extensionApiVersion = '0.10';
+export const extensionApiVersion = '0.11';
 
 export interface ExtensionAPI {
 	readonly apiVersion: string;