fix: use user id and anonymous id as segment identity VSCODE-326 (#394)

* fix: use user id and anonymous id as segment identity VSCODE-326

* test: try to fix fluky export to language test

* refactor: add AnalyticsNodeIdentity interface

* test: try config set msvs_version 2017

* build: try with node-gyp@latest

* build: try windows-2019

Author: alenakhineika

.github/workflows/test-and-build.yaml

@@ -14,7 +14,7 @@ jobs:
 
     strategy:
       matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
+        os: [ubuntu-latest, windows-2019, macos-latest]
 
       fail-fast: false
 
@@ -51,7 +51,7 @@ jobs:
         run: |
           npm config delete node_gyp
           npm uninstall --global node-gyp
-          npm install --global node-gyp
+          npm install --global node-gyp@latest
           npm prefix -g | % {npm config set node_gyp "$_\node_modules\node-gyp\bin\node-gyp.js"}
 
       - name: Install Dependencies

package-lock.json

@@ -901,8 +901,8 @@
     }
   },
   "dependencies": {
-    "@babel/parser": "^7.17.0",
-    "@babel/traverse": "^7.17.0",
+    "@babel/parser": "^7.17.3",
+    "@babel/traverse": "^7.17.3",
     "@fortawesome/fontawesome-svg-core": "^1.2.36",
     "@fortawesome/free-solid-svg-icons": "^5.15.4",
     "@fortawesome/react-fontawesome": "^0.1.17",

package.json

@@ -101,11 +101,11 @@ export default class HelpTree implements vscode.TreeDataProvider<vscode.TreeItem
         'report'
       );
 
