feat: add shouldRedactCommand

Author: gagik

packages/mongodb-redact/src/should-redact-command.spec.ts

@@ -0,0 +1,52 @@
+import { expect } from 'chai';
+import { shouldRedactCommand } from '.';
+
+describe('shouldRedactCommand', function () {
+  describe('shouldRedactCommand', function () {
+    it('returns true for createUser commands', function () {
+      expect(shouldRedactCommand('db.createUser({ user: "test" })')).to.be.true;
+    });
+
+    it('returns true for auth commands', function () {
+      expect(shouldRedactCommand('db.auth("user", "pass")')).to.be.true;
+    });
+
+    it('returns true for updateUser commands', function () {
+      expect(shouldRedactCommand('db.updateUser("user", { roles: [] })')).to.be
+        .true;
+    });
+
+    it('returns true for changeUserPassword commands', function () {
+      expect(shouldRedactCommand('db.changeUserPassword("user", "newpass")')).to
+        .be.true;
+    });
+
+    it('returns true for connect commands', function () {
+      expect(shouldRedactCommand('db = connect("mongodb://localhost")')).to.be
+        .true;
+    });
+
+    it('returns true for Mongo constructor', function () {
+      expect(shouldRedactCommand('new Mongo("mongodb://localhost")')).to.be
+        .true;
+    });
+
+    it('returns false for non-sensitive commands', function () {
+      expect(shouldRedactCommand('db.collection.find()')).to.be.false;
+    });
+
+    it('returns false for partial words like "authentication"', function () {
+      // The \b (word boundary) should prevent matching "auth" within "authentication"
+      expect(shouldRedactCommand('db.collection.find({authentication: true})'))
+        .to.be.false;
+    });
+
+    it('returns false for getUsers command', function () {
+      expect(shouldRedactCommand('db.getUsers()')).to.be.false;
+    });
+
+    it('returns false for show commands', function () {
+      expect(shouldRedactCommand('show dbs')).to.be.false;
+    });
+  });
+});

packages/mongodb-redact/src/should-redact-command.ts

@@ -0,0 +1,27 @@
+/**
+ * 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);
+}