Implement #51

Author: lramos15

lib/telemetryReporter.d.ts

@@ -1,19 +1,17 @@
+/*---------------------------------------------------------
+ * Copyright (C) Microsoft Corporation. All rights reserved.
+ *--------------------------------------------------------*/
+
+export interface TelemetryEventProperties {
+	readonly [key: string]: string;
+}
+export interface TelemetryEventMeasurements {
+	readonly [key: string]: number;
+}
 export default class TelemetryReporter {
-    constructor(extensionId: string, extensionVersion: string, key: string, firstParty?: boolean);
-    sendTelemetryEvent(eventName: string, properties?: {
-        [key: string]: string;
-    }, measurements?: {
-        [key: string]: number;
-    }): void;
-    sendTelemetryErrorEvent(eventName: string, properties?: {
-        [key: string]: string;
-    }, measurements?: {
-        [key: string]: number;
-    }, errorProps?: string[]): void;
-    sendTelemetryException(error: Error, properties?: {
-        [key: string]: string;
-    }, measurements?: {
-        [key: string]: number;
-    }): void;
-    dispose(): Promise<any>;
+	constructor(extensionId: string, extensionVersion: string, key: string, firstParty?: boolean);
+	sendTelemetryEvent(eventName: string, properties?: TelemetryEventProperties, measurements?: TelemetryEventMeasurements): void;
+	sendTelemetryErrorEvent(eventName: string, properties?: TelemetryEventProperties, measurements?: TelemetryEventMeasurements): void;
+	sendTelemetryException(error: Error, properties?: TelemetryEventProperties, measurements?: TelemetryEventMeasurements): void;
+	dispose(): Promise<any>;
 }

src/browser/telemetryReporter.ts

@@ -4,7 +4,7 @@
 
 import * as vscode from "vscode";
 import { ApplicationInsights } from "@microsoft/applicationinsights-web";
-import { BaseTelemtryReporter, ITelemetryAppender } from "../common/baseTelemetryReporter";
+import { AppenderData, BaseTelemtryReporter, ITelemetryAppender } from "../common/baseTelemetryReporter";
 
 class WebAppInsightsAppender implements ITelemetryAppender {
 	private _aiClient: ApplicationInsights | undefined;
@@ -43,14 +43,14 @@ class WebAppInsightsAppender implements ITelemetryAppender {
 		}
 	}
 
-	public logEvent(eventName: string, data: any): void {
+	public logEvent(eventName: string, data: AppenderData): void {
 		if (!this._aiClient) {
 			return;
 		}
 		this._aiClient.trackEvent({ name: eventName }, { ...data.properties, ...data.measurements });
 	}
 
-	public logException(exception: Error, data: any): void {
+	public logException(exception: Error, data: AppenderData): void {
 		if (!this._aiClient) {
 			return;
 		}

src/common/baseTelemetryReporter.ts

@@ -3,10 +3,15 @@
  *--------------------------------------------------------*/
 
 import * as vscode from "vscode";
+import type { TelemetryEventMeasurements, TelemetryEventProperties } from "../../lib/telemetryReporter";
 
+export interface AppenderData {
+	properties?: TelemetryEventProperties,
+	measurements?: TelemetryEventMeasurements
+}
 export interface ITelemetryAppender {
-	logEvent(eventName: string, data?: any): void;
-	logException(exception: Error, data?: any): void;
+	logEvent(eventName: string, data?: AppenderData): void;
+	logException(exception: Error, data?: AppenderData): void;
 	flush(): void | Promise<void>;
 }
 
@@ -133,7 +138,7 @@ export class BaseTelemtryReporter {
 	// __GDPR__COMMON__ "common.uikind" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
 	// __GDPR__COMMON__ "common.remotename" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
 	// __GDPR__COMMON__ "common.isnewappinstall" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
-	private getCommonProperties(): { [key: string]: string } {
+	private getCommonProperties(): TelemetryEventProperties {
 		const commonProperties = Object.create(null);
 		commonProperties["common.os"] = this.osShim.platform;
 		commonProperties["common.platformversion"] = (this.osShim.release || "").replace(/^(\d+)(\.\d+)?(\.\d+)?(.*)/, "$1$2$3");
@@ -221,7 +226,7 @@ export class BaseTelemtryReporter {
 		return updatedStack;
 	}
 
-	private removePropertiesWithPossibleUserInfo(properties: { [key: string]: string } | undefined): { [key: string]: string } | undefined {
+	private removePropertiesWithPossibleUserInfo(properties: TelemetryEventProperties | undefined): TelemetryEventProperties | undefined {
 		if (typeof properties !== "object") {
 			return;
 		}
@@ -257,7 +262,7 @@ export class BaseTelemtryReporter {
 	 * @param properties The properties to send with the event
 	 * @param measurements The measurements (numeric values) to send with the event
 	 */
-	public sendTelemetryEvent(eventName: string, properties?: { [key: string]: string }, measurements?: { [key: string]: number }): void {
+	public sendTelemetryEvent(eventName: string, properties?: TelemetryEventProperties, measurements?: TelemetryEventMeasurements): void {
 		if (this.userOptIn && eventName !== "") {
 			properties = { ...properties, ...this.getCommonProperties() };
 			const cleanProperties = this.cloneAndChange(properties, (_key: string, prop: string) => this.anonymizeFilePaths(prop, this.firstParty));
@@ -299,7 +304,7 @@ export class BaseTelemtryReporter {
 	 * @param properties The properties to send with the event
 	 * @param measurements The measurements (numeric values) to send with the event
 	 */
-	public sendTelemetryException(error: Error, properties?: { [key: string]: string }, measurements?: { [key: string]: number }): void {
+	public sendTelemetryException(error: Error, properties?: TelemetryEventProperties, measurements?: TelemetryEventMeasurements): void {
 		if (this.shouldSendErrorTelemetry() && this.userOptIn && error) {
 			properties = { ...properties, ...this.getCommonProperties() };
 			const cleanProperties = this.cloneAndChange(properties, (_key: string, prop: string) => this.anonymizeFilePaths(prop, this.firstParty));

src/node/telemetryReporter.ts

@@ -5,7 +5,7 @@
 import * as os from "os";
 import * as vscode from "vscode";
 import * as appInsights from "applicationinsights";
-import { BaseTelemtryReporter, ITelemetryAppender } from "../common/baseTelemetryReporter";
+import { AppenderData, BaseTelemtryReporter, ITelemetryAppender } from "../common/baseTelemetryReporter";
 
 class AppInsightsAppender implements ITelemetryAppender {
 
@@ -39,25 +39,25 @@ class AppInsightsAppender implements ITelemetryAppender {
 		}
 	}
 
-	logEvent(eventName: string, data?: any): void {
+	logEvent(eventName: string, data?: AppenderData): void {
 		if (!this._appInsightsClient) {
 			return;
 		}
 		this._appInsightsClient.trackEvent({
 			name: eventName,
-			properties: data.properties,
-			measurements: data.measurements
+			properties: data?.properties,
+			measurements: data?.measurements
 		});
 	}
 
-	logException(exception: Error, data?: any): void {
+	logException(exception: Error, data?: AppenderData): void {
 		if (!this._appInsightsClient) {
 			return;
 		}
 		this._appInsightsClient.trackException({
 			exception,
-			properties: data.properties,
-			measurements: data.measurements
+			properties: data?.properties,
+			measurements: data?.measurements
 		});
 	}