feat: add device ID to compass telemetry

Author: gagik

packages/compass-e2e-tests/tests/logging.test.ts

@@ -179,6 +179,7 @@ describe('Logging and Telemetry integration', function () {
             expect(actual.hasAnalytics).to.equal(true);
             expect(actual.currentUserId).to.not.exist;
             expect(actual.telemetryAnonymousId).to.be.a('string');
+            expect(actual.telemetryDeviceId).to.match(/^[a-f0-9]{64}$/);
             expect(actual.state).to.equal('enabled');
           },
         },

packages/compass/src/main/device-id.ts

@@ -0,0 +1,35 @@
+import { createHmac } from 'crypto';
+
+/**
+ * TODO: This hashing function should eventually be moved to devtools-shared.
+ * @returns A hashed, unique identifier for the running device or `"unknown"` if not known.
+ */
+export async function getDeviceId({
+  onError,
+}: {
+  onError?: (error: Error) => void;
+} = {}): Promise<string | 'unknown'> {
+  try {
+    // Create a hashed format from the all uppercase version of the machine ID
+    // to match it exactly with the denisbrodbeck/machineid library that Atlas CLI uses.
+    const originalId: string =
+      // eslint-disable-next-line @typescript-eslint/no-var-requires
+      await require('native-machine-id').getMachineId({
+        raw: true,
+      });
+
+    if (!originalId) {
+      return 'unknown';
+    }
+    const hmac = createHmac('sha256', originalId);
+
+    /** This matches the message used to create the hashes in Atlas CLI */
+    const DEVICE_ID_HASH_MESSAGE = 'atlascli';
+
+    hmac.update(DEVICE_ID_HASH_MESSAGE);
+    return hmac.digest('hex');
+  } catch (error) {
+    onError?.(error as Error);
+    return 'unknown';
+  }
+}

packages/compass/src/main/telemetry.ts

@@ -6,6 +6,7 @@ import type { CompassApplication } from './application';
 import type { EventEmitter } from 'events';
 import { getOsInfo } from '@mongodb-js/get-os-info';
 import type { IdentifyTraits } from '@mongodb-js/compass-telemetry';
+import { getDeviceId } from './device-id';
 
 const { log, mongoLogId } = createLogger('COMPASS-TELEMETRY');
 
@@ -38,6 +39,7 @@ class CompassTelemetry {
   private static queuedEvents: EventInfo[] = []; // Events that happen before we fetch user preferences
   private static telemetryAnonymousId = ''; // The randomly generated anonymous user id.
   private static telemetryAtlasUserId?: string;
+  private static telemetryDeviceId = 'unknown';
   private static lastReportedScreen = '';
   private static osInfo: ReturnType<typeof getOsInfo> extends Promise<infer T>
     ? Partial<T>
@@ -53,6 +55,7 @@ class CompassTelemetry {
     // Used in both track and identify to add common traits
     // to any event that we send to segment
     return {
+      device_id: this.telemetryDeviceId,
       compass_version: app.getVersion().split('.').slice(0, 2).join('.'),
       compass_full_version: app.getVersion(),
       compass_distribution: process.env.HADRON_DISTRIBUTION,
@@ -138,6 +141,15 @@ class CompassTelemetry {
       preferences.getPreferences();
     this.telemetryAnonymousId = telemetryAnonymousId ?? '';
     this.telemetryAtlasUserId = telemetryAtlasUserId;
+    this.telemetryDeviceId = await getDeviceId({
+      onError: (err) =>
+        log.error(
+          mongoLogId(1_001_000_148),
+          'Telemetry',
+          'Failed to get device ID',
+          { err: err.message }
+        ),
+    });
 
     try {
       this.osInfo = await getOsInfo();