Add null checks to jsonPrune (#186)

Previously, json-prune and its related scriptlets silently broke webpages if null or undefined was present in objects passed to pruners. This fixes that.
anfragment · Dec 24, 2024 · de6ecf3 · de6ecf3
1 parent 99977c2
commit de6ecf3
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 2 deletions.
diff --git a/internal/scriptlet/bundle.js b/internal/scriptlet/bundle.js
diff --git a/scriptlets/src/helpers/jsonPrune.ts b/scriptlets/src/helpers/jsonPrune.ts
@@ -47,7 +47,7 @@ export function createPrune(propsToRemove: string, requiredProps?: string, stack
 }
 
 function prunePath(obj: any, path: PropPath) {
-  if (path.length === 0) {
+  if (path.length === 0 || obj == null) {
     return;
   }
 
@@ -83,6 +83,9 @@ function prunePath(obj: any, path: PropPath) {
 }
 
 function matchesPath(obj: any, path: PropPath): boolean {
+  if (obj == null) {
+    return false;
+  }
   if (path.length === 0) {
     return true;
   }

diff --git a/scriptlets/src/json-prune.test.ts b/scriptlets/src/json-prune.test.ts
@@ -83,4 +83,10 @@ describe('json-prune', () => {
     const obj = JSON.parse('{"a": 123}');
     expect(obj).toEqual({});
   });
+
+  test('"null" gets parsed to null', () => {
+    jsonPrune('test');
+
+    expect(JSON.parse('null')).toEqual(null);
+  });
 });