Stop using XRay in Firefox (#2852)

* Testing firefox mv3 content-script injection * Fix some C-S-S paths for dev builds * Encode content script messages (objects are not supported in FF) * Revert the temporary makefile change (bundle contents is changed in C-S-S) * WIP: temporarily pin to a dev c-s-s branch * Bump C-S-S version * WIP temporary pin to a dev C-S-S branch * WIP Pin to a specific C-S-S commit * Bump c-s-s version --------- Co-authored-by: Sam Macbeth <[email protected]>
duckduckgo · Jan 9, 2025 · f4b3a62 · f4b3a62
1 parent 067acc9
commit f4b3a62
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 21 deletions.
diff --git a/Makefile b/Makefile
@@ -105,7 +105,7 @@ chrome-release-zip:
 .PHONY: chrome-release-zip
 
 chrome-beta-zip: prepare-chrome-beta chrome-release-zip
-	
+
 
 .PHONY: chrome-beta-zip
 
@@ -231,12 +231,12 @@ CONTENT_SCOPE_SCRIPTS = node_modules/@duckduckgo/content-scope-scripts
 CONTENT_SCOPE_SCRIPTS_DEPS =
 CONTENT_SCOPE_SCRIPTS_LOCALES_DEPS =
 ifneq ("$(wildcard $(CONTENT_SCOPE_SCRIPTS)/.git/)","")
-  CONTENT_SCOPE_SCRIPTS_DEPS += $(shell find $(CONTENT_SCOPE_SCRIPTS)/src $(CONTENT_SCOPE_SCRIPTS)/inject $(CONTENT_SCOPE_SCRIPTS)/scripts -type f -not -name "*~")
+  CONTENT_SCOPE_SCRIPTS_DEPS += $(shell find $(CONTENT_SCOPE_SCRIPTS)/injected/src $(CONTENT_SCOPE_SCRIPTS)/injected/entry-points $(CONTENT_SCOPE_SCRIPTS)/injected/scripts -type f -not -name "*~")
   CONTENT_SCOPE_SCRIPTS_DEPS += $(CONTENT_SCOPE_SCRIPTS)/package.json
   CONTENT_SCOPE_SCRIPTS_DEPS += $(CONTENT_SCOPE_SCRIPTS)/node_modules
   CONTENT_SCOPE_SCRIPTS_DEPS += $(CONTENT_SCOPE_SCRIPTS)/build/locales
 
-  CONTENT_SCOPE_SCRIPTS_LOCALES_DEPS += $(shell find $(CONTENT_SCOPE_SCRIPTS)/src/locales $(CONTENT_SCOPE_SCRIPTS)/scripts)
+  CONTENT_SCOPE_SCRIPTS_LOCALES_DEPS += $(shell find $(CONTENT_SCOPE_SCRIPTS)/injected/src/locales $(CONTENT_SCOPE_SCRIPTS)/injected/scripts)
   CONTENT_SCOPE_SCRIPTS_LOCALES_DEPS += $(CONTENT_SCOPE_SCRIPTS)/package.json
   CONTENT_SCOPE_SCRIPTS_LOCALES_DEPS += $(CONTENT_SCOPE_SCRIPTS)/node_modules
 endif
@@ -246,11 +246,11 @@ $(CONTENT_SCOPE_SCRIPTS)/node_modules: $(CONTENT_SCOPE_SCRIPTS)/package.json
 	touch $@
 
 $(CONTENT_SCOPE_SCRIPTS)/build/locales: $(CONTENT_SCOPE_SCRIPTS_LOCALES_DEPS)
-	cd $(CONTENT_SCOPE_SCRIPTS); npm run build-locales
+	cd $(CONTENT_SCOPE_SCRIPTS)/injected; npm run build-locales
 	touch $@
 
 $(CONTENT_SCOPE_SCRIPTS)/build/$(LEGACY_BROWSER)/inject.js: $(CONTENT_SCOPE_SCRIPTS_DEPS)
-	cd $(CONTENT_SCOPE_SCRIPTS); npm run build-$(LEGACY_BROWSER)
+	cd $(CONTENT_SCOPE_SCRIPTS)/injected; npm run build-$(LEGACY_BROWSER)
 
 $(BUILD_DIR)/public/js/inject.js: $(CONTENT_SCOPE_SCRIPTS)/build/$(LEGACY_BROWSER)/inject.js shared/data/bundled/tracker-lookup.json shared/data/bundled/extension-config.json
 	node scripts/bundleContentScopeScripts.mjs $@ $^
@@ -277,7 +277,7 @@ $(BUILD_DIR)/public/font/%: $(INTERMEDIATES_DIR)/%
 
 # Fetch fonts from the webserver to be included in the generated build
 .SECONDARY:
-$(INTERMEDIATES_DIR)/%: 
+$(INTERMEDIATES_DIR)/%:
 	curl -s -o $@ https://duckduckgo.com/font/all/`basename $@`
 
 ## Other

diff --git a/browsers/firefox/manifest.json b/browsers/firefox/manifest.json
@@ -48,6 +48,21 @@
             ],
             "match_about_blank": true,
             "all_frames": true,
