chore: refactor to reuse the iteration, instead of iterating twice

Author: kmruiz

packages/mongodb-redact/src/index.ts

@@ -1,25 +1,26 @@
 import { regexes } from './regexes';
 import { isPlainObject } from './utils';
-import { redactSecrets } from './secrets';
+import { redactSecretsOnString } from './secrets';
 import type { Secret } from './secrets';
 
 export function redact<T>(
   message: T,
   secrets: Secret[] | undefined = undefined,
 ): T {
-  if (secrets) {
-    message = redactSecrets(message, secrets);
-  }
-
   if (isPlainObject(message)) {
     // recursively walk through all values of an object
-    return Object.fromEntries(
+    const newMessage = Object.fromEntries(
       Object.entries(message).map(([key, value]) => [
         key,
         redact(value, secrets),
       ]),
     ) as T;
+
+    // make sure we inherit the prototype so we don't add new behaviour to the object
+    // nobody is expecting
+    return Object.setPrototypeOf(newMessage, Object.getPrototypeOf(message));
   }
+
   if (Array.isArray(message)) {
     // walk through array and redact each value
     return message.map((msg) => redact(msg, secrets)) as T;
@@ -28,6 +29,11 @@ export function redact<T>(
     // all non-string types can be safely returned
     return message;
   }
+
+  if (secrets) {
+    message = redactSecretsOnString(message, secrets);
+  }
+
   // apply all available regexes to the string
   for (const [regex, replacement] of regexes) {
     // The type here isn't completely accurate in case `T` is a specific string template
@@ -38,3 +44,4 @@ export function redact<T>(
 }
 
 export default redact;
+export type { Secret } from './secrets';

packages/mongodb-redact/src/secrets.spec.ts

@@ -1,28 +1,38 @@
 import { expect } from 'chai';
-import { SECRET_KIND, redactSecrets } from './secrets';
+import { SECRET_KIND } from './secrets';
 import type { SecretKind } from './secrets';
+import { redact } from './index';
 
-describe('secret redaction on a string', function () {
+describe('dictionary-based secret redaction', function () {
   for (const kind of SECRET_KIND) {
     it(`redacts content of kind '${kind}'`, function () {
       const secret = '123456';
       const content = '123456';
 
-      const redacted = redactSecrets(content, [{ value: secret, kind: kind }]);
+      const redacted = redact(content, [{ value: secret, kind: kind }]);
 
       expect(redacted).equal(`<${kind}>`);
     });
   }
 
   for (const invalidValue of [null, undefined, false, 0]) {
     it(`returns itself on an invalid value like ${String(invalidValue)}`, function () {
-      expect(redactSecrets(invalidValue as any, [])).equal(invalidValue);
+      expect(redact(invalidValue as any, [])).equal(invalidValue);
     });
   }
 
+  it('redacts multiple coincidences of a secret', function () {
+    const secret = '123456';
+    const content = '123456 abc 123456';
+
+    const redacted = redact(content, [{ value: secret, kind: 'password' }]);
+
+    expect(redacted).to.equal('<password> abc <password>');
+  });
+
   it('rejects unknown types', function () {
     expect(() =>
-      redactSecrets('some content to redact', [
+      redact('some content to redact', [
         {
           value: 'some',
           kind: 'invalid' as SecretKind,
@@ -35,9 +45,7 @@ describe('secret redaction on a string', function () {
     const secret = '123456';
     const content = '.123456.';
 
-    const redacted = redactSecrets(content, [
-      { value: secret, kind: 'password' },
-    ]);
+    const redacted = redact(content, [{ value: secret, kind: 'password' }]);
 
     expect(redacted).equal('.<password>.');
   });
@@ -46,9 +54,7 @@ describe('secret redaction on a string', function () {
     const secret = '123456';
     const content = 'abc123456def';
 
-    const redacted = redactSecrets(content, [
-      { value: secret, kind: 'password' },
-    ]);
+    const redacted = redact(content, [{ value: secret, kind: 'password' }]);
 
     expect(redacted).equal('abc123456def');
   });
@@ -57,9 +63,7 @@ describe('secret redaction on a string', function () {
     const secret = '.+';
     const content = '.abcdef.';
 
-    const redacted = redactSecrets(content, [
-      { value: secret, kind: 'password' },
-    ]);
+    const redacted = redact(content, [{ value: secret, kind: 'password' }]);
 
     expect(redacted).equal('.abcdef.');
   });
@@ -68,9 +72,7 @@ describe('secret redaction on a string', function () {
     const secret = 'abc';
     const content = ['abc', 'cbd'];
 
-    const redacted = redactSecrets(content, [
-      { value: secret, kind: 'password' },
-    ]);
+    const redacted = redact(content, [{ value: secret, kind: 'password' }]);
 
     expect(redacted).deep.equal(['<password>', 'cbd']);
   });
@@ -81,7 +83,7 @@ describe('secret redaction on a string', function () {
 
     const content = { pwd: pwdSecret, usr: usrSecret };
 
-    const redacted = redactSecrets(content, [
+    const redacted = redact(content, [
       { value: pwdSecret, kind: 'password' },
       { value: usrSecret, kind: 'user' },
     ]);

packages/mongodb-redact/src/secrets.ts

@@ -22,7 +22,7 @@ export type Secret = {
   readonly kind: SecretKind;
 };
 
-function redactSecretsOnString<T extends string>(
+export function redactSecretsOnString<T extends string>(
   content: T,
   secrets: Secret[],
 ): T {
@@ -34,30 +34,9 @@ function redactSecretsOnString<T extends string>(
       );
     }
 
-    const regex = new RegExp(`\\b${escape(value)}\\b`);
+    const regex = new RegExp(`\\b${escape(value)}\\b`, 'g');
     result = result.replace(regex, `<${kind}>`) as T;
   }
 
   return result;
 }
-
-export function redactSecrets<T>(message: T, secrets: Secret[]): T {
-  if (isPlainObject(message)) {
-    return Object.fromEntries(
-      Object.entries(message).map(([key, value]) => [
-        key,
-        redactSecrets(value, secrets),
-      ]),
-    ) as T;
-  }
-
-  if (Array.isArray(message)) {
-    return message.map((e) => redactSecrets(e, secrets)) as T;
-  }
-
-  if (typeof message === 'string') {
-    return redactSecretsOnString(message, secrets);
-  }
-
-  return message;
-}