Refactor src helpers AG-16980

Merge in ADGUARD-FILTERS/scriptlets from fix/AG-16980 to release/v1.7 Squashed commit of the following: commit 3443834 Author: Stanislav A <[email protected]> Date: Fri Nov 18 19:33:19 2022 +0300 fix misc commit cfd9486 Author: Stanislav A <[email protected]> Date: Fri Nov 18 17:41:33 2022 +0300 improve jsdoc for forced parameter commit 295c12b Author: Stanislav A <[email protected]> Date: Fri Nov 18 17:22:43 2022 +0300 update description for 'forced' arg of logMessage commit 03cba16 Author: Stanislav A <[email protected]> Date: Fri Nov 18 17:11:03 2022 +0300 add default value for logMessage 'forced' arg commit 4f80768 Author: Stanislav A <[email protected]> Date: Fri Nov 18 14:15:43 2022 +0300 add Source typedef commit 2056cb7 Author: Stanislav A <[email protected]> Date: Thu Nov 17 20:20:46 2022 +0300 redo logger & swap everywhere commit fa95a0b Merge: cb86ba7 48bd360 Author: Stanislav A <[email protected]> Date: Thu Nov 17 15:59:46 2022 +0300 resolve conflicts commit cb86ba7 Merge: 3cce20b ef618b3 Author: Stanislav A <[email protected]> Date: Wed Nov 16 19:09:40 2022 +0300 Merge branch 'release/v1.7' into fix/AG-16980 commit 3cce20b Author: Stanislav A <[email protected]> Date: Wed Nov 16 19:09:06 2022 +0300 redo typo commit 117da17 Author: Stanislav A <[email protected]> Date: Wed Nov 16 19:08:31 2022 +0300 remove legacy eslnit no-console directives commit a2b90e5 Author: Stanislav A <[email protected]> Date: Wed Nov 16 19:06:02 2022 +0300 add logVerbose to getLimitedStorageItemValue commit cb97abe Author: Stanislav A <[email protected]> Date: Wed Nov 16 14:21:58 2022 +0300 fix console.error calls commit 3ae7455 Author: Stanislav A <[email protected]> Date: Wed Nov 16 14:16:21 2022 +0300 fix logging in ga & log-on-stack-trace commit 4d2cb8f Author: Stanislav A <[email protected]> Date: Tue Nov 15 14:21:51 2022 +0300 fix jsdocs commit c7b0de8 Author: Stanislav A <[email protected]> Date: Tue Nov 15 13:51:15 2022 +0300 fix throttle imports commit f18dc3a Author: Stanislav A <[email protected]> Date: Fri Nov 11 15:43:00 2022 +0300 add getLimitedStorageItemValue helper commit e411fe3 Author: Stanislav A <[email protected]> Date: Fri Nov 11 15:23:29 2022 +0300 remove getWildcardSymbol helper commit dfd8ce1 Author: Stanislav A <[email protected]> Date: Fri Nov 11 15:07:46 2022 +0300 add log helpers & refactor logging in scriptlets commit 959fe50 Author: Stanislav A <[email protected]> Date: Fri Nov 11 12:35:41 2022 +0300 sort index commit e1b8933 Author: Stanislav A <[email protected]> Date: Thu Nov 10 19:29:09 2022 +0300 fix logging at trusted-replace-fetch-response ... and 6 more commits
AdguardTeam · Nov 21, 2022 · 4ad761d · 4ad761d
1 parent 48bd360
commit 4ad761d
Show file tree

Hide file tree

Showing 59 changed files with 536 additions and 482 deletions.
diff --git a/src/helpers/adjust-set-utils.js b/src/helpers/adjust-set-utils.js
@@ -1,7 +1,6 @@
 import { nativeIsNaN, nativeIsFinite } from './number-utils';
-import { getWildcardSymbol } from './constants';
 
