add log helpers & refactor logging in scriptlets

AdguardTeam · Nov 11, 2022 · dfd8ce1 · dfd8ce1
1 parent 959fe50
commit dfd8ce1
Show file tree

Hide file tree

Showing 32 changed files with 185 additions and 132 deletions.
diff --git a/src/helpers/index.js b/src/helpers/index.js
@@ -6,6 +6,7 @@ export * from './adjust-set-utils';
 export * from './array-utils';
 export * from './constants';
 export * from './cookie-utils';
+export * from './log-utils';
 export * from './noop-utils';
 export * from './number-utils';
 export * from './object-utils';
@@ -22,7 +23,6 @@ export * from './get-descriptor-addon';
 export * from './get-property-in-chain';
 export * from './get-wildcard-property-in-chain';
 export * from './hit';
-export * from './logMessage';
 export * from './match-request-props';
 export * from './match-stack';
 export * from './observer';

diff --git a/src/helpers/log-utils.js b/src/helpers/log-utils.js
@@ -0,0 +1,22 @@
+/**
+ * Logs message to console.
+ * Used when logging is a part of a scriptlet's functionality.
+ * @param {string} message
+ */
+export const logMessage = (message) => {
+    // eslint-disable-next-line no-console
+    console.log(message);
+};
+
+/**
+ * Logs message to console in debug mode.
+ * Used to log errors, such as exceptions, invalid input etc.
+ * @param {string} message
+ * @param {boolean} verbose
+ */
+export const logVerbose = (message, verbose) => {
+    if (verbose) {
+        // eslint-disable-next-line no-console
+        console.log(message);
+    }
+};
diff --git a/src/scriptlets/abort-current-inline-script.js b/src/scriptlets/abort-current-inline-script.js
@@ -6,6 +6,7 @@ import {
     startsWith,
     createOnErrorHandler,
     hit,
+    logVerbose,
     // following helpers should be imported and injected
     // because they are used by helpers above
     isEmptyObject,
@@ -139,7 +140,9 @@ export function abortCurrentInlineScript(source, property, search) {
             const props = property.split('.');
             const propIndex = props.indexOf(prop);
             const baseName = props[propIndex - 1];
-            console.log(`The scriptlet had been executed before the ${baseName} was loaded.`); // eslint-disable-line no-console, max-len
+
+            const message = `The scriptlet had been executed before the ${baseName} was loaded.`;
+            logVerbose(message, source.verbose);
             return;
         }
 
@@ -233,6 +236,7 @@ abortCurrentInlineScript.injections = [
     startsWith,
     createOnErrorHandler,
     hit,
+    logVerbose,
     isEmptyObject,
     getDescriptorAddon,
 ];
diff --git a/src/scriptlets/abort-on-stack-trace.js b/src/scriptlets/abort-on-stack-trace.js
@@ -7,6 +7,7 @@ import {
     isValidStrPattern,
     matchStackTrace,
     getDescriptorAddon,
+    logVerbose,
     // following helpers are needed for helpers above
     escapeRegExp,
     toRegExp,
@@ -76,8 +77,7 @@ export function abortOnStackTrace(source, property, stack) {
         }
 
         if (!isValidStrPattern(stack)) {
-            // eslint-disable-next-line no-console
-            console.log(`Invalid parameter: ${stack}`);
+            logVerbose(`Invalid parameter: ${stack}`, source.verbose);
             return;
         }
 
@@ -138,6 +138,7 @@ abortOnStackTrace.injections = [
     escapeRegExp,
     matchStackTrace,
     getDescriptorAddon,
+    logVerbose,
     toRegExp,
     isEmptyObject,
     getNativeRegexpTest,

diff --git a/src/scriptlets/adjust-setInterval.js b/src/scriptlets/adjust-setInterval.js
@@ -4,6 +4,7 @@ import {
     toRegExp,
     getBoostMultiplier,
     isDelayMatched,
+    logVerbose,
     // following helpers are needed for helpers above
     nativeIsNaN,
     nativeIsFinite,
@@ -70,10 +71,9 @@ export function adjustSetInterval(source, matchCallback, matchDelay, boost) {
     const intervalWrapper = (callback, delay, ...args) => {
         // https://github.com/AdguardTeam/Scriptlets/issues/221
         if (!isValidCallback(callback)) {
-            if (source.verbose) {
-                // eslint-disable-next-line no-console, max-len
-                console.log(`Scriptlet adjust-setInterval can not be applied because of invalid callback: '${String(callback)}'.`);
-            }
+            // eslint-disable-next-line max-len
+            const message = `Scriptlet adjust-setInterval can not be applied because of invalid callback: '${String(callback)}'.`;
+            logVerbose(message, source.verbose);
         } else if (matchRegexp.test(callback.toString()) && isDelayMatched(matchDelay, delay)) {
             delay *= getBoostMultiplier(boost);
             hit(source);
@@ -100,6 +100,7 @@ adjustSetInterval.injections = [
     toRegExp,
     getBoostMultiplier,
     isDelayMatched,
+    logVerbose,
     // following helpers should be injected as helpers above use them
     nativeIsNaN,
     nativeIsFinite,

diff --git a/src/scriptlets/adjust-setTimeout.js b/src/scriptlets/adjust-setTimeout.js
@@ -4,6 +4,7 @@ import {
     toRegExp,
     getBoostMultiplier,
     isDelayMatched,
+    logVerbose,
     // following helpers are needed for helpers above
     nativeIsNaN,
     nativeIsFinite,
@@ -70,10 +71,9 @@ export function adjustSetTimeout(source, matchCallback, matchDelay, boost) {
     const timeoutWrapper = (callback, delay, ...args) => {
         // https://github.com/AdguardTeam/Scriptlets/issues/221
         if (!isValidCallback(callback)) {
-            if (source.verbose) {
-                // eslint-disable-next-line no-console, max-len
-                console.log(`Scriptlet adjust-setTimeout can not be applied because of invalid callback: '${String(callback)}'.`);
-            }
+            // eslint-disable-next-line max-len
+            const message = `Scriptlet adjust-setTimeout can not be applied because of invalid callback: '${String(callback)}'.`;
+            logVerbose(message, source.verbose);
         } else if (matchRegexp.test(callback.toString()) && isDelayMatched(matchDelay, delay)) {
             delay *= getBoostMultiplier(boost);
             hit(source);
@@ -102,6 +102,7 @@ adjustSetTimeout.injections = [
     toRegExp,
     getBoostMultiplier,
     isDelayMatched,
+    logVerbose,
     // following helpers should be injected as helpers above use them
     nativeIsNaN,
     nativeIsFinite,

diff --git a/src/scriptlets/close-window.js b/src/scriptlets/close-window.js
@@ -1,4 +1,8 @@
-import { hit, toRegExp } from '../helpers/index';
+import {
+    hit,
+    toRegExp,
+    logVerbose,
+} from '../helpers/index';
 
 /**
  * @scriptlet close-window
@@ -28,15 +32,10 @@ import { hit, toRegExp } from '../helpers/index';
  * ```
  */
 export function forceWindowClose(source, path = '') {
-    // eslint-disable-next-line no-console
-    const log = console.log.bind(console);
-
     // https://github.com/AdguardTeam/Scriptlets/issues/158#issuecomment-993423036
     if (typeof window.close !== 'function') {
-        if (source.verbose) {
-            log('window.close() is not a function so \'close-window\' scriptlet is unavailable');
-        }
-        return;
+        const message = 'window.close() is not a function so \'close-window\' scriptlet is unavailable';
+        logVerbose(message, source.verbose);
     }
 
     const closeImmediately = () => {
@@ -46,7 +45,7 @@ export function forceWindowClose(source, path = '') {
         } catch (e) {
             // log the error if window closing is impossible
             // https://developer.mozilla.org/en-US/docs/Web/API/Window/close
-            log(e);
+            logVerbose(e, source.verbose);
         }
     };
 
@@ -86,4 +85,8 @@ forceWindowClose.names = [
     'ubo-window-close-if',
 ];
 
-forceWindowClose.injections = [hit, toRegExp];
+forceWindowClose.injections = [
+    hit,
+    toRegExp,
+    logVerbose,
+];
diff --git a/src/scriptlets/debug-current-inline-script.js b/src/scriptlets/debug-current-inline-script.js
@@ -5,6 +5,7 @@ import {
     toRegExp,
     createOnErrorHandler,
     hit,
+    logVerbose,
     // following helpers should be imported and injected
     // because they are used by helpers above
     isEmptyObject,
@@ -79,7 +80,9 @@ export function debugCurrentInlineScript(source, property, search) {
             const props = property.split('.');
             const propIndex = props.indexOf(prop);
             const baseName = props[propIndex - 1];
-            console.log(`The scriptlet had been executed before the ${baseName} was loaded.`); // eslint-disable-line no-console, max-len
+
+            const message = `The scriptlet had been executed before the ${baseName} was loaded.`;
+            logVerbose(message, source.verbose);
             return;
         }
 
@@ -127,5 +130,6 @@ debugCurrentInlineScript.injections = [
     toRegExp,
     createOnErrorHandler,
     hit,
+    logVerbose,
     isEmptyObject,
 ];
diff --git a/src/scriptlets/json-prune.js b/src/scriptlets/json-prune.js
@@ -2,6 +2,8 @@ import {
     hit,
     matchStackTrace,
     getWildcardPropertyInChain,
+    logVerbose,
+    logMessage,
     // following helpers are needed for helpers above
     toRegExp,
     getWildcardSymbol,
@@ -89,8 +91,7 @@ export function jsonPrune(source, propsToRemove, requiredInitialProps, stack) {
     if (!!stack && !matchStackTrace(stack, new Error().stack)) {
         return;
     }
-    // eslint-disable-next-line no-console
-    const log = console.log.bind(console);
+
     const prunePaths = propsToRemove !== undefined && propsToRemove !== ''
         ? propsToRemove.split(/ +/)
         : [];
@@ -111,7 +112,7 @@ export function jsonPrune(source, propsToRemove, requiredInitialProps, stack) {
             const matchRegex = toRegExp(requiredPaths.join(''));
             const shouldLog = matchRegex.test(rootString);
             if (shouldLog) {
-                log(window.location.hostname, root);
+                logMessage(`${window.location.hostname} ${root}`);
                 shouldProcess = false;
                 return shouldProcess;
             }
@@ -157,7 +158,7 @@ export function jsonPrune(source, propsToRemove, requiredInitialProps, stack) {
      */
     const jsonPruner = (root) => {
         if (prunePaths.length === 0 && requiredPaths.length === 0) {
-            log(window.location.hostname, root);
+            logMessage(`${window.location.hostname} ${root}`);
             return root;
         }
 
@@ -178,7 +179,7 @@ export function jsonPrune(source, propsToRemove, requiredInitialProps, stack) {
                 });
             });
         } catch (e) {
-            log(e.toString());
+            logVerbose(e.toString(), source.verbose);
         }
 
         return root;
@@ -229,6 +230,8 @@ jsonPrune.injections = [
     hit,
     matchStackTrace,
     getWildcardPropertyInChain,
+    logVerbose,
+    logMessage,
     toRegExp,
     getWildcardSymbol,
     getNativeRegexpTest,

diff --git a/src/scriptlets/log-addEventListener.js b/src/scriptlets/log-addEventListener.js
@@ -4,6 +4,8 @@ import {
     validateListener,
     listenerToString,
     convertTypeToString,
+    logMessage,
+    logVerbose,
     // following helpers are needed for helpers above
     objectToString,
     isEmptyObject,
@@ -25,22 +27,20 @@ import {
  * ```
  */
 export function logAddEventListener(source) {
-    // eslint-disable-next-line no-console
-    const log = console.log.bind(console);
     const nativeAddEventListener = window.EventTarget.prototype.addEventListener;
 
     function addEventListenerWrapper(type, listener, ...args) {
         if (validateType(type) && validateListener(listener)) {
-            const logMessage = `addEventListener("${type}", ${listenerToString(listener)})`;
-            log(logMessage);
+            const message = `addEventListener("${type}", ${listenerToString(listener)})`;
+            logMessage(message);
             hit(source);
-        } else if (source.verbose) {
-            // logging while debugging
-            const logMessage = `Invalid event type or listener passed to addEventListener:
+        }
+
+        // logging while debugging
+        const message = `Invalid event type or listener passed to addEventListener:
 type: ${convertTypeToString(type)}
 listener: ${convertTypeToString(listener)}`;
-            log(logMessage);
-        }
+        logVerbose(message);
 
         return nativeAddEventListener.apply(this, [type, listener, ...args]);
     }
@@ -74,6 +74,8 @@ logAddEventListener.injections = [
     validateListener,
     listenerToString,
     convertTypeToString,
+    logMessage,
+    logVerbose,
     objectToString,
     isEmptyObject,
     getObjectEntries,

diff --git a/src/scriptlets/log-eval.js b/src/scriptlets/log-eval.js
@@ -1,5 +1,5 @@
-/* eslint-disable no-console, no-eval */
-import { hit } from '../helpers/index';
+/* eslint-disable no-eval */
+import { hit, logMessage } from '../helpers/index';
 
 /**
  * @scriptlet log-eval
@@ -13,12 +13,11 @@ import { hit } from '../helpers/index';
  * ```
  */
 export function logEval(source) {
-    const log = console.log.bind(console);
     // wrap eval function
     const nativeEval = window.eval;
     function evalWrapper(str) {
         hit(source);
-        log(`eval("${str}")`);
+        logMessage(`eval("${str}")`);
         return nativeEval(str);
     }
     window.eval = evalWrapper;
@@ -28,7 +27,7 @@ export function logEval(source) {
 
     function FunctionWrapper(...args) {
         hit(source);
-        log(`new Function(${args.join(', ')})`);
+        logMessage(`new Function(${args.join(', ')})`);
         return nativeFunction.apply(this, [...args]);
     }
 
@@ -42,4 +41,4 @@ logEval.names = [
     'log-eval',
 ];
 
-logEval.injections = [hit];
+logEval.injections = [hit, logMessage];
diff --git a/src/scriptlets/nowebrtc.js b/src/scriptlets/nowebrtc.js
@@ -2,6 +2,7 @@
 import {
     hit,
     noopFunc,
+    logVerbose,
     convertRtcConfigToString,
 } from '../helpers/index';
 
@@ -35,7 +36,9 @@ export function nowebrtc(source) {
 
     const rtcReplacement = (config) => {
         // eslint-disable-next-line max-len
-        hit(source, `Document tried to create an RTCPeerConnection: ${convertRtcConfigToString(config)}`);
+        const message = `Document tried to create an RTCPeerConnection: ${convertRtcConfigToString(config)}`;
+        logVerbose(message, source.verbose);
+        hit(source);
     };
     rtcReplacement.prototype = {
         close: noopFunc,
@@ -66,5 +69,6 @@ nowebrtc.names = [
 nowebrtc.injections = [
     hit,
     noopFunc,
+    logVerbose,
     convertRtcConfigToString,
 ];