webext-messenger 0.15.0-0 → 0.15.0-4

package/distribution/index.js

@@ -1,5 +1,10 @@
+// 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";
+import { initPrivateApi } from "./thisTarget.js";
 initPrivateApi();

package/distribution/receiver.js

@@ -3,7 +3,7 @@ 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 { getActionForMessage, nameThisTarget } from "./thisTarget";
+import { getActionForMessage, nameThisTarget } from "./thisTarget.js";
 export function isMessengerMessage(message) {
     return (isObject(message) &&
         typeof message["type"] === "string" &&
@@ -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;
     }

package/distribution/sender.js

@@ -26,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.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. 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);

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,10 @@
-import { Target, PageTarget, MessengerMeta } from "./types.js";
-declare type AnyTarget = Partial<Target & PageTarget>;
-export declare function getActionForMessage(target: AnyTarget): "respond" | "forward" | "ignore";
+import { MessengerMeta, Sender } from "./types.js";
+interface AnyTarget {
+    tabId?: number | "this";
+    frameId?: number;
+    page?: string;
+}
+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,14 +1,15 @@
-import { isBackgroundPage, isContentScript } from "webext-detect-page";
-import { messenger } from "./index";
+import { isBackgroundPage, isContentScript, isExtensionContext, } 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") {
+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;
     }
@@ -46,8 +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 (isExtensionContext()) {
+        // Any context can handler this message
+        registerMethods({ __getTabData });
+    }
     if (isBackgroundPage()) {
         thisTarget = { page: "background" };
-        registerMethods({ __getTabData });
     }
 }

package/distribution/types.d.ts

@@ -50,7 +50,7 @@ export interface Target {
     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-0",
+  "version": "0.15.0-4",
   "description": "Browser Extension component messaging framework",
   "keywords": [],
   "repository": "pixiebrix/webext-messenger",
@@ -13,7 +13,8 @@
     "./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",
@@ -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,35 +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",
+    "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",
-    "webext-content-scripts": "^0.10.1",
-    "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/api.d.ts

@@ -1,10 +0,0 @@
-import { Target, MessengerMeta } from "./types";
-declare function __getTabData(this: MessengerMeta): Target;
-declare global {
-    interface MessengerMethods {
-        __getTabData: typeof __getTabData;
-    }
-}
-export declare const getTabData: () => Promise<Target>;
-export declare function initPrivateApi(): void;
-export {};

package/distribution/api.js

@@ -1,13 +0,0 @@
-import { getMethod } from "./sender";
-import { registerMethods } from "./receiver";
-import { isBackgroundPage } from "webext-detect-page";
-function __getTabData() {
-    return { tabId: this.trace[0].tab.id, frameId: this.trace[0].frameId };
-}
-// First page to respond wins. Any context has this piece of information.
-export const getTabData = getMethod("__getTabData", { page: "any" });
-export function initPrivateApi() {
-    if (isBackgroundPage()) {
-        registerMethods({ __getTabData });
-    }
-}

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,
-        });
-    }
-}