-      const userId = this._telemetryService?.getSegmentUserId();
-      const segmentId = userId ? `&ajs_aid=${userId}` : '';
+      const segmentAnonymousId = this._telemetryService?.getSegmentAnonymousId();
+      const ajsAid = segmentAnonymousId ? `&ajs_aid=${segmentAnonymousId}` : '';
       const atlas = new HelpLinkTreeItem(
         'Create Free Atlas Cluster',
-        `https://mongodb.com/products/vs-code/vs-code-atlas-signup?utm_campaign=vs-code-extension&utm_source=visual-studio&utm_medium=product${segmentId}`,
+        `https://mongodb.com/products/vs-code/vs-code-atlas-signup?utm_campaign=vs-code-extension&utm_source=visual-studio&utm_medium=product${ajsAid}`,
         'freeClusterCTA',
         'atlas',
         true

src/explorer/helpTree.ts

@@ -7,7 +7,9 @@ export enum StorageVariables {
   // Only exists on globalState.
   GLOBAL_HAS_BEEN_SHOWN_INITIAL_VIEW = 'GLOBAL_HAS_BEEN_SHOWN_INITIAL_VIEW',
   GLOBAL_SAVED_CONNECTIONS = 'GLOBAL_SAVED_CONNECTIONS',
+  // Analytics user identify.
   GLOBAL_USER_ID = 'GLOBAL_USER_ID',
+  GLOBAL_ANONYMOUS_ID = 'GLOBAL_ANONYMOUS_ID',
   // Only exists on workspaceState.
   WORKSPACE_SAVED_CONNECTIONS = 'WORKSPACE_SAVED_CONNECTIONS'
 }
@@ -32,6 +34,7 @@ export type ConnectionsFromStorage = {
 
 interface StorageVariableContents {
   [StorageVariables.GLOBAL_USER_ID]: string;
+  [StorageVariables.GLOBAL_ANONYMOUS_ID]: string;
   [StorageVariables.GLOBAL_HAS_BEEN_SHOWN_INITIAL_VIEW]: boolean;
   [StorageVariables.GLOBAL_SAVED_CONNECTIONS]: ConnectionsFromStorage;
   [StorageVariables.WORKSPACE_SAVED_CONNECTIONS]: ConnectionsFromStorage;
@@ -63,17 +66,35 @@ export default class StorageController {
     return Promise.resolve();
   }
 
-  getUserID(): string {
-    let globalUserId = this.get(StorageVariables.GLOBAL_USER_ID);
+  getUserIdentity() {
+    return {
+      userId: this.getUserId(),
+      anonymousId: this.getAnonymousId()
+    };
+  }
+
+  getAnonymousId() {
+    let globalAnonymousId = this.get(StorageVariables.GLOBAL_ANONYMOUS_ID);
+
+    if (globalAnonymousId && typeof globalAnonymousId === 'string') {
+      return globalAnonymousId;
+    }
+
+    const globalUserId = this.get(StorageVariables.GLOBAL_USER_ID);
 
     if (globalUserId && typeof globalUserId === 'string') {
-      return globalUserId;
+      globalAnonymousId = globalUserId;
+    } else {
+      globalAnonymousId = uuidv4();
     }
 
-    globalUserId = uuidv4();
-    void this.update(StorageVariables.GLOBAL_USER_ID, globalUserId);
+    void this.update(StorageVariables.GLOBAL_ANONYMOUS_ID, globalAnonymousId);
+
+    return globalAnonymousId;
+  }
 
-    return globalUserId;
+  getUserId(): string | undefined {
+    return this.get(StorageVariables.GLOBAL_USER_ID);
   }
 
   async saveConnectionToStore(storeConnectionInfo: StoreConnectionInfo): Promise<void> {

src/storage/storageController.ts

@@ -18,6 +18,11 @@ import { StorageController } from '../storage';
 const log = createLogger('telemetry');
 const { version } = require('../../package.json');
 
+interface AnalyticsNodeIdentity {
+  userId?: string;
+  anonymousId: string;
+}
+
 type PlaygroundTelemetryEventProperties = {
   type: string | null;
   partial: boolean;
@@ -26,7 +31,8 @@ type PlaygroundTelemetryEventProperties = {
 
 export type SegmentProperties = {
   event: string;
-  userId: string;
+  userId?: string;
+  anonymousId: string;
   properties: unknown;
 };
 
@@ -85,7 +91,8 @@ export enum TelemetryEventTypes {
  */
 export default class TelemetryService {
   _segmentAnalytics?: SegmentAnalytics;
-  _segmentUserID: string; // The user uuid from the global storage.
+  _segmentUserId?: string; // Should exist only for users prior v0.9.0.
+  _segmentAnonymousId: string; // The randomly generated uuid.
   _segmentKey?: string; // The segment API write key.
 
   private _context: vscode.ExtensionContext;
@@ -96,9 +103,11 @@ export default class TelemetryService {
     context: vscode.ExtensionContext,
     shouldTrackTelemetry?: boolean
   ) {
+    const { userId, anonymousId } = storageController.getUserIdentity();
     this._context = context;
     this._shouldTrackTelemetry = shouldTrackTelemetry || false;
-    this._segmentUserID = storageController.getUserID();
+    this._segmentUserId = userId;
+    this._segmentAnonymousId = anonymousId;
     this._segmentKey = this._readSegmentKey();
 
     vscode.workspace.onDidOpenTextDocument((document) => {
@@ -153,7 +162,13 @@ export default class TelemetryService {
         flushInterval: 10000 // 10 seconds is the default libraries' value.
       });
 
-      this._segmentAnalytics.identify({ userId: this._segmentUserID });
+      const identity: AnalyticsNodeIdentity = {
+        anonymousId: this._segmentAnonymousId
+      };
+      if (this._segmentUserId) {
+        identity.userId = this._segmentUserId;
+      }
+      this._segmentAnalytics.identify(identity);
     }
   }
 
@@ -190,7 +205,8 @@ export default class TelemetryService {
     if (this._isTelemetryFeatureEnabled()) {
       const segmentProperties: SegmentProperties = {
         event: eventType,
-        userId: this._segmentUserID,
+        userId: this._segmentUserId,
+        anonymousId: this._segmentAnonymousId,
         properties: {
           ...properties,
           extension_version: `${version}`
@@ -260,8 +276,8 @@ export default class TelemetryService {
     return 'other';
   }
 
-  getSegmentUserId(): string {
-    return this._segmentUserID;
+  getSegmentAnonymousId(): string {
+    return this._segmentAnonymousId;
   }
 
   trackPlaygroundCodeExecuted(

src/telemetry/telemetryService.ts

@@ -262,7 +262,7 @@ suite('Connection Controller Test Suite', function () {
     assert.strictEqual(connections[Object.keys(connections)[2]].connectionOptions?.connectionString, expectedDriverUrl);
   });
 
-  test('when a connection is added it is saved to the global store', async () => {
+  test('when a connection is added it is saved to the global storage', async () => {
     await testConnectionController.loadSavedConnections();
     await vscode.workspace
       .getConfiguration('mdb.connectionSaving')
@@ -460,7 +460,7 @@ suite('Connection Controller Test Suite', function () {
     assert.strictEqual(Object.keys(postWorkspaceStoreConnections).length, 0);
   });
 
-  test('when a connection is removed it is also removed from global store', async () => {
+  test('when a connection is removed it is also removed from global storage', async () => {
     await testConnectionController.loadSavedConnections();
     await vscode.workspace
       .getConfiguration('mdb.connectionSaving')
@@ -951,7 +951,7 @@ suite('Connection Controller Test Suite', function () {
     assert.strictEqual(mockMigratePreviouslySavedConnection.called, false);
   });
 
-  test('addNewConnectionStringAndConnect saves connection without secrets to the global store', async () => {
+  test('addNewConnectionStringAndConnect saves connection without secrets to the global storage', async () => {
     const mockConnect: any = sinon.fake.resolves({ successfullyConnected: true });
 
     sinon.replace(

src/test/suite/connectionController.test.ts

@@ -44,7 +44,7 @@ suite('Help Explorer Test Suite', function () {
     assert.strictEqual(atlasHelpItem.label, 'Create Free Atlas Cluster');
     assert.strictEqual(
       atlasHelpItem.url,
-      `https://mongodb.com/products/vs-code/vs-code-atlas-signup?utm_campaign=vs-code-extension&utm_source=visual-studio&utm_medium=product&ajs_aid=${mdbTestExtension.testExtensionController._telemetryService.getSegmentUserId()}`
+      `https://mongodb.com/products/vs-code/vs-code-atlas-signup?utm_campaign=vs-code-extension&utm_source=visual-studio&utm_medium=product&ajs_aid=${mdbTestExtension.testExtensionController._telemetryService.getSegmentAnonymousId()}`
     );
     assert.strictEqual(atlasHelpItem.iconName, 'atlas');
     assert.strictEqual(atlasHelpItem.linkId, 'freeClusterCTA');