Set userId for telemetry events

Author: jeanp413

extensions/gitpod/src/authentication.ts

@@ -56,6 +56,9 @@ export default class GitpodAuthenticationProvider extends Disposable implements
 		// Contains the current state of the sessions we have available.
 		this._sessionsPromise = this.readSessions();
 
+		// Update telemetry userId
+		this._sessionsPromise.then(sessions => this._telemetry.setUserId(sessions.length ? sessions[0].id : undefined));
+
 		this._register(vscode.authentication.registerAuthenticationProvider('gitpod', 'Gitpod', this, { supportsMultipleAccounts: false }));
 		this._register(this.context.secrets.onDidChange(() => this.checkForUpdates()));
 	}
@@ -106,6 +109,9 @@ export default class GitpodAuthenticationProvider extends Disposable implements
 		if (added.length || removed.length) {
 			this._sessionChangeEmitter.fire({ added, removed, changed: [] });
 		}
+
+		// Update telemetry userId
+		this._telemetry.setUserId(storedSessions.length ? storedSessions[0].id : undefined);
 	}
 
 	private async readSessions(): Promise<vscode.AuthenticationSession[]> {
@@ -179,6 +185,9 @@ export default class GitpodAuthenticationProvider extends Disposable implements
 		this._sessionsPromise = Promise.resolve(sessions);
 		await this._keychain.setToken(JSON.stringify(sessions));
 		this._logger.info(`Stored ${sessions.length} sessions!`);
+
+		// Update telemetry userId
+		this._telemetry.setUserId(sessions.length ? sessions[0].id : undefined);
 	}
 
 	public async createSession(scopes: string[]): Promise<vscode.AuthenticationSession> {

extensions/gitpod/src/telemetryReporter.ts

@@ -3,44 +3,57 @@ import SegmentAnalytics from 'analytics-node';
 import * as os from 'os';
 import * as vscode from 'vscode';
 
-const analyticsClientFactory = async (key: string): Promise<BaseTelemetryClient> => {
-	let segmentAnalyticsClient = new SegmentAnalytics(key);
-
-	// Sets the analytics client into a standardized form
-	const telemetryClient: BaseTelemetryClient = {
-		logEvent: (eventName: string, data?: AppenderData) => {
-			try {
-				segmentAnalyticsClient.track({
-					anonymousId: vscode.env.machineId,
-					event: eventName,
-					properties: data?.properties
-				});
-			} catch (e: any) {
-				throw new Error('Failed to log event to app analytics!\n' + e.message);
-			}
-		},
-		logException: (_exception: Error, _data?: AppenderData) => {
-			throw new Error('Failed to log exception to app analytics!\n');
-		},
-		flush: async () => {
-			try {
-				// Types are oudated, flush does return a promise
-				await segmentAnalyticsClient.flush();
-			} catch (e: any) {
-				throw new Error('Failed to flush app analytics!\n' + e.message);
-			}
-		}
-	};
-	return telemetryClient;
-};
-
 export default class TelemetryReporter extends BaseTelemetryReporter {
+
+	private _userId: string | undefined;
+
 	constructor(extensionId: string, extensionVersion: string, key: string) {
-		const appender = new BaseTelemetryAppender(key, (key) => analyticsClientFactory(key));
+		let resolveTelemetryClient: (value: Promise<BaseTelemetryClient>) => void;
+		const telemetryClientPromise = new Promise<BaseTelemetryClient>((resolve, _reject) => resolveTelemetryClient = resolve);
+
+		const appender = new BaseTelemetryAppender(key, () => telemetryClientPromise);
 		super(extensionId, extensionVersion, appender, {
 			release: os.release(),
 			platform: os.platform(),
 			architecture: os.arch(),
 		});
+
+		resolveTelemetryClient!(this.analyticsClientFactory(key));
+	}
+
+	setUserId(id: string | undefined) {
+		this._userId = id;
+	}
+
+	async analyticsClientFactory(key: string): Promise<BaseTelemetryClient> {
+		let segmentAnalyticsClient = new SegmentAnalytics(key);
+
+		// Sets the analytics client into a standardized form
+		const telemetryClient: BaseTelemetryClient = {
+			logEvent: (eventName: string, data?: AppenderData) => {
+				try {
+					segmentAnalyticsClient.track({
+						userId: this._userId,
+						anonymousId: vscode.env.machineId,
+						event: eventName,
+						properties: data?.properties
+					});
+				} catch (e: any) {
+					throw new Error('Failed to log event to app analytics!\n' + e.message);
+				}
+			},
+			logException: (_exception: Error, _data?: AppenderData) => {
+				throw new Error('Failed to log exception to app analytics!\n');
+			},
+			flush: async () => {
+				try {
+					// Types are oudated, flush does return a promise
+					await segmentAnalyticsClient.flush();
+				} catch (e: any) {
+					throw new Error('Failed to flush app analytics!\n' + e.message);
+				}
+			}
+		};
+		return telemetryClient;
 	}
 }