webext-messenger 0.14.0 → 0.15.0-2

package/distribution/index.d.ts

@@ -1,3 +1,3 @@
-export { registerMethods } from "./receiver.js";
-export { messenger, getMethod, getNotifier, backgroundTarget, } from "./sender.js";
-export { MessengerMeta, Target } from "./types.js";
+export * from "./receiver.js";
+export * from "./sender.js";
+export * from "./types.js";

package/distribution/index.js

@@ -1,2 +1,10 @@
-export { registerMethods } from "./receiver.js";
-export { messenger, getMethod, getNotifier, backgroundTarget, } from "./sender.js";
+// Imports must use the .js extension because of ESM requires it and TS refuses to rewrite .ts to .js
+// This works in TS even if the .js doesn't exist, but it breaks Parcel (the tests builder)
+// For this reason, there's an `alias` field in package.json to redirect these imports.
+// If you see "@parcel/resolver-default: Cannot load file './yourNewFile.js'" you need to add it to the `alias` list
+// 🥲
+export * from "./receiver.js";
+export * from "./sender.js";
+export * from "./types.js";
+import { initPrivateApi } from "./thisTarget.js";
+initPrivateApi();

package/distribution/receiver.js

@@ -1,7 +1,9 @@
 import browser from "webextension-polyfill";
 import { serializeError } from "serialize-error";
 import { messenger } from "./sender.js";
-import { handlers, isObject, MessengerError, debug, warn, __webextMessenger, } from "./shared.js";
+import { handlers, isObject, MessengerError, debug, __webextMessenger, } from "./shared.js";
+import { getContextName } from "webext-detect-page";
+import { getActionForMessage, nameThisTarget } from "./thisTarget.js";
 export function isMessengerMessage(message) {
     return (isObject(message) &&
         typeof message["type"] === "string" &&
@@ -14,21 +16,27 @@ function onMessageListener(message, sender) {
         // TODO: Add test for this eventuality: ignore unrelated messages
         return;
     }
-    const { type, target, args } = message;
+    // Target check must be synchronous (`await` means we're handing the message)
+    const action = getActionForMessage(message.target);
+    if (action === "ignore") {
+        return;
+    }
+    return handleMessage(message, sender, action);
+}
+// 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 });
     let handleMessage;
-    if (target) {
-        if (!browser.tabs) {
-            throw new MessengerError(`Message ${type} sent to wrong context, it can't be forwarded to ${JSON.stringify(target)}`);
-        }
+    if (action === "forward") {
         debug(type, "🔀 forwarded", { sender, target });
-        handleMessage = async () => messenger(type, {}, target, ...args);
+        handleMessage = async () => messenger(type, { trace }, target, ...args);
     }
     else {
         const localHandler = handlers.get(type);
         if (!localHandler) {
-            warn(type, "⚠️ ignored, can't be handled here");
-            return;
+            throw new MessengerError(`No handler registered for ${type} in ${getContextName()}`);
         }
         debug(type, "➡️ will be handled here");
         const meta = { trace: [sender] };
@@ -46,6 +54,7 @@ function onMessageListener(message, sender) {
     });
 }
 export function registerMethods(methods) {
+    void nameThisTarget();
     for (const [type, method] of Object.entries(methods)) {
         if (handlers.has(type)) {
             throw new MessengerError(`Handler already set for ${type}`);
@@ -53,10 +62,5 @@ export function registerMethods(methods) {
         console.debug("Messenger: Registered", type);
         handlers.set(type, method);
     }
-    if ("browser" in globalThis) {
-        browser.runtime.onMessage.addListener(onMessageListener);
-    }
-    else {
-        throw new Error("`webext-messenger` requires `webextension");
-    }
+    browser.runtime.onMessage.addListener(onMessageListener);
 }

package/distribution/sender.d.ts

@@ -4,7 +4,7 @@ export declare const errorNonExistingTarget = "Could not establish connection. R
 declare function messenger<Type extends keyof MessengerMethods, Method extends MessengerMethods[Type]>(type: Type, options: {
     isNotification: true;
 }, target: Target | PageTarget, ...args: Parameters<Method>): void;
-declare function messenger<Type extends keyof MessengerMethods, Method extends MessengerMethods[Type], ReturnValue extends ReturnType<Method>>(type: Type, options: Options, target: Target | PageTarget, ...args: Parameters<Method>): ReturnValue;
+declare function messenger<Type extends keyof MessengerMethods, Method extends MessengerMethods[Type], ReturnValue extends Promise<ReturnType<Method>>>(type: Type, options: Options, target: Target | PageTarget, ...args: Parameters<Method>): ReturnValue;
 declare function getMethod<Type extends keyof MessengerMethods, Method extends MessengerMethods[Type], PublicMethodType extends PublicMethod<Method>>(type: Type, target: Target | PageTarget): PublicMethodType;
 declare function getMethod<Type extends keyof MessengerMethods, Method extends MessengerMethods[Type], PublicMethodWithDynamicTarget extends PublicMethodWithTarget<Method>>(type: Type): PublicMethodWithDynamicTarget;
 declare function getNotifier<Type extends keyof MessengerMethods, Method extends MessengerMethods[Type], PublicMethodType extends SetReturnType<PublicMethod<Method>, void>>(type: Type, target: Target | PageTarget): PublicMethodType;

package/distribution/sender.js

@@ -7,12 +7,13 @@ export const errorNonExistingTarget = "Could not establish connection. Receiving
 function isMessengerResponse(response) {
     return isObject(response) && response["__webextMessenger"] === true;
 }
-function makeMessage(type, args, target) {
+function makeMessage(type, args, target, options) {
     return {
         __webextMessenger,
         type,
         args,
         target,
+        options,
     };
 }
 // Do not turn this into an `async` function; Notifications must turn `void`
@@ -25,20 +26,26 @@ function manageConnection(type, options, sendMessage) {
     });
 }
 async function manageMessage(type, sendMessage) {
-    const response = await pRetry(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 === null || error === void 0 ? void 0 : error.message).startsWith(errorNonExistingTarget)) {
+            if (error instanceof MessengerError ||
+                String(error.message).startsWith(errorNonExistingTarget)) {
+                debug(type, "will retry. Attempt", error.attemptNumber);
+            }
+            else {
                 throw error;
             }
-            debug(type, "will retry");
         },
     });
