webext-messenger 0.18.2 → 0.20.0

package/distribution/handlers.d.ts

@@ -0,0 +1,10 @@
+import { __getTabData } from "./thisTarget.js";
+import { Method } from "./types.js";
+declare global {
+    interface MessengerMethods {
+        __getTabData: typeof __getTabData;
+    }
+}
+export declare const privateMethods: (typeof __getTabData)[];
+export declare const handlers: Map<string, Method>;
+export declare function didUserRegisterMethods(): boolean;

package/distribution/handlers.js

@@ -0,0 +1,6 @@
+import { __getTabData } from "./thisTarget.js";
+export const privateMethods = [__getTabData];
+export const handlers = new Map();
+export function didUserRegisterMethods() {
+    return handlers.size > privateMethods.length;
+}

package/distribution/receiver.js

@@ -1,8 +1,9 @@
 import { serializeError } from "serialize-error";
-import { messenger } from "./sender.js";
-import { handlers, isObject, MessengerError, debug, __webextMessenger, } from "./shared.js";
 import { getContextName, isBackground } from "webext-detect-page";
+import { messenger } from "./sender.js";
+import { isObject, MessengerError, debug, __webextMessenger, } from "./shared.js";
 import { getActionForMessage, nameThisTarget } from "./thisTarget.js";
+import { didUserRegisterMethods, handlers } from "./handlers.js";
 export function isMessengerMessage(message) {
     return (isObject(message) &&
         typeof message["type"] === "string" &&
@@ -42,6 +43,9 @@ action) {
             args,
             wasForwarded: trace.length > 1,
         });
