AG-27395: new values for set-cookie

Merge in ADGUARD-FILTERS/scriptlets from feature/AG-27395 to master Squashed commit of the following: commit d6f9dea Author: Dmitriy Seregin <d.seregin@adguard.com> Date: Mon Jan 29 18:50:49 2024 +0300 undo changes commit f0e1a3d Author: Dmitriy Seregin <d.seregin@adguard.com> Date: Mon Jan 29 18:49:44 2024 +0300 changes commit e4152c8 Author: Dmitriy Seregin <d.seregin@adguard.com> Date: Mon Jan 29 18:46:24 2024 +0300 fixed bamboo plans commit 0afd30f Author: Dmitriy Seregin <d.seregin@adguard.com> Date: Mon Jan 29 18:45:47 2024 +0300 fixes for compatibility table commit 73dafe5 Author: Dmitriy Seregin <d.seregin@adguard.com> Date: Mon Jan 29 18:00:08 2024 +0300 undo changes in wiki commit 148efec Author: Dmitriy Seregin <d.seregin@adguard.com> Date: Mon Jan 29 17:53:08 2024 +0300 update compatibility tables commit 824b5f6 Author: Dmitriy Seregin <d.seregin@adguard.com> Date: Mon Jan 29 17:42:01 2024 +0300 AG-27395: new values for set-cookie
AdguardTeam · Jan 30, 2024 · f5c1cd9 · f5c1cd9
1 parent d71db5c
commit f5c1cd9
Show file tree

Hide file tree

Showing 10 changed files with 70 additions and 174 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,13 @@ The format is based on [Keep a Changelog], and this project adheres to [Semantic
 <!-- TODO: add @added tag to the files with specific version -->
 <!--       during new scriptlets or redirects releasing -->
 
+## Unreleased
+
+### Added
+
+- New values `t`, `f`, `necessary`, `required` for `set-cookie` and `set-cookie-reload`
+  [#379](https://github.com/AdguardTeam/Scriptlets/issues/379)
+
 ## [v1.9.105] - 2023-12-25
 
 ### Added

diff --git a/bamboo-specs/build.yaml b/bamboo-specs/build.yaml
@@ -36,8 +36,7 @@ Build:
             yarn install ${bamboo.varsYarn}
             yarn build
 
-            yarn wiki:build-docs
-            yarn wiki:build-table
+            yarn wiki
 
             rm -rf node_modules
     - inject-variables:

diff --git a/bamboo-specs/test.yaml b/bamboo-specs/test.yaml
@@ -34,10 +34,8 @@ Build:
             yarn install
 
             # build docs to lint them later
-            # 1. check compatibility table updates and build it
-            yarn wiki:build-table
-            # 2. build other wiki docs
-            yarn wiki:build-docs
+            # check compatibility table updates and build it and build wiki docs
+            yarn wiki
 
             yarn test
             yarn build

diff --git a/package.json b/package.json
@@ -12,6 +12,7 @@
         "lint:md": "markdownlint .",
         "lint-staged": "lint-staged",
         "prepare": "husky install",
+        "wiki": "yarn wiki:build-table && yarn wiki:build-docs",
         "wiki:build-table": "node ./scripts/check-sources-updates.js && node ./scripts/build-compatibility-table.js",
         "wiki:build-docs": "node scripts/build-docs.js",
         "prepublishOnly": "yarn build",

diff --git a/scripts/compatibility-table.json b/scripts/compatibility-table.json
@@ -108,7 +108,7 @@
         },
         {
             "adg": "prevent-fetch",
-            "ubo": "no-fetch-if.js (prevent-fetch.js)"
+            "ubo": "prevent-fetch.js (no-fetch-if.js)"
         },
         {
             "adg": "prevent-xhr",
@@ -319,6 +319,12 @@
         },
         {
             "ubo": "trusted-replace-node-text.js (trusted-rpnt.js, replace-node-text.js, rpnt.js)"
+        },
+        {
+            "ubo": "remove-cache-storage-item.js"
+        },
+        {
+            "ubo": "trusted-replace-argument.js"
         }
     ],
     "redirects": [
@@ -528,4 +534,4 @@
             "ubo": "noop-0.5s.mp3"
         }
     ]
