refactor: extend shell log from shell api

Author: alenakhineika

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

@@ -578,11 +578,6 @@ describe('e2e', function () {
       shell.assertNoErrors();
     });
 
-    it('runs a custom log command', async function () {
-      await shell.executeLine("log.info('Try me')");
-      shell.assertNoErrors();
-    });
-
     it('runs help command', async function () {
       expect(await shell.executeLine('help')).to.include('Shell Help');
       shell.assertNoErrors();
@@ -1514,6 +1509,7 @@ describe('e2e', function () {
 
         it('writes custom log directly', async function () {
           await shell.executeLine("log.info('This is a custom entry')");
+          expect(shell.assertNoErrors());
           await eventually(async () => {
             const log = await readLogfile();
             expect(
@@ -1531,14 +1527,11 @@ describe('e2e', function () {
           );
           const filename = path.resolve(
             __dirname,
-            '..',
-            '..',
-            'e2e-tests',
-            'test',
             'fixtures',
             'custom-log-info.js'
           );
           await shell.executeLine(`load(${JSON.stringify(filename)})`);
+          expect(shell.assertNoErrors());
           await eventually(async () => {
             const log = await readLogfile();
             expect(

packages/shell-api/src/shell-instance-state.ts

@@ -35,7 +35,7 @@ import NoDatabase from './no-db';
 import type { ShellBson } from './shell-bson';
 import constructShellBson from './shell-bson';
 import { Streams } from './streams';
-import constructShellLog, { type ShellLog } from './shell-log';
+import ShellLog from './shell-log';
 
 /**
  * The subset of CLI options that is relevant for the shell API's behavior itself.
@@ -189,7 +189,7 @@ export default class ShellInstanceState {
     this.initialServiceProvider = initialServiceProvider;
     this.messageBus = messageBus;
     this.shellApi = new ShellApi(this);
-    this.shellLog = constructShellLog(this.messageBus);
+    this.shellLog = new ShellLog(this);
     this.shellBson = constructShellBson(
       initialServiceProvider.bsonLibrary,
       (msg: string) => {

packages/shell-api/src/shell-log.ts

@@ -1,54 +1,68 @@
-import type { MongoshBus } from '@mongosh/types';
+import type ShellInstanceState from './shell-instance-state';
+import { shellApiClassDefault, ShellApiClass } from './decorators';
 
-export interface ShellLog {
+const instanceStateSymbol = Symbol.for('@@mongosh.instanceState');
+
+/**
+ * This class contains the *global log* property that is considered part of the immediate shell API.
+ */
+@shellApiClassDefault
+export default class ShellLog extends ShellApiClass {
+  // Use symbols to make sure these are *not* among the things copied over into
+  // the global scope.
+  [instanceStateSymbol]: ShellInstanceState;
   log: {
     info: (message: string, attr?: unknown) => void;
     warn: (message: string, attr?: unknown) => void;
     error: (message: string, attr?: unknown) => void;
     fatal: (message: string, attr?: unknown) => void;
     debug: (message: string, attr?: unknown, level?: 1 | 2 | 3 | 4 | 5) => void;
   };
-}
 
-export default function constructShellLog(messageBus: MongoshBus): ShellLog {
-  return {
-    log: {
+  get _instanceState(): ShellInstanceState {
+    return this[instanceStateSymbol];
+  }
+
+  constructor(instanceState: ShellInstanceState) {
+    super();
+    this[instanceStateSymbol] = instanceState;
+    this.log = {
       info(message: string, attr?: unknown) {
-        messageBus.emit('mongosh:write-custom-log', {
+        instanceState.messageBus.emit('mongosh:write-custom-log', {
           method: 'info',
           message,
           attr,
         });
       },
       warn(message: string, attr?: unknown) {
-        messageBus.emit('mongosh:write-custom-log', {
+        instanceState.messageBus.emit('mongosh:write-custom-log', {
           method: 'warn',
           message,
           attr,
         });
       },
       error(message: string, attr?: unknown) {
-        messageBus.emit('mongosh:write-custom-log', {
+        instanceState.messageBus.emit('mongosh:write-custom-log', {
           method: 'error',
           message,
           attr,
         });
       },
       fatal(message: string, attr?: unknown) {
-        messageBus.emit('mongosh:write-custom-log', {
+        instanceState.messageBus.emit('mongosh:write-custom-log', {
           method: 'fatal',
           message,
           attr,
         });
       },
       debug(message: string, attr?: unknown, level?: 1 | 2 | 3 | 4 | 5) {
-        messageBus.emit('mongosh:write-custom-log', {
+        instanceState.messageBus.emit('mongosh:write-custom-log', {
           method: 'debug',
           message,
           attr,
           level,
         });
       },
-    },
-  };
+    };
+  }
 }