+        if (!didUserRegisterMethods()) {
+            throw new MessengerError(`No handlers registered in ${getContextName()}`);
+        }
         const localHandler = handlers.get(type);
         if (!localHandler) {
             throw new MessengerError(`No handler registered for ${type} in ${getContextName()}`);

package/distribution/sender.d.ts

@@ -1,6 +1,7 @@
 import { PublicMethod, PublicMethodWithTarget, Options, Target, PageTarget } from "./types.js";
 import { SetReturnType } from "type-fest";
-export declare const errorNonExistingTarget = "Could not establish connection. Receiving end does not exist.";
+export declare const errorTargetClosedEarly = "The target was closed before receiving a response";
+export declare const errorTabDoesntExist = "The tab doesn't exist";
 declare function messenger<Type extends keyof MessengerMethods, Method extends MessengerMethods[Type]>(type: Type, options: {
     isNotification: true;
 }, target: Target | PageTarget, ...args: Parameters<Method>): void;

package/distribution/sender.js

@@ -1,8 +1,14 @@
 import pRetry from "p-retry";
 import { isBackground } from "webext-detect-page";
+import { doesTabExist } from "webext-tools";
 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.";
+import { isObject, MessengerError, __webextMessenger, debug, warn, } from "./shared.js";
+import { handlers } from "./handlers.js";
+const _errorNonExistingTarget = "Could not establish connection. Receiving end does not exist.";
+// https://github.com/mozilla/webextension-polyfill/issues/384
+const _errorTargetClosedEarly = "A listener indicated an asynchronous response by returning true, but the message channel closed before a response was received";
+export const errorTargetClosedEarly = "The target was closed before receiving a response";
+export const errorTabDoesntExist = "The tab doesn't exist";
 function isMessengerResponse(response) {
     return isObject(response) && response["__webextMessenger"] === true;
 }
@@ -35,11 +41,22 @@ async function manageMessage(type, target, sendMessage) {
         minTimeout: 100,
         factor: 1.3,
         maxRetryTime: 4000,
-        onFailedAttempt(error) {
+        async onFailedAttempt(error) {
+            if (error.message === _errorTargetClosedEarly) {
+                throw new Error(errorTargetClosedEarly);
+            }
             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)) {
+                // Page or its content script not yet loaded
+                String(error.message).startsWith(_errorNonExistingTarget) ||
+                // `registerMethods` not yet loaded
+                String(error.message).startsWith("No handlers registered in ")) {
+                if (browser.tabs &&
+                    typeof target.tabId === "number" &&
+                    !(await doesTabExist(target.tabId))) {
+                    throw new Error(errorTabDoesntExist);
+                }
                 debug(type, "will retry. Attempt", error.attemptNumber);
             }
             else {

package/distribution/shared.d.ts

@@ -1,5 +1,4 @@
 import { JsonObject } from "type-fest";
-import { Method } from "./types.js";
 declare type ErrorObject = {
     name?: string;
     stack?: string;
@@ -11,7 +10,6 @@ export declare function isObject(value: unknown): value is Record<string, unknow
 export declare class MessengerError extends Error {
     name: string;
 }
-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;

package/distribution/shared.js

@@ -25,13 +25,12 @@ export class MessengerError extends Error {
         });
     }
 }
-export const handlers = new Map();
 // .bind preserves the call location in the console
 export const debug = logging ? console.debug.bind(console, "Messenger:") : noop;
 export const warn = logging ? console.warn.bind(console, "Messenger:") : noop;
 export function isErrorObject(error) {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any -- This is a type guard function and it uses ?.
-    return typeof (error === null || error === void 0 ? void 0 : error.message) === "string";
+    return typeof error?.message === "string";
 }
 export async function delay(milliseconds) {
     return new Promise((resolve) => {

package/distribution/thisTarget.d.ts

@@ -1,11 +1,5 @@
 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 {
-    interface MessengerMethods {
-        __getTabData: typeof __getTabData;
-    }
-}
+export declare function __getTabData(this: MessengerMeta): AnyTarget;
 export declare function initPrivateApi(): void;
-export {};

package/distribution/thisTarget.js

@@ -29,7 +29,6 @@ function compareTargets(to, thisTarget) {
 }
 export function getActionForMessage(from, { ...to } // Clone object because we're editing it
 ) {
-    var _a;
     if (to.page === "any") {
         return "respond";
     }
@@ -48,7 +47,7 @@ export function getActionForMessage(from, { ...to } // Clone object because we'r
         return "ignore";
     }
     // Set "this" tab to the current tabId
-    if (to.tabId === "this" && thisTarget.tabId === ((_a = from.tab) === null || _a === void 0 ? void 0 : _a.id)) {
+    if (to.tabId === "this" && thisTarget.tabId === from.tab?.id) {
         to.tabId = thisTarget.tabId;
     }
     // Every `target` key must match `thisTarget`
@@ -67,9 +66,8 @@ export async function nameThisTarget() {
         thisTarget.page = location.pathname + location.search;
     }
 }
-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 __getTabData() {
+    return { tabId: this.trace[0]?.tab?.id, frameId: this.trace[0]?.frameId };
 }
 export function initPrivateApi() {
     if (isBackground()) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "webext-messenger",
-  "version": "0.18.2",
+  "version": "0.20.0",
   "description": "Browser Extension component messaging framework",
   "keywords": [],
   "repository": "pixiebrix/webext-messenger",
@@ -18,123 +18,42 @@
     "fix": "eslint . --fix",
     "watch": "tsc --watch"
   },
-  "eslintConfig": {
-    "env": {
-      "browser": true
-    },
-    "parserOptions": {
-      "project": "tsconfig.json"
-    },
-    "plugins": [
-      "import"
-    ],
-    "extends": [
-      "plugin:@typescript-eslint/recommended",
-      "xo",
-      "xo-typescript",
-      "prettier",
-      "plugin:import/recommended",
-      "plugin:import/typescript",
-      "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",
-        {
-          "case": "camelCase"
-        }
-      ],
-      "unicorn/no-useless-undefined": [
-        "error",
-        {
-          "checkArguments": false
-        }
-      ],
-      "unicorn/prevent-abbreviations": [
-        "error",
-        {
-          "allowList": {
-            "args": true
-          }
-        }
-      ]
-    },
-    "overrides": [
-      {
-        "files": [
-          "*.test.ts"
-        ],
-        "rules": {
-          "@typescript-eslint/no-explicit-any": "off",
-          "@typescript-eslint/no-non-null-assertion": "off",
-          "@typescript-eslint/no-unsafe-member-access": "off"
-        }
-      },
-      {
-        "files": [
-          "source/test/**/*"
-        ],
-        "rules": {
-          "import/extensions": "off"
-        }
-      }
-    ]
-  },
   "dependencies": {
-    "p-retry": "^5.1.0",
+    "p-retry": "^5.1.1",
     "serialize-error": "^11.0.0",
-    "type-fest": "^2.12.1",
-    "webext-detect-page": "^4.0.1"
+    "type-fest": "^2.13.0",
+    "webext-detect-page": "^4.0.1",
+    "webext-tools": "^1.1.0"
   },
   "devDependencies": {
-    "@parcel/config-webextension": "^2.4.0",
-    "@sindresorhus/tsconfig": "^2.0.0",
-    "@types/chrome": "^0.0.180",
+    "@parcel/config-webextension": "^2.6.0",
+    "@sindresorhus/tsconfig": "^3.0.1",
+    "@types/chrome": "^0.0.188",
     "@types/tape": "^4.13.2",
-    "@types/webextension-polyfill": "^0.8.3",
-    "@typescript-eslint/eslint-plugin": "^5.17.0",
-    "@typescript-eslint/parser": "^5.17.0",
+    "@types/webextension-polyfill": "^0.9.0",
+    "@typescript-eslint/eslint-plugin": "^5.27.0",
+    "@typescript-eslint/parser": "^5.27.0",
     "buffer": "^6.0.3",
-    "eslint": "^8.12.0",
+    "eslint": "^8.17.0",
     "eslint-config-prettier": "^8.5.0",
-    "eslint-config-xo": "^0.40.0",
-    "eslint-config-xo-typescript": "^0.50.0",
-    "eslint-plugin-import": "^2.25.4",
-    "eslint-plugin-unicorn": "^41.0.1",
+    "eslint-config-xo": "^0.41.0",
+    "eslint-config-xo-typescript": "^0.51.1",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-unicorn": "^42.0.0",
     "events": "^3.3.0",
     "npm-run-all": "^4.1.5",
-    "parcel": "^2.4.0",
+    "parcel": "^2.6.0",
     "path-browserify": "^1.0.1",
     "process": "^0.11.10",
     "stream-browserify": "^3.0.0",
-    "tape": "^5.5.2",
-    "typescript": "^4.6.3",
-    "webext-content-scripts": "^1.0.1",
+    "tape": "^5.5.3",
+    "typescript": "^4.7.3",
+    "webext-content-scripts": "^1.0.2",
     "webextension-polyfill": "^0.9.0"
   },
   "alias": {
-    "./this-stuff-is-just-for-local-parcel-tests": "./package.json",
-    "./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/thisTarget.js": "./source/thisTarget.ts"
+    "./this-stuff-is-just-for-local-parcel-tests": "https://github.com/parcel-bundler/parcel/issues/4936",
+    "./source/**/*.js": "./source/$1/$2.ts"
   },
   "targets": {
     "main": false,

package/readme.md

@@ -14,3 +14,7 @@ npm install webext-messenger
 ```js
 import messenger from "webext-messenger";
 ```
+
+## Context
+
+- [Initial considerations for this library](https://github.com/pixiebrix/webext-messenger/issues/1)