WIP - chore: use redact package

Author: gagik

packages/history/src/history.ts

@@ -1,6 +1,5 @@
-import redactSensitiveData from 'mongodb-redact';
-
-export const HIDDEN_COMMANDS = String.raw`\b(createUser|auth|updateUser|changeUserPassword|connect|Mongo)\b`;
+import { shouldRedactCommand } from './redact';
+import { redact } from 'mongodb-redact';
 
 /**
  * Modifies the most recent command in history based on sensitive information.
@@ -11,16 +10,13 @@ export const HIDDEN_COMMANDS = String.raw`\b(createUser|auth|updateUser|changeUs
  */
 export function changeHistory(
   history: string[],
-  redact: 'redact-sensitive-data' | 'keep-sensitive-data'
+  redactMode: 'redact-sensitive-data' | 'keep-sensitive-data'
 ): void {
   if (history.length === 0) return;
-  const hiddenCommands = new RegExp(HIDDEN_COMMANDS, 'g');
 
-  if (hiddenCommands.test(history[0])) {
+  if (shouldRedactCommand(history[0])) {
     history.shift();
-  } else if (redact === 'redact-sensitive-data') {
-    history[0] = redactSensitiveData(history[0]);
+  } else if (redactMode === 'redact-sensitive-data') {
+    history[0] = redact(history[0]);
   }
 }
-
-export { redactSensitiveData };

packages/history/src/index.ts

@@ -1,2 +1,5 @@
-export { changeHistory, redactSensitiveData, HIDDEN_COMMANDS } from './history';
-export { redactConnectionString as redactURICredentials } from 'mongodb-connection-string-url';
+export { changeHistory } from './history';
+export {
+  shouldRedactCommand,
+  redactUriCredentials as redactURICredentials,
+} from './redact';

packages/history/src/redact.ts

@@ -0,0 +1,35 @@
+// TODO: This will completely be replaced by mongodb-redact once it is released
+
+/**
+ * Regex pattern for commands that contain sensitive information and should be
+ * completely removed from history rather than redacted.
+ *
+ * These commands typically involve authentication or connection strings with credentials.
+ */
+const HIDDEN_COMMANDS = String.raw`\b(createUser|auth|updateUser|changeUserPassword|connect|Mongo)\b`;
+
+/**
+ * Checks if a mongosh command should be redacted because it often contains sensitive information like credentials.
+ *
+ * @param input - The command string to check
+ * @returns true if the command should be hidden/redacted, false otherwise
+ *
+ * @example
+ * ```typescript
+ * shouldRedactCommand('db.createUser({user: "admin", pwd: "secret"})')
+ * // Returns: true
+ *
+ * shouldRedactCommand('db.getUsers()')
+ * // Returns: false
+ * ```
+ */
+export function shouldRedactCommand(input: string): boolean {
+  const hiddenCommands = new RegExp(HIDDEN_COMMANDS, 'g');
+  return hiddenCommands.test(input);
+}
+
+import { redactConnectionString } from 'mongodb-connection-string-url';
+
+export function redactUriCredentials(uri: string): string {
+  return redactConnectionString(uri);
+}

packages/logging/src/logging-and-telemetry.spec.ts

@@ -1132,6 +1132,42 @@ describe('MongoshLoggingAndTelemetry', function () {
     expect(analyticsOutput).to.be.empty;
   });
 
+  it('does not log sensitive commands', async function () {
+    loggingAndTelemetry.attachLogger(logger);
+    await (loggingAndTelemetry as LoggingAndTelemetry).setupTelemetryPromise;
+
+    expect(logOutput).to.have.lengthOf(0);
+
+    // Test that sensitive commands are not logged
+    bus.emit('mongosh:evaluate-input', {
+      input: 'db.createUser({user: "admin", pwd: "password", roles: []})',
+    });
+    bus.emit('mongosh:evaluate-input', { input: 'db.auth("user", "pass")' });
+    bus.emit('mongosh:evaluate-input', {
+      input: 'db.updateUser("user", {pwd: "newpass"})',
+    });
+    bus.emit('mongosh:evaluate-input', {
+      input: 'db.changeUserPassword("user", "newpass")',
+    });
+    bus.emit('mongosh:evaluate-input', {
+      input: 'connect("mongodb://user:pass@localhost/")',
+    });
+    bus.emit('mongosh:evaluate-input', {
+      input: 'new Mongo("mongodb://user:pass@localhost/")',
+    });
+
+    // Test that non-sensitive commands are still logged
+    bus.emit('mongosh:evaluate-input', { input: 'db.getUsers()' });
+    bus.emit('mongosh:evaluate-input', { input: 'show dbs' });
+
+    // Should only have logged the non-sensitive commands
+    expect(logOutput).to.have.lengthOf(2);
+    expect(logOutput[0].msg).to.equal('Evaluating input');
+    expect(logOutput[0].attr.input).to.equal('db.getUsers()');
+    expect(logOutput[1].msg).to.equal('Evaluating input');
+    expect(logOutput[1].attr.input).to.equal('show dbs');
+  });
+
   it('tracks custom logging events', async function () {
     expect(logOutput).to.have.lengthOf(0);
     expect(analyticsOutput).to.be.empty;

packages/logging/src/logging-and-telemetry.ts

@@ -1,5 +1,5 @@
-import redactInfo from 'mongodb-redact';
-import { redactURICredentials } from '@mongosh/history';
+import { redact } from 'mongodb-redact';
+import { shouldRedactCommand } from '@mongosh/history';
 import type {
   MongoshBus,
   ApiEventWithArguments,
@@ -460,6 +460,11 @@ export class LoggingAndTelemetry implements MongoshLoggingAndTelemetry {
     });
 
     onBus('mongosh:evaluate-input', (args: EvaluateInputEvent) => {
+      // Skip logging sensitive commands
+      if (shouldRedactCommand(args.input)) {
+        return;
+      }
+
       this.log.info(
         'MONGOSH',
         mongoLogId(1_000_000_007),
@@ -523,7 +528,7 @@ export class LoggingAndTelemetry implements MongoshLoggingAndTelemetry {
         mongoLogId(1_000_000_011),
         'shell-api',
         'Performed API call',
-        redactInfo(arg)
+        redact(arg)
       );
     });
 
@@ -848,7 +853,7 @@ export class LoggingAndTelemetry implements MongoshLoggingAndTelemetry {
           mongoLogId(1_000_000_047),
           'editor',
           'Open external editor',
-          redactInfo(ev)
+          redact(ev)
         );
       }
     );

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

@@ -17,7 +17,7 @@ import type {
   ShellUserConfig,
 } from '@mongosh/types';
 import { EventEmitter } from 'events';
-import redactInfo from 'mongodb-redact';
+import { redactURICredentials } from '@mongosh/history';
 import { toIgnore } from './decorators';
 import {
   ALL_PLATFORMS,
@@ -304,7 +304,7 @@ export class ShellInstanceState {
         api_version: apiVersionInfo?.version,
         api_strict: apiVersionInfo?.strict,
         api_deprecation_errors: apiVersionInfo?.deprecationErrors,
-        uri: redactInfo(connectionInfo?.extraInfo?.uri),
+        uri: redactURICredentials(connectionInfo?.extraInfo?.uri ?? ''),
       });
       return connectionInfo;
     }