chore: move device_id to common properties (#1038)

gagik · web-flow · commit 08925881d97d · 2025-05-07T17:54:31.000+02:00
diff --git a/src/explorer/helpTree.ts b/src/explorer/helpTree.ts
@@ -116,11 +116,11 @@ export default class HelpTree
         iconName: 'report',
       });
 
-      const telemetryUserIdentity = this._telemetryService?.userIdentity;
+      const anonymousId = this._telemetryService?.anonymousId;
 
       const atlas = new HelpLinkTreeItem({
         title: 'Create Free Atlas Cluster',
-        url: LINKS.createAtlasCluster(telemetryUserIdentity?.anonymousId ?? ''),
+        url: LINKS.createAtlasCluster(anonymousId ?? ''),
         linkId: 'freeClusterCTA',
         iconName: 'atlas',
         useRedirect: true,
diff --git a/src/telemetry/telemetryService.ts b/src/telemetry/telemetryService.ts
@@ -42,14 +42,13 @@ export class TelemetryService {
   public _segmentKey?: string; // The segment API write key.
   private eventBuffer: TelemetryEvent[] = [];
   private isBufferingEvents = true;
-  public userIdentity: {
-    anonymousId: string;
-    deviceId?: string;
-  };
-  private resolveDeviceId: ((value: string) => void) | undefined;
+  public readonly anonymousId: string;
   private readonly _context: vscode.ExtensionContext;
   private readonly _shouldTrackTelemetry: boolean; // When tests run the extension, we don't want to track telemetry.
 
+  public deviceId: string | undefined;
+  private resolveDeviceId: ((value: string) => void) | undefined;
+
   constructor(
     storageController: StorageController,
     context: vscode.ExtensionContext,
@@ -58,9 +57,11 @@ export class TelemetryService {
     const { anonymousId } = storageController.getUserIdentity();
     this._context = context;
     this._shouldTrackTelemetry = shouldTrackTelemetry || false;
-    this.userIdentity = {
-      anonymousId,
-    };
+    this.anonymousId = anonymousId;
+  }
+
+  public getCommonProperties(): Record<string, string | undefined> {
+    return { extension_version: `${version}`, device_id: this.deviceId };
   }
 
   private async readSegmentKey(): Promise<string | undefined> {
@@ -97,10 +98,18 @@ export class TelemetryService {
       flushInterval: 10000, // 10 seconds is the default libraries' value.
     });
 
-    this.userIdentity = await this.getTelemetryUserIdentity();
-    this._segmentAnalytics.identify(this.userIdentity);
+    this.deviceId = await this.getDeviceId();
+
+    const userIdentity = {
+      anonymousId: this.anonymousId,
+      traits: {
+        device_id: this.deviceId,
+      },
+    };
+
+    this._segmentAnalytics.identify(userIdentity);
     this.isBufferingEvents = false;
-    log.info('Segment analytics activated', this.userIdentity);
+    log.info('Segment analytics activated', userIdentity);
 
     // Process buffered events
     let event: TelemetryEvent | undefined;
@@ -158,11 +167,11 @@ export class TelemetryService {
       }
 
       this._segmentAnalyticsTrack({
-        ...this.userIdentity,
+        anonymousId: this.anonymousId,
         event: event.type,
         properties: {
+          ...this.getCommonProperties(),
           ...event.properties,
-          extension_version: `${version}`,
         },
       });
     } catch (e) {
@@ -180,18 +189,15 @@ export class TelemetryService {
     this.track(new NewConnectionTelemetryEvent(connectionTelemetryProperties));
   }
 
-  private async getTelemetryUserIdentity(): Promise<typeof this.userIdentity> {
+  private async getDeviceId(): Promise<string> {
     const { value: deviceId, resolve: resolveDeviceId } = getDeviceId({
       getMachineId: (): Promise<string> => nodeMachineId.machineId(true),
       isNodeMachineId: true,
     });
 
     this.resolveDeviceId = resolveDeviceId;
 
-    return {
-      anonymousId: this.userIdentity.anonymousId,
-      deviceId: await deviceId,
-    };
+    return deviceId;
   }
 
   trackParticipantError(err: any, command: ParticipantResponseType): void {
diff --git a/src/test/suite/explorer/helpExplorer.test.ts b/src/test/suite/explorer/helpExplorer.test.ts
@@ -42,7 +42,7 @@ suite('Help Explorer Test Suite', function () {
     assert.strictEqual(atlasHelpItem.label, 'Create Free Atlas Cluster');
     assert.strictEqual(atlasHelpItem.url.includes('mongodb.com'), true);
     const { anonymousId } =
-      mdbTestExtension.testExtensionController._telemetryService.userIdentity;
+      mdbTestExtension.testExtensionController._telemetryService;
     assert.strictEqual(
       new URL(atlasHelpItem.url).searchParams.get('ajs_aid'),
       anonymousId,
diff --git a/src/test/suite/telemetry/telemetryService.test.ts b/src/test/suite/telemetry/telemetryService.test.ts
@@ -40,12 +40,16 @@ suite('Telemetry Controller Test Suite', () => {
     mdbTestExtension.testExtensionController._telemetryService;
 
   let dataServiceStub: DataService;
+  let fakeSegmentAnalyticsTrack: SinonSpy;
+
+  const testDeviceId = 'test-device-id';
   const telemetryIdentity = {
-    ...testTelemetryService.userIdentity,
-    deviceId: 'testDeviceId',
+    anonymousId: testTelemetryService.anonymousId,
+  };
+  const commonProperties = {
+    extension_version: version,
+    device_id: testDeviceId,
   };
-
-  let fakeSegmentAnalyticsTrack: SinonSpy;
 
   const sandbox = sinon.createSandbox();
 
@@ -70,9 +74,9 @@ suite('Telemetry Controller Test Suite', () => {
     sandbox.replace(
       mdbTestExtension.testExtensionController._telemetryService,
       // @ts-expect-error This is a private method
-      'getTelemetryUserIdentity',
+      'getDeviceId',
       () => {
-        return Promise.resolve(telemetryIdentity);
+        return Promise.resolve(testDeviceId);
       },
     );
     sandbox.replace(
@@ -143,7 +147,7 @@ suite('Telemetry Controller Test Suite', () => {
           event: 'Command Run',
           properties: {
             command: 'mdb.addConnection',
-            extension_version: version,
+            ...commonProperties,
           },
         }),
       );
@@ -164,7 +168,7 @@ suite('Telemetry Controller Test Suite', () => {
             is_used_command_palette: true,
             is_used_saved_connection: false,
             vscode_mdb_extension_version: version,
-            extension_version: version,
+            ...commonProperties,
           },
         }),
       );
@@ -185,7 +189,7 @@ suite('Telemetry Controller Test Suite', () => {
             is_used_command_palette: false,
             is_used_saved_connection: false,
             vscode_mdb_extension_version: version,
-            extension_version: version,
+            ...commonProperties,
           },
         }),
       );
@@ -206,7 +210,7 @@ suite('Telemetry Controller Test Suite', () => {
             is_used_command_palette: false,
             is_used_saved_connection: true,
             vscode_mdb_extension_version: version,
-            extension_version: version,
+            ...commonProperties,
           },
         }),
       );
@@ -225,7 +229,7 @@ suite('Telemetry Controller Test Suite', () => {
           properties: {
             source: 'treeview',
             success: true,
-            extension_version: version,
+            ...commonProperties,
           },
         }),
       );
@@ -263,7 +267,7 @@ suite('Telemetry Controller Test Suite', () => {
             type: 'other',
             partial: false,
             error: false,
-            extension_version: version,
+            ...commonProperties,
           },
         }),
       );
@@ -283,7 +287,7 @@ suite('Telemetry Controller Test Suite', () => {
           event: 'Playground Loaded',
           properties: {
             file_type: 'mongodb',
-            extension_version: version,
+            ...commonProperties,
           },
         }),
       );
@@ -302,7 +306,7 @@ suite('Telemetry Controller Test Suite', () => {
           event: 'Playground Loaded',
           properties: {
             file_type: 'mongodbjs',
-            extension_version: version,
+            ...commonProperties,
           },
         }),
       );
@@ -321,7 +325,7 @@ suite('Telemetry Controller Test Suite', () => {
           event: 'Playground Saved',
           properties: {
             file_type: 'mongodbjs',
-            extension_version: version,
+            ...commonProperties,
           },
         }),
       );
@@ -339,7 +343,7 @@ suite('Telemetry Controller Test Suite', () => {
           properties: {
             screen: 'helpPanel',
             link_id: 'linkId',
-            extension_version: version,
+            ...commonProperties,
           },
         }),
       );
