Merge branch 'master' into fix/AG-33558

AdguardTeam · Jul 8, 2024 · 2ca4790 · 2ca4790
2 parents 4822423 + 15a2d8f
commit 2ca4790
Show file tree

Hide file tree

Showing 8 changed files with 98 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,12 +12,20 @@ The format is based on [Keep a Changelog], and this project adheres to [Semantic
 ### Added
 
 - new values to `set-cookie` and `set-cookie-reload` scriptlets: `hide`, `hidden` [#433]
+- new values to `set-local-storage-item` and `set-session-storage-item` scriptlets:
+  `accept`, `accepted`, `reject`, `rejected` [#429]
 - ability to log original and modified content in `trusted-replace-node-text`, `xml-prune`, `m3u-prune`,
   `trusted-replace-fetch-response` and `trusted-replace-xhr-response` scriptlets [#411]
 
+### Changed
+
+- Log message format [CoreLibs#180]
+
 [Unreleased]: https://github.com/AdguardTeam/Scriptlets/compare/v1.11.1...HEAD
 [#433]: https://github.com/AdguardTeam/Scriptlets/issues/433
+[#429]: https://github.com/AdguardTeam/Scriptlets/issues/429
 [#411]: https://github.com/AdguardTeam/Scriptlets/issues/411
+[CoreLibs#180]: https://github.com/AdguardTeam/CoreLibs/issues/180
 
 ## [v1.11.1] - 2024-06-13
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@adguard/scriptlets",
-    "version": "1.11.2",
+    "version": "1.11.4",
     "description": "AdGuard's JavaScript library of Scriptlets and Redirect resources",
     "scripts": {
         "build": "babel-node -x .js,.ts scripts/build.js",

diff --git a/src/helpers/hit.ts b/src/helpers/hit.ts
@@ -14,25 +14,32 @@ declare global {
  * for logging scriptlets
  */
 export const hit = (source: Source) => {
-    if (source.verbose !== true) {
+    const ADGUARD_PREFIX = '[AdGuard]';
+    if (!source.verbose) {
         return;
     }
 
     try {
-        const log = console.log.bind(console);
         const trace = console.trace.bind(console);
 
-        let prefix = '';
-        if (source.domainName) {
-            prefix += `${source.domainName}`;
+        let label = `${ADGUARD_PREFIX} `;
+        if (source.engine === 'corelibs') {
+            // rule text will be available for corelibs
+            label += source.ruleText;
+        } else {
+            if (source.domainName) {
+                label += `${source.domainName}`;
+            }
+            if (source.args) {
+                label += `#%#//scriptlet('${source.name}', '${source.args.join("', '")}')`;
+            } else {
+                label += `#%#//scriptlet('${source.name}')`;
+            }
         }
-        prefix += `#%#//scriptlet('${source.name}', '${source.args.join(', ')}')`;
 
-        log(`${prefix} trace start`);
         if (trace) {
-            trace();
+            trace(label);
         }
-        log(`${prefix} trace end`);
     } catch (e) {
         // try catch for Edge 15
         // In according to this issue https://developer.microsoft.com/en-us/microsoft-edge/platform/issues/14495220/

diff --git a/src/helpers/storage-utils.ts b/src/helpers/storage-utils.ts
@@ -30,9 +30,11 @@ export const setStorageItem = (source: Source, storage: Storage, key: string, va
  */
 export const removeStorageItem = (source: Source, storage: Storage, key: string): void => {
     try {
-        if (key.startsWith('/')
-        && (key.endsWith('/') || key.endsWith('/i'))
-        && isValidStrPattern(key)) {
+        if (
+            key.startsWith('/')
+            && (key.endsWith('/') || key.endsWith('/i'))
+            && isValidStrPattern(key)
+        ) {
             const regExpKey = toRegExp(key);
             const storageKeys = Object.keys(storage);
             storageKeys.forEach((storageKey) => {
@@ -70,6 +72,10 @@ export const getLimitedStorageItemValue = (value: string): StorageItemValue | nu
         'no',
         'on',
         'off',
+        'accept',
+        'accepted',
+        'reject',
+        'rejected',
     ]);
 
     let validValue;

diff --git a/src/scriptlets/set-local-storage-item.js b/src/scriptlets/set-local-storage-item.js
@@ -46,6 +46,10 @@ import {
  *         - `no`
  *         - `on`
  *         - `off`
+ *         - `accept`
+ *         - `accepted`
+ *         - `reject`
+ *         - `rejected`
  *         - `$remove$` — remove specific item from localStorage
  *
  * ### Examples

diff --git a/src/scriptlets/set-session-storage-item.js b/src/scriptlets/set-session-storage-item.js
@@ -46,6 +46,10 @@ import {
  *         - `no`
  *         - `on`
  *         - `off`
+ *         - `accept`
+ *         - `accepted`
+ *         - `reject`
+ *         - `rejected`
  *         - `$remove$` — remove specific item from sessionStorage
  *
  * ### Examples

diff --git a/tests/scriptlets/set-local-storage-item.test.js b/tests/scriptlets/set-local-storage-item.test.js
@@ -135,6 +135,34 @@ if (isSafariBrowser()) {
         assert.strictEqual(window.hit, 'FIRED', 'Hit was fired');
         assert.strictEqual(window.localStorage.getItem(iName), 'off', 'localStorage item has been set');
         clearStorageItem(iName);
+
+        iName = '__test-item_accept';
+        iValue = 'accept';
+        runScriptlet(name, [iName, iValue]);
+        assert.strictEqual(window.hit, 'FIRED', 'Hit was fired');
+        assert.strictEqual(window.localStorage.getItem(iName), 'accept', 'localStorage item has been set');
+        clearStorageItem(iName);
+
+        iName = '__test-item_accepted';
+        iValue = 'accepted';
+        runScriptlet(name, [iName, iValue]);
+        assert.strictEqual(window.hit, 'FIRED', 'Hit was fired');
+        assert.strictEqual(window.localStorage.getItem(iName), 'accepted', 'localStorage item has been set');
+        clearStorageItem(iName);
+
+        iName = '__test-item_reject';
+        iValue = 'reject';
+        runScriptlet(name, [iName, iValue]);
+        assert.strictEqual(window.hit, 'FIRED', 'Hit was fired');
+        assert.strictEqual(window.localStorage.getItem(iName), 'reject', 'localStorage item has been set');
+        clearStorageItem(iName);
+
+        iName = '__test-item_rejected';
+        iValue = 'rejected';
+        runScriptlet(name, [iName, iValue]);
+        assert.strictEqual(window.hit, 'FIRED', 'Hit was fired');
+        assert.strictEqual(window.localStorage.getItem(iName), 'rejected', 'localStorage item has been set');
+        clearStorageItem(iName);
     });
 
     test('Set localStorage key with invalid value', (assert) => {

diff --git a/tests/scriptlets/set-session-storage-item.test.js b/tests/scriptlets/set-session-storage-item.test.js
@@ -135,6 +135,34 @@ if (isSafariBrowser()) {
         assert.strictEqual(window.hit, 'FIRED', 'Hit was fired');
         assert.strictEqual(window.sessionStorage.getItem(cName), 'off', 'sessionStorage item has been set');
         clearStorageItem(cName);
+
+        cName = '__test-item_accept';
+        cValue = 'accept';
+        runScriptlet(name, [cName, cValue]);
+        assert.strictEqual(window.hit, 'FIRED', 'Hit was fired');
+        assert.strictEqual(window.sessionStorage.getItem(cName), 'accept', 'sessionStorage item has been set');
+        clearStorageItem(cName);
+
+        cName = '__test-item_accepted';
+        cValue = 'accepted';
+        runScriptlet(name, [cName, cValue]);
+        assert.strictEqual(window.hit, 'FIRED', 'Hit was fired');
+        assert.strictEqual(window.sessionStorage.getItem(cName), 'accepted', 'sessionStorage item has been set');
+        clearStorageItem(cName);
+
+        cName = '__test-item_reject';
+        cValue = 'reject';
+        runScriptlet(name, [cName, cValue]);
+        assert.strictEqual(window.hit, 'FIRED', 'Hit was fired');
+        assert.strictEqual(window.sessionStorage.getItem(cName), 'reject', 'sessionStorage item has been set');
+        clearStorageItem(cName);
+
+        cName = '__test-item_rejected';
+        cValue = 'rejected';
+        runScriptlet(name, [cName, cValue]);
+        assert.strictEqual(window.hit, 'FIRED', 'Hit was fired');
+        assert.strictEqual(window.sessionStorage.getItem(cName), 'rejected', 'sessionStorage item has been set');
+        clearStorageItem(cName);
     });
 
     test('Set sessionStorage key with invalid value', (assert) => {