refactor: move getPath to the log object

Author: alenakhineika

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

@@ -78,6 +78,7 @@ export type MongoshIOProvider = Omit<
   ): Promise<{ contents: string; absolutePath: string }>;
   getCryptLibraryOptions(): Promise<AutoEncryptionOptions['extraOptions']>;
   bugReportErrorMessageInfo?(): string | undefined;
+  getLogPath(): string | undefined;
 };
 
 export type JSContext = 'repl' | 'plain-vm';

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

@@ -1984,6 +1984,13 @@ describe('e2e', function () {
           });
         });
 
+        it('gets a path to the current log file', async function () {
+          await shell.executeLine('log.getPath()');
+          expect(shell.assertNoErrors());
+          const logPath = path.join(logBasePath, `${shell.logId}_log`);
+          expect(shell.output).to.include(logPath);
+        });
+
         it('writes custom log directly', async function () {
           await shell.executeLine("log.info('This is a custom entry')");
           expect(shell.assertNoErrors());

packages/i18n/src/locales/en_US.ts

@@ -137,6 +137,10 @@ const translations: Catalog = {
           description: 'Shell log methods',
           link: '#',
           attributes: {
+            getPath: {
+              description: 'Gets a path to the current log file',
+              example: 'log.getPath()',
+            },
             info: {
               description: 'Writes a custom info message to the log file',
               example: 'log.info("Custom info message")',
@@ -167,7 +171,8 @@ const translations: Catalog = {
           attributes: {
             log: {
               description:
-                "'log.info(<msg>)': Write a custom info/warn/error/fatal/debug message to the log file",
+                "'log.info(<msg>)': Write a custom info/warn/error/fatal/debug message to the log file\n" +
+                "'log.getPath()': Gets a path to the current log file\n",
             },
             use: {
               description: 'Set current database',

packages/node-runtime-worker-thread/src/worker-runtime.spec.ts

@@ -626,15 +626,15 @@ describe('worker-runtime', function () {
     });
 
     describe('getLogPath', function () {
-      it('should be called when shell evaluates `getLogPath()`', async function () {
+      it('should be called when shell evaluates `log.getPath()`', async function () {
         const { init, evaluate } = caller;
         const evalListener = createSpiedEvaluationListener();
 
         exposed = exposeAll(evalListener, worker);
 
         await init('mongodb://nodb/', dummyOptions, { nodb: true });
 
-        await evaluate('getLogPath()');
+        await evaluate('log.getPath()');
         expect(evalListener.getLogPath).to.have.been.called;
       });
     });

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

@@ -366,15 +366,6 @@ export default class ShellApi extends ShellApiClass {
     }
   }
 
-  @platforms(['CLI'])
-  getLogPath(): string | undefined {
-    try {
-      return this._instanceState.evaluationListener.getLogPath?.();
-    } catch (err: unknown) {
-      return String(err);
-    }
-  }
-
   @returnsPromise
   @platforms(['CLI'])
   async passwordPrompt(): Promise<string> {

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

@@ -117,6 +117,11 @@ export interface EvaluationListener
    * options used to access it.
    */
   getCryptLibraryOptions?: () => Promise<AutoEncryptionOptions['extraOptions']>;
+
+  /**
+   * Called when log.getPath() is used in the shell.
+   */
+  getLogPath?: () => string | undefined;
 }
 
 /**

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

@@ -21,34 +21,42 @@ export class ShellLog extends ShellApiClass {
     this[instanceStateSymbol] = instanceState;
   }
 
+  getPath(): string | undefined {
+    return this._instanceState.evaluationListener.getLogPath?.();
+  }
+
   info(message: string, attr?: unknown) {
     this[instanceStateSymbol].messageBus.emit('mongosh:write-custom-log', {
       method: 'info',
       message,
       attr,
     });
   }
+
   warn(message: string, attr?: unknown) {
     this[instanceStateSymbol].messageBus.emit('mongosh:write-custom-log', {
       method: 'warn',
       message,
       attr,
     });
   }
+
   error(message: string, attr?: unknown) {
     this[instanceStateSymbol].messageBus.emit('mongosh:write-custom-log', {
       method: 'error',
       message,
       attr,
     });
   }
+
   fatal(message: string, attr?: unknown) {
     this[instanceStateSymbol].messageBus.emit('mongosh:write-custom-log', {
       method: 'fatal',
       message,
       attr,
     });
   }
+
   debug(message: string, attr?: unknown, level?: 1 | 2 | 3 | 4 | 5) {
     this[instanceStateSymbol].messageBus.emit('mongosh:write-custom-log', {
       method: 'debug',

packages/types/src/index.ts

@@ -630,7 +630,6 @@ export interface ConfigProvider<T> {
     value: T[K]
   ): Promise<string | null>;
   listConfigOptions(): string[] | undefined | Promise<string[]>;
-  getLogPath(): string | undefined;
 }
 
 function isValidUrl(url: string): boolean {