chore(telemetry): append user anonymousId & connectionId to appName passed to server COMPASS-8591 (#982)

Author: gagik

package-lock.json

@@ -1315,7 +1315,7 @@
     "@babel/parser": "^7.25.8",
     "@babel/traverse": "^7.25.7",
     "@mongodb-js/compass-components": "^1.34.5",
-    "@mongodb-js/connection-form": "1.47.2",
+    "@mongodb-js/connection-form": "1.47.6",
     "@mongodb-js/connection-info": "^0.11.6",
     "@mongodb-js/mongodb-constants": "^0.11.0",
     "@mongosh/browser-runtime-electron": "^3.8.0",

package.json

@@ -30,6 +30,7 @@ import LINKS from './utils/links';
 import { isAtlasStream } from 'mongodb-build-info';
 import type { ConnectionTreeItem } from './explorer';
 import { PresetConnectionEditedTelemetryEvent } from './telemetry';
+import getBuildInfo from 'mongodb-build-info';
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const packageJSON = require('../package.json');
@@ -304,13 +305,6 @@ export default class ConnectionController {
 
     const connectionStringData = new ConnectionString(connectionString);
 
-    // TODO: Allow overriding appname + use driverInfo instead
-    // (https://jira.mongodb.org/browse/MONGOSH-1015)
-    connectionStringData.searchParams.set(
-      'appname',
-      `${packageJSON.name} ${packageJSON.version}`
-    );
-
     try {
       const connectResult = await this.saveNewConnectionAndConnect({
         connectionId: uuidv4(),
@@ -362,6 +356,33 @@ export default class ConnectionController {
     return this._connect(connection.id, connectionType);
   }
 
+  /**
+   * In older versions, we'd manually store a connectionString with an appended
+   * appName with the VSCode extension name and version. This overrides the
+   * connection string if needed and returns true if it does so, false otherwise.
+   */
+  private _overrideLegacyConnectionStringAppName(
+    connectionId: string
+  ): boolean {
+    const connectionString = new ConnectionString(
+      this._connections[connectionId].connectionOptions.connectionString
+    );
+
+    if (
+      connectionString.searchParams
+        .get('appname')
+        ?.match(/mongodb-vscode \d\.\d\.\d.*/)
+    ) {
+      connectionString.searchParams.delete('appname');
+
+      this._connections[connectionId].connectionOptions.connectionString =
+        connectionString.toString();
+
+      return true;
+    }
+    return false;
+  }
+
   // eslint-disable-next-line complexity
   async _connect(
     connectionId: string,
@@ -427,10 +448,17 @@ export default class ConnectionController {
 
       const connectionOptions = adjustConnectionOptionsBeforeConnect({
         connectionOptions: connectionInfo.connectionOptions,
-        defaultAppName: packageJSON.name,
+        connectionInfo: {
+          id: connectionId,
+          isAtlas: getBuildInfo.isAtlas(
+            connectionInfo.connectionOptions.connectionString
+          ),
+        },
+        defaultAppName: `${packageJSON.name} ${packageJSON.version}`,
         notifyDeviceFlow,
         preferences: {
           forceConnectionOptions: [],
+          telemetryAnonymousId: this._connectionStorage.getUserAnonymousId(),
           browserCommandForOIDCAuth: undefined, // We overwrite this below.
         },
       });
@@ -620,12 +648,23 @@ export default class ConnectionController {
     }
 
     try {
-      await this._connect(connectionId, ConnectionTypes.CONNECTION_ID);
+      const wasOverridden =
+        this._overrideLegacyConnectionStringAppName(connectionId);
 
-      return {
-        successfullyConnected: true,
-        connectionErrorMessage: '',
-      };
+      const result = await this._connect(
+        connectionId,
+        ConnectionTypes.CONNECTION_ID
+      );
+
+      /** After successfully connecting with an overridden connection
+       *  string, save it to storage for the future. */
+      if (result.successfullyConnected && wasOverridden) {
+        await this._connectionStorage.saveConnection(
+          this._connections[connectionId]
+        );
+      }
+
+      return result;
     } catch (error) {
       log.error('Failed to connect by a connection id', error);
       const printableError = formatError(error);

src/connectionController.ts

@@ -324,4 +324,8 @@ export class ConnectionStorage {
 
     return StorageLocation.NONE;
   }
+
+  getUserAnonymousId(): string {
+    return this._storageController.getUserIdentity().anonymousId;
+  }
 }