fix(debug): fix redaction of logger overwriting values (#79)

fix #78

Author: dkundel

__tests__/utils/debug.test.ts

@@ -0,0 +1,51 @@
+import { createRedactedObject, generalRedactor } from '../../src/utils/debug';
+
+describe('generalRedactor', () => {
+  test('redacts the correct properties', () => {
+    const context = {
+      ACCOUNT_SID: 'ACxxxxxxx',
+      AUTH_TOKEN: 'auth-token',
+      SOME_URL: 'https://twilio.com/labs',
+    };
+
+    const redacted = generalRedactor(context);
+    expect(redacted.ACCOUNT_SID).toBe('ACxxxxxxx');
+    expect(redacted.AUTH_TOKEN).toBe('[REDACTED]');
+    expect(redacted.SOME_URL).toBe('https://twilio.com/labs');
+  });
+});
+
+describe('createRedactedObject', () => {
+  test('does not modify the original object', () => {
+    const context = {
+      ACCOUNT_SID: 'ACxxxxxxx',
+      AUTH_TOKEN: 'auth-token',
+      SOME_URL: 'https://twilio.com/labs',
+      env: {
+        ACCOUNT_SID: 'ACyyyyyyy',
+        AUTH_TOKEN: 'another-auth-token',
+      },
+    };
+
+    const redacted = createRedactedObject(context, generalRedactor);
+
+    expect(redacted).toEqual({
+      ACCOUNT_SID: 'ACxxxxxxx',
+      AUTH_TOKEN: '[REDACTED]',
+      SOME_URL: 'https://twilio.com/labs',
+      env: {
+        ACCOUNT_SID: '[REDACTED]',
+        AUTH_TOKEN: '[REDACTED]',
+      },
+    });
+    expect(context).toEqual({
+      ACCOUNT_SID: 'ACxxxxxxx',
+      AUTH_TOKEN: 'auth-token',
+      SOME_URL: 'https://twilio.com/labs',
+      env: {
+        ACCOUNT_SID: 'ACyyyyyyy',
+        AUTH_TOKEN: 'another-auth-token',
+      },
+    });
+  });
+});

src/utils/debug.ts

@@ -28,38 +28,52 @@ export const generalRedactor = fastRedact({
       'TWILIO_API_SECRET',
     ]),
   ],
-});
+  serialize: false,
+}) as <T>(x: T) => T;
 
 export const allPropertiesRedactor = fastRedact({
   paths: ['*'],
-});
+  serialize: false,
+}) as <T>(x: T) => T;
+
+export function copyObject(obj: object) {
+  return JSON.parse(JSON.stringify(obj));
+}
+
+export function createRedactedObject(
+  obj: object,
+  redactor: typeof generalRedactor
+) {
+  const copiedObject = copyObject(obj);
+  return redactor(copiedObject);
+}
 
 debug.formatters.P = function protectedFormatterMultiline(v: any): string {
   if (typeof v === 'object') {
-    v = JSON.parse(generalRedactor(v));
+    v = createRedactedObject(v, generalRedactor);
   }
 
   return debug.formatters.O.bind(debug)(v);
 };
 
 debug.formatters.p = function protectedFormatterSameline(v: any): string {
   if (typeof v === 'object') {
-    v = JSON.parse(generalRedactor(v));
+    v = createRedactedObject(v, generalRedactor);
   }
 
   return debug.formatters.o.bind(debug)(v);
 };
 
 debug.formatters.R = function redactedFormatterMultiline(v: any): string {
   if (typeof v === 'object') {
-    v = JSON.parse(allPropertiesRedactor(v));
+    v = createRedactedObject(v, allPropertiesRedactor);
   }
   return debug.formatters.O.bind(debug)(v);
 };
 
 debug.formatters.r = function redactedFormatterSameline(v: any): string {
   if (typeof v === 'object') {
-    v = JSON.parse(allPropertiesRedactor(v));
+    v = createRedactedObject(v, allPropertiesRedactor);
   }
   return debug.formatters.o.bind(debug)(v);
 };