Merge pull request #27 from forcedotcom/d/W-14219242-supp

@W-14219242@: Fixing behavioral issues with telemetry.
forcedotcom · Dec 1, 2023 · 26c72da · 26c72da
2 parents 5cea1a0 + 641cd19
commit 26c72da
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 38 deletions.
diff --git a/src/extension.ts b/src/extension.ts
@@ -15,8 +15,7 @@ import {RuleResult} from './types';
 import {DiagnosticManager} from './lib/diagnostics';
 import {messages} from './lib/messages';
 import {Fixer} from './lib/fixer';
-import { CoreExtensionService } from './lib/core-extension-service';
-import { TelemetryService } from './lib/telemetry';
+import { CoreExtensionService, TelemetryService } from './lib/core-extension-service';
 import * as Constants from './lib/constants';
 
 type RunInfo = {
@@ -85,8 +84,7 @@ export async function activate(context: vscode.ExtensionContext): Promise<vscode
 		});
 	});
 	context.subscriptions.push(runOnActiveFile, runOnSelected, runDfaOnSelectedMethod);
-	const telemetryService = CoreExtensionService.getTelemetryService();
-	telemetryService.sendExtensionActivationEvent(extensionHrStart);
+	TelemetryService.sendExtensionActivationEvent(extensionHrStart);
 	return Promise.resolve(context);
 }
 
@@ -240,6 +238,5 @@ async function summarizeResultsAsToast(targets: string[], results: RuleResult[])
 
 // This method is called when your extension is deactivated
 export function deactivate() {
-	const telemetryService = CoreExtensionService.getTelemetryService();
-	telemetryService.dispose();
+	TelemetryService.dispose();
 }
diff --git a/src/lib/core-extension-service.ts b/src/lib/core-extension-service.ts
@@ -16,7 +16,7 @@ import { CORE_EXTENSION_ID, MINIMUM_REQUIRED_VERSION_CORE_EXTENSION } from './co
  */
 export class CoreExtensionService {
 	private static initialized = false;
-	private static telemetryService: TelemetryService;
+	private static telemetryService: CoreTelemetryService;
 
 	public static async loadDependencies(context: vscode.ExtensionContext): Promise<void> {
 		if (!CoreExtensionService.initialized) {
@@ -61,11 +61,11 @@ export class CoreExtensionService {
 	}
 
 	/**
-	 * Initializes a {@link TelemetryService} instance of the provided class, or a {@link NoOpTelemetryService} if none was provided
+	 * Initializes a {@link CoreTelemetryService} instance of the provided class, or uses null if none was provided.
 	 * @param telemetryService
 	 * @param context
 	 */
-	private static async initializeTelemetryService(telemetryService: TelemetryService | undefined, context: vscode.ExtensionContext): Promise<void> {
+	private static async initializeTelemetryService(telemetryService: CoreTelemetryService | undefined, context: vscode.ExtensionContext): Promise<void> {
 		if (!telemetryService) {
 			console.log(`Telemetry service not present in core dependency API. Using null instead.`);
 			CoreExtensionService.telemetryService = null;
@@ -79,14 +79,34 @@ export class CoreExtensionService {
 	 *
 	 * @returns The {@link TelemetryService} object exported by the Core Extension if available, else null.
 	 */
-	public static getTelemetryService(): TelemetryService|null {
+	public static _getTelemetryService(): CoreTelemetryService|null {
 		if (CoreExtensionService.initialized) {
 			return CoreExtensionService.telemetryService;
 		}
 		throw new Error(messages.error.coreExtensionServiceUninitialized);
 	}
 }
 
+export class TelemetryService {
+
+	public static sendExtensionActivationEvent(hrStart: [number, number]): void {
+		CoreExtensionService._getTelemetryService()?.sendExtensionActivationEvent(hrStart);
+	}
+
+	public static sendCommandEvent(key: string, data: Properties): void {
+		CoreExtensionService._getTelemetryService()?.sendCommandEvent(key, undefined, data);
+	}
+
+	public static sendException(name: string, message: string, data?: Record<string, string>): void {
+		const fullMessage = data ? message + JSON.stringify(data) : message;
+		CoreExtensionService._getTelemetryService()?.sendException(name, fullMessage);
+	}
+
+	public static dispose(): void {
+		CoreExtensionService._getTelemetryService()?.dispose();
+	}
+}
+
 
 interface Measurements {
 	[key: string]: number;
@@ -99,10 +119,10 @@ export interface Properties {
 /**
  * This interface is a subset of the TelemetryService interface from the salesforcedx-utils-vscode package.
  */
-interface TelemetryService {
+interface CoreTelemetryService {
 	extensionName: string;
 	isTelemetryEnabled(): boolean;
-	getInstance(): TelemetryService;
+	getInstance(): CoreTelemetryService;
 	initializeService(extensionContext: vscode.ExtensionContext): Promise<void>;
 	sendExtensionActivationEvent(hrstart: [number, number]): void;
 	sendExtensionDeactivationEvent(): void;
@@ -118,6 +138,6 @@ interface TelemetryService {
 
 interface CoreExtensionApi {
 	services: {
-		TelemetryService: TelemetryService;
+		TelemetryService: CoreTelemetryService;
 	}
 }
diff --git a/src/lib/telemetry.ts b/src/lib/telemetry.ts
diff --git a/src/test/suite/extension.test.ts b/src/test/suite/extension.test.ts
@@ -11,7 +11,7 @@ import {SfCli} from '../../lib/sf-cli';
 import Sinon = require('sinon');
 import { _runAndDisplayPathless, _runAndDisplayDfa, _clearDiagnostics } from '../../extension';
 import {messages} from '../../lib/messages';
-import {TelemetryService} from '../../lib/telemetry';
+import {TelemetryService} from '../../lib/core-extension-service';
 import * as Constants from '../../lib/constants';
 
 // You can import and use all API from the 'vscode' module