AG-18869 Improve json-prune — fix issue with logging null. #282

Squashed commit of the following: commit b4a5884 Merge: 98cedec 85e6beb Author: Adam Wróblewski <[email protected]> Date: Tue Feb 28 15:14:09 2023 +0100 Merge branch 'master' into fix/AG-18869 commit 98cedec Author: Adam Wróblewski <[email protected]> Date: Mon Feb 27 18:05:45 2023 +0100 Remove objectToString from import and related helpers Update comment Update logMessage description commit 3cda968 Author: Adam Wróblewski <[email protected]> Date: Wed Feb 22 13:01:35 2023 +0100 Fix test commit 68cf621 Author: Adam Wróblewski <[email protected]> Date: Tue Feb 21 16:58:23 2023 +0100 Fix issue with logging null Improve logging
AdguardTeam · Feb 28, 2023 · d6edd08 · d6edd08
1 parent 85e6beb
commit d6edd08
Show file tree

Hide file tree

Showing 4 changed files with 60 additions and 15 deletions.
diff --git a/src/helpers/log-message.js b/src/helpers/log-message.js
@@ -5,7 +5,7 @@
  * and use 'forced' argument otherwise.
  *
  * @param {Object} source required, scriptlet properties
- * @param {string} message required, message to log
+ * @param {any} message required, message to log
  * @param {boolean} [forced=false] to log message unconditionally
  * @param {boolean} [convertMessageToString=true] to convert message to string
  */

diff --git a/src/helpers/string-utils.js b/src/helpers/string-utils.js
@@ -273,6 +273,11 @@ export const parseDelayArg = (delay) => {
  * @returns {string} object's string representation
  */
 export const objectToString = (obj) => {
+    // In case if the type of passed obj is different than Object
+    // https://github.com/AdguardTeam/Scriptlets/issues/282
+    if (!obj || typeof obj !== 'object') {
+        return String(obj);
+    }
     return isEmptyObject(obj)
         ? '{}'
         : getObjectEntries(obj)

diff --git a/src/scriptlets/json-prune.js b/src/scriptlets/json-prune.js
@@ -3,11 +3,8 @@ import {
     matchStackTrace,
     getWildcardPropertyInChain,
     logMessage,
-    objectToString,
     // following helpers are needed for helpers above
     toRegExp,
-    isEmptyObject,
-    getObjectEntries,
     getNativeRegexpTest,
     shouldAbortInlineOrInjectedScript,
 } from '../helpers/index';
@@ -113,7 +110,10 @@ export function jsonPrune(source, propsToRemove, requiredInitialProps, stack) {
             const matchRegex = toRegExp(requiredPaths.join(''));
             const shouldLog = matchRegex.test(rootString);
             if (shouldLog) {
-                logMessage(source, `${window.location.hostname} ${objectToString(root)}`, true);
+                logMessage(source, `${window.location.hostname}\n${JSON.stringify(root, null, 2)}`, true);
+                if (root && typeof root === 'object') {
+                    logMessage(source, root, true, false);
+                }
                 shouldProcess = false;
                 return shouldProcess;
             }
@@ -161,7 +161,10 @@ export function jsonPrune(source, propsToRemove, requiredInitialProps, stack) {
      */
     const jsonPruner = (root) => {
         if (prunePaths.length === 0 && requiredPaths.length === 0) {
-            logMessage(source, `${window.location.hostname} ${objectToString(root)}`, true);
+            logMessage(source, `${window.location.hostname}\n${JSON.stringify(root, null, 2)}`, true);
+            if (root && typeof root === 'object') {
+                logMessage(source, root, true, false);
+            }
             return root;
         }
 
@@ -232,11 +235,8 @@ jsonPrune.injections = [
     matchStackTrace,
     getWildcardPropertyInChain,
     logMessage,
-    objectToString,
     // following helpers are needed for helpers above
     toRegExp,
-    isEmptyObject,
-    getObjectEntries,
     getNativeRegexpTest,
     shouldAbortInlineOrInjectedScript,
 ];
diff --git a/tests/scriptlets/json-prune.test.js b/tests/scriptlets/json-prune.test.js
@@ -484,19 +484,26 @@ test('can NOT remove propsToRemove if nested requiredInitialProps has wildcard b
 });
 
 test('does NOT remove propsToRemove if invoked without parameter propsToRemove and return hostname', (assert) => {
-    console.log = (message) => {
-        assert.ok(message.includes(window.location.hostname), 'should log hostname in console');
-        assert.ok(message.includes('a:"1" b:"2"'), 'should log parameters in console');
+    assert.expect(2);
+    console.log = (...args) => {
+        if (args.length === 1) {
+            assert.ok(args[0].includes(window.location.hostname), 'should log hostname in console');
+            assert.ok(args[0].includes('"a": 1,\n  "b": 2'), 'should log parameters in console');
+        }
+        nativeConsole(...args);
     };
     runScriptlet('json-prune');
     JSON.parse('{"a":1, "b":2}');
 });
 
 test('logs matched object and hostname if invoked with only second arg', (assert) => {
     assert.expect(2);
-    console.log = (message) => {
-        assert.ok(message.includes(window.location.hostname), 'should log hostname in console');
-        assert.ok(message.includes('a:"1"'), 'should log parameters in console');
+    console.log = (...args) => {
+        if (args.length === 1) {
+            assert.ok(args[0].includes(window.location.hostname), 'should log hostname in console');
+            assert.ok(args[0].includes('"a": 1'), 'should log parameters in console');
+        }
+        nativeConsole(...args);
     };
     runScriptlet('json-prune', '', '"a":1');
     JSON.parse('{"a":1}');
@@ -556,3 +563,36 @@ test('does not remove propsToRemove - invalid regexp pattern for stack match', (
     runScriptlet('json-prune', 'x', '', stackArg);
     assert.deepEqual(JSON.parse('{"x":1}'), { x: 1 }, 'should NOT remove propsToRemove');
 });
+
+test('logs null', (assert) => {
+    assert.expect(2);
+    console.log = (message) => {
+        assert.ok(message.includes(window.location.hostname), 'should log hostname in console');
+        assert.ok(message.includes('null'), 'should log parameters in console');
+        nativeConsole(message);
+    };
+    runScriptlet('json-prune');
+    JSON.parse(null);
+});
+
+test('logs 0', (assert) => {
+    assert.expect(2);
+    console.log = (message) => {
+        assert.ok(message.includes(window.location.hostname), 'should log hostname in console');
+        assert.ok(message.endsWith('0'), 'should log parameters in console');
+        nativeConsole(message);
+    };
+    runScriptlet('json-prune');
+    JSON.parse(0);
+});
+
+test('logs 10', (assert) => {
+    assert.expect(2);
+    console.log = (message) => {
+        assert.ok(message.includes(window.location.hostname), 'should log hostname in console');
+        assert.ok(message.endsWith('10'), 'should log parameters in console');
+        nativeConsole(message);
+    };
+    runScriptlet('json-prune');
+    JSON.parse(10);
+});