chore: switch default to mv3

.env/dev-preference.example

@@ -39,7 +39,7 @@
 # Use Chromium Manifest V3 as default development target.
 
 ; manifest=chromium-mv2
-; manifest=chromium-beta-mv2
+; manifest=chromium-beta-mv3
 ; manifest=chromium-mv3
 ; manifest=firefox-mv2
 ; manifest=firefox-mv3

package.json

@@ -15,7 +15,7 @@
     "start": "dev",
     "start:mv2": "dev --manifest 2",
     "start:mv3": "dev --manifest 3",
-    "start:fx": "dev --manifest firefox-mv2",
+    "start:fx": "dev --manifest firefox-mv3",
     "codegen": "gulp codegen-watch",
     "build": "build",
     "build:mv3": "build --manifest 3",

packages/mask/.webpack/flags.ts

@@ -3,8 +3,8 @@ import { join, isAbsolute } from 'node:path'
 
 export enum ManifestFile {
     ChromiumMV2 = 'chromium-mv2',
-    ChromiumBetaMV2 = 'chromium-beta-mv2',
     ChromiumMV3 = 'chromium-mv3',
+    ChromiumBetaMV3 = 'chromium-beta-mv3',
     FirefoxMV2 = 'firefox-mv2',
     FirefoxMV3 = 'firefox-mv3',
     SafariMV3 = 'safari-mv3',
@@ -39,7 +39,7 @@ export function normalizeBuildFlags(flags: BuildFlags): NormalizedFlags {
         channel = 'stable',
         devtoolsEditorURI = 'vscode://file/{path}:{line}',
         sourceMapHideFrameworks = true,
-        manifestFile = ManifestFile.ChromiumMV2,
+        manifestFile = ManifestFile.ChromiumMV3,
     } = flags
     let {
         hmr = mode === 'development',
@@ -50,6 +50,12 @@ export function normalizeBuildFlags(flags: BuildFlags): NormalizedFlags {
     } = flags
     if (!isAbsolute(outputPath)) outputPath = join(import.meta.dirname, '../../../', outputPath)
 
+    if (manifestFile === ManifestFile.FirefoxMV3) {
+        // TODO: Firefox MV3 blocked by website's CSP
+        hmr = false
+        // TODO: "devtools_page" in manifest.json causes all Promises in browser.* hang
+        devtools = false
+    }
     if (mode === 'production' || profiling) hmr = false
     if (!hmr) reactRefresh = false
 

packages/mask/.webpack/manifest/manifest-mv3.json

@@ -6,7 +6,6 @@
     "optional_permissions": ["notifications", "clipboardRead"],
     "optional_host_permissions": ["<all_urls>"],
     "background": { "service_worker": "/manifest-v3.entry.js" },
-    "options_ui": { "page": "dashboard.html", "open_in_tab": true },
     "icons": {
         "16": "assets/16x16.png",
         "48": "assets/48x48.png",
@@ -31,5 +30,10 @@
     "content_security_policy": {
         "extension_pages": "script-src 'self' 'wasm-unsafe-eval'; object-src 'self'; trusted-types default dompurify mask;"
     },
-    "minimum_chrome_version": "102"
+    "minimum_chrome_version": "102",
+    "browser_specific_settings": {
+        "gecko": {
+            "id": "{0e57e2ae-3e13-4d5d-9243-6159219852a6}"
+        }
+    }
 }

packages/mask/.webpack/manifest/manifest.json

@@ -5,7 +5,6 @@
     "permissions": ["storage", "webNavigation", "activeTab"],
     "optional_permissions": ["<all_urls>", "notifications", "clipboardRead"],
     "background": { "page": "background.html" },
-    "options_ui": { "page": "dashboard.html", "open_in_tab": true },
     "icons": {
         "16": "assets/16x16.png",
         "48": "assets/48x48.png",

packages/mask/.webpack/plugins/manifest.ts

@@ -53,7 +53,7 @@ function prepareAllManifest(flags: NormalizedFlags, computedFlags: ComputedFlags
     )
 
     const manifestFlags: Record<NormalizedFlags['manifestFile'], ManifestPresets> = {
-        'chromium-beta-mv2': [{ ...flags, channel: 'beta' }, mv2Base],
+        'chromium-beta-mv3': [{ ...flags, channel: 'beta' }, mv3Base],
         'chromium-mv2': [flags, mv2Base],
         'chromium-mv3': [flags, mv3Base],
         'firefox-mv2': [flags, mv2Base, (manifest: ManifestV2) => manifest.permissions!.push('tabs')],
@@ -62,10 +62,23 @@ function prepareAllManifest(flags: NormalizedFlags, computedFlags: ComputedFlags
             mv3Base,
             (manifest: ManifestV3) => {
                 manifest.host_permissions = (manifest as any).optional_host_permissions
+                delete (manifest as any).optional_host_permissions
                 manifest.background = { page: 'background.html' }
+                manifest.web_accessible_resources?.forEach(
+                    (x) => typeof x === 'object' && delete (x as any).use_dynamic_url,
+                )
+                delete manifest.key
+            },
+        ],
+        'safari-mv3': [
+            flags,
+            mv3Base,
+            (manifest: ManifestV3) => {
+                manifest.host_permissions = (manifest as any).optional_host_permissions
+                delete (manifest as any).optional_host_permissions
+                delete manifest.key
             },
         ],
-        'safari-mv3': [flags, mv3Base],
     }
     const manifest = new Map<NormalizedFlags['manifestFile'], ManifestV2 | ManifestV3>()
     for (const fileName in manifestFlags) {

packages/mask/background/services/site-adaptors/sdk.ts

@@ -1,3 +1,4 @@
+import { Sniffings } from '@masknet/shared-base'
 import { maskSDK_URL, injectUserScriptMV2, evaluateContentScript } from '../../utils/injectScript.js'
 
 export async function attachMaskSDKToCurrentActivePage(): Promise<boolean> {
@@ -17,12 +18,14 @@ async function attachMaskSDK2() {
     })
 }
 async function attachMaskSDK3(id: number) {
-    const [{ error }] = await browser.scripting.executeScript({
+    // TODO: Firefox MV3
+    const target = {
         target: { tabId: id },
         files: [maskSDK_URL],
-        // @ts-expect-error Chrome API
-        world: 'MAIN',
-    })
+        world: 'MAIN' as any,
+    }
+    if (Sniffings.is_firefox) delete target.world
+    const [{ error }] = await browser.scripting.executeScript(target)
     if (error) throw error
 }
 export async function developmentMaskSDKReload(): Promise<void> {

packages/mask/background/tasks/Cancellable/InjectContentScripts_declarative.ts

@@ -38,6 +38,7 @@ function prepareMainWorldScript(name: string, matches: string[], url: string): S
         runAt: 'document_start',
         matches,
     }
+    if (Sniffings.is_firefox) delete (result as any).world
     return [result]
 }
 
@@ -62,6 +63,10 @@ async function prepareContentScript(matches: string[]): Promise<Scripting.Regist
         runAt: 'document_idle',
         matches,
     }
-    if (globalThis.navigator?.userAgent.includes('Firefox')) return [xrayScript, content]
+    if (Sniffings.is_firefox) {
+        delete (xrayScript as any).world
+        delete (content as any).world
+        return [xrayScript, content]
+    }
     return [content]
 }

