webext-messenger 0.15.0 → 0.17.0

package/distribution/receiver.js

@@ -2,7 +2,7 @@ import browser from "webextension-polyfill";
 import { serializeError } from "serialize-error";
 import { messenger } from "./sender.js";
 import { handlers, isObject, MessengerError, debug, __webextMessenger, } from "./shared.js";
-import { getContextName, isBackgroundPage } from "webext-detect-page";
+import { getContextName, isBackground } from "webext-detect-page";
 import { getActionForMessage, nameThisTarget } from "./thisTarget.js";
 export function isMessengerMessage(message) {
     return (isObject(message) &&
@@ -28,20 +28,25 @@ function onMessageListener(message, sender) {
 async function handleMessage(message, sender, 
 // Once messages reach this function they cannot be "ignored", they're already being handled
 action) {
-    const { type, target, args, options: { trace } = {} } = message;
-    debug(type, "↘️ received", { sender, args });
+    const { type, target, args, options = {} } = message;
+    const { trace = [] } = options;
+    trace.push(sender);
+    const meta = { trace };
     let handleMessage;
     if (action === "forward") {
         debug(type, "🔀 forwarded", { sender, target });
-        handleMessage = async () => messenger(type, { trace }, target, ...args);
+        handleMessage = async () => messenger(type, meta, target, ...args);
     }
     else {
+        debug(type, "↘️ received in", getContextName(), {
+            sender,
+            args,
+            wasForwarded: trace.length > 1,
+        });
         const localHandler = handlers.get(type);
         if (!localHandler) {
             throw new MessengerError(`No handler registered for ${type} in ${getContextName()}`);
         }
-        debug(type, "➡️ will be handled here");
-        const meta = { trace: [sender] };
         handleMessage = async () => localHandler.apply(meta, args);
     }
     const response = await handleMessage().then((value) => ({ value }), (error) => ({
@@ -53,14 +58,14 @@ action) {
     return { ...response, __webextMessenger };
 }
 export function registerMethods(methods) {
-    if (!isBackgroundPage()) {
+    if (!isBackground()) {
         void nameThisTarget();
     }
     for (const [type, method] of Object.entries(methods)) {
         if (handlers.has(type)) {
             throw new MessengerError(`Handler already set for ${type}`);
         }
-        console.debug("Messenger: Registered", type);
+        debug("Registered", type);
         handlers.set(type, method);
     }
     browser.runtime.onMessage.addListener(onMessageListener);

package/distribution/sender.js

@@ -1,6 +1,6 @@
 import browser from "webextension-polyfill";
 import pRetry from "p-retry";
-import { isBackgroundPage } from "webext-detect-page";
+import { isBackground } from "webext-detect-page";
 import { deserializeError } from "serialize-error";
 import { isObject, MessengerError, __webextMessenger, handlers, debug, warn, } from "./shared.js";
 export const errorNonExistingTarget = "Could not establish connection. Receiving end does not exist.";
@@ -58,7 +58,7 @@ async function manageMessage(type, target, sendMessage) {
 function messenger(type, options, target, ...args) {
     // Message goes to extension page
     if ("page" in target) {
-        if (target.page === "background" && isBackgroundPage()) {
+        if (target.page === "background" && isBackground()) {
             const handler = handlers.get(type);
             if (handler) {
                 warn(type, "is being handled locally");

package/distribution/shared.js

@@ -1,3 +1,15 @@
+const logging = (() => {
+    try {
+        // @ts-expect-error it would break Webpack
+        return process.env.WEBEXT_MESSENGER_LOGGING === "true";
+    }
+    catch {
+        return false;
+    }
+})();
+function noop() {
+    /* */
+}
 export const __webextMessenger = true;
 export function isObject(value) {
     return typeof value === "object" && value !== null;
@@ -15,8 +27,8 @@ export class MessengerError extends Error {
 }
 export const handlers = new Map();
 // .bind preserves the call location in the console
-export const debug = console.debug.bind(console, "Messenger:");
-export const warn = console.warn.bind(console, "Messenger:");
+export const debug = logging ? console.debug.bind(console, "Messenger:") : noop;
+export const warn = logging ? console.warn.bind(console, "Messenger:") : noop;
 export function isErrorObject(error) {
     var _a;
     // eslint-disable-next-line @typescript-eslint/no-explicit-any -- This is a type guard function and it uses ?.

package/distribution/thisTarget.js

@@ -1,4 +1,4 @@
-import { isBackgroundPage, isContentScript, isExtensionContext, } from "webext-detect-page";
+import { isBackground, isContentScript, isExtensionContext, } from "webext-detect-page";
 import { messenger } from "./sender.js";
 import { registerMethods } from "./receiver.js";
 import { debug } from "./shared.js";
@@ -6,6 +6,27 @@ import { debug } from "./shared.js";
 // This CANNOT be awaited because waiting for it means "I will handle the message."
 // If a message is received before this is ready, it will just have to be ignored.
 let thisTarget;
+function compareTargets(to, thisTarget) {
+    for (const [key, value] of Object.entries(to)) {
+        if (thisTarget[key] === value) {
+            continue;
+        }
+        if (key !== "page") {
+            return false;
+        }
+        const toUrl = new URL(to.page, location.origin);
+        const thisUrl = new URL(thisTarget.page, location.origin);
+        if (toUrl.pathname !== thisUrl.pathname) {
+            return false;
+        }
+        for (const [parameterKey, parameterValue] of toUrl.searchParams) {
+            if (thisUrl.searchParams.get(parameterKey) !== parameterValue) {
+                return false;
+            }
+        }
+    }
+    return true;
+}
 export function getActionForMessage(from, { ...to } // Clone object because we're editing it
 ) {
     var _a;
@@ -31,9 +52,7 @@ export function getActionForMessage(from, { ...to } // Clone object because we'r
         to.tabId = thisTarget.tabId;
     }
     // Every `target` key must match `thisTarget`
-    const isThisTarget = Object.entries(to).every(
-    // @ts-expect-error Optional properties
-    ([key, value]) => thisTarget[key] === value);
+    const isThisTarget = compareTargets(to, thisTarget);
     if (!isThisTarget) {
         debug("The message’s target is", to, "but this is", thisTarget);
     }
@@ -45,7 +64,7 @@ export async function nameThisTarget() {
     if (!nameRequested && !thisTarget && !isContentScript()) {
         nameRequested = true;
         thisTarget = await messenger("__getTabData", {}, { page: "any" });
-        thisTarget.page = location.pathname;
+        thisTarget.page = location.pathname + location.search;
     }
 }
 function __getTabData() {
@@ -53,7 +72,7 @@ function __getTabData() {
     return { tabId: (_b = (_a = this.trace[0]) === null || _a === void 0 ? void 0 : _a.tab) === null || _b === void 0 ? void 0 : _b.id, frameId: (_c = this.trace[0]) === null || _c === void 0 ? void 0 : _c.frameId };
 }
 export function initPrivateApi() {
-    if (isBackgroundPage()) {
+    if (isBackground()) {
         thisTarget = { page: "background" };
     }
     if (isExtensionContext()) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "webext-messenger",
-  "version": "0.15.0",
+  "version": "0.17.0",
   "description": "Browser Extension component messaging framework",
   "keywords": [],
   "repository": "pixiebrix/webext-messenger",
@@ -18,7 +18,7 @@
   },
   "scripts": {
     "build": "tsc",
-    "demo:watch": "parcel watch --no-cache --no-hmr",
+    "demo:watch": "WEBEXT_MESSENGER_LOGGING=true parcel watch --no-cache --no-hmr",
     "demo:build": "parcel build --no-cache",
     "prepack": "tsc --sourceMap false",
     "test": "eslint . && tsc --noEmit",
@@ -107,19 +107,19 @@
   "dependencies": {
     "p-retry": "^5.0.0",
     "serialize-error": "^9.0.0",
-    "type-fest": "^2.6.0",
-    "webext-detect-page": "^3.1.0",
+    "type-fest": "^2.8.0",
+    "webext-detect-page": "^4.0.0",
     "webextension-polyfill": "^0.8.0"
   },
   "devDependencies": {
     "@parcel/config-webextension": "^2.0.1",
     "@sindresorhus/tsconfig": "^2.0.0",
-    "@types/chrome": "^0.0.164",
+    "@types/chrome": "^0.0.171",
     "@types/tape": "^4.13.2",
     "@types/webextension-polyfill": "^0.8.2",
-    "@typescript-eslint/eslint-plugin": "^5.4.0",
-    "@typescript-eslint/parser": "^5.4.0",
-    "eslint": "^8.3.0",
+    "@typescript-eslint/eslint-plugin": "^5.7.0",
+    "@typescript-eslint/parser": "^5.7.0",
+    "eslint": "^8.4.1",
     "eslint-config-prettier": "^8.3.0",
     "eslint-config-xo": "^0.39.0",
     "eslint-config-xo-typescript": "^0.47.1",
@@ -128,8 +128,8 @@
     "npm-run-all": "^4.1.5",
     "parcel": "^2.0.1",
     "tape": "^5.3.2",
-    "typescript": "^4.5.2",
-    "webext-content-scripts": "^0.10.1"
+    "typescript": "^4.5.4",
+    "webext-content-scripts": "^0.12.0"
   },
   "targets": {
     "main": false,