-export const shouldMatchAnyDelay = (delay) => delay === getWildcardSymbol();
+export const shouldMatchAnyDelay = (delay) => delay === '*';
 
 /**
  * Handles input delay value

diff --git a/src/helpers/constants.js b/src/helpers/constants.js
diff --git a/src/helpers/converter.js b/src/helpers/converter.js
@@ -9,8 +9,6 @@ import {
 
 import { isExisting } from './array-utils';
 
-import { getWildcardSymbol } from './constants';
-
 import validator from './validator';
 
 import { parseRule } from './parse-rule';
@@ -48,7 +46,7 @@ const UBO_SET_CONSTANT_EMPTY_STRING = '\'\'';
 
 const ADG_PREVENT_FETCH_NAME = 'prevent-fetch';
 const ADG_PREVENT_FETCH_EMPTY_STRING = '';
-const ADG_PREVENT_FETCH_WILDCARD = getWildcardSymbol();
+const ADG_PREVENT_FETCH_WILDCARD = '*';
 const UBO_NO_FETCH_IF_WILDCARD = '/^/';
 
 const ESCAPED_COMMA_SEPARATOR = '\\,';

diff --git a/src/helpers/cookie-utils.js b/src/helpers/cookie-utils.js
@@ -1,4 +1,9 @@
 import { nativeIsNaN } from './number-utils';
+import { logMessage } from './log-message';
+
+/**
+ * @typedef { import('../scriptlets/index').Source } Source
+ */
 
 /**
  * Checks whether the input path is supported
@@ -30,16 +35,16 @@ export const getCookiePath = (rawPath) => {
 /**
  * Combines input cookie name, value, and path into string.
  *
+ * @param {Source} source
  * @param {string} rawName
  * @param {string} rawValue
  * @param {string} rawPath
  *
  * @returns {string} string OR `null` if path is not supported
  */
