Remove unnecessary hit function

Rename shouldLog to shouldPruneResponse
AdguardTeam · Oct 10, 2022 · 8185ae3 · 8185ae3
1 parent cf1f380
commit 8185ae3
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 9 deletions.
diff --git a/src/scriptlets/xml-prune.js b/src/scriptlets/xml-prune.js
@@ -55,11 +55,13 @@ export function xmlPrune(source, propsToRemove, optionalProp = '', urlToMatch) {
         return;
     }
 
-    let shouldLog = false;
+    let shouldPruneResponse = true;
     // eslint-disable-next-line no-console
     const log = console.log.bind(console);
     if (!propsToRemove) {
-        shouldLog = true;
+        // If "propsToRemove" is not defined, then response shouldn't be pruned
+        // but it should be logged in browser console
+        shouldPruneResponse = false;
     }
 
     urlToMatch = toRegExp(urlToMatch);
@@ -109,10 +111,9 @@ export function xmlPrune(source, propsToRemove, optionalProp = '', urlToMatch) {
                 if (thisArg.readyState === 4) {
                     const { response } = thisArg;
                     thisArg.removeEventListener('readystatechange', pruneResponse);
-                    if (shouldLog) {
+                    if (!shouldPruneResponse) {
                         if (isXML(response)) {
                             log(`URL: ${xhrURL}\n${response}`);
-                            hit(source);
                         }
                     } else {
                         const prunedResponseContent = pruneXML(response);
@@ -147,9 +148,8 @@ export function xmlPrune(source, propsToRemove, optionalProp = '', urlToMatch) {
         if (urlToMatch.test(fetchURL)) {
             return realFetch.apply(this, args).then((response) => {
                 return response.text().then((text) => {
-                    if (shouldLog) {
+                    if (!shouldPruneResponse) {
                         if (isXML(text)) {
-                            hit(source);
                             log(`URL: ${fetchURL}\n${text}`);
                         }
                         return Reflect.apply(target, thisArg, args);

diff --git a/tests/scriptlets/xml-prune.test.js b/tests/scriptlets/xml-prune.test.js
@@ -70,7 +70,7 @@ if (!isSupported) {
         const responseMPD = await response.text();
 
         assert.ok(responseMPD.indexOf('pre-roll-1-ad-1') > -1);
-        assert.strictEqual(window.hit, 'FIRED', 'hit function fired');
+        assert.strictEqual(window.hit, undefined, 'should not hit');
         done();
     });
 
@@ -205,7 +205,7 @@ if (!isSupported) {
         xhr.open(METHOD, MPD_PATH);
         xhr.onload = () => {
             assert.ok(xhr.responseText.indexOf('pre-roll-1-ad-1') > -1);
-            assert.strictEqual(window.hit, 'FIRED', 'hit function fired');
+            assert.strictEqual(window.hit, undefined, 'should not hit');
             done();
         };
         xhr.send();

diff --git a/wiki/about-scriptlets.md b/wiki/about-scriptlets.md
@@ -1725,7 +1725,7 @@ example.org#%#//scriptlet('xml-prune'[, propsToMatch[, optionalProp[, urlToMatch
     example.org#%#//scriptlet('xml-prune', 'Period[id*="-ad-"]', '', '.mpd')
     ```
 
-4. Call with no arguments will log response payload at the console
+4. Call with no arguments will log response payload and URL at the console
     ```
     example.org#%#//scriptlet('xml-prune')
     ```