add blocking page for mv3

Author: slavaleleka

CHANGELOG.md

@@ -10,10 +10,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Send last filters update time during issue reporting [#3055].
+- Blocked by `$document` rules blocking page for MV3.
 
 ### Changed
 
-- Updated Safebrowsing and blocked by rules blocking pages.
+- Updated blocking pages for MV2 — Safebrowsing and blocked by `$document` rules.
 
 ### Removed
 

Extension/pages/blocking/blocked/page-handler.ts

@@ -110,15 +110,20 @@ const updatePlaceholders = ({ url, filterName, rule }: PlaceholdersData): void =
 /**
  * Adds listener to handle "Proceed Anyway" button click.
  *
- * @param url URL to add to trusted.
+ * @param url In MV2 — URL to add to trusted, in MV3 — URL to proceed to.
+ * @param rule In MV2 — not needed, in MV3 — rule that blocked the page and should be badfiltered.
  */
-const addProceedAnywayListener = (url: string): void => {
+const addProceedAnywayListener = (url: string, rule: string): void => {
     const proceedAnywayBtn = getElementById(BLOCKED_PROCEED_ANYWAY_BTN_ID);
 
     proceedAnywayBtn.addEventListener('click', (e: Event) => {
         e.preventDefault();
 
-        messenger.addUrlToTrusted(url);
+        if (__IS_MV3__) {
+            messenger.badfilterRuleAsTrusted(rule, url);
+        } else {
+            messenger.addUrlToTrusted(url);
+        }
     });
 };
 
@@ -175,7 +180,7 @@ const runInit = ({
 
     updateTheme(theme);
     updatePlaceholders({ url, filterName, rule });
-    addProceedAnywayListener(url);
+    addProceedAnywayListener(url, rule);
     addAddToAllowlistListener(url);
     addGoBackButtonListener(BLOCKED_GO_BACK_BTN_ID);
 };

Extension/src/background/api/document-block.ts

@@ -61,22 +61,32 @@ export class DocumentBlockApi {
     }
 
     /**
-     * Adds the domain to the list of trusted domains with DocumentBlockApi#TRUSTED_TTL_MS timeout.
+     * Stores trusted domain in the storage.
+     * Removes expired domains and duplicates.
      *
-     * @param url A trusted domain to add.
+     * @param input A trusted domain to add.
      */
-    public static async setTrustedDomain(url: string): Promise<void> {
-        const { hostname } = new URL(url);
-
+    public static async storeTrustedDomain(input: string): Promise<void> {
         const now = Date.now();
 
         // remove expired and duplicates
         const data = trustedDomainsStorage
             .getData()
-            .filter(({ expires, domain }) => (now < expires) && (domain !== hostname));
+            .filter(({ expires, domain }) => (now < expires) && (domain !== input));
 
-        data.push({ domain: hostname, expires: DocumentBlockApi.TRUSTED_TTL_MS + now });
+        data.push({ domain: input, expires: DocumentBlockApi.TRUSTED_TTL_MS + now });
 
         await trustedDomainsStorage.setData(data);
     }
+
+    /**
+     * Adds the domain to the list of trusted domains with DocumentBlockApi#TRUSTED_TTL_MS timeout.
+     *
+     * @param url A trusted domain to add.
+     */
+    public static async setTrustedDomain(url: string): Promise<void> {
+        const { hostname } = new URL(url);
+
+        DocumentBlockApi.storeTrustedDomain(hostname);
+    }
 }

Extension/src/background/engine/engine-mv3.ts

@@ -40,6 +40,7 @@ import {
     filteringLogApi,
     CommonFilterApi,
     iconsApi,
+    DocumentBlockApi,
 } from '../api';
 import { RulesLimitsService, rulesLimitsService } from '../services/rules-limits/rules-limits-service-mv3';
 import { UserRulesService } from '../services/userrules';
@@ -240,6 +241,8 @@ export class Engine implements TsWebExtensionEngine {
         //     };
         // }));
 
+        const blockingTrustedRules = await DocumentBlockApi.getTrustedDomains();
+
         return {
             declarativeLogEnabled: filteringLogApi.isOpen(),
             // TODO: revert to actual customFilters when their support will be added back
@@ -253,6 +256,7 @@ export class Engine implements TsWebExtensionEngine {
             settings,
             filtersPath: 'filters/',
             ruleSetsPath: 'filters/declarative',
+            blockingTrustedRules,
         };
     }
 

Extension/src/background/keep-alive.ts

@@ -162,7 +162,8 @@ export class KeepAlive {
                 }
                 return;
             } catch (e) {
-                logger.error(`[KeepAlive.executeScriptOnTab] Tab ${tab.id} error: ${e}`);
+                // use debug level to avoid extension errors when blocking pages is loading
+                logger.debug(`[KeepAlive.executeScriptOnTab] Tab ${tab.id} error: ${e}`);
             }
         }
     }

Extension/src/background/services/document-block.ts

@@ -17,7 +17,11 @@
  */
 import browser from 'webextension-polyfill';
 
-import { type AddUrlToTrustedMessage, MessageType } from '../../common/messages';
+import {
+    type AddUrlToTrustedMessage,
+    type BadfilterRuleAsTrustedMessage,
+    MessageType,
+} from '../../common/messages';
 import { DocumentBlockApi, TabsApi } from '../api';
 import { engine } from '../engine';
 import { messageHandler } from '../message-handler';
@@ -34,9 +38,31 @@ export class DocumentBlockService {
     public static async init(): Promise<void> {
         await DocumentBlockApi.init();
 
-        messageHandler.addListener(MessageType.AddUrlToTrusted, DocumentBlockService.onAddUrlToTrusted);
+        if (__IS_MV3__) {
+            messageHandler.addListener(
+                MessageType.BadfilterRuleAsTrusted,
+                DocumentBlockService.onBadfilterRuleAsTrusted,
+            );
+        } else {
+            messageHandler.addListener(MessageType.AddUrlToTrusted, DocumentBlockService.onAddUrlToTrusted);
+        }
     }
 
+    /**
+     * Updates the active tab with the provided URL.
+     *
+     * @param url The URL to update the active tab with.
+     */
+    private static updateActiveTab = async (url: string): Promise<void> => {
+        const tab = await TabsApi.getActive();
+
+        if (!tab?.id) {
+            return;
+        }
+
+        await browser.tabs.update(tab.id, { url });
+    };
+
     /**
      * Listener for the event of adding a domain to trusted domains.
      *
@@ -49,10 +75,21 @@ export class DocumentBlockService {
         await DocumentBlockApi.setTrustedDomain(url);
         await engine.update();
 
-        const tab = await TabsApi.getActive();
+        DocumentBlockService.updateActiveTab(url);
+    }
 
-        if (tab?.id) {
-            await browser.tabs.update(tab.id, { url });
-        }
+    /**
+     * Listener for the event of adding a domain to trusted domains.
+     *
+     * @param message Message of type {@link AddUrlToTrustedMessage}.
+     * @param message.data Contains string url domain.
+     */
+    private static async onBadfilterRuleAsTrusted({ data }: BadfilterRuleAsTrustedMessage): Promise<void> {
+        const { rule, url } = data;
+
+        await DocumentBlockApi.storeTrustedDomain(rule);
+        await engine.update();
+
+        DocumentBlockService.updateActiveTab(url);
     }
 }

Extension/src/common/messages/constants.ts

@@ -123,6 +123,7 @@ export enum MessageType {
     SaveCookieLogEvent = 'saveCookieRuleEvent',
     LoadSettingsJson = 'loadSettingsJson',
     AddUrlToTrusted = 'addUrlToTrusted',
+    BadfilterRuleAsTrusted = 'badfilterRuleAsTrusted',
     SetPreserveLogState = 'setPreserveLogState',
     GetUserRulesEditorData = 'getUserRulesEditorData',
     GetEditorStorageContent = 'getEditorStorageContent',
@@ -536,6 +537,14 @@ export type AddUrlToTrustedMessage = {
     };
 };
 
+export type BadfilterRuleAsTrustedMessage = {
+    type: MessageType.BadfilterRuleAsTrusted;
+    data: {
+        rule: string;
+        url: string;
+    };
+};
+
 export type SetNotificationViewedMessage = {
     type: MessageType.SetNotificationViewed;
     data: {
@@ -897,6 +906,10 @@ export type MessageMap = {
         message: AddUrlToTrustedMessage;
         response: void;
     };
+    [MessageType.BadfilterRuleAsTrusted]: {
+        message: BadfilterRuleAsTrustedMessage;
+        response: void;
+    };
     [MessageType.CurrentLimitsMv3]: {
         message: CurrentLimitsMv3Message;
         response: Mv3LimitsCheckResult;

Extension/src/pages/services/messenger.ts

@@ -59,6 +59,7 @@ import {
     type SetNotificationViewedMessage,
     type UpdateFullscreenUserRulesThemeMessage,
     type AddUrlToTrustedMessage,
+    type BadfilterRuleAsTrustedMessage,
     type ExtractedMessage,
     type OpenSafebrowsingTrustedMessage,
 } from '../../common/messages';
@@ -965,6 +966,22 @@ class Messenger {
         return this.sendMessage(MessageType.AddUrlToTrusted, { url });
     }
 
+    /**
+     * Sends a message to the background page to badfilter specific rule as trusted temporarily
+     * and url is needed to update the tab url after blocking page display.
+     *
+     * @param rule Rule to badfilter.
+     * @param url Url to update for the tab.
+     *
+     * @returns Promise that resolves after the message is sent.
+     */
+    async badfilterRuleAsTrusted(
+        rule: BadfilterRuleAsTrustedMessage['data']['rule'],
+        url: BadfilterRuleAsTrustedMessage['data']['url'],
+    ): Promise<ExtractMessageResponse<MessageType.BadfilterRuleAsTrusted>> {
+        return this.sendMessage(MessageType.BadfilterRuleAsTrusted, { rule, url });
+    }
+
     /**
      * Sends a message to the background page to get user rules editor data.
      *