log scriptlet to browser console only if filtering log is opened. #2584…

… AG-27413

Squashed commit of the following:

commit 689db87
Author: Slava Leleka <v.leleka@adguard.com>
Date:   Fri Dec 1 11:48:09 2023 +0200

    fix tests

commit 1d0dbee
Author: Slava Leleka <v.leleka@adguard.com>
Date:   Thu Nov 30 20:33:17 2023 +0200

    fix prop name

commit 999055d
Author: Slava Leleka <v.leleka@adguard.com>
Date:   Thu Nov 30 20:29:39 2023 +0200

    update deps

commit 0d9d5c0
Author: Slava Leleka <v.leleka@adguard.com>
Date:   Thu Nov 30 20:29:19 2023 +0200

    update changelog

commit 1f6998f
Merge: ea99ab2 5d3f7d5
Author: Slava Leleka <v.leleka@adguard.com>
Date:   Thu Nov 30 20:27:37 2023 +0200

    merge master into the branch, resolve conflicts

commit ea99ab2
Author: Slava Leleka <v.leleka@adguard.com>
Date:   Mon Nov 27 15:37:18 2023 +0200

    fix naming

commit 902976b
Author: Slava Leleka <v.leleka@adguard.com>
Date:   Fri Nov 24 13:25:39 2023 +0200

    update changelog

commit f6850b1
Author: Slava Leleka <v.leleka@adguard.com>
Date:   Fri Nov 24 13:24:18 2023 +0200

    log scriptlet to browser console only if filtering log is opened

CHANGELOG.md

