Merge pull request #60 from kwonoj/skip-object-traverse

feat(loggerhelper): skip traverse object payload when there's no maskkey

Author: terehov

src/LoggerHelper.ts

@@ -300,6 +300,10 @@ export class LoggerHelper {
     keys: (number | string)[],
     maskPlaceholder: string
   ): T {
+    if (!Array.isArray(keys) || keys.length === 0) {
+      return obj;
+    }
+
     const fn = (
       key: number | string,
       value: unknown

tests/settings.test.ts

@@ -780,6 +780,47 @@ describe("Logger: settings", () => {
     expect(stdStringGroups2?.[3]).toBe("[xxx]");
   });
 
+  test("init logger(type=json): empty maskValuesOfKeys", (): void => {
+    const stdArray: string[] = [];
+    const std: { write: (line: string) => void } = {
+      write: (line: string) => {
+        stdArray.push(line);
+      },
+    };
+    const logger: Logger = new Logger({
+      type: "json",
+      maskValuesOfKeys: [],
+      stdOut: std,
+      stdErr: std,
+    });
+    let verySecretiveCircularObject = {
+      password: "swordfish",
+      Authorization: 1234567,
+      stringPwd: "swordfish",
+      nested: {
+        regularString: "I am just a regular string.",
+        otherString: "pass1234.567",
+      },
+    };
+    verySecretiveCircularObject.nested[
+      "circular"
+    ] = verySecretiveCircularObject;
+
+    const { argumentsArray } = logger.info(verySecretiveCircularObject);
+    expect(argumentsArray[0]).toBe(verySecretiveCircularObject);
+
+    stdArray.length = 0;
+    const undefinedMaskValuesLogger: Logger = new Logger({
+      type: "json",
+      maskValuesOfKeys: undefined,
+      stdOut: std,
+      stdErr: std,
+    });
+
+    const { argumentsArray: undefinedMaskValuesArgArray } = undefinedMaskValuesLogger.info(verySecretiveCircularObject);
+    expect(undefinedMaskValuesArgArray[0]).toBe(verySecretiveCircularObject);
+  });
+
   test("init logger(type=pretty): maskAnyRegEx", (): void => {
     const stdArray: string[] = [];
     const std: { write: (line: string) => void } = {