AG-40548 Fix json-prune — content of array is incorrectly removed. #482

Squashed commit of the following:

commit 4e7a9b2
Author: Adam Wróblewski <[email protected]>
Date:   Thu Mar 6 16:07:04 2025 +0100

    Reduce nesting

commit b5e1708
Author: Adam Wróblewski <[email protected]>
Date:   Thu Mar 6 15:45:17 2025 +0100

    Update package.json and changeLog

commit 188f2f6
Author: Adam Wróblewski <[email protected]>
Date:   Thu Mar 6 14:02:27 2025 +0100

    Update changelog

commit d08451c
Author: Adam Wróblewski <[email protected]>
Date:   Thu Mar 6 13:39:08 2025 +0100

    Fix json-prune — content of array is incorrectly removed

Author: AdamWr

CHANGELOG.md

@@ -10,6 +10,15 @@ The format is based on [Keep a Changelog], and this project adheres to [Semantic
 <!-- TODO: change `@added unknown` tag due to the actual version -->
 <!--       during new scriptlets or redirects releasing -->
 
+## [v2.1.6] - 2025-03-06
+
+### Fixed
+
+- issue with incorrectly removing content from parsed array when using the `json-prune` scriptlet [#482]
+
+  [v2.1.6]: https://github.com/AdguardTeam/Scriptlets/compare/v2.1.5...v2.1.6
+  [#482]: https://github.com/AdguardTeam/Scriptlets/issues/482
+
 ## [v2.1.5] - 2025-02-28
 
 ### Changed

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@adguard/scriptlets",
-    "version": "2.1.5",
+    "version": "2.1.6",
     "description": "AdGuard's JavaScript library of Scriptlets and Redirect resources",
     "type": "module",
     "scripts": {

src/helpers/prune-utils.ts

@@ -149,20 +149,28 @@ export const jsonPruner = (
             // Iterate in reverse order to avoid index issues when removing elements from an array
             for (let i = ownerObjArr.length - 1; i >= 0; i -= 1) {
                 const ownerObj = ownerObjArr[i];
-                if (ownerObj !== undefined && ownerObj.base) {
-                    if (Array.isArray(ownerObj.base)) {
-                        try {
-                            const index = Number(ownerObj.prop);
-                            // Delete operator leaves "undefined" in the array and it sometimes causes issues
-                            ownerObj.base.splice(index, 1);
-                        } catch (error) {
-                            // eslint-disable-next-line no-console
-                            console.error('Error while deleting array element', error);
-                        }
-                    } else {
-                        delete ownerObj.base[ownerObj.prop];
+                if (ownerObj === undefined || !ownerObj.base) {
+                    continue;
+                }
+
+                hit(source);
+
+                if (!Array.isArray(ownerObj.base)) {
+                    delete ownerObj.base[ownerObj.prop];
+                    continue;
+                }
+
+                try {
+                    const index = Number(ownerObj.prop);
+                    if (Number.isNaN(index)) {
+                        continue;
                     }
-                    hit(source);
+
+                    // Delete operator leaves "undefined" in the array and it sometimes causes issues
+                    ownerObj.base.splice(index, 1);
+                } catch (error) {
+                    // eslint-disable-next-line no-console
+                    console.error('Error while deleting array element', error);
                 }
             }
         });

tests/helpers/prune-utils.spec.js

@@ -931,4 +931,30 @@ describe('jsonPruner tests', () => {
 
         expect(result).toStrictEqual(expected);
     });
+
+    test('Array - should not be removed', async () => {
+        const root = [
+            'foo',
+            0,
+            1,
+            43200,
+            100,
+        ];
+
+        const expected = [
+            'foo',
+            0,
+            1,
+            43200,
+            100,
+        ];
+
+        // eslint-disable-next-line max-len
+        const pathToPrune = getPrunePath('playerResponse.adPlacements playerResponse.playerAds playerResponse.adSlots adPlacements playerAds adSlots');
+        const requiredPaths = getPrunePath('');
+        const stack = '';
+        const result = jsonPruner(name, root, pathToPrune, requiredPaths, stack, nativeObjects);
+
+        expect(result).toStrictEqual(expected);
+    });
 });