+            "world": "ISOLATED",
+            "js": ["public/js/content-scripts/content-scope-messaging.js"],
+            "run_at": "document_start"
+        },
+        {
+            "matches": [
+                "<all_urls>"
+            ],
+            "exclude_matches": [
+                "*://localhost/*",
+                "*://*.localhost/*"
+            ],
+            "match_about_blank": true,
+            "all_frames": true,
+            "world": "MAIN",
             "js": [
                 "public/js/inject.js"
             ],
@@ -106,4 +121,4 @@
         "/public/css/autofill.css",
         "/public/font/*"
     ]
-}
+}
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -65,7 +65,7 @@
     },
     "dependencies": {
         "@duckduckgo/autofill": "github:duckduckgo/duckduckgo-autofill#15.1.0",
-        "@duckduckgo/content-scope-scripts": "github:duckduckgo/content-scope-scripts#6.44.0",
+        "@duckduckgo/content-scope-scripts": "github:duckduckgo/content-scope-scripts#7.3.0",
         "@duckduckgo/ddg2dnr": "file:packages/ddg2dnr",
         "@duckduckgo/jsbloom": "^1.0.2",
         "@duckduckgo/privacy-dashboard": "github:duckduckgo/privacy-dashboard#7.5.0",

diff --git a/shared/js/content-scripts/content-scope-messaging.js b/shared/js/content-scripts/content-scope-messaging.js
@@ -52,10 +52,10 @@ async function init() {
             // Init the content-scope-scripts with the argumentsObject.
             window.dispatchEvent(
                 new CustomEvent(secret, {
-                    detail: {
+                    detail: JSON.stringify({
                         type: 'register',
                         argumentsObject,
-                    },
+                    }),
                 }),
             );
         },
@@ -68,20 +68,21 @@ async function init() {
     // response.
     // Note: This event listener is only for Chrome MV3 builds of the extension,
     //       the equivalent Chrome MV2 event listener lives in
-    //       content-scope-scripts/inject/chrome.js.
+    //       content-scope-scripts/entry-points/chrome.js.
     window.addEventListener('sendMessageProxy' + secret, (event) => {
         event.stopImmediatePropagation();
 
         if (!(event instanceof CustomEvent) || !event?.detail) {
             return console.warn('no details in sendMessage proxy', event);
         }
 
-        const messageType = event.detail?.messageType;
+        const eventDetail = JSON.parse(event.detail);
+        const messageType = eventDetail.messageType;
         if (!allowedMessages.includes(messageType)) {
             return console.warn('Ignoring invalid sendMessage messageType', messageType);
         }
 
-        chrome.runtime.sendMessage(event.detail, (response) => {
+        chrome.runtime.sendMessage(eventDetail, (response) => {
             const message = {
                 type: 'update',
                 messageType: 'response',
@@ -91,7 +92,7 @@ async function init() {
 
             window.dispatchEvent(
                 new CustomEvent(secret, {
-                    detail: message,
+                    detail: JSON.stringify(message),
                 }),
             );
         });
@@ -100,7 +101,7 @@ async function init() {
     chrome.runtime.onMessage.addListener((message) => {
         window.dispatchEvent(
             new CustomEvent(secret, {
-                detail: message,
+                detail: JSON.stringify(message),
             }),
         );
     });