@@ -358,7 +362,7 @@ suite('Telemetry Controller Test Suite', () => {
           properties: {
             language: 'java',
             with_driver_syntax: false,
-            extension_version: version,
+            ...commonProperties,
           },
         }),
       );
@@ -377,7 +381,7 @@ suite('Telemetry Controller Test Suite', () => {
             event: 'Playground Created',
             properties: {
               playground_type: 'search',
-              extension_version: version,
+              ...commonProperties,
             },
           }),
         );
@@ -402,7 +406,7 @@ suite('Telemetry Controller Test Suite', () => {
             event: 'Playground Created',
             properties: {
               playground_type: 'createCollection',
-              extension_version: version,
+              ...commonProperties,
             },
           }),
         );
@@ -419,7 +423,7 @@ suite('Telemetry Controller Test Suite', () => {
             event: 'Playground Created',
             properties: {
               playground_type: 'createDatabase',
-              extension_version: version,
+              ...commonProperties,
             },
           }),
         );
@@ -437,7 +441,7 @@ suite('Telemetry Controller Test Suite', () => {
             event: 'Playground Created',
             properties: {
               playground_type: 'index',
-              extension_version: version,
+              ...commonProperties,
             },
           }),
         );
@@ -474,7 +478,7 @@ suite('Telemetry Controller Test Suite', () => {
             event: 'Playground Created',
             properties: {
               playground_type: 'cloneDocument',
-              extension_version: version,
+              ...commonProperties,
             },
           }),
         );