-}
+}
diff --git a/src/helpers/cookie-utils.ts b/src/helpers/cookie-utils.ts
@@ -62,7 +62,9 @@ export const getLimitedCookieValue = (value: string): string | number | null =>
 
     const allowedCookieValues = new Set([
         'true',
+        't',
         'false',
+        'f',
         'yes',
         'y',
         'no',
@@ -83,6 +85,8 @@ export const getLimitedCookieValue = (value: string): string | number | null =>
         'enabled',
         'disable',
         'disabled',
+        'necessary',
+        'required',
     ]);
 
     let validValue;

diff --git a/src/scriptlets/set-cookie-reload.js b/src/scriptlets/set-cookie-reload.js
@@ -29,13 +29,19 @@ import {
  * - `value` — required, cookie value; possible values:
  *     - number `>= 0 && <= 15`
  *     - one of the predefined constants in any case variation:
- *         - `true`
- *         - `false`
+ *         - `true` / `t`
+ *         - `false` / `f`
  *         - `yes` / `y`
  *         - `no` / `n`
  *         - `ok`
- *         - `accept`/ `reject`
- *         - `allow` / `deny`
+ *         - `on` / `off`
+ *         - `accept`/ `accepted` / `notaccepted`
+ *         - `reject` / `rejected`
+ *         - `allow` / `allowed`
+ *         - `disallow` / `deny`
+ *         - `enable` / `enabled`
+ *         - `disable` / `disabled`
+ *         - `necessary` / `required`
  * - `path` — optional, cookie path, defaults to `/`; possible values:
  *     - `/` — root path
  *     - `none` — to set no path at all

diff --git a/src/scriptlets/set-cookie.js b/src/scriptlets/set-cookie.js
@@ -31,8 +31,8 @@ import {
  * - `value` — required, cookie value; possible values:
  *     - number `>= 0 && <= 15`
  *     - one of the predefined constants in any case variation:
- *         - `true`
- *         - `false`
+ *         - `true` / `t`
+ *         - `false` / `f`
  *         - `yes` / `y`
  *         - `no` / `n`
  *         - `ok`
@@ -43,6 +43,7 @@ import {
  *         - `disallow` / `deny`
  *         - `enable` / `enabled`
  *         - `disable` / `disabled`
+ *         - `necessary` / `required`
  * - `path` — optional, cookie path, defaults to `/`; possible values:
  *     - `/` — root path
  *     - `none` — to set no path at all

diff --git a/tests/scriptlets/set-cookie.test.js b/tests/scriptlets/set-cookie.test.js
@@ -38,163 +38,37 @@ test('Checking if alias name works', (assert) => {
     assert.strictEqual(codeByAdgParams, codeByUboParams, 'ubo name - ok');
 });
 
-test('Set cookie with valid value', (assert) => {
-    let cName = '__test-cookie_OK';
-    let cValue = 'OK';
-    runScriptlet(name, [cName, cValue]);
-    assert.strictEqual(window.hit, 'FIRED', 'Hit was fired');
-    assert.strictEqual(document.cookie.includes(cName) && document.cookie.includes(cValue), true, 'Cookie is set');
-    clearCookie(cName);
-
-    cName = '__test-cookie_true';
-    cValue = 'true';
-    runScriptlet(name, [cName, cValue]);
-    assert.strictEqual(window.hit, 'FIRED', 'Hit was fired');
-    assert.strictEqual(document.cookie.includes(cName) && document.cookie.includes(cValue), true, 'Cookie is set');
-    clearCookie(cName);
-
-    cName = '__test-cookie_false';
-    cValue = 'false';
-    runScriptlet(name, [cName, cValue]);
-    assert.strictEqual(window.hit, 'FIRED', 'Hit was fired');
-    assert.strictEqual(document.cookie.includes(cName) && document.cookie.includes(cValue), true, 'Cookie is set');
-    clearCookie(cName);
-
-    cName = '__test-cookie_no';
-    cValue = 'no';
-    runScriptlet(name, [cName, cValue]);
-    assert.strictEqual(window.hit, 'FIRED', 'Hit was fired');
-    assert.strictEqual(document.cookie.includes(cName) && document.cookie.includes(cValue), true, 'Cookie is set');
-    clearCookie(cName);
-
-    cName = '__test-cookie_n';
-    cValue = 'n';
-    runScriptlet(name, [cName, cValue]);
-    assert.strictEqual(window.hit, 'FIRED', 'Hit was fired');
-    assert.strictEqual(document.cookie.includes(cName) && document.cookie.includes(cValue), true, 'Cookie is set');
-    clearCookie(cName);
-
-    cName = '__test-cookie_Accept';
-    cValue = 'Accept';
-    runScriptlet(name, [cName, cValue]);
-    assert.strictEqual(window.hit, 'FIRED', 'Hit was fired');
-    assert.strictEqual(document.cookie.includes(cName) && document.cookie.includes(cValue), true, 'Cookie is set');
-    clearCookie(cName);
-
-    cName = '__test-cookie_Reject';
-    cValue = 'Reject';
-    runScriptlet(name, [cName, cValue]);
-    assert.strictEqual(window.hit, 'FIRED', 'Hit was fired');
-    assert.strictEqual(document.cookie.includes(cName) && document.cookie.includes(cValue), true, 'Cookie is set');
-    clearCookie(cName);
-
-    cName = '__test-cookie_allow';
-    cValue = 'allow';
-    runScriptlet(name, [cName, cValue]);
-    assert.strictEqual(window.hit, 'FIRED', 'Hit was fired');
-    assert.strictEqual(document.cookie.includes(cName) && document.cookie.includes(cValue), true, 'Cookie is set');
-    clearCookie(cName);
-
-    cName = '__test-cookie_deny';
-    cValue = 'deny';
-    runScriptlet(name, [cName, cValue]);
-    assert.strictEqual(window.hit, 'FIRED', 'Hit was fired');
-    assert.strictEqual(document.cookie.includes(cName) && document.cookie.includes(cValue), true, 'Cookie is set');
-    clearCookie(cName);
-
-    cName = '__test-cookie_dENy';
-    cValue = 'dENy';
-    runScriptlet(name, [cName, cValue]);
-    assert.strictEqual(window.hit, 'FIRED', 'Hit was fired');
-    assert.strictEqual(document.cookie.includes(cName) && document.cookie.includes(cValue), true, 'Cookie is set');
-    clearCookie(cName);
-
-    cName = '__test-cookie_0';
-    cValue = '0';
-    runScriptlet(name, [cName, cValue]);
-    assert.strictEqual(window.hit, 'FIRED', 'Hit was fired');
-    assert.strictEqual(document.cookie.includes(cName) && document.cookie.includes(cValue), true, 'Cookie is set');
-    clearCookie(cName);
-
-    cName = '__test-cookie_1';
-    cValue = '1';
-    runScriptlet(name, [cName, cValue]);
-    assert.strictEqual(window.hit, 'FIRED', 'Hit was fired');
-    assert.strictEqual(document.cookie.includes(cName) && document.cookie.includes(cValue), true, 'Cookie is set');
-    clearCookie(cName);
-
-    cName = '__test-cookie_on';
-    cValue = 'on';
-    runScriptlet(name, [cName, cValue]);
-    assert.strictEqual(window.hit, 'FIRED', 'Hit was fired');
-    assert.strictEqual(document.cookie.includes(cName) && document.cookie.includes(cValue), true, 'Cookie is set');
-    clearCookie(cName);
-
-    cName = '__test-cookie_off';
-    cValue = 'off';
-    runScriptlet(name, [cName, cValue]);
-    assert.strictEqual(window.hit, 'FIRED', 'Hit was fired');
-    assert.strictEqual(document.cookie.includes(cName) && document.cookie.includes(cValue), true, 'Cookie is set');
-    clearCookie(cName);
-
-    cName = '__test-cookie_accepted';
-    cValue = 'accepted';
-    runScriptlet(name, [cName, cValue]);
-    assert.strictEqual(window.hit, 'FIRED', 'Hit was fired');
-    assert.strictEqual(document.cookie.includes(cName) && document.cookie.includes(cValue), true, 'Cookie is set');
-    clearCookie(cName);
-
-    cName = '__test-cookie_notaccepted';
-    cValue = 'notaccepted';
-    runScriptlet(name, [cName, cValue]);
-    assert.strictEqual(window.hit, 'FIRED', 'Hit was fired');
-    assert.strictEqual(document.cookie.includes(cName) && document.cookie.includes(cValue), true, 'Cookie is set');
-    clearCookie(cName);
-
-    cName = '__test-cookie_rejected';
-    cValue = 'rejected';
-    runScriptlet(name, [cName, cValue]);
-    assert.strictEqual(window.hit, 'FIRED', 'Hit was fired');
-    assert.strictEqual(document.cookie.includes(cName) && document.cookie.includes(cValue), true, 'Cookie is set');
-    clearCookie(cName);
-
-    cName = '__test-cookie_allowed';
-    cValue = 'allowed';
-    runScriptlet(name, [cName, cValue]);
-    assert.strictEqual(window.hit, 'FIRED', 'Hit was fired');
-    assert.strictEqual(document.cookie.includes(cName) && document.cookie.includes(cValue), true, 'Cookie is set');
-    clearCookie(cName);
-
-    cName = '__test-cookie_disallow';
-    cValue = 'disallow';
-    runScriptlet(name, [cName, cValue]);
-    assert.strictEqual(window.hit, 'FIRED', 'Hit was fired');
-    assert.strictEqual(document.cookie.includes(cName) && document.cookie.includes(cValue), true, 'Cookie is set');
-    clearCookie(cName);
-
-    cName = '__test-cookie_enable';
-    cValue = 'enable';
-    runScriptlet(name, [cName, cValue]);
-    assert.strictEqual(window.hit, 'FIRED', 'Hit was fired');
-    assert.strictEqual(document.cookie.includes(cName) && document.cookie.includes(cValue), true, 'Cookie is set');
-    clearCookie(cName);
-
-    cName = '__test-cookie_enabled';
-    cValue = 'enabled';
-    runScriptlet(name, [cName, cValue]);
-    assert.strictEqual(window.hit, 'FIRED', 'Hit was fired');
-    assert.strictEqual(document.cookie.includes(cName) && document.cookie.includes(cValue), true, 'Cookie is set');
-    clearCookie(cName);
-
-    cName = '__test-cookie_disable';
-    cValue = 'disable';
-    runScriptlet(name, [cName, cValue]);
-    assert.strictEqual(window.hit, 'FIRED', 'Hit was fired');
-    assert.strictEqual(document.cookie.includes(cName) && document.cookie.includes(cValue), true, 'Cookie is set');
-    clearCookie(cName);
-
-    cName = '__test-cookie_disabled';
-    cValue = 'disabled';
+const cookies = [
+    ['__test-cookie_OK', 'OK'],
+    ['__test-cookie_true', 'true'],
+    ['__test-cookie_true', 't'],
+    ['__test-cookie_false', 'false'],
+    ['__test-cookie_false', 'f'],
+    ['__test-cookie_no', 'no'],
+    ['__test-cookie_n', 'n'],
+    ['__test-cookie_Accept', 'Accept'],
+    ['__test-cookie_Reject', 'Reject'],
+    ['__test-cookie_allow', 'allow'],
+    ['__test-cookie_deny', 'deny'],
+    ['__test-cookie_dENy', 'dENy'],
+    ['__test-cookie_0', '0'],
+    ['__test-cookie_1', '1'],
+    ['__test-cookie_on', 'on'],
+    ['__test-cookie_off', 'off'],
+    ['__test-cookie_accepted', 'accepted'],
+    ['__test-cookie_notaccepted', 'notaccepted'],
+    ['__test-cookie_rejected', 'rejected'],
+    ['__test-cookie_allowed', 'allowed'],
+    ['__test-cookie_disallow', 'disallow'],
+    ['__test-cookie_enable', 'enable'],
+    ['__test-cookie_enabled', 'enabled'],
+    ['__test-cookie_disable', 'disable'],
+    ['__test-cookie_disabled', 'disabled'],
+    ['__test-cookie_necessary', 'necessary'],
+    ['__test-cookie_required', 'required'],
+];
+
+test.each('Set cookie with valid value', cookies, (assert, [cName, cValue]) => {
     runScriptlet(name, [cName, cValue]);
     assert.strictEqual(window.hit, 'FIRED', 'Hit was fired');
     assert.strictEqual(document.cookie.includes(cName) && document.cookie.includes(cValue), true, 'Cookie is set');

diff --git a/yarn.lock b/yarn.lock
@@ -2298,9 +2298,9 @@ camelcase@^6.2.0:
   integrity sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA==
 
 caniuse-lite@^1.0.30001251, caniuse-lite@^1.0.30001489:
-  version "1.0.30001498"
-  resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001498.tgz#84e4ee2d03e0e4f8a04a508853b75a980c703201"
-  integrity sha512-LFInN2zAwx3ANrGCDZ5AKKJroHqNKyjXitdV5zRIVIaQlXKj3GmxUKagoKsjqUfckpAObPCEWnk5EeMlyMWcgw==
+  version "1.0.30001581"
+  resolved "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001581.tgz"
+  integrity sha512-whlTkwhqV2tUmP3oYhtNfaWGYHDdS3JYFQBKXxcUR9qqPWsRhFHhoISO2Xnl/g0xyKzht9mI1LZpiNWfMzHixQ==
 
 chalk@^2.0.0:
   version "2.4.2"