fix: allow for the value of a masked property to be undefined or null (…

…#1760) fix: allow for the value of a masked property to be undefined or null
jmcdo29 · Oct 1, 2023 · 11177bb · 11177bb
2 parents eba51c8 + 6cd729d
commit 11177bb
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 4 deletions.
diff --git a/.changeset/lovely-icons-help.md b/.changeset/lovely-icons-help.md
@@ -0,0 +1,5 @@
+---
+'@ogma/logger': patch
+---
+
+Allow for the value of a masked property to be null or undefined
diff --git a/packages/logger/src/logger/ogma.ts b/packages/logger/src/logger/ogma.ts
@@ -154,7 +154,7 @@ export class Ogma {
     const seen = new WeakSet();
     return (key: string, value: any): string | number | boolean => {
       if (this.cachedMasks?.has(key)) {
-        return '*'.repeat(value.toString().length);
+        return '*'.repeat(value?.toString().length ?? 9);
       }
 
       if (value === null) return value;
@@ -326,10 +326,16 @@ export class Ogma {
       return '';
     }
 
-    if (this.cachedContextFormatted.has(value) && this.cachedContextFormatted.get(value).has(color))
+    if (
+      this.cachedContextFormatted.has(value) &&
+      this.cachedContextFormatted.get(value).has(color)
+    ) {
       return this.cachedContextFormatted.get(value).get(color);
+    }
 
-    if (!this.cachedContextFormatted.has(value)) this.cachedContextFormatted.set(value, new Map());
+    if (!this.cachedContextFormatted.has(value)) {
+      this.cachedContextFormatted.set(value, new Map());
+    }
 
     const cachedValue = colorize(
       this.wrapInBrackets(value),

diff --git a/packages/logger/test/ogma.spec.ts b/packages/logger/test/ogma.spec.ts
@@ -272,7 +272,7 @@ OgmaSuite(
 );
 for (const json of [true, false]) {
   OgmaSuite(
-    `it should make the value for the password. JSON: ${json}`,
+    `it should mask the value for the password. JSON: ${json}`,
     ({ writeSpy, ogmaFactory, getFirstCallString }) => {
       const ogma = ogmaFactory({ json, masks: ['password'] });
       ogma.log({ username: 'something', password: 'mask this' });
@@ -281,6 +281,26 @@ for (const json of [true, false]) {
       match(loggedVal, /"password":\s?"\*{9}"/);
     },
   );
+  OgmaSuite(
+    `it should allow for an undefined value for the masked field. JSON: ${json}`,
+    ({ writeSpy, ogmaFactory, getFirstCallString }) => {
+      const ogma = ogmaFactory({ json, masks: ['password'] });
+      ogma.log({ username: 'something', password: undefined });
+      const loggedVal = getFirstCallString(writeSpy);
+      match(loggedVal, /"username":\s?"something",/);
+      match(loggedVal, /"password":\s?"\*{9}"/);
+    },
+  );
+  OgmaSuite(
+    `it should allow for an null value for the masked field. JSON: ${json}`,
+    ({ writeSpy, ogmaFactory, getFirstCallString }) => {
+      const ogma = ogmaFactory({ json, masks: ['password'] });
+      ogma.log({ username: 'something', password: null });
+      const loggedVal = getFirstCallString(writeSpy);
+      match(loggedVal, /"username":\s?"something",/);
+      match(loggedVal, /"password":\s?"\*{9}"/);
+    },
+  );
 }
 OgmaSuite(
   'it should print each array value if the option "each" is true',