AG-30145 && AG-30144: fixed ignoring all cosmetic rules for Opera

Merge in ADGUARD-FILTERS/tsurlfilter from fix/AG-30145 to master

Squashed commit of the following:

commit 6f0475d
Author: Dmitriy Seregin <[email protected]>
Date:   Tue Feb 6 14:04:39 2024 +0300

    AG-30145 && AG-30144: fixed ignoring all cosmetic rules for Opera

Author: 105th

packages/tswebextension/CHANGELOG.md

@@ -8,6 +8,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 <!-- TODO: manually add compare links for version to the end of the file -->
 <!-- e.g. [0.1.2]: https://github.com/AdguardTeam/tsurlfilter/compare/tswebextension-v0.1.1...tswebextension-v0.1.2 -->
 
+## [1.0.11] - 2024-02-06
+
+### Fixed
+- Incorrect handling hook `webNavigation.onCommitted` for Opera with force
+  recalculating matching result.
+- Correct export of `EXTENDED_CSS_VERSION` for mv2 version.
+
 ## [1.0.10] - 2024-01-27
 
 ### Fixed

packages/tswebextension/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adguard/tswebextension",
-  "version": "1.0.10",
+  "version": "1.0.11",
   "description": "This is a TypeScript library that implements AdGuard's extension API",
   "main": "dist/index.js",
   "typings": "dist/types/src/lib/mv2/background/index.d.ts",

packages/tswebextension/rollup.config.ts

@@ -211,6 +211,8 @@ const assistantInjectScriptConfig = {
     ],
 };
 
+// TODO: Remove index files from 'src/lib', 'src/lib/mv2', 'src/lib/mv3' because
+// they are not participating in the build process and not specified as entry points.
 export default [
     backgroundMv2Config,
     backgroundMv3Config,

packages/tswebextension/src/lib/mv2/background/index.ts

@@ -6,6 +6,12 @@ export {
     NetworkRuleOption,
 } from '@adguard/tsurlfilter';
 
+// Re-export needed to print libraries version in extension popup.
+// NOTE: Do not export anything from extended-css in MV3 environment to prevent
+// environment runtime errors, like call window.console, which is not available
+// in the service worker in MV3.
+export { EXTENDED_CSS_VERSION } from '@adguard/extended-css';
+
 export * from './api';
 export * from './app';
 export * from './ext-session-storage';

packages/tswebextension/src/lib/mv2/background/web-request-api.ts

@@ -230,6 +230,9 @@ export class WebRequestApi {
         RequestEvents.onCompleted.addListener(WebRequestApi.onCompleted);
 
         // browser.webNavigation Events
+        // Note: We need to force set matching result in Opera before run `WebRequestApi.onCommitted`
+        // TODO: remove this when Opera bug is fixed.
+        browser.webNavigation.onCommitted.addListener(WebRequestApi.onCommittedOperaHook);
         browser.webNavigation.onCommitted.addListener(WebRequestApi.onCommitted);
         browser.webNavigation.onDOMContentLoaded.addListener(WebRequestApi.onDomContentLoaded);
         browser.webNavigation.onCompleted.addListener(WebRequestApi.deleteFrameContext);
@@ -693,33 +696,6 @@ export class WebRequestApi {
             url,
         } = details;
 
-        /**
-         * There is Opera bug that prevents firing WebRequest events for document and subdocument requests.
-         * We now handle this by checking if matching result exists for main frame and if not - we create it.
-         *
-         * TODO remove this when Opera bug is fixed.
-         */
-        if (isOpera && frameId === MAIN_FRAME_ID) {
-            const tabContext = tabsApi.getTabContext(tabId);
-            if (!tabContext) {
-                return;
-            }
-
-            const frame = tabContext.frames.get(frameId);
-            if (!frame || frame.matchingResult) {
-                return;
-            }
-
-            const matchingResult = engineApi.matchRequest({
-                requestUrl: url,
-                frameUrl: url,
-                requestType: RequestType.Document,
-                frameRule: tabContext.mainFrameRule,
-            });
-
-            frame.matchingResult = matchingResult;
-        }
-
         WebRequestApi.injectCosmetic({
             frameId,
             tabId,
@@ -877,4 +853,45 @@ export class WebRequestApi {
          */
         setTimeout(() => tabContext.frames.delete(frameId), FRAME_DELETION_TIMEOUT);
     }
+
+    /**
+     * On committed web navigation event handler only for Opera.
+     *
+     * There is Opera bug that prevents firing WebRequest events for document
+     * and subdocument requests.
+     * We now handle this by checking if matching result exists for main frame
+     * and if not - we force create it.
+     *
+     * TODO: remove this when Opera bug is fixed.
+     *
+     * @param details Event details.
+     */
+    private static onCommittedOperaHook(details: WebNavigation.OnCommittedDetailsType): void {
+        const {
+            frameId,
+            tabId,
+            url,
+        } = details;
+
+        if (isOpera && frameId === MAIN_FRAME_ID) {
+            const tabContext = tabsApi.getTabContext(tabId);
+            if (!tabContext) {
+                return;
+            }
+
+            const frame = tabContext.frames.get(frameId);
+            if (!frame || frame.matchingResult) {
+                return;
+            }
+
+            const matchingResult = engineApi.matchRequest({
+                requestUrl: url,
+                frameUrl: url,
+                requestType: RequestType.Document,
+                frameRule: tabContext.mainFrameRule,
+            });
+
+            frame.matchingResult = matchingResult;
+        }
+    }
 }

packages/tswebextension/src/lib/mv2/index.ts

@@ -1,8 +1,2 @@
 export * from './background';
 export * from './content-script';
-
-// Needed to print libraries version in extension popup.
-// NOTE: Do not export anything from extended-css in MV3 environment to prevent
-// environment runtime errors, like call window.console, which is not available
-// in the service worker in MV3.
-export { EXTENDED_CSS_VERSION } from '@adguard/extended-css';