feat(logging): add option to set log location MONGOSH-1983

Author: gagik

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

@@ -322,6 +322,7 @@ describe('CliRepl', function () {
           'browser',
           'updateURL',
           'disableLogging',
+          'logLocation',
         ] satisfies (keyof CliUserConfig)[]);
       });
 
@@ -1428,6 +1429,42 @@ describe('CliRepl', function () {
           });
         });
 
+        context('logging configuration', function () {
+          it('logging is enabled by default and event is called', async function () {
+            const onLogInitialized = sinon.stub();
+            cliRepl.bus.on('mongosh:log-initialized', onLogInitialized);
+
+            await cliRepl.start(await testServer.connectionString(), {});
+
+            expect(await cliRepl.getConfig('disableLogging')).is.false;
+
+            expect(onLogInitialized).calledOnce;
+            expect(cliRepl.logWriter).is.instanceOf(MongoLogWriter);
+          });
+
+          it('does not initialize logging when it is disabled', async function () {
+            cliRepl.config.disableLogging = true;
+            const onLogInitialized = sinon.stub();
+            cliRepl.bus.on('mongosh:log-initialized', onLogInitialized);
+
+            await cliRepl.start(await testServer.connectionString(), {});
+
+            expect(await cliRepl.getConfig('disableLogging')).is.true;
+            expect(onLogInitialized).not.called;
+
+            expect(cliRepl.logWriter).is.undefined;
+          });
+
+          it('can set the log location', async function () {
+            const testPath = path.join('./test', 'path');
+            cliRepl.config.logLocation = testPath;
+            await cliRepl.start(await testServer.connectionString(), {});
+
+            expect(cliRepl.getConfig('logLocation')).is.true;
+            expect(cliRepl.logWriter?.logFilePath).equals(testPath);
+          });
+        });
+
         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

