chore: add support for arbitrarily deep object redacting

Author: kmruiz

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

@@ -25,10 +25,22 @@ db.history.updateOne({"_id": ObjectId("63ed1d522d8573fa5c203660")}, {$set:{chang
 
 describe('mongodb-redact', function () {
   describe('Secrets', function () {
-    it('should redact provided secrets', function () {
+    it('should redact provided secrets in strings', function () {
       const res = redact('foo@bar', [{ value: 'foo@bar', kind: 'password' }]);
       expect(res).to.equal('<password>');
     });
+
+    it('should redact provided secrets in objects', function () {
+      const res = redact({ key: 'foo@bar' }, [
+        { value: 'foo@bar', kind: 'password' },
+      ]);
+      expect(res).to.deep.equal({ key: '<password>' });
+    });
+
+    it('should redact provided secrets in arrays', function () {
+      const res = redact(['foo@bar'], [{ value: 'foo@bar', kind: 'password' }]);
+      expect(res).to.deep.equal(['<password>']);
+    });
   });
 
   describe('Types', function () {

packages/mongodb-redact/src/index.ts

@@ -14,12 +14,15 @@ export function redact<T>(
   if (isPlainObject(message)) {
     // recursively walk through all values of an object
     return Object.fromEntries(
-      Object.entries(message).map(([key, value]) => [key, redact(value)]),
+      Object.entries(message).map(([key, value]) => [
+        key,
+        redact(value, secrets),
+      ]),
     ) as T;
   }
   if (Array.isArray(message)) {
     // walk through array and redact each value
-    return message.map((msg) => redact(msg)) as T;
+    return message.map((msg) => redact(msg, secrets)) as T;
   }
   if (typeof message !== 'string') {
     // all non-string types can be safely returned