fix: check search engine access in MV3

Author: dessant

src/utils/app.js

@@ -10,7 +10,9 @@ import {
   getPlatform,
   isAndroid,
   getDayPrecisionEpoch,
-  getDarkColorSchemeQuery
+  getDarkColorSchemeQuery,
+  getExtensionDomain,
+  getRandomInt
 } from 'utils/common';
 import {
   targetEnv,
@@ -477,6 +479,35 @@ async function getStartupState({event = ''} = {}) {
   return startup;
 }
 
+function getNetRequestRuleIds({count = 1, reserved = false} = {}) {
+  const ruleIds = [];
+
+  let minValue, maxValue;
+  if (reserved) {
+    minValue = 1;
+    maxValue = 100_000_000;
+  } else {
+    minValue = 100_000_001;
+    maxValue = ['firefox', 'safari'].includes(targetEnv)
+      ? Number.MAX_SAFE_INTEGER
+      : 2_147_483_647;
+  }
+
+  while (true) {
+    const ruleId = getRandomInt(minValue, maxValue);
+
+    if (!ruleIds.includes(ruleId)) {
+      ruleIds.push(ruleId);
+    }
+
+    if (ruleIds.length === count) {
+      break;
+    }
+  }
+
+  return ruleIds;
+}
+
 function getEngineMenuIcon(engine, {variant = ''} = {}) {
   engine = engineIconAlias[engine] || engine;
 
@@ -525,40 +556,83 @@ async function isContextMenuSupported() {
 }
 
 async function checkSearchEngineAccess() {
-  // Check if search engine access is enabled in Opera
-  if (!mv3 && / opr\//i.test(navigator.userAgent)) {
+  if (/ opr\//i.test(navigator.userAgent)) {
+    // Check if the "Allow access to search page results" option
+    // is enabled in Opera. Host access is needed for redirecting a request
+    // with declarativeNetRequest (but not for blocking), so a request is made
+    // with manual redirection. If host access has been granted, the request
+    // does not reach the server and the response type will be 'opaqueredirect'.
+
     const {lastEngineAccessCheck} = await storage.get('lastEngineAccessCheck');
     // run at most once a week
     if (Date.now() - lastEngineAccessCheck > 604800000) {
       await storage.set({lastEngineAccessCheck: Date.now()});
 
       const url = 'https://www.google.com/generate_204';
 
-      const hasAccess = await new Promise(resolve => {
-        let access = false;
-
-        function requestCallback() {
-          access = true;
-          removeCallback();
-          return {cancel: true};
+      let hasAccess = false;
+
+      if (mv3) {
+        const ruleIds = getNetRequestRuleIds({reserved: true});
+
+        await browser.declarativeNetRequest.updateSessionRules({
+          removeRuleIds: ruleIds,
+          addRules: [
+            {
+              id: ruleIds[0],
+              action: {
+                type: 'redirect',
+                redirect: {
+                  transform: {path: ''}
+                }
+              },
+              condition: {
+                urlFilter: url,
+                initiatorDomains: [getExtensionDomain()],
+                resourceTypes: ['xmlhttprequest']
+              }
+            }
+          ]
+        });
+
+        const rsp = await fetch(url, {
+          redirect: 'manual',
+          credentials: 'omit'
+        }).catch(err => null);
+
+        if (rsp && rsp.type === 'opaqueredirect') {
+          hasAccess = true;
         }
 
-        const removeCallback = function () {
-          window.clearTimeout(timeoutId);
-          browser.webRequest.onBeforeRequest.removeListener(requestCallback);
-
-          resolve(access);
-        };
-        const timeoutId = window.setTimeout(removeCallback, 3000); // 3 seconds
-
-        browser.webRequest.onBeforeRequest.addListener(
-          requestCallback,
-          {urls: [url], types: ['xmlhttprequest']},
-          ['blocking']
-        );
-
-        fetch(url).catch(err => null);
-      });
+        await browser.declarativeNetRequest.updateSessionRules({
+          removeRuleIds: ruleIds
+        });
+      } else {
+        await new Promise(resolve => {
+          function requestCallback() {
+            hasAccess = true;
+            removeCallback();
+
+            return {cancel: true};
+          }
+
+          const removeCallback = function () {
+            self.clearTimeout(timeoutId);
+            browser.webRequest.onBeforeRequest.removeListener(requestCallback);
+
+            resolve();
+          };
+          const timeoutId = self.setTimeout(removeCallback, 3000); // 3 seconds
+
+          browser.webRequest.onBeforeRequest.addListener(
+            requestCallback,
+            {urls: [url], types: ['xmlhttprequest']},
+            ['blocking']
+          );
+
+          fetch(url).catch(err => null);
+        });
+      }
 
       if (!hasAccess) {
         await showNotification({messageId: 'error_noSearchEngineAccess'});
@@ -627,6 +701,7 @@ export {
   isSessionStartup,
   isStartup,
   getStartupState,
+  getNetRequestRuleIds,
   getEngineIcon,
   getEngineMenuIcon,
   handleActionEscapeKey,

src/utils/common.js

@@ -330,6 +330,22 @@ function isBackgroundPageContext() {
   return self.location.href === backgroundUrl;
 }
 
+function getExtensionDomain() {
+  try {
+    const {hostname} = new URL(
+      browser.runtime.getURL('/src/background/script.js')
+    );
+
+    return hostname;
+  } catch (err) {}
+
+  return null;
+}
+
+function getRandomInt(min, max) {
+  return Math.floor(Math.random() * (max - min + 1)) + min;
+}
+
 function querySelectorXpath(selector, {rootNode = null} = {}) {
   rootNode = rootNode || document;
 
@@ -522,6 +538,8 @@ export {
   getDarkColorSchemeQuery,
   getDayPrecisionEpoch,
   isBackgroundPageContext,
+  getExtensionDomain,
+  getRandomInt,
   querySelectorXpath,
   nodeQuerySelector,
   findNode,