@@ -8,19 +8,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+- Updated `@adguard/tswebextension` to [v0.4.9](https://github.com/AdguardTeam/tsurlfilter/blob/master/packages/tswebextension/CHANGELOG.md).
+- Updated `@adguard/tsurlfilter` to [v2.2.7](https://github.com/AdguardTeam/tsurlfilter/blob/master/packages/tsurlfilter/CHANGELOG.md).
+- Updated `@adguard/scriptlets` to [v1.9.101](https://github.com/AdguardTeam/Scriptlets/blob/master/CHANGELOG.md)
+
 ### Fixed
 - TSUrlFilter library loading by Fullscreen User Rules Editor
   [#2412](https://github.com/AdguardTeam/AdguardBrowserExtension/issues/2412).
 - Displaying of Stealth Mode modified cookie rules in Filtering log as "Modified"
   [#2512](https://github.com/AdguardTeam/AdguardBrowserExtension/issues/2512).
 - Highlighting of `$inline-font` and `$inline-script`
   [#2609](https://github.com/AdguardTeam/AdguardBrowserExtension/issues/2609).
+- Scriptlets logging in browser console only if Filtering log is opened
+  [#2584](https://github.com/AdguardTeam/AdguardBrowserExtension/issues/2584).
 - Filters updating notification styles
   [#2309](https://github.com/AdguardTeam/AdguardBrowserExtension/issues/2309).
 
 
-<!-- TODO: add date after the version is released on Github -->
-## [4.2.228]
+## [4.2.228] - 2023-11-27
 
 ### Fixed
 

Extension/src/background/api/filtering-log.ts

@@ -140,6 +140,12 @@ export class FilteringLogApi {
     public onOpenFilteringLogPage(): void {
         this.openedFilteringLogsPages += 1;
 
+        try {
+            Engine.api.setDebugScriptlets(true);
+        } catch (e) {
+            Log.error('Failed to enable `verbose scriptlets logging` option', e);
+        }
+
         try {
             Engine.api.setCollectHitStats(true);
         } catch (e) {
@@ -158,6 +164,12 @@ export class FilteringLogApi {
                 tabInfo.filteringEvents = [];
             });
 
+            try {
+                Engine.api.setDebugScriptlets(false);
+            } catch (e) {
+                Log.error('Failed to disable `verbose scriptlets logging` option', e);
+            }
+
             if (settingsStorage.get(SettingOption.DisableCollectHits)) {
                 try {
                     Engine.api.setCollectHitStats(false);

Extension/src/background/api/settings/main.ts

@@ -146,6 +146,7 @@ export class SettingsApi {
             assistantUrl: `/${ASSISTANT_INJECT_OUTPUT}.js`,
             documentBlockingPageUrl: `${Prefs.baseUrl}${DOCUMENT_BLOCK_OUTPUT}.html`,
             collectStats: !settingsStorage.get(SettingOption.DisableCollectHits) || filteringLogApi.isOpen(),
+            debugScriptlets: filteringLogApi.isOpen(),
             allowlistInverted: !settingsStorage.get(SettingOption.DefaultAllowlistMode),
             allowlistEnabled: settingsStorage.get(SettingOption.AllowlistEnabled),
             stealthModeEnabled: !settingsStorage.get(SettingOption.DisableStealthMode),

package.json

@@ -89,10 +89,10 @@
   "dependencies": {
     "@adguard/assistant": "^4.3.70",
     "@adguard/filters-downloader": "^1.1.23",
-    "@adguard/scriptlets": "^1.9.96",
+    "@adguard/scriptlets": "^1.9.101",
     "@adguard/translate": "^1.0.2",
-    "@adguard/tsurlfilter": "^2.2.6",
-    "@adguard/tswebextension": "^0.4.7",
+    "@adguard/tsurlfilter": "^2.2.7",
+    "@adguard/tswebextension": "^0.4.9",
     "@xstate/react": "^1.5.1",
     "ace-builds": "^1.8.1",
     "assert": "^2.0.0",

tests/helpers/fixtures/getDefaultSettingsConfigFixture.ts

@@ -6,10 +6,12 @@ import { defaultSettings } from '../../../Extension/src/common/settings';
 export const getDefaultSettingsConfigFixture = (
     documentBlockingPageUrl: string,
     assistantUrl: string,
+    debugScriptlets: boolean,
 ): SettingsConfig => ({
     assistantUrl,
     documentBlockingPageUrl,
     collectStats: !defaultSettings[SettingOption.DisableCollectHits],
+    debugScriptlets,
     allowlistInverted: !defaultSettings[SettingOption.DefaultAllowlistMode],
     allowlistEnabled: defaultSettings[SettingOption.AllowlistEnabled],
     stealthModeEnabled: !defaultSettings[SettingOption.DisableStealthMode],

tests/helpers/mocks/tswebextension.ts

@@ -48,6 +48,8 @@ export class MockedTsWebExtension {
 
     public setCollectHitStats = jest.fn();
 
+    public setDebugScriptlets = jest.fn();
+
     public setStealthModeEnabled = jest.fn();
 
     public setSelfDestructFirstPartyCookies = jest.fn();

tests/src/background/api/settings.test.ts

@@ -90,6 +90,7 @@ describe('Settings Api', () => {
             const expected = getDefaultSettingsConfigFixture(
                 browser.runtime.getURL(`${DOCUMENT_BLOCK_OUTPUT}.html`),
                 `/${ASSISTANT_INJECT_OUTPUT}.js`,
+                false,
             );
             expect(SettingsApi.getTsWebExtConfiguration()).toStrictEqual(expected);
         });

yarn.lock

@@ -19,10 +19,10 @@
   dependencies:
     axios "^0.21.1"
 
-"@adguard/scriptlets@^1.9.96":
-  version "1.9.96"
-  resolved "https://registry.yarnpkg.com/@adguard/scriptlets/-/scriptlets-1.9.96.tgz#641e6a5d11072649c52ac0738b82de13ce4f26f8"
-  integrity sha512-pX9qKN14i9kO9aiIOx00tmnM8BuTpSyvACycVmD5GLQbzWOs1m16SiiYXwYrdIXLVwF4S4ddeS6bx67O9jbwOA==
+"@adguard/scriptlets@^1.9.101":
+  version "1.9.101"
+  resolved "https://registry.yarnpkg.com/@adguard/scriptlets/-/scriptlets-1.9.101.tgz#f18ba3b16b673790e92a6ec66977590cc619ae05"
+  integrity sha512-mqqQ57v/BRVVEYXXmWUPI2S6Fgxj1lj5pC1rA7Sde3QiLyS9CqL29yu9EydXY2QJw9eN9Xw/NsdoXaOEfSd9bA==
   dependencies:
     "@babel/runtime" "^7.20.13"
     js-yaml "^3.13.1"
@@ -32,12 +32,12 @@
   resolved "https://registry.yarnpkg.com/@adguard/translate/-/translate-1.0.2.tgz#e8076902f0950a62d40519d6eb389778516928a0"
   integrity sha512-TeQV4ngse/fcpFDCrtU5VqjZfQsdytSuGT8wF4biIM6c6v6W/tkUdrTDhNItq126hAZe65V8QgipTAp8qHdeZw==
 
-"@adguard/tsurlfilter@^2.2.6":
-  version "2.2.6"
-  resolved "https://registry.yarnpkg.com/@adguard/tsurlfilter/-/tsurlfilter-2.2.6.tgz#4d6af36aa724cae5a69bc98beb76feedf57eb87c"
-  integrity sha512-D7lO95aG1ndudDSZq3dGgcrzfOWBY8sQwGD7PkAn3i0y2paWRYtIXyyVO7V6anraYjs9bQt2RDcqNwU8coFKMg==
+"@adguard/tsurlfilter@^2.2.7":
+  version "2.2.7"
+  resolved "https://registry.yarnpkg.com/@adguard/tsurlfilter/-/tsurlfilter-2.2.7.tgz#283e42fc0e13b84234a606f76ae9eab8ccbbe230"
+  integrity sha512-DgNx6yG2fkcvAMSz6CuB1dQfUiB7mrJytA3fQWYkm335V7m89RMdsORwjL/TA2cBYtNDgV3DDDvwJsy/B+/kAQ==
   dependencies:
-    "@adguard/scriptlets" "^1.9.96"
+    "@adguard/scriptlets" "^1.9.101"
     cidr-tools "^6.4.1"
     commander "9.4.1"
     is-cidr "4.0.2"
@@ -47,15 +47,15 @@
     tldts "5.6.45"
     zod "3.19.1"
 
-"@adguard/tswebextension@^0.4.7":
-  version "0.4.7"
-  resolved "https://registry.yarnpkg.com/@adguard/tswebextension/-/tswebextension-0.4.7.tgz#92aa5d266fcaae2f3edf115da2f773119eb78979"
-  integrity sha512-YE68SPI79a+llLYNoWWRt3L1lB8YgcoEHLWl0XN1fbUe61T9aPUT5eNL3P0OePmqiHDz7ARajnbvoO0NZqO61A==
+"@adguard/tswebextension@^0.4.9":
+  version "0.4.9"
+  resolved "https://registry.yarnpkg.com/@adguard/tswebextension/-/tswebextension-0.4.9.tgz#4b64600bc5bda167059085a3e82b92def5ba470e"
+  integrity sha512-1b0opWR8VsNvK4HH1PHm1l3D1bAYbF5EqpPP4YtETsXp2E9VYqQ1qvey+BLTkhhUKxtvMDkWHN/Knyiw6xZjdw==
   dependencies:
     "@adguard/assistant" "^4.3.70"
     "@adguard/extended-css" "^2.0.52"
-    "@adguard/scriptlets" "^1.9.96"
-    "@adguard/tsurlfilter" "^2.2.6"
+    "@adguard/scriptlets" "^1.9.101"
+    "@adguard/tsurlfilter" "^2.2.7"
     bowser "2.11.0"
     commander "11.0.0"
     fs-extra "11.1.1"