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

mongodb-js · Feb 7, 2025 · 6236c36 · 6236c36
1 parent e7859a9
commit 6236c36
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 1 deletion.
diff --git a/packages/cli-repl/src/cli-repl.spec.ts b/packages/cli-repl/src/cli-repl.spec.ts
@@ -323,6 +323,7 @@ describe('CliRepl', function () {
           'updateURL',
           'disableLogging',
           'logLocation',
+          'logRetentionDays',
         ] satisfies (keyof CliUserConfig)[]);
       });
 
@@ -1443,6 +1444,19 @@ describe('CliRepl', function () {
               )
             );
           });
+
+          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 () {

diff --git a/packages/cli-repl/src/cli-repl.ts b/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
       ),

diff --git a/packages/types/src/index.spec.ts b/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'
     );

diff --git a/packages/types/src/index.ts b/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`;
         }