feat: report hostname for atlas COMPASS-8093

packages/cli-repl/src/mongosh-repl.spec.ts

@@ -1461,6 +1461,7 @@ describe('MongoshNodeRepl', function () {
         'getConnectionInfo',
         'getFleOptions',
         'getRawClient',
+        'getTopology',
         'getURI',
         'runCommandWithCheck',
       ]);

packages/logging/src/setup-logger-and-telemetry.spec.ts

@@ -3,10 +3,13 @@ import { expect } from 'chai';
 import { MongoLogWriter } from 'mongodb-log-writer';
 import { setupLoggerAndTelemetry } from './';
 import { EventEmitter } from 'events';
+import { promisify } from 'util';
 import { MongoshInvalidInputError } from '@mongosh/errors';
 import type { MongoshBus } from '@mongosh/types';
 import { toSnakeCase } from './setup-logger-and-telemetry';
 
+const wait = promisify(setTimeout);
+
 describe('toSnakeCase', function () {
   const useCases = [
     { input: 'MongoDB REPL', output: 'mongo_db_repl' },
@@ -64,7 +67,7 @@ describe('setupLoggerAndTelemetry', function () {
     bus = new EventEmitter();
   });
 
-  it('works', function () {
+  it('tracks new local connection events', async function () {
     setupLoggerAndTelemetry(
       bus,
       logger,
@@ -78,14 +81,116 @@ describe('setupLoggerAndTelemetry', function () {
     expect(logOutput).to.have.lengthOf(0);
     expect(analyticsOutput).to.be.empty;
 
-    bus.emit('mongosh:new-user', { userId, anonymousId: userId });
-    bus.emit('mongosh:update-user', { userId, anonymousId: userId });
     bus.emit('mongosh:connect', {
+      mongosh_version: '1.0.0',
       uri: 'mongodb://localhost/',
       is_localhost: true,
       is_atlas: false,
+      resolved_hostname: 'localhost',
+      node_version: 'v12.19.0',
+    });
+
+    // Make sure cloud info is resolved.
+    await wait(500);
+
+    expect(logOutput[0].msg).to.equal('Connecting to server');
+    expect(logOutput[0].attr.connectionUri).to.equal('mongodb://localhost/');
+    expect(logOutput[0].attr.is_localhost).to.equal(true);
+    expect(logOutput[0].attr.is_atlas).to.equal(false);
+    expect(logOutput[0].attr.atlas_hostname).to.equal(null);
+    expect(logOutput[0].attr.node_version).to.equal('v12.19.0');
+
+    expect(analyticsOutput).to.deep.equal([
+      [
+        'track',
+        {
+          anonymousId: undefined,
+          event: 'New Connection',
+          properties: {
+            mongosh_version: '1.0.0',
+            session_id: '5fb3c20ee1507e894e5340f3',
+            is_localhost: true,
+            is_atlas: false,
+            atlas_hostname: null,
+            node_version: 'v12.19.0',
+          },
+        },
+      ],
+    ]);
+  });
+
+  it('tracks new atlas connection events', async function () {
+    setupLoggerAndTelemetry(
+      bus,
+      logger,
+      analytics,
+      {
+        platform: process.platform,
+        arch: process.arch,
+      },
+      '1.0.0'
+    );
+    expect(logOutput).to.have.lengthOf(0);
+    expect(analyticsOutput).to.be.empty;
+
+    bus.emit('mongosh:connect', {
+      mongosh_version: '1.0.0',
+      uri: 'mongodb://test-data-sets-a011bb.mongodb.net/',
+      is_localhost: false,
+      is_atlas: true,
+      resolved_hostname: 'test-data-sets-00-02-a011bb.mongodb.net',
       node_version: 'v12.19.0',
-    } as any);
+    });
+
+    // Make sure cloud info is resolved.
+    await wait(500);
+
+    expect(logOutput[0].msg).to.equal('Connecting to server');
+    expect(logOutput[0].attr.connectionUri).to.equal(
+      'mongodb://test-data-sets-a011bb.mongodb.net/'
+    );
+    expect(logOutput[0].attr.is_localhost).to.equal(false);
+    expect(logOutput[0].attr.is_atlas).to.equal(true);
+    expect(logOutput[0].attr.atlas_hostname).to.equal(
+      'test-data-sets-00-02-a011bb.mongodb.net'
+    );
+    expect(logOutput[0].attr.node_version).to.equal('v12.19.0');
+
+    expect(analyticsOutput).to.deep.equal([
+      [
+        'track',
+        {
+          anonymousId: undefined,
+          event: 'New Connection',
+          properties: {
+            mongosh_version: '1.0.0',
+            session_id: '5fb3c20ee1507e894e5340f3',
+            is_localhost: false,
+            is_atlas: true,
+            atlas_hostname: 'test-data-sets-00-02-a011bb.mongodb.net',
+            node_version: 'v12.19.0',
+          },
+        },
+      ],
+    ]);
+  });
+
+  it('tracks a sequence of events', function () {
+    setupLoggerAndTelemetry(
+      bus,
+      logger,
+      analytics,
+      {
+        platform: process.platform,
+        arch: process.arch,
+      },
+      '1.0.0'
+    );
+    expect(logOutput).to.have.lengthOf(0);
+    expect(analyticsOutput).to.be.empty;
+
+    bus.emit('mongosh:new-user', { userId, anonymousId: userId });
+    bus.emit('mongosh:update-user', { userId, anonymousId: userId });
     bus.emit('mongosh:start-session', {
       isInteractive: true,
       jsContext: 'foo',
@@ -230,16 +335,8 @@ describe('setupLoggerAndTelemetry', function () {
     });
 
     let i = 0;
+
     expect(logOutput[i++].msg).to.equal('User updated');
-    expect(logOutput[i].msg).to.equal('Connecting to server');
-    expect(logOutput[i].attr.session_id).to.equal('5fb3c20ee1507e894e5340f3');
-    expect(logOutput[i].attr.telemetryAnonymousId).to.equal(
-      '53defe995fa47e6c13102d9d'
-    );
-    expect(logOutput[i].attr.connectionUri).to.equal('mongodb://localhost/');
-    expect(logOutput[i].attr.is_localhost).to.equal(true);
-    expect(logOutput[i].attr.is_atlas).to.equal(false);
-    expect(logOutput[i++].attr.node_version).to.equal('v12.19.0');
     expect(logOutput[i].s).to.equal('E');
     expect(logOutput[i++].attr.message).to.match(/meow/);
     expect(logOutput[i].s).to.equal('F');
@@ -401,20 +498,6 @@ describe('setupLoggerAndTelemetry', function () {
           },
         },
       ],
-      [
-        'track',
-        {
-          anonymousId: '53defe995fa47e6c13102d9d',
-          event: 'New Connection',
-          properties: {
-            mongosh_version: '1.0.0',
-            session_id: '5fb3c20ee1507e894e5340f3',
-            is_localhost: true,
-            is_atlas: false,
-            node_version: 'v12.19.0',
-          },
-        },
-      ],
       [
         'track',
         {

packages/logging/src/setup-logger-and-telemetry.ts

@@ -141,32 +141,38 @@ export function setupLoggerAndTelemetry(
   );
 
   bus.on('mongosh:connect', function (args: ConnectEvent) {
-    const connectionUri = args.uri && redactURICredentials(args.uri);
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    const { uri: _uri, ...argsWithoutUri } = args;
-    const params = {
-      session_id,
-      userId,
-      telemetryAnonymousId,
-      connectionUri,
-      ...argsWithoutUri,
+    const { uri, resolved_hostname, ...argsWithoutUriAndHostname } = args;
+    const connectionUri = uri && redactURICredentials(uri);
+    const atlasHostname = {
+      atlas_hostname: args.is_atlas ? resolved_hostname : null,
     };
-    log.info(
-      'MONGOSH',
-      mongoLogId(1_000_000_004),
-      'connect',
-      'Connecting to server',
-      params
-    );
 
-    analytics.track({
-      ...getTelemetryUserIdentity(),
-      event: 'New Connection',
-      properties: {
+    (async () => {
+      const properties = {
         ...trackProperties,
-        ...argsWithoutUri,
-      },
-    });
+        ...argsWithoutUriAndHostname,
+        ...atlasHostname,
+      };
+
+      log.info(
+        'MONGOSH',
+        mongoLogId(1_000_000_004),
+        'connect',
+        'Connecting to server',
+        {
+          userId,
+          telemetryAnonymousId,
+          connectionUri,
+          ...properties,
+        }
+      );
+
+      analytics.track({
+        ...getTelemetryUserIdentity(),
+        event: 'New Connection',
+        properties,
+      });
+    })().catch(() => undefined);
   });
 
   bus.on('mongosh:start-session', function (args: SessionStartedEvent) {