-    if (!isMessengerResponse(response)) {
-        throw new MessengerError(`No handler for ${type} was registered in the receiving end`);
-    }
     if ("error" in response) {
         debug(type, "↘️ replied with error", response.error);
         throw deserializeError(response.error);
@@ -47,6 +54,7 @@ async function manageMessage(type, sendMessage) {
     return response.value;
 }
 function messenger(type, options, target, ...args) {
+    // Message goes to extension page
     if ("page" in target) {
         if (target.page === "background" && isBackgroundPage()) {
             const handler = handlers.get(type);
@@ -58,7 +66,7 @@ function messenger(type, options, target, ...args) {
         }
         const sendMessage = async () => {
             debug(type, "↗️ sending message to runtime");
-            return browser.runtime.sendMessage(makeMessage(type, args));
+            return browser.runtime.sendMessage(makeMessage(type, args, target, options));
         };
         return manageConnection(type, options, sendMessage);
     }
@@ -66,7 +74,7 @@ function messenger(type, options, target, ...args) {
     if (!browser.tabs) {
         return manageConnection(type, options, async () => {
             debug(type, "↗️ sending message to runtime");
-            return browser.runtime.sendMessage(makeMessage(type, args, target));
+            return browser.runtime.sendMessage(makeMessage(type, args, target, options));
         });
     }
     // `frameId` must be specified. If missing, the message is sent to every frame
@@ -74,7 +82,7 @@ function messenger(type, options, target, ...args) {
     // Message tab directly
     return manageConnection(type, options, async () => {
         debug(type, "↗️ sending message to tab", tabId, "frame", frameId);
-        return browser.tabs.sendMessage(tabId, makeMessage(type, args), {
+        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

@@ -0,0 +1,12 @@
+import { Target, PageTarget, MessengerMeta } from "./types.js";
+declare type AnyTarget = Partial<Target & PageTarget>;
+export declare function getActionForMessage(target: AnyTarget): "respond" | "forward" | "ignore";
+export declare function nameThisTarget(): Promise<void>;
+declare function __getTabData(this: MessengerMeta): AnyTarget;
+declare global {
+    interface MessengerMethods {
+        __getTabData: typeof __getTabData;
+    }
+}
+export declare function initPrivateApi(): void;
+export {};

package/distribution/thisTarget.js

@@ -0,0 +1,53 @@
+import { isBackgroundPage, isContentScript } from "webext-detect-page";
+import { messenger } from "./sender.js";
+import { registerMethods } from "./receiver.js";
+import { debug } from "./shared.js";
+// Soft warning: Race conditions are possible.
+// 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") {
+        return "respond";
+    }
+    // Content scripts only receive messages that are meant for them. In the future
+    // they'll also forward them, but that still means they need to be handled here.
+    if (isContentScript()) {
+        return "respond";
+    }
+    // We're in an extension page, but the target is not one.
+    if (!("page" in target)) {
+        return "forward";
+    }
+    if (!thisTarget) {
+        console.warn("A message was received before this context was ready");
+        // If this *was* the target, then probably no one else answered
+        return "ignore";
+    }
+    // Every `target` key must match `thisTarget`
+    const isThisTarget = Object.entries(target).every(
+    // @ts-expect-error Optional properties
+    ([key, value]) => thisTarget[key] === value);
+    if (!isThisTarget) {
+        debug("The message’s target is", target, "but this is", thisTarget);
+    }
+    return isThisTarget ? "respond" : "ignore";
+}
+export async function nameThisTarget() {
+    // Same as above: CS receives messages correctly
+    if (!thisTarget && !isContentScript()) {
+        thisTarget = await messenger("__getTabData", {}, { page: "any" });
+        thisTarget.page = location.pathname;
+    }
+}
+function __getTabData() {
+    var _a, _b, _c;
+    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()) {
+        thisTarget = { page: "background" };
+        registerMethods({ __getTabData });
+    }
+}

package/distribution/types.d.ts

@@ -6,13 +6,13 @@ declare global {
         _: Method;
     }
 }
-declare type WithTarget<Method> = Method extends (...args: infer PreviousArguments) => infer TReturnValue ? (target: Target, ...args: PreviousArguments) => TReturnValue : never;
+declare type WithTarget<Method> = Method extends (...args: infer PreviousArguments) => infer TReturnValue ? (target: Target | PageTarget, ...args: PreviousArguments) => TReturnValue : never;
 declare type ActuallyOmitThisParameter<T> = T extends (...args: infer A) => infer R ? (...args: A) => R : T;
 /** Removes the `this` type and ensure it's always Promised */
 export declare type PublicMethod<Method extends ValueOf<MessengerMethods>> = Asyncify<ActuallyOmitThisParameter<Method>>;
 export declare type PublicMethodWithTarget<Method extends ValueOf<MessengerMethods>> = WithTarget<PublicMethod<Method>>;
 export interface MessengerMeta {
-    trace: Runtime.MessageSender[];
+    trace: Sender[];
 }
 declare type RawMessengerResponse = {
     value: unknown;
@@ -31,15 +31,16 @@ export interface Options {
      * @default false
      */
     isNotification?: boolean;
+    trace?: Sender[];
 }
 export declare type Message<LocalArguments extends Arguments = Arguments> = {
     type: keyof MessengerMethods;
     args: LocalArguments;
-    /** If the message is being sent to an intermediary receiver, also set the target */
-    target?: Target;
+    target: Target | PageTarget;
     /** If the message is being sent to an intermediary receiver, also set the options */
-    options?: Target;
+    options?: Options;
 };
+export declare type Sender = Runtime.MessageSender;
 export declare type MessengerMessage = Message & {
     /** Guarantees that a message is meant to be handled by this library */
     __webextMessenger: true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "webext-messenger",
-  "version": "0.14.0",
+  "version": "0.15.0-2",
   "description": "Browser Extension component messaging framework",
   "keywords": [],
   "repository": "pixiebrix/webext-messenger",
@@ -13,12 +13,13 @@
     "./source/sender.js": "./source/sender.ts",
     "./source/receiver.js": "./source/receiver.ts",
     "./source/types.js": "./source/types.ts",
-    "./source/shared.js": "./source/shared.ts"
+    "./source/shared.js": "./source/shared.ts",
+    "./source/thisTarget.js": "./source/thisTarget.ts"
   },
   "scripts": {
     "build": "tsc",
-    "demo:watch": "parcel watch --no-cache --no-hmr --detailed-report 0",
-    "demo:build": "parcel build --no-cache --detailed-report 0",
+    "demo:watch": "parcel watch --no-cache --no-hmr",
+    "demo:build": "parcel build --no-cache",
     "prepack": "tsc --sourceMap false",
     "test": "eslint . && tsc --noEmit",
     "lint": "eslint .",
@@ -45,6 +46,21 @@
       "plugin:unicorn/recommended"
     ],
     "rules": {
+      "no-restricted-imports": [
+        "error",
+        {
+          "paths": [
+            {
+              "name": "./index",
+              "message": "The index file is only used to re-export internal files. Use direct imports instead."
+            }
+          ]
+        }
+      ],
+      "import/extensions": [
+        "error",
+        "always"
+      ],
       "import/no-unresolved": "off",
       "unicorn/filename-case": [
         "error",
@@ -77,34 +93,43 @@
           "@typescript-eslint/no-explicit-any": "off",
           "@typescript-eslint/no-unsafe-member-access": "off"
         }
+      },
+      {
+        "files": [
+          "source/test/**/*"
+        ],
+        "rules": {
+          "import/extensions": "off"
+        }
       }
     ]
   },
   "dependencies": {
-    "p-retry": "^4.6.1",
-    "serialize-error": "^8.1.0",
-    "type-fest": "^2.5.1",
-    "webext-detect-page": "^3.0.2",
+    "p-retry": "^5.0.0",
+    "serialize-error": "^9.0.0",
+    "type-fest": "^2.6.0",
+    "webext-detect-page": "^3.1.0",
     "webextension-polyfill": "^0.8.0"
   },
   "devDependencies": {
-    "@parcel/config-webextension": "^2.0.0",
+    "@parcel/config-webextension": "^2.0.1",
     "@sindresorhus/tsconfig": "^2.0.0",
-    "@types/chrome": "^0.0.159",
-    "@types/webextension-polyfill": "^0.8.0",
-    "@typescript-eslint/eslint-plugin": "^5.1.0",
-    "@typescript-eslint/parser": "^5.1.0",
-    "eslint": "^8.1.0",
+    "@types/chrome": "^0.0.164",
+    "@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",
     "eslint-config-prettier": "^8.3.0",
     "eslint-config-xo": "^0.39.0",
-    "eslint-config-xo-typescript": "^0.45.2",
-    "eslint-plugin-import": "^2.25.2",
-    "eslint-plugin-unicorn": "^37.0.1",
-    "fresh-tape": "^5.3.1",
+    "eslint-config-xo-typescript": "^0.47.1",
+    "eslint-plugin-import": "^2.25.3",
+    "eslint-plugin-unicorn": "^39.0.0",
     "npm-run-all": "^4.1.5",
-    "parcel": "^2.0.0",
-    "typescript": "^4.4.4",
-    "xo": "^0.45.0"
+    "parcel": "^2.0.1",
+    "tape": "^5.3.2",
+    "typescript": "^4.5.2",
+    "webext-content-scripts": "^0.10.1"
   },
   "targets": {
     "main": false,

package/distribution/namedTargets.d.ts

@@ -1,14 +0,0 @@
-/// <reference types="firefox-webext-browser" />
-import { NamedTarget, Target, MessengerMeta } from "./types.js";
-declare global {
-    interface MessengerMethods {
-        __webextMessengerTargetRegistration: typeof _registerTarget;
-    }
-}
-export declare function resolveNamedTarget(target: NamedTarget, sender?: browser.runtime.MessageSender): Target;
-export declare const targets: Map<string, Target>;
-/** Register the current context so that it can be targeted with a name */
-export declare const registerTarget: (name: string) => Promise<void>;
-declare function _registerTarget(this: MessengerMeta, name: string): Promise<void>;
-export declare function initTargets(): void;
-export {};

package/distribution/namedTargets.js

@@ -1,40 +0,0 @@
-import { isBackgroundPage } from "webext-detect-page";
-import { errorNonExistingTarget, getMethod } from "./sender.js";
-import { registerMethods } from "./receiver.js";
-export function resolveNamedTarget(target, sender) {
-    var _a;
-    if (!isBackgroundPage()) {
-        throw new Error("Named targets can only be resolved in the background page");
-    }
-    const { name, tabId = (_a = sender === null || sender === void 0 ? void 0 : sender.tab) === null || _a === void 0 ? void 0 : _a.id, // If not specified, try to use the sender’s
-     } = target;
-    if (typeof tabId === "undefined") {
-        throw new TypeError(`${errorNonExistingTarget} The tab ID was not specified nor it was automatically determinable.`);
-    }
-    const resolvedTarget = targets.get(`${tabId}%${name}`);
-    if (!resolvedTarget) {
-        throw new Error(`${errorNonExistingTarget} Target named ${name} not registered for tab ${tabId}.`);
-    }
-    return resolvedTarget;
-}
-// TODO: Remove targets after tab closes to avoid "memory leaks"
-export const targets = new Map();
-/** Register the current context so that it can be targeted with a name */
-export const registerTarget = getMethod("__webextMessengerTargetRegistration");
-async function _registerTarget(name) {
-    const sender = this.trace[0];
-    const tabId = sender.tab.id;
-    const { frameId } = sender;
-    targets.set(`${tabId}%${name}`, {
-        tabId,
-        frameId,
-    });
-    console.debug(`Messenger: Target "${name}" registered for tab ${tabId}`);
-}
-export function initTargets() {
-    if (isBackgroundPage()) {
-        registerMethods({
-            __webextMessengerTargetRegistration: _registerTarget,
-        });
-    }
-}