webext-messenger 0.15.0-1 → 0.15.0-5

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, isBackgroundPage } from "webext-detect-page";
 import { getActionForMessage, nameThisTarget } from "./thisTarget.js";
 export function isMessengerMessage(message) {
     return (isObject(message) &&
@@ -17,7 +17,7 @@ function onMessageListener(message, sender) {
         return;
     }
     // Target check must be synchronous (`await` means we're handing the message)
-    const action = getActionForMessage(message.target);
+    const action = getActionForMessage(sender, message.target);
     if (action === "ignore") {
         return;
     }
@@ -25,7 +25,9 @@ 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) {
+async function handleMessage(message, sender, 
+// Once messages reach handleMessage they cannot be "ignored", they're already being handled
+action) {
     const { type, target, args, options: { trace } = {} } = message;
     debug(type, "↘️ received", { sender, args });
     let handleMessage;
@@ -54,7 +56,9 @@ async function handleMessage(message, sender, action) {
     });
 }
 export function registerMethods(methods) {
-    void nameThisTarget();
+    if (!isBackgroundPage()) {
+        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

@@ -17,29 +17,37 @@ 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) {
-    const response = await pRetry(sendMessage, {
+async function manageMessage(type, target, sendMessage) {
+    const response = await pRetry(async () => {
+        const response = await sendMessage();
+        if (!isMessengerResponse(response)) {
+            throw new MessengerError(`No handler registered for ${type} in the receiving end`);
+        }
+        return response;
+    }, {
         minTimeout: 100,
         factor: 1.3,
         maxRetryTime: 4000,
         onFailedAttempt(error) {
-            if (!String(error.message).startsWith(errorNonExistingTarget)) {
+            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);
+            }
+            else {
                 throw error;
             }
-            debug(type, "will retry. Attempt", error.attemptNumber);
         },
     });
-    if (!isMessengerResponse(response)) {
-        throw new MessengerError(`No handler registered for ${type} in the receiving end`);
-    }
     if ("error" in response) {
         debug(type, "↘️ replied with error", response.error);
         throw deserializeError(response.error);
@@ -62,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));
         });
@@ -74,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/shared.d.ts

@@ -1,4 +1,11 @@
+import { JsonObject } from "type-fest";
 import { Method } from "./types.js";
+declare type ErrorObject = {
+    name?: string;
+    stack?: string;
+    message?: string;
+    code?: string;
+} & JsonObject;
 export declare const __webextMessenger = true;
 export declare function isObject(value: unknown): value is Record<string, unknown>;
 export declare class MessengerError extends Error {
@@ -7,3 +14,6 @@ export declare class MessengerError extends Error {
 export declare const handlers: Map<string, Method>;
 export declare const debug: (...args: any[]) => void;
 export declare const warn: (...args: any[]) => void;
+export declare function isErrorObject(error: unknown): error is ErrorObject;
+export declare function delay(milliseconds: number): Promise<void>;
+export {};

package/distribution/shared.js

@@ -17,3 +17,13 @@ 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 function isErrorObject(error) {
+    var _a;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any -- This is a type guard function and it uses ?.
+    return typeof ((_a = error) === null || _a === void 0 ? void 0 : _a.message) === "string";
+}
+export async function delay(milliseconds) {
+    return new Promise((resolve) => {
+        setTimeout(resolve, milliseconds);
+    });
+}

package/distribution/thisTarget.d.ts

@@ -1,6 +1,5 @@
-import { Target, PageTarget, MessengerMeta } from "./types.js";
-declare type AnyTarget = Partial<Target & PageTarget>;
-export declare function getActionForMessage(target: AnyTarget): "respond" | "forward" | "ignore";
+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;
 declare global {

package/distribution/thisTarget.js

@@ -1,4 +1,4 @@
-import { isBackgroundPage, isContentScript } from "webext-detect-page";
+import { isBackgroundPage, isContentScript, isExtensionContext, } from "webext-detect-page";
 import { messenger } from "./sender.js";
 import { registerMethods } from "./receiver.js";
 import { debug } from "./shared.js";
@@ -6,9 +6,10 @@ 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;
-//
-export function getActionForMessage(target) {
-    if (target.page === "any") {
+export function getActionForMessage(from, { ...to } // Clone object because we're editing it
+) {
+    var _a;
+    if (to.page === "any") {
         return "respond";
     }
     // Content scripts only receive messages that are meant for them. In the future
@@ -17,7 +18,7 @@ export function getActionForMessage(target) {
         return "respond";
     }
     // We're in an extension page, but the target is not one.
-    if (!("page" in target)) {
+    if (!to.page) {
         return "forward";
     }
     if (!thisTarget) {
@@ -25,18 +26,24 @@ export function getActionForMessage(target) {
         // 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
+    if (to.tabId === "this" && thisTarget.tabId === ((_a = from.tab) === null || _a === void 0 ? void 0 : _a.id)) {
+        to.tabId = thisTarget.tabId;
+    }
     // Every `target` key must match `thisTarget`
-    const isThisTarget = Object.entries(target).every(
+    const isThisTarget = Object.entries(to).every(
     // @ts-expect-error Optional properties
     ([key, value]) => thisTarget[key] === value);
     if (!isThisTarget) {
-        debug("The message’s target is", target, "but this is", thisTarget);
+        debug("The message’s target is", to, "but this is", thisTarget);
     }
     return isThisTarget ? "respond" : "ignore";
 }
+let nameRequested = false;
 export async function nameThisTarget() {
     // Same as above: CS receives messages correctly
-    if (!thisTarget && !isContentScript()) {
+    if (!nameRequested && !thisTarget && !isContentScript()) {
+        nameRequested = true;
         thisTarget = await messenger("__getTabData", {}, { page: "any" });
         thisTarget.page = location.pathname;
     }
@@ -48,6 +55,9 @@ function __getTabData() {
 export function initPrivateApi() {
     if (isBackgroundPage()) {
         thisTarget = { page: "background" };
+    }
+    if (isExtensionContext()) {
+        // Any context can handler this message
         registerMethods({ __getTabData });
     }
 }

package/distribution/types.d.ts

@@ -45,12 +45,17 @@ 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;
 }
 export interface PageTarget {
-    tabId?: number;
+    tabId?: number | "this";
     page: string;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "webext-messenger",
-  "version": "0.15.0-1",
+  "version": "0.15.0-5",
   "description": "Browser Extension component messaging framework",
   "keywords": [],
   "repository": "pixiebrix/webext-messenger",