@@ -489,7 +493,7 @@ suite('Telemetry Controller Test Suite', () => {
             event: 'Playground Created',
             properties: {
               playground_type: 'crud',
-              extension_version: version,
+              ...commonProperties,
             },
           }),
         );
@@ -506,7 +510,7 @@ suite('Telemetry Controller Test Suite', () => {
             event: 'Playground Created',
             properties: {
               playground_type: 'crud',
-              extension_version: version,
+              ...commonProperties,
             },
           }),
         );
@@ -523,7 +527,7 @@ suite('Telemetry Controller Test Suite', () => {
             event: 'Playground Created',
             properties: {
               playground_type: 'crud',
-              extension_version: version,
+              ...commonProperties,
             },
           }),
         );
@@ -669,8 +673,10 @@ suite('Telemetry Controller Test Suite', () => {
     const verifyEvent = (call: sinon.SinonSpyCall): void => {
       const event = call.args[0] as SegmentProperties;
       expect(event.event).to.equal('Side Panel Opened');
-      expect(event.properties).to.have.keys(['extension_version']);
-      expect(Object.keys(event.properties)).to.have.length(1);
+      expect(event.properties).to.have.keys(commonProperties);
+      expect(Object.keys(event.properties)).to.have.length(
+        Object.keys(commonProperties).length,
+      );
     };
 
     expect(fakeSegmentAnalyticsTrack.getCalls()).has.length(0);
