Allow 3rd party extensions to track errors in language client & server (#3162)

* Allow 3rd party extensions to track errors in language client & server

Signed-off-by: Jinbo Wang <[email protected]>

Author: testforstephen

src/apiManager.ts

@@ -17,6 +17,7 @@ class ApiManager {
     private onDidClasspathUpdateEmitter: Emitter<Uri> = new Emitter<Uri>();
     private onDidServerModeChangeEmitter: Emitter<ServerMode> = new Emitter<ServerMode>();
     private onDidProjectsImportEmitter: Emitter<Uri[]> = new Emitter<Uri[]>();
+    private traceEventEmitter: Emitter<any> = new Emitter<any>();
     private serverReadyPromiseResolve: (result: boolean) => void;
 
     public initialize(requirements: RequirementsData, serverMode: ServerMode): void {
@@ -38,6 +39,7 @@ class ApiManager {
         const onDidClasspathUpdate = this.onDidClasspathUpdateEmitter.event;
         const onDidServerModeChange = this.onDidServerModeChangeEmitter.event;
         const onDidProjectsImport = this.onDidProjectsImportEmitter.event;
+        const traceEvent = this.traceEventEmitter.event;
 
         const serverReadyPromise: Promise<boolean> = new Promise<boolean>((resolve) => {
             this.serverReadyPromiseResolve = resolve;
@@ -62,6 +64,7 @@ class ApiManager {
             onDidProjectsImport,
             serverReady,
             onDidRequestEnd,
+            trackEvent: traceEvent,
         };
     }
 
@@ -85,6 +88,10 @@ class ApiManager {
         this.onDidProjectsImportEmitter.fire(event);
     }
 
+    public fireTraceEvent(event: any): void {
+        this.traceEventEmitter.fire(event);
+    }
+
     public updateServerMode(mode: ServerMode): void {
         this.api.serverMode = mode;
     }

src/clientErrorHandler.ts

@@ -3,7 +3,9 @@ import { serverStatusBarProvider } from './serverStatusBarProvider';
 import { ErrorHandler, Message, ErrorAction, CloseAction, ErrorHandlerResult, CloseHandlerResult } from "vscode-languageclient";
 import { Commands } from "./commands";
 import { logger } from "./log";
+import { apiManager } from "./apiManager";
 
+const CLIENT_ERROR = "java.client.error";
 export class ClientErrorHandler implements ErrorHandler {
 	private restarts: number[];
 
@@ -20,7 +22,14 @@ export class ClientErrorHandler implements ErrorHandler {
 			};
 		}
 
-		logger.error(`${this.name} server encountered error and will shut down: ${_message}, ${_error && _error.toString()}`);
+		const errorMessage = `${this.name} server encountered error and will shut down: ${_message}, ${_error && _error.toString()}`;
+		apiManager.fireTraceEvent({
+			name: CLIENT_ERROR,
+			properties: {
+				message: errorMessage,
+			},
+		});
+		logger.error(errorMessage);
 		return {
 			action: ErrorAction.Shutdown,
 			handled: true
@@ -39,6 +48,12 @@ export class ClientErrorHandler implements ErrorHandler {
 			const diff = this.restarts[this.restarts.length - 1] - this.restarts[0];
 			if (diff <= 3 * 60 * 1000) {
 				const message = `The ${this.name} server crashed 5 times in the last 3 minutes. The server will not be restarted.`;
+				apiManager.fireTraceEvent({
+					name: CLIENT_ERROR,
+					properties: {
+						message,
+					},
+				});
 				logger.error(message);
 				serverStatusBarProvider.setError();
 				const action = "Show logs";

src/extension.api.ts

@@ -92,7 +92,7 @@ export interface TraceEvent {
 	resultLength?: number | undefined;
 }
 
-export const extensionApiVersion = '0.8';
+export const extensionApiVersion = '0.9';
 
 export interface ExtensionAPI {
 	readonly apiVersion: string;
@@ -144,4 +144,12 @@ export interface ExtensionAPI {
 	 * @since extension version 1.16.0
 	 */
 	readonly onDidRequestEnd: Event<TraceEvent>;
+
+	/**
+	 * Allow 3rd party trace handler to track the language client & server error events.
+	 *
+	 * @since API version 0.9
+	 * @since extension version 1.20.0
+	 */
+	readonly trackEvent: Event<any>;
 }

src/standardLanguageClient.ts

@@ -296,6 +296,7 @@ export class StandardLanguageClient {
 		});
 
 		this.languageClient.onTelemetry(async (e: TelemetryEvent) => {
+			apiManager.fireTraceEvent(e);
 			if (e.name === Telemetry.SERVER_INITIALIZED_EVT) {
 				return Telemetry.sendTelemetry(Telemetry.STARTUP_EVT, e.properties);
 			}