-export const concatCookieNameValuePath = (rawName, rawValue, rawPath) => {
-    const log = console.log.bind(console); // eslint-disable-line no-console
+export const concatCookieNameValuePath = (source, rawName, rawValue, rawPath) => {
     if (!isValidCookieRawPath(rawPath)) {
-        log(`Invalid cookie path: '${rawPath}'`);
+        logMessage(source, `Invalid cookie path: '${rawPath}'`);
         return null;
     }
     // eslint-disable-next-line max-len
@@ -49,15 +54,16 @@ export const concatCookieNameValuePath = (rawName, rawValue, rawPath) => {
 /**
  * Gets supported cookie value
  *
+ * @param {Source} source
  * @param {string} value input cookie value
  *
  * @returns {string|null} valid cookie string if ok OR null if not
  */
-export const getLimitedCookieValue = (value) => {
+export const getLimitedCookieValue = (source, value) => {
     if (!value) {
         return null;
     }
-    const log = console.log.bind(console); // eslint-disable-line no-console
+
     let validValue;
     if (value === 'true') {
         validValue = 'true';
@@ -82,11 +88,11 @@ export const getLimitedCookieValue = (value) => {
     } else if (/^\d+$/.test(value)) {
         validValue = parseFloat(value);
         if (nativeIsNaN(validValue)) {
-            log(`Invalid cookie value: '${value}'`);
+            logMessage(source, `Invalid cookie value: '${value}'`);
             return null;
         }
         if (Math.abs(validValue) < 0 || Math.abs(validValue) > 15) {
-            log(`Invalid cookie value: '${value}'`);
+            logMessage(source, `Invalid cookie value: '${value}'`);
             return null;
         }
     } else {

diff --git a/src/helpers/get-wildcard-property-in-chain.js b/src/helpers/get-wildcard-property-in-chain.js
@@ -1,5 +1,3 @@
-import { getWildcardSymbol } from './constants';
-
 /**
  * @typedef Chain
  * @property {Object} base
@@ -23,7 +21,7 @@ export function getWildcardPropertyInChain(base, chain, lookThrough = false, out
     const pos = chain.indexOf('.');
     if (pos === -1) {
         // for paths like 'a.b.*' every final nested prop should be processed
-        if (chain === getWildcardSymbol() || chain === '[]') {
+        if (chain === '*' || chain === '[]') {
             // eslint-disable-next-line no-restricted-syntax
             for (const key in base) {
                 // to process each key in base except inherited ones
@@ -41,7 +39,7 @@ export function getWildcardPropertyInChain(base, chain, lookThrough = false, out
     const prop = chain.slice(0, pos);
 
     const shouldLookThrough = (prop === '[]' && Array.isArray(base))
-        || (prop === getWildcardSymbol() && base instanceof Object);
+        || (prop === '*' && base instanceof Object);
 
     if (shouldLookThrough) {
         const nextProp = chain.slice(pos + 1);

diff --git a/src/helpers/index.js b/src/helpers/index.js
@@ -1,32 +1,33 @@
 /**
  * This file must export all used dependencies
  */
-export * from './constants';
-export * from './random-id';
-export * from './set-property-access';
-export * from './get-property-in-chain';
-export * from './get-wildcard-property-in-chain';
-export * from './string-utils';
-export * from './create-on-error-handler';
-export * from './noop';
-export * from './hit';
-export * from './observer';
-export * from './match-stack';
-export * from './script-source-utils';
-export * from './open-shadow-dom-utils';
+
+export * from './add-event-listener-utils';
+export * from './adjust-set-utils';
 export * from './array-utils';
 export * from './cookie-utils';
+export * from './noop-utils';
 export * from './number-utils';
-export * from './adjust-set-utils';
-export * from './request-utils';
 export * from './object-utils';
-export * from './prevent-window-open-utils';
-export * from './add-event-listener-utils';
+export * from './script-source-utils';
+export * from './open-shadow-dom-utils';
 export * from './prevent-utils';
+export * from './prevent-window-open-utils';
 export * from './regexp-utils';
-export * from './random-response';
+export * from './request-utils';
+export * from './storage-utils';
+export * from './string-utils';
+
+export * from './log-message';
+export * from './create-on-error-handler';
 export * from './get-descriptor-addon';
-export * from './parse-flags';
+export * from './get-property-in-chain';
+export * from './get-wildcard-property-in-chain';
+export * from './hit';
 export * from './match-request-props';
-export * from './storage-utils';
+export * from './match-stack';
+export * from './observer';
+export * from './parse-flags';
 export * from './parse-keyword-value';
+export * from './random-id';
+export * from './throttle';
diff --git a/src/helpers/log-message.js b/src/helpers/log-message.js
@@ -0,0 +1,19 @@
+/**
+ * @typedef { import('../scriptlets/index').Source } Source
+ */
+
+/**
+ * Conditionally logs message to console.
+ * Convention is to log messages by source.verbose if such log
+ * is not a part of scriptlet's functionality, eg on invalid input,
+ * and use 'forced' argument otherwise.
+ * @param {Source} source required
+ * @param {string} message required, message to log
+ * @param {boolean} [forced=false] to log message unconditionally
+ */
+export const logMessage = (source, message, forced = false) => {
+    if (forced || source.verbose) {
+        // eslint-disable-next-line no-console
+        console.log(`${source.name}: ${message}`);
+    }
+};
diff --git a/src/helpers/match-request-props.js b/src/helpers/match-request-props.js
@@ -3,16 +3,22 @@ import {
     validateParsedData,
     parseMatchProps,
 } from './request-utils';
+import { logMessage } from './log-message';
+
+/**
+ * @typedef { import('../scriptlets/index').Source } Source
+ */
 
 /**
  * Checks if given propsToMatch string matches with given request data
  * This is used by prevent-xhr, prevent-fetch, trusted-replace-xhr-response
  * and  trusted-replace-fetch-response scriptlets
+ * @param {Source} source
  * @param {string} propsToMatch
  * @param {Object} requestData object with standard properties of fetch/xhr like url, method etc
  * @returns {boolean}
  */
-export const matchRequestProps = (propsToMatch, requestData) => {
+export const matchRequestProps = (source, propsToMatch, requestData) => {
     if (propsToMatch === '' || propsToMatch === '*') {
         return true;
     }
@@ -21,8 +27,7 @@ export const matchRequestProps = (propsToMatch, requestData) => {
 
     const parsedData = parseMatchProps(propsToMatch);
     if (!validateParsedData(parsedData)) {
-        // eslint-disable-next-line no-console
-        console.log(`Invalid parameter: ${propsToMatch}`);
+        logMessage(source, `Invalid parameter: ${propsToMatch}`);
         isMatched = false;
     } else {
         const matchData = getMatchPropsData(parsedData);

diff --git a/src/helpers/noop.js → src/helpers/noop-utils.js b/src/helpers/noop.js → src/helpers/noop-utils.js
diff --git a/src/helpers/number-utils.js b/src/helpers/number-utils.js
@@ -34,3 +34,16 @@ export const getNumberFromString = (rawString) => {
         : parsedDelay;
     return validDelay;
 };
+
+/**
+ * Generate a random integer between two values, inclusive
+ * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/random#getting_a_random_integer_between_two_values_inclusive
+ * @param {number} min
+ * @param {number} max
+ * @returns {number}
+ */
+export function getRandomIntInclusive(min, max) {
+    min = Math.ceil(min);
+    max = Math.floor(max);
+    return Math.floor(Math.random() * (max - min + 1) + min);
+}
diff --git a/src/helpers/object-utils.js b/src/helpers/object-utils.js
@@ -50,3 +50,19 @@ export const safeGetDescriptor = (obj, prop) => {
     }
     return null;
 };
+
+/**
+ * Set getter and setter to property if it's configurable
+ * @param {Object} object target object with property
+ * @param {string} property property name
+ * @param {PropertyDescriptor} descriptor contains getter and setter functions
+ * @returns {boolean} is operation successful
+ */
+export function setPropertyAccess(object, property, descriptor) {
+    const currentDescriptor = Object.getOwnPropertyDescriptor(object, property);
+    if (currentDescriptor && !currentDescriptor.configurable) {
+        return false;
+    }
+    Object.defineProperty(object, property, descriptor);
+    return true;
+}
diff --git a/src/helpers/observer.js b/src/helpers/observer.js
@@ -1,36 +1,11 @@
+import { throttle } from './throttle';
+
 /**
  * DOM tree changes observer. Used for 'remove-attr' and 'remove-class' scriptlets
  * @param {Function} callback
- * @param {Boolean} observeAttrs - optional parameter - should observer check attributes changes
+ * @param {boolean} observeAttrs - optional parameter - should observer check attributes changes
  */
 export const observeDOMChanges = (callback, observeAttrs = false, attrsToObserve = []) => {
-    /**
-     * Returns a wrapper, passing the call to 'method' at maximum once per 'delay' milliseconds.
-     * Those calls that fall into the "cooldown" period, are ignored
-     * @param {Function} method
-     * @param {Number} delay - milliseconds
-     */
-    const throttle = (method, delay) => {
-        let wait = false;
-        let savedArgs;
-        const wrapper = (...args) => {
-            if (wait) {
-                savedArgs = args;
-                return;
-            }
-            method(...args);
-            wait = true;
-            setTimeout(() => {
-                wait = false;
-                if (savedArgs) {
-                    wrapper(savedArgs);
-                    savedArgs = null;
-                }
-            }, delay);
-        };
-        return wrapper;
-    };
-
     /**
      * 'delay' in milliseconds for 'throttle' method
      */

diff --git a/src/helpers/prevent-window-open-utils.js b/src/helpers/prevent-window-open-utils.js
@@ -1,7 +1,7 @@
 import {
     noopFunc,
     trueFunc,
-} from './noop';
+} from './noop-utils';
 import {
     startsWith,
     endsWith,

diff --git a/src/helpers/random-response.js b/src/helpers/random-response.js