tests: add initial set of tests

Will follow up with more end to end tests.

Author: gagik

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

@@ -1313,37 +1313,6 @@ describe('CliRepl', function () {
       hasCollectionNames: true,
       hasDatabaseNames: true,
     });
-
-    context('logging configuration', function () {
-      afterEach(function () {
-        sinon.restore();
-      });
-
-      it('start logging when it is not disabled', async function () {
-        const emitSpy = sinon.spy(cliRepl.bus, 'emit');
-
-        await cliRepl.start(await testServer.connectionString(), {});
-
-        expect(cliRepl.getConfig('disableLogging')).is.false;
-
-        expect(emitSpy).calledWith('mongosh:logger-initialized');
-        expect(cliRepl.logWriter).is.instanceOf(MongoLogWriter);
-      });
-
-      it('does not start logging when it is disabled', async function () {
-        const emitSpy = sinon.spy(cliRepl.bus, 'emit');
-        cliRepl.config.disableLogging = true;
-
-        await cliRepl.start(await testServer.connectionString(), {});
-
-        expect(cliRepl.getConfig('disableLogging')).is.true;
-
-        expect(emitSpy).called;
-        expect(emitSpy).not.calledWith('mongosh:logger-initialized');
-        expect(cliRepl.logWriter).is.undefined;
-      });
-    });
-
     context('analytics integration', function () {
       context('with network connectivity', function () {
         let srv: http.Server;
@@ -1394,6 +1363,33 @@ describe('CliRepl', function () {
           setTelemetryDelay(0);
         });
 
+        context('logging configuration', function () {
+          it('logging is enabled by default', async function () {
+            const onLoggerInitialized = sinon.stub();
+            cliRepl.bus.on('mongosh:logger-initialized', onLoggerInitialized);
+
+            await cliRepl.start(await testServer.connectionString(), {});
+
+            expect(await cliRepl.getConfig('disableLogging')).is.false;
+
+            expect(onLoggerInitialized).calledOnce;
+            expect(cliRepl.logWriter).is.instanceOf(MongoLogWriter);
+          });
+
+          it('does not start logging when it is disabled', async function () {
+            cliRepl.config.disableLogging = true;
+            const onLoggerInitialized = sinon.stub();
+            cliRepl.bus.on('mongosh:logger-initialized', onLoggerInitialized);
+
+            await cliRepl.start(await testServer.connectionString(), {});
+
+            expect(await cliRepl.getConfig('disableLogging')).is.true;
+            expect(onLoggerInitialized).not.called;
+
+            expect(cliRepl.logWriter).is.undefined;
+          });
+        });
+
         it('times out fast', async function () {
           const testStartMs = Date.now();
           // The `httpRequestTimeout` of our Segment Analytics is set to

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

@@ -272,7 +272,6 @@ export class CliRepl implements MongoshIOProvider {
     loggingAndTelemetry.setupLogger(logger);
 
     markTime(TimingCategories.Logging, 'instantiated log writer');
-    this.bus.emit('mongosh:logger-initialized');
     logger.info('MONGOSH', mongoLogId(1_000_000_000), 'log', 'Starting log', {
       execPath: process.execPath,
       envInfo: redactSensitiveData(this.getLoggedEnvironmentVariables()),

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

@@ -37,14 +37,14 @@ describe('MongoshLoggingAndTelemetry', function () {
     },
   };
 
+  let loggingAndTelemetry: MongoshLoggingAndTelemetry;
+
   beforeEach(function () {
     logOutput = [];
     analyticsOutput = [];
     bus = new EventEmitter();
-  });
 
-  it('throws when trying to setup writer prematurely', function () {
-    const loggingAndTelemetry = new MongoshLoggingAndTelemetry(
+    loggingAndTelemetry = new MongoshLoggingAndTelemetry(
       bus,
       analytics,
       {
@@ -53,23 +53,31 @@ describe('MongoshLoggingAndTelemetry', function () {
       },
       '1.0.0'
     );
+  });
+
+  it('throws when running setup twice', function () {
+    loggingAndTelemetry.setup();
+
+    expect(() => loggingAndTelemetry.setup()).throws(
+      'Setup can only be called once.'
+    );
+  });
 
+  it('throws when trying to setup writer prematurely', function () {
     expect(() => loggingAndTelemetry.setupLogger(logger)).throws(
       'Run setup() before setting up the log writer.'
     );
   });
 
-  it('tracks new local connection events', function () {
-    const loggingAndTelemetry = new MongoshLoggingAndTelemetry(
-      bus,
-      analytics,
-      {
-        platform: process.platform,
-        arch: process.arch,
-      },
-      '1.0.0'
+  it('throws when running setupLogger twice', function () {
+    loggingAndTelemetry.setup();
+    loggingAndTelemetry.setupLogger(logger);
+    expect(() => loggingAndTelemetry.setupLogger(logger)).throws(
+      'Logger has already been initialized.'
     );
+  });
 
+  it('tracks new local connection events', function () {
     loggingAndTelemetry.setup();
     loggingAndTelemetry.setupLogger(logger);
 
@@ -125,16 +133,6 @@ describe('MongoshLoggingAndTelemetry', function () {
   });
 
   it('tracks new atlas connection events', function () {
-    const loggingAndTelemetry = new MongoshLoggingAndTelemetry(
-      bus,
-      analytics,
-      {
-        platform: process.platform,
-        arch: process.arch,
-      },
-      '1.0.0'
-    );
-
     loggingAndTelemetry.setup();
     loggingAndTelemetry.setupLogger(logger);
 
@@ -663,16 +661,6 @@ describe('MongoshLoggingAndTelemetry', function () {
   });
 
   it('buffers deprecated API calls', function () {
-    const loggingAndTelemetry = new MongoshLoggingAndTelemetry(
-      bus,
-      analytics,
-      {
-        platform: process.platform,
-        arch: process.arch,
-      },
-      '1.0.0'
-    );
-
     loggingAndTelemetry.setup();
     loggingAndTelemetry.setupLogger(logger);
 
@@ -849,16 +837,6 @@ describe('MongoshLoggingAndTelemetry', function () {
   });
 
   it('does not track database calls outside of evaluate-{started,finished}', function () {
-    const loggingAndTelemetry = new MongoshLoggingAndTelemetry(
-      bus,
-      analytics,
-      {
-        platform: process.platform,
-        arch: process.arch,
-      },
-      '1.0.0'
-    );
-
     loggingAndTelemetry.setup();
     loggingAndTelemetry.setupLogger(logger);
 

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

@@ -46,6 +46,8 @@ import { MultiSet, toSnakeCase } from './helpers';
 import { Writable } from 'stream';
 
 export class MongoshLoggingAndTelemetry {
+  public log: MongoLogWriter;
+
   private readonly trackingProperties: {
     mongosh_version: string;
     session_id: string;
@@ -54,14 +56,12 @@ export class MongoshLoggingAndTelemetry {
     [key: string]: unknown;
   };
 
-  private log: MongoLogWriter;
   private pendingLogEvents: CallableFunction[] = [];
 
   private telemetryAnonymousId: string | undefined;
   private userId: string | undefined;
-
-  private isSetup = false;
   private hasMongoLogWriterInitialized = false;
+  private isSetup = false;
 
   constructor(
     public readonly bus: MongoshBus,
@@ -90,6 +90,9 @@ export class MongoshLoggingAndTelemetry {
   }
 
   public setup(): void {
+    if (this.isSetup) {
+      throw new Error('Setup can only be called once.');
+    }
     this._setupBusEventListeners();
     this.isSetup = true;
   }