refactor: move custom log entries into new structure

Author: gagik

packages/e2e-tests/test/e2e.spec.ts

@@ -1356,7 +1356,7 @@ describe('e2e', function () {
     let logBasePath: string;
     let historyPath: string;
     let readConfig: () => Promise<any>;
-    let readLogFile: () => Promise<LogEntry[]>;
+    let readLogFile: <T = LogEntry>() => Promise<T[]>;
     let startTestShell: (...extraArgs: string[]) => Promise<TestShell>;
 
     beforeEach(function () {
@@ -1652,7 +1652,12 @@ describe('e2e', function () {
           await shell.executeLine("log.info('This is a custom entry')");
           expect(shell.assertNoErrors());
           await eventually(async () => {
-            const log = await readLogfile();
+            const log = await readLogFile<{
+              msg: string;
+              s: string;
+              c: string;
+              ctx: string;
+            }>();
             const customLogEntry = log.filter((logEntry) =>
               logEntry.msg.includes('This is a custom entry')
             );
@@ -1676,7 +1681,7 @@ describe('e2e', function () {
           await shell.executeLine(`load(${JSON.stringify(filename)})`);
           expect(shell.assertNoErrors());
           await eventually(async () => {
-            const log = await readLogfile();
+            const log = await readLogFile<{ msg: string }>();
             expect(
               log.filter((logEntry) =>
                 logEntry.msg.includes('Initiating connection attemp')

packages/e2e-tests/test/test-shell.ts

@@ -368,10 +368,9 @@ export class TestShell {
     if (!matches || matches.length === 0) {
       return null;
     }
-    const lastMatch = matches[matches.length - 1];
-    const logIdMatch = /^Current Mongosh Log ID:\s*([a-z0-9]{24})$/.exec(
-      lastMatch
+    const lastMatch = /^Current Mongosh Log ID:\s*([a-z0-9]{24})$/.exec(
+      matches[matches.length - 1]
     );
-    return logIdMatch ? logIdMatch[1] : null;
+    return lastMatch ? lastMatch[1] : null;
   }
 }

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

@@ -271,16 +271,6 @@ describe('MongoshLoggingAndTelemetry', function () {
   });
 
   it('tracks a sequence of events', function () {
-    const loggingAndTelemetry = new MongoshLoggingAndTelemetry(
-      bus,
-      analytics,
-      {
-        platform: process.platform,
-        arch: process.arch,
-      },
-      '1.0.0'
-    );
-
     loggingAndTelemetry.setup();
     loggingAndTelemetry.attachLogger(logger);
 
@@ -945,19 +935,12 @@ describe('MongoshLoggingAndTelemetry', function () {
   });
 
   it('tracks custom logging 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;
 
+    loggingAndTelemetry.setup();
+    loggingAndTelemetry.attachLogger(logger);
+
     bus.emit('mongosh:connect', {
       uri: 'mongodb://localhost/',
       is_localhost: true,

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

@@ -32,6 +32,7 @@ import type {
   FetchingUpdateMetadataCompleteEvent,
   SessionStartedEvent,
   MongoshBusEventsMap,
+  WriteCustomLogEvent,
 } from '@mongosh/types';
 import { inspect } from 'util';
 import { MongoLogWriter } from 'mongodb-log-writer';
@@ -320,6 +321,19 @@ export class MongoshLoggingAndTelemetry {
       }
     });
 
+    onBus('mongosh:write-custom-log', (event: WriteCustomLogEvent) => {
+      if (this.log) {
+        this.log[event.method](
+          'MONGOSH-SCRIPTS',
+          mongoLogId(1_000_000_054),
+          'custom-log',
+          event.message,
+          event.attr,
+          event.level
+        );
+      }
+    });
+
     onBus('mongosh:globalconfig-load', (args: GlobalConfigFileLoadEvent) => {
       this.log?.info(
         'MONGOSH',

packages/types/src/index.ts

@@ -97,13 +97,6 @@ export interface MongocryptdLogEvent {
   logEntry: any;
 }
 
-export interface WriteCustomLogEvent {
-  method: 'info' | 'error' | 'warn' | 'debug';
-  message: string;
-  attr?: unknown;
-  level?: 1 | 2 | 3 | 4 | 5;
-}
-
 export interface StartMongoshReplEvent {
   version: string;
 }