AG-34277 Improve 'set-cookie' — add 'essential' and 'nonessential' to…

… supported values. #436 Squashed commit of the following: commit 378ad52 Author: Adam Wróblewski <[email protected]> Date: Thu Jul 11 12:35:11 2024 +0200 Fix typos in test commit 2d249cf Author: Adam Wróblewski <[email protected]> Date: Thu Jul 11 11:28:09 2024 +0200 Add new values to 'set-cookie' and 'set-cookie-reload' scriptlets: 'essential', 'nonessential'
AdguardTeam · Jul 11, 2024 · 977dd80 · 977dd80
1 parent 871a0cc
commit 977dd80
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,9 +11,11 @@ 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: `essential`, `nonessential` [#436]
 - `trusted-set-session-storage-item` scriptlet [#426]
 
 [Unreleased]: https://github.com/AdguardTeam/Scriptlets/compare/v1.11.6...HEAD
+[#436]: https://github.com/AdguardTeam/Scriptlets/issues/436
 [#426]: https://github.com/AdguardTeam/Scriptlets/issues/426
 
 ## [v1.11.6] - 2024-07-08

diff --git a/src/helpers/cookie-utils.ts b/src/helpers/cookie-utils.ts
@@ -106,6 +106,8 @@ export const getLimitedCookieValue = (value: string): string | number | null =>
  'required',
  'hide',
  'hidden',
+ 'essential',
+ 'nonessential',
  ]);
 
  let validValue;

diff --git a/src/scriptlets/set-cookie-reload.js b/src/scriptlets/set-cookie-reload.js
@@ -43,6 +43,7 @@ import {
  * - `disable` / `disabled`
  * - `necessary` / `required`
  * - `hide` / `hidden`
+ * - `essential` / `nonessential`
  * - `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
@@ -45,6 +45,7 @@ import {
  * - `disable` / `disabled`
  * - `necessary` / `required`
  * - `hide` / `hidden`
+ * - `essential` / `nonessential`
  * - `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
@@ -66,8 +66,10 @@ const cookies = [
  ['__test-cookie_disabled', 'disabled'],
  ['__test-cookie_necessary', 'necessary'],
  ['__test-cookie_required', 'required'],
- ['__test-cookie_required', 'hide'],
- ['__test-cookie_required', 'hidden'],
+ ['__test-cookie_hide', 'hide'],
+ ['__test-cookie_hidden', 'hidden'],
+ ['__test-cookie_essential', 'essential'],
+ ['__test-cookie_nonessential', 'nonessential'],
 ];
 
 test.each('Set cookie with valid value', cookies, (assert, [cName, cValue]) => {