AG-41928 Add support for 'emptyArr' and 'emptyObj' in 'set-cookie' and 'set-cookie-reload' scriptlets. #497

Squashed commit of the following:

commit 1e6f1c9
Author: Adam Wróblewski <[email protected]>
Date:   Fri Apr 25 16:37:30 2025 +0200

    Add support for 'emptyArr' and 'emptyObj' in `set-cookie` and `set-cookie-reload` scriptlets

Author: AdamWr

CHANGELOG.md

@@ -14,6 +14,7 @@ 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: `emptyArr`, `emptyObj` [#497].
 - Ability to set random response content in `prevent-fetch` scriptlet [#416].
 - Ability to choose CSS injection method in `inject-css-in-shadow-dom` scriptlet [#477].
 - TypeScript types for CoreLibs provided [`ContentScriptApi`](./README.md#scriptlets-api--content-script-api).
@@ -33,6 +34,7 @@ The format is based on [Keep a Changelog], and this project adheres to [Semantic
 [#416]: https://github.com/AdguardTeam/Scriptlets/issues/416
 [#477]: https://github.com/AdguardTeam/Scriptlets/issues/477
 [#496]: https://github.com/AdguardTeam/Scriptlets/issues/496
+[#497]: https://github.com/AdguardTeam/Scriptlets/issues/497
 
 ## [v2.1.7] - 2025-04-03
 

src/helpers/cookie-utils.ts

@@ -138,6 +138,10 @@ export const getLimitedCookieValue = (value: string): string | number | null =>
     let validValue;
     if (allowedCookieValues.has(value.toLowerCase())) {
         validValue = value;
+    } else if (value === 'emptyArr') {
+        validValue = '[]';
+    } else if (value === 'emptyObj') {
+        validValue = '{}';
     } else if (/^\d+$/.test(value)) {
         validValue = parseFloat(value);
         if (nativeIsNaN(validValue)) {

src/scriptlets/set-cookie-reload.js

@@ -44,6 +44,8 @@ import {
  *         - `essential` / `nonessential`
  *         - `checked` / `unchecked`
  *         - `forbidden` / `forever`
+ *         - `emptyArr` to set an empty array `[]`
+ *         - `emptyObj` to set an empty object `{}`
  * - `path` — optional, cookie path, defaults to `/`; possible values:
  *     - `/` — root path
  *     - `none` — to set no path at all
@@ -90,7 +92,7 @@ export function setCookieReload(source, name, value, path = '/', domain = '') {
         return;
     }
 
-    const cookieToSet = serializeCookie(name, validValue, path, domain);
+    const cookieToSet = serializeCookie(name, validValue, path, domain, false);
     if (!cookieToSet) {
         logMessage(source, 'Invalid cookie name or value');
         return;

src/scriptlets/set-cookie.js

@@ -46,6 +46,8 @@ import {
  *         - `essential` / `nonessential`
  *         - `checked` / `unchecked`
  *         - `forbidden` / `forever`
+ *         - `emptyArr` to set an empty array `[]`
+ *         - `emptyObj` to set an empty object `{}`
  * - `path` — optional, cookie path, defaults to `/`; possible values:
  *     - `/` — root path
  *     - `none` — to set no path at all
@@ -89,7 +91,7 @@ export function setCookie(source, name, value, path = '/', domain = '') {
         return;
     }
 
-    const cookieToSet = serializeCookie(name, validValue, path, domain);
+    const cookieToSet = serializeCookie(name, validValue, path, domain, false);
     if (!cookieToSet) {
         logMessage(source, 'Invalid cookie name or value');
         return;

tests/scriptlets/set-cookie.test.js

@@ -70,12 +70,40 @@ const cookies = [
     ['__test-cookie_unchecked', 'unchecked'],
     ['__test-cookie_forbidden', 'forbidden'],
     ['__test-cookie_forever', 'forever'],
+    ['__test-cookie_emptyArray', 'emptyArr'],
+    ['__test-cookie_emptyObject', 'emptyObj'],
 ];
 
 test.each('Set cookie with valid value', cookies, (assert, [cName, cValue]) => {
+    const emptyArrValue = '[]';
+    const emptyObjValue = '{}';
+
     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');
+    switch (cValue) {
+        case 'emptyArr':
+            assert.strictEqual(
+                document.cookie.includes(cName)
+                && document.cookie.includes(emptyArrValue),
+                true,
+                'Cookie is set',
+            );
+            break;
+        case 'emptyObj':
+            assert.strictEqual(
+                document.cookie.includes(cName)
+                && document.cookie.includes(emptyObjValue),
+                true,
+                'Cookie is set');
+            break;
+        default:
+            assert.strictEqual(
+                document.cookie.includes(cName)
+                && document.cookie.includes(cValue),
+                true,
+                'Cookie is set',
+            );
+    }
     clearCookie(cName);
 });