webext-messenger 0.15.0-4 → 0.16.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 } from "webext-detect-page";
+import { getContextName, isBackground } from "webext-detect-page";
 import { getActionForMessage, nameThisTarget } from "./thisTarget.js";
 export function isMessengerMessage(message) {
     return (isObject(message) &&
@@ -16,7 +16,7 @@ function onMessageListener(message, sender) {
         // TODO: Add test for this eventuality: ignore unrelated messages
         return;
     }
-    // Target check must be synchronous (`await` means we're handing the message)
+    // Target check must be synchronous (`await` means we're handling the message)
     const action = getActionForMessage(sender, message.target);
     if (action === "ignore") {
         return;
@@ -25,36 +25,39 @@ function onMessageListener(message, sender) {
 }
 // This function can only be called when the message *will* be handled locally.
 // Returning "undefined" or throwing an error will still handle it.
-async function handleMessage(message, sender, action) {
-    const { type, target, args, options: { trace } = {} } = message;
-    debug(type, "↘️ received", { sender, args });
+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 = {} } = message;
+    const { trace = [] } = options;
+    trace.push(sender);
+    const meta = { trace };
+    debug(type, "↘️ received", { sender, args, wasForwarded: trace.length > 1 });
     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 {
         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] };
+        debug(type, "➡️ will be handled here,", getContextName());
         handleMessage = async () => localHandler.apply(meta, args);
     }
-    return handleMessage()
-        .then((value) => ({ value }), (error) => ({
-        // Errors must be serialized because the stacktraces are currently lost on Chrome
+    const response = await handleMessage().then((value) => ({ value }), (error) => ({
+        // Errors must be serialized because the stack traces are currently lost on Chrome
         // and https://github.com/mozilla/webextension-polyfill/issues/210
         error: serializeError(error),
-    }))
-        .then((response) => {
-        debug(type, "↗️ responding", response);
-        return { ...response, __webextMessenger };
-    });
+    }));
+    debug(type, "↗️ responding", response);
+    return { ...response, __webextMessenger };
 }
 export function registerMethods(methods) {
-    void nameThisTarget();
+    if (!isBackground()) {
+        void nameThisTarget();
+    }
     for (const [type, method] of Object.entries(methods)) {
         if (handlers.has(type)) {
             throw new MessengerError(`Handler already set for ${type}`);

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.";
@@ -17,15 +17,15 @@ function makeMessage(type, args, target, options) {
     };
 }
 // Do not turn this into an `async` function; Notifications must turn `void`
-function manageConnection(type, options, sendMessage) {
+function manageConnection(type, options, target, sendMessage) {
     if (!options.isNotification) {
-        return manageMessage(type, sendMessage);
+        return manageMessage(type, target, sendMessage);
     }
     void sendMessage().catch((error) => {
         debug(type, "notification failed", { error });
     });
 }
-async function manageMessage(type, sendMessage) {
+async function manageMessage(type, target, sendMessage) {
     const response = await pRetry(async () => {
         const response = await sendMessage();
         if (!isMessengerResponse(response)) {
@@ -37,7 +37,9 @@ async function manageMessage(type, sendMessage) {
         factor: 1.3,
         maxRetryTime: 4000,
         onFailedAttempt(error) {
-            if (error instanceof MessengerError ||
+            if (
+            // Don't retry sending to the background page unless it really hasn't loaded yet
+            (target.page !== "background" && error instanceof MessengerError) ||
                 String(error.message).startsWith(errorNonExistingTarget)) {
                 debug(type, "will retry. Attempt", error.attemptNumber);
             }
@@ -56,7 +58,7 @@ async function manageMessage(type, 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");
@@ -68,11 +70,11 @@ function messenger(type, options, target, ...args) {
             debug(type, "↗️ sending message to runtime");
             return browser.runtime.sendMessage(makeMessage(type, args, target, options));
         };
-        return manageConnection(type, options, sendMessage);
+        return manageConnection(type, options, target, sendMessage);
     }
     // Contexts without direct Tab access must go through background
     if (!browser.tabs) {
-        return manageConnection(type, options, async () => {
+        return manageConnection(type, options, target, async () => {
             debug(type, "↗️ sending message to runtime");
             return browser.runtime.sendMessage(makeMessage(type, args, target, options));
         });
@@ -80,7 +82,7 @@ function messenger(type, options, target, ...args) {
     // `frameId` must be specified. If missing, the message is sent to every frame
     const { tabId, frameId = 0 } = target;
     // Message tab directly
-    return manageConnection(type, options, async () => {
+    return manageConnection(type, options, target, async () => {
         debug(type, "↗️ sending message to tab", tabId, "frame", frameId);
         return browser.tabs.sendMessage(tabId, makeMessage(type, args, target, options), {
             frameId,

package/distribution/thisTarget.d.ts

@@ -1,9 +1,4 @@
-import { MessengerMeta, Sender } from "./types.js";
-interface AnyTarget {
-    tabId?: number | "this";
-    frameId?: number;
-    page?: string;
-}
+import { AnyTarget, MessengerMeta, Sender } from "./types.js";
 export declare function getActionForMessage(from: Sender, { ...to }: AnyTarget): "respond" | "forward" | "ignore";
 export declare function nameThisTarget(): Promise<void>;
 declare function __getTabData(this: MessengerMeta): AnyTarget;

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";
@@ -26,7 +26,7 @@ export function getActionForMessage(from, { ...to } // Clone object because we'r
         // If this *was* the target, then probably no one else answered
         return "ignore";
     }
-    // If requests "this" tab, then set it to allow the next condition
+    // Set "this" tab to the current tabId
     if (to.tabId === "this" && thisTarget.tabId === ((_a = from.tab) === null || _a === void 0 ? void 0 : _a.id)) {
         to.tabId = thisTarget.tabId;
     }
@@ -53,11 +53,11 @@ 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 (isBackground()) {
+        thisTarget = { page: "background" };
+    }
     if (isExtensionContext()) {
         // Any context can handler this message
         registerMethods({ __getTabData });
     }
-    if (isBackgroundPage()) {
-        thisTarget = { page: "background" };
-    }
 }

package/distribution/types.d.ts

@@ -45,6 +45,11 @@ export declare type MessengerMessage = Message & {
     /** Guarantees that a message is meant to be handled by this library */
     __webextMessenger: true;
 };
+export interface AnyTarget {
+    tabId?: number | "this";
+    frameId?: number;
+    page?: string;
+}
 export interface Target {
     tabId: number;
     frameId?: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "webext-messenger",
-  "version": "0.15.0-4",
+  "version": "0.16.0",
   "description": "Browser Extension component messaging framework",
   "keywords": [],
   "repository": "pixiebrix/webext-messenger",
@@ -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,