feat(cli-repl): add ability to set log retention days MONGOSH-1984

Author: gagik

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

@@ -323,6 +323,7 @@ describe('CliRepl', function () {
           'updateURL',
           'disableLogging',
           'logLocation',
+          'logRetentionDays',
         ] satisfies (keyof CliUserConfig)[]);
       });
 
@@ -1427,33 +1428,6 @@ describe('CliRepl', function () {
               )
             ).to.have.lengthOf(1);
           });
-        });
-
-        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');
@@ -1463,6 +1437,19 @@ describe('CliRepl', function () {
             expect(cliRepl.getConfig('logLocation')).is.true;
             expect(cliRepl.logWriter?.logFilePath).equals(testPath);
           });
+
+          it('can set log retention days', async function () {
+            const testRetentionDays = 123;
+            cliRepl.config.logRetentionDays = testRetentionDays;
+            await cliRepl.start(await testServer.connectionString(), {});
+
+            expect(cliRepl.getConfig('logRetentionDays')).equals(
+              testRetentionDays
+            );
+            expect(cliRepl.logManager?._options.retentionDays).equals(
+              testRetentionDays
+            );
+          });
         });
 
         it('times out fast', async function () {

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

@@ -259,7 +259,7 @@ export class CliRepl implements MongoshIOProvider {
       directory:
         (await this.getConfig('logLocation')) ||
         this.shellHomeDirectory.localPath('.'),
-      retentionDays: 30,
+      retentionDays: await this.getConfig('logRetentionDays'),
       maxLogFileCount: +(
         process.env.MONGOSH_TEST_ONLY_MAX_LOG_FILE_COUNT || 100
       ),

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

@@ -27,6 +27,7 @@ import { once } from 'events';
 import type { AddressInfo } from 'net';
 const { EJSON } = bson;
 import { sleep } from './util-helpers';
+import type { LogEntry } from '@mongosh/shell-api/src/log-entry';
 
 const jsContextFlagCombinations: `--jsContext=${'plain-vm' | 'repl'}`[][] = [
   [],
@@ -1361,7 +1362,7 @@ describe('e2e', function () {
     let historyPath: string;
     let readConfig: () => Promise<any>;
     let readLogFile: <T extends MongoLogEntryFromFile>(
-      customBasePath?: string
+      path?: string
     ) => Promise<T[]>;
     let startTestShell: (...extraArgs: string[]) => Promise<TestShell>;
 

packages/types/src/index.spec.ts

@@ -25,6 +25,12 @@ describe('config validation', function () {
     expect(await validate('historyLength', 0)).to.equal(null);
     expect(await validate('historyLength', 1)).to.equal(null);
     expect(await validate('historyLength', Infinity)).to.equal(null);
+    expect(await validate('logRetentionDays', 'foo')).to.equal(
+      'logRetentionDays must be a positive integer'
+    );
+    expect(await validate('logRetentionDays', -1)).to.equal(
+      'logRetentionDays must be a positive integer'
+    );
     expect(await validate('showStackTraces', 'foo')).to.equal(
       'showStackTraces must be a boolean'
     );

packages/types/src/index.ts

@@ -509,6 +509,7 @@ export class CliUserConfig extends SnippetShellUserConfig {
   updateURL = 'https://downloads.mongodb.com/compass/mongosh.json';
   disableLogging = false;
   logLocation: string | undefined = undefined;
+  logRetentionDays = 30;
 }
 
 export class CliUserConfigValidator extends SnippetShellUserConfigValidator {
@@ -531,6 +532,7 @@ export class CliUserConfigValidator extends SnippetShellUserConfigValidator {
         return null;
       case 'inspectDepth':
       case 'historyLength':
+      case 'logRetentionDays':
         if (typeof value !== 'number' || value < 0) {
           return `${key} must be a positive integer`;
         }