@@ -256,7 +256,9 @@ export class CliRepl implements MongoshIOProvider {
     }
 
     this.logManager ??= new MongoLogManager({
-      directory: this.shellHomeDirectory.localPath('.'),
+      directory:
+        (await this.getConfig('logLocation')) ||
+        this.shellHomeDirectory.localPath('.'),
       retentionDays: 30,
       maxLogFileCount: +(
         process.env.MONGOSH_TEST_ONLY_MAX_LOG_FILE_COUNT || 100

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

@@ -15,7 +15,11 @@ import { promisify } from 'util';
 import path from 'path';
 import os from 'os';
 import type { MongoLogEntryFromFile } from './repl-helpers';
-import { readReplLogFile, setTemporaryHomeDirectory } from './repl-helpers';
+import {
+  readReplLogFile,
+  setTemporaryHomeDirectory,
+  useTmpdir,
+} from './repl-helpers';
 import { bson } from '@mongosh/service-provider-core';
 import type { Server as HTTPServer } from 'http';
 import { createServer as createHTTPServer } from 'http';
@@ -1356,7 +1360,9 @@ describe('e2e', function () {
     let logBasePath: string;
     let historyPath: string;
     let readConfig: () => Promise<any>;
-    let readLogFile: <T extends MongoLogEntryFromFile>() => Promise<T[]>;
+    let readLogFile: <T extends MongoLogEntryFromFile>(
+      customBasePath?: string
+    ) => Promise<T[]>;
     let startTestShell: (...extraArgs: string[]) => Promise<TestShell>;
 
     beforeEach(function () {
@@ -1393,11 +1399,16 @@ describe('e2e', function () {
       }
       readConfig = async () =>
         EJSON.parse(await fs.readFile(configPath, 'utf8'));
-      readLogFile = async <T extends MongoLogEntryFromFile>(): Promise<T[]> => {
+      readLogFile = async <T extends MongoLogEntryFromFile>(
+        customBasePath?: string
+      ): Promise<T[]> => {
         if (!shell.logId) {
           throw new Error('Shell does not have a logId associated with it');
         }
-        const logPath = path.join(logBasePath, `${shell.logId}_log`);
+        const logPath = path.join(
+          customBasePath ?? logBasePath,
+          `${shell.logId}_log`
+        );
         return readReplLogFile<T>(logPath);
       };
       startTestShell = async (...extraArgs: string[]) => {
@@ -1557,6 +1568,112 @@ describe('e2e', function () {
           ).to.have.lengthOf(1);
         });
 
+        describe('with custom log location', function () {
+          const customLogDir = useTmpdir();
+
+          it('fails with relative or invalid paths', async function () {
+            const globalConfig = path.join(homedir, 'globalconfig.conf');
+            await fs.writeFile(
+              globalConfig,
+              `mongosh:\n  logLocation: "./some-relative-path"`
+            );
+
+            shell = this.startTestShell({
+              args: ['--nodb'],
+              env: {
+                ...env,
+                MONGOSH_GLOBAL_CONFIG_FILE_FOR_TESTING: globalConfig,
+              },
+              forceTerminal: true,
+            });
+            await shell.waitForPrompt();
+            shell.assertContainsOutput('Ignoring config option "logLocation"');
+            shell.assertContainsOutput(
+              'must be a valid absolute path or empty'
+            );
+
+            expect(
+              await shell.executeLine(
+                'config.set("logLocation", "[123123123123]")'
+              )
+            ).contains(
+              'Cannot set option "logLocation": logLocation must be a valid absolute path or empty'
+            );
+          });
+
+          it('gets created according to logLocation, if set', async function () {
+            const globalConfig = path.join(homedir, 'globalconfig.conf');
+            await fs.writeFile(
+              globalConfig,
+              `mongosh:\n  logLocation: "${customLogDir.path}"`
+            );
+
+            shell = this.startTestShell({
+              args: ['--nodb'],
+              env: {
+                ...env,
+                MONGOSH_GLOBAL_CONFIG_FILE_FOR_TESTING: globalConfig,
+              },
+              forceTerminal: true,
+            });
+            await shell.waitForPrompt();
+            expect(
+              await shell.executeLine('config.get("logLocation")')
+            ).contains(customLogDir.path);
+
+            try {
+              await readLogFile();
+              expect.fail('expected to throw');
+            } catch (error) {
+              expect((error as Error).message).includes(
+                'no such file or directory'
+              );
+            }
+
+            expect(
+              (await readLogFile(customLogDir.path)).some(
+                (log) => log.attr?.input === 'config.get("logLocation")'
+              )
+            ).is.true;
+          });
+
+          it('setting location while running mongosh does not have an immediate effect on logging', async function () {
+            expect(
+              await shell.executeLine('config.get("logLocation")')
+            ).does.not.contain(customLogDir.path);
+            const oldLogId = shell.logId;
+
+            const oldLogEntries = await readLogFile();
+            await shell.executeLine(
+              `config.set("logLocation", "${customLogDir.path}")`
+            );
+
+            await shell.waitForPrompt();
+            expect(
+              await shell.executeLine('config.get("logLocation")')
+            ).contains(customLogDir.path);
+
+            expect(shell.logId).equals(oldLogId);
+
+            const currentLogEntries = await readLogFile();
+
+            try {
+              await readLogFile(customLogDir.path);
+              expect.fail('expected to throw');
+            } catch (error) {
+              expect((error as Error).message).includes(
+                'no such file or directory'
+              );
+            }
+            expect(
+              currentLogEntries.some(
+                (log) => log.attr?.input === 'config.get("logLocation")'
+              )
+            ).is.true;
+            expect(currentLogEntries.length - oldLogEntries.length).equals(2);
+          });
+        });
+
         it('creates a log file that keeps track of session events', async function () {
           expect(await shell.executeLine('print(123 + 456)')).to.include('579');
           const log = await readLogFile();

packages/types/src/index.ts

@@ -1,4 +1,5 @@
 import type { ConnectEventMap } from '@mongodb-js/devtools-connect';
+import path from 'path';
 
 export interface ApiEventArguments {
   pipeline?: any[];
@@ -507,6 +508,7 @@ export class CliUserConfig extends SnippetShellUserConfig {
   browser: undefined | false | string = undefined;
   updateURL = 'https://downloads.mongodb.com/compass/mongosh.json';
   disableLogging = false;
+  logLocation: string | undefined = undefined;
 }
 
 export class CliUserConfigValidator extends SnippetShellUserConfigValidator {
@@ -579,6 +581,11 @@ export class CliUserConfigValidator extends SnippetShellUserConfigValidator {
           return `${key} must be a valid URL or empty`;
         }
         return null;
+      case 'logLocation':
+        if (typeof value !== 'string' || !path.isAbsolute(value)) {
+          return `${key} must be a valid absolute path or empty`;
+        }
+        return null;
       default:
         return super.validate(
           key as keyof SnippetShellUserConfig,