packages/mask/background/utils/injectScript.ts

@@ -1,3 +1,4 @@
+import { Sniffings } from '@masknet/shared-base'
 import { memoize } from 'lodash-es'
 
 export const injectedScriptURL = '/js/injected-script.js'
@@ -12,11 +13,13 @@ export async function evaluateContentScript(tabId: number | undefined, frameId?:
             tabId = activeTab[0].id
         }
         if (!tabId) return
-        await browser.scripting.executeScript({
+        const script = {
             target: { tabId, frameIds: frameId ? [frameId] : undefined },
             files: await fetchInjectContentScriptList(),
-            world: 'ISOLATED',
-        })
+            world: 'ISOLATED' as any,
+        }
+        if (Sniffings.is_firefox) delete script.world
+        await browser.scripting.executeScript(script)
     } else {
         for (const script of await fetchInjectContentScriptList()) {
             await browser.tabs.executeScript(tabId, {

packages/scripts/src/extension/ci.ts

@@ -15,7 +15,7 @@ export const ciBuild: TaskFunction = series(
     zipTo('MaskNetwork.chromium.zip', ManifestFile.ChromiumMV2),
     zipTo('MaskNetwork.firefox.zip', ManifestFile.FirefoxMV2, true),
     zipTo('MaskNetwork.firefox-mv3.zip', ManifestFile.FirefoxMV3, true),
-    zipTo('MaskNetwork.chromium-beta.zip', ManifestFile.ChromiumBetaMV2),
+    zipTo('MaskNetwork.chromium-beta.zip', ManifestFile.ChromiumBetaMV3),
     zipTo('MaskNetwork.chromium-mv3.zip', ManifestFile.ChromiumMV3),
 )
 export const buildChrome: TaskFunction = series(
@@ -33,7 +33,7 @@ function zipTo(
 ): TaskFunction {
     const f: TaskFunction = async () => {
         await copyFile(new URL(`manifest-${withManifestFile}.json`, BUILD_PATH), new URL('manifest.json', BUILD_PATH))
-        if (!reproducible && withManifestFile === ManifestFile.ChromiumBetaMV2) {
+        if (!reproducible && withManifestFile === ManifestFile.ChromiumBetaMV3) {
             await copyFile(new URL('build-info-beta.json', BUILD_PATH), new URL('build-info.json', BUILD_PATH))
         }
         const { cmd } = await import('web-ext')

packages/scripts/src/extension/dotenv.ts

@@ -30,7 +30,7 @@ export function parseManifest(manifest: '2' | '3' | 2 | 3 | undefined | Manifest
     if (manifest === 2 || manifest === '2') return ManifestFile.ChromiumMV2
     if (manifest === 3 || manifest === '3') return ManifestFile.ChromiumMV3
     if (typeof manifest === 'string') return manifest
-    return ManifestFile.ChromiumMV2
+    return ManifestFile.ChromiumMV3
 }
 function parseBoolean(val: string | undefined) {
     if (val === undefined) return undefined

packages/scripts/src/extension/normal.ts

@@ -25,7 +25,7 @@ export function buildExtensionFlag(name: string, args: BuildFlagsExtended): Task
     return f
 }
 export const buildBaseExtension: TaskFunction = buildExtensionFlag('default', {
-    manifestFile: ManifestFile.ChromiumMV2,
+    manifestFile: ManifestFile.ChromiumMV3,
     channel: 'stable',
     mode: 'production',
 })
@@ -40,7 +40,7 @@ export async function extensionWatch(f: Function | BuildFlagsExtended) {
     if (typeof f === 'function')
         return awaitChildProcess(
             webpack({
-                manifestFile: ManifestFile.ChromiumMV2,
+                manifestFile: ManifestFile.ChromiumMV3,
                 channel: 'stable',
                 mode: 'development',
             }),