feat(cli-repl): add ability to disable logging

Author: gagik

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

@@ -33,6 +33,7 @@ import type { DevtoolsConnectOptions } from '@mongosh/service-provider-node-driv
 import type { AddressInfo } from 'net';
 import sinon from 'sinon';
 import type { CliUserConfig } from '@mongosh/types';
+import { MongoLogWriter } from 'mongodb-log-writer';
 const { EJSON } = bson;
 
 const delay = promisify(setTimeout);
@@ -1318,17 +1319,18 @@ describe('CliRepl', function () {
         sinon.restore();
       });
 
-      it('logging occurs when it is not disabled', async function () {
+      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:log-initialized');
+        expect(cliRepl.logWriter).is.instanceOf(MongoLogWriter);
       });
 
-      it('uses the disable logging setting', async function () {
+      it('does not start logging when it is disabled', async function () {
         const emitSpy = sinon.spy(cliRepl.bus, 'emit');
         cliRepl.config.disableLogging = true;
 
@@ -1338,6 +1340,7 @@ describe('CliRepl', function () {
 
         expect(emitSpy).called;
         expect(emitSpy).not.calledWith('mongosh:log-initialized');
+        expect(cliRepl.logWriter).is.undefined;
       });
     });
 

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

@@ -257,50 +257,30 @@ export class CliRepl implements MongoshIOProvider {
     );
   }
 
-  /** Setup analytics, logging and telemetry. */
-  private async startLoggingAndTelemetry() {
-    // Read the global config with log settings, e.g. logLocation, disableLogging
-    const disableLogging = this.getConfig('disableLogging');
-    if (!disableLogging) {
-      await this.logManager.cleanupOldLogFiles();
-      markTime(TimingCategories.Logging, 'cleaned up log files');
-
-      const logger = await this.logManager.createLogWriter();
-      const { quiet } = CliRepl.getFileAndEvalInfo(this.cliOptions);
-      if (!quiet) {
-        this.output.write(`Current Mongosh Log ID:\t${logger.logId}\n`);
-      }
-
-      this.logWriter = logger;
-      setupMongoLogWriter(logger);
-      markTime(TimingCategories.Logging, 'instantiated log writer');
-      this.bus.emit('mongosh:log-initialized');
-      logger.info('MONGOSH', mongoLogId(1_000_000_000), 'log', 'Starting log', {
-        execPath: process.execPath,
-        envInfo: redactSensitiveData(this.getLoggedEnvironmentVariables()),
-        ...(await buildInfo()),
-      });
-
-      markTime(TimingCategories.Logging, 'logged initial message');
-    }
-
-    markTime(TimingCategories.Telemetry, 'completed telemetry setup');
-
-    // Create analytics instance
-    let analyticsSetupError: Error | null = null;
-    try {
-      await this.setupAnalytics();
-    } catch (err: unknown) {
-      // Need to delay emitting the error on the bus so that logging is in place
-      // as well
-      analyticsSetupError = err as Error;
+  /** Setup log writer and start logging. */
+  private async startLogging() {
+    await this.logManager.cleanupOldLogFiles();
+    markTime(TimingCategories.Logging, 'cleaned up log files');
+    const logger = await this.logManager.createLogWriter();
+    const { quiet } = CliRepl.getFileAndEvalInfo(this.cliOptions);
+    if (!quiet) {
+      this.output.write(`Current Mongosh Log ID:\t${logger.logId}\n`);
     }
 
-    markTime(TimingCategories.Telemetry, 'created analytics instance');
-
-    if (analyticsSetupError) {
-      this.bus.emit('mongosh:error', analyticsSetupError, 'analytics');
-    }
+    this.logWriter = logger;
+    this.logWriter = logger;
+    setupMongoLogWriter(logger);
+    this.logWriter = logger;
+    setupMongoLogWriter(logger);
+    markTime(TimingCategories.Logging, 'instantiated log writer');
+    setupMongoLogWriter(logger);
+    this.bus.emit('mongosh:log-initialized');
+    logger.info('MONGOSH', mongoLogId(1_000_000_000), 'log', 'Starting log', {
+      execPath: process.execPath,
+      envInfo: redactSensitiveData(this.getLoggedEnvironmentVariables()),
+      ...(await buildInfo()),
+    });
+    markTime(TimingCategories.Logging, 'logged initial message');
   }
 
   /**
@@ -355,14 +335,20 @@ export class CliRepl implements MongoshIOProvider {
     }
     markTime(TimingCategories.REPLInstantiation, 'ensured shell homedir');
 
-    // Setup telemetry
+    let analyticsSetupError: Error | null = null;
+    try {
+      await this.setupAnalytics();
+    } catch (err: unknown) {
+      // Need to delay emitting the error on the bus so that logging is in place
+      // as well
+      analyticsSetupError = err as Error;
+    }
+
+    markTime(TimingCategories.Telemetry, 'created analytics instance');
+
     setupLoggerAndTelemetry(
       this.bus,
       this.toggleableAnalytics,
-      {
-        userId: this.getConfig('userId'),
-        telemetryAnonymousId: this.getConfig('telemetryAnonymousId'),
-      },
       {
         platform: process.platform,
         arch: process.arch,
@@ -371,8 +357,13 @@ export class CliRepl implements MongoshIOProvider {
       },
       version
     );
+    markTime(TimingCategories.Telemetry, 'completed telemetry setup');
+
+    if (analyticsSetupError) {
+      this.bus.emit('mongosh:error', analyticsSetupError, 'analytics');
+    }
 
-    // Get configuration
+    // Read local and global configuration
     try {
       this.config = await this.configDirectory.generateOrReadConfig(
         this.config
@@ -384,7 +375,10 @@ export class CliRepl implements MongoshIOProvider {
     this.globalConfig = await this.loadGlobalConfigFile();
     markTime(TimingCategories.UserConfigLoading, 'read global config files');
 
-    await this.startLoggingAndTelemetry();
+    const disableLogging = this.getConfig('disableLogging');
+    if (disableLogging !== true) {
+      await this.startLogging();
+    }
 
     // Needs to happen after loading the mongosh config file(s)
     void this.fetchMongoshUpdateUrl();
@@ -543,6 +537,7 @@ export class CliRepl implements MongoshIOProvider {
     this.bus.emit('mongosh:start-mongosh-repl', { version });
     markTime(TimingCategories.REPLInstantiation, 'starting repl');
     await this.mongoshRepl.startRepl(initialized);
+
     this.bus.emit('mongosh:start-session', {
       isInteractive: true,
       jsContext: this.mongoshRepl.jsContext(),
@@ -647,7 +642,7 @@ export class CliRepl implements MongoshIOProvider {
     files: string[],
     evalScripts: string[]
   ): Promise<number> {
-    let lastEvalResult: any;
+    let lastEvalResult: unknown;
     let exitCode = 0;
     try {
       markTime(TimingCategories.Eval, 'start eval scripts');
@@ -1305,7 +1300,8 @@ export class CliRepl implements MongoshIOProvider {
   }
 
   async getMoreRecentMongoshVersion(): Promise<string | null> {
-    const { version } = require('../package.json');
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    const { version }: { version: string } = require('../package.json');
     return await this.updateNotificationManager.getLatestVersionIfMoreRecent(
       process.env
         .MONGOSH_ASSUME_DIFFERENT_VERSION_FOR_UPDATE_NOTIFICATION_TEST ||

packages/logging/src/analytics-helpers.ts

@@ -11,7 +11,7 @@ export type MongoshAnalyticsIdentity =
       anonymousId: string;
     };
 
-type AnalyticsIdentifyMessage = MongoshAnalyticsIdentity & {
+export type AnalyticsIdentifyMessage = MongoshAnalyticsIdentity & {
   traits: { platform: string; session_id: string };
   timestamp?: Date;
 };

packages/logging/src/multi-set.ts

@@ -20,3 +20,30 @@ export class MultiSet<T extends Record<string, unknown>> {
     }
   }
 }
+
+/**
+ * It transforms a random string into snake case. Snake case is completely
+ * lowercase and uses '_' to separate words. For example:
+ *
+ * This function defines a "word" as a sequence of characters until the next `.` or capital letter.
+ *
+ * 'Random String' => 'random_string'
+ *
+ * It will also remove any non alphanumeric characters to ensure the string
+ * is compatible with Segment. For example:
+ *
+ * 'Node.js REPL Instantiation' => 'node_js_repl_instantiation'
+ *
+ * @param str Any non snake-case formatted string
+ * @returns The snake-case formatted string
+ */
+export function toSnakeCase(str: string): string {
+  const matches = str.match(
+    /[A-Z]{2,}(?=[A-Z][a-z]+[0-9]*|\b)|[A-Z]?[a-z]+[0-9]*|[A-Z]|[0-9]+/g
+  );
+  if (!matches) {
+    return str;
+  }
+
+  return matches.map((x) => x.toLowerCase()).join('_');
+}