webext-messenger 0.23.1 → 0.25.0-0

package/distribution/index.d.ts

@@ -2,4 +2,4 @@ export * from "./receiver.js";
 export * from "./sender.js";
 export * from "./types.js";
 export { getThisFrame, getTopLevelFrame } from "./thisTarget.js";
-export { toggleLogging } from "./shared.js";
+export { toggleLogging } from "./logging.js";

package/distribution/index.js

@@ -3,6 +3,8 @@ export * from "./receiver.js";
 export * from "./sender.js";
 export * from "./types.js";
 export { getThisFrame, getTopLevelFrame } from "./thisTarget.js";
-export { toggleLogging } from "./shared.js";
+export { toggleLogging } from "./logging.js";
 import { initPrivateApi } from "./thisTarget.js";
+// Required side effect to better track errors:
+// https://github.com/pixiebrix/webext-messenger/pull/80
 initPrivateApi();

package/distribution/logging.d.ts

@@ -0,0 +1,5 @@
+export declare const log: {
+    debug: (...args: unknown[]) => void;
+    warn: (...args: unknown[]) => void;
+};
+export declare function toggleLogging(enabled: boolean): void;

package/distribution/logging.js

@@ -0,0 +1,13 @@
+/* Warning: Do not use import browser-polyfill directly or indirectly */
+// .bind preserves the call location in the console
+const debug = console.debug.bind(console, "Messenger:");
+const warn = console.warn.bind(console, "Messenger:");
+const noop = () => {
+    /* */
+};
+// Default to "no logs"
+export const log = { debug: noop, warn: noop };
+export function toggleLogging(enabled) {
+    log.debug = enabled ? debug : noop;
+    log.warn = enabled ? warn : noop;
+}

package/distribution/receiver.js

@@ -1,7 +1,8 @@
 import { serializeError } from "serialize-error";
 import { getContextName } from "webext-detect-page";
 import { messenger } from "./sender.js";
-import { isObject, MessengerError, log, __webextMessenger } from "./shared.js";
+import { isObject, MessengerError, __webextMessenger } from "./shared.js";
+import { log } from "./logging.js";
 import { getActionForMessage } from "./thisTarget.js";
 import { didUserRegisterMethods, handlers } from "./handlers.js";
 export function isMessengerMessage(message) {

package/distribution/sender.js

@@ -1,7 +1,8 @@
 import pRetry from "p-retry";
 import { isBackground } from "webext-detect-page";
 import { deserializeError } from "serialize-error";
-import { isObject, MessengerError, __webextMessenger, log } from "./shared.js";
+import { isObject, MessengerError, __webextMessenger } from "./shared.js";
+import { log } from "./logging.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

package/distribution/shared.d.ts

@@ -10,11 +10,6 @@ export declare function isObject(value: unknown): value is Record<string, unknow
 export declare class MessengerError extends Error {
     name: string;
 }
-export declare const log: {
-    debug: (...args: any[]) => void;
-    warn: (...args: any[]) => void;
-};
-export declare function toggleLogging(enabled: boolean): void;
 export declare function isErrorObject(error: unknown): error is ErrorObject;
 export declare function delay(milliseconds: number): Promise<void>;
 export declare function once<Callback extends (...arguments_: unknown[]) => unknown>(function_: Callback): Callback;

package/distribution/shared.js

@@ -3,32 +3,11 @@ export const __webextMessenger = true;
 export function isObject(value) {
     return typeof value === "object" && value !== null;
 }
-function noop() {
-    /* */
-}
 export class MessengerError extends Error {
-    constructor() {
-        super(...arguments);
-        Object.defineProperty(this, "name", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: "MessengerError"
-        });
-    }
+    name = "MessengerError";
 }
 // @ts-expect-error Wrong `errorConstructors` types
 errorConstructors.set("MessengerError", MessengerError);
-// .bind preserves the call location in the console
-const debug = console.debug.bind(console, "Messenger:");
-const warn = console.warn.bind(console, "Messenger:");
-export const log = { debug, warn };
-export function toggleLogging(enabled) {
-    log.debug = enabled ? debug : noop;
-    log.warn = enabled ? warn : noop;
-}
-// Default to "no logs"
-toggleLogging(false);
 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?.message === "string";

package/distribution/thisTarget.js

@@ -1,7 +1,8 @@
 import { isBackground, isContentScript, isExtensionContext, } from "webext-detect-page";
 import { messenger } from "./sender.js";
 import { registerMethods } from "./receiver.js";
-import { log, MessengerError, once } from "./shared.js";
+import { MessengerError, once } from "./shared.js";
+import { log } from "./logging.js";
 /**
  * @file This file exists because `runtime.sendMessage` acts as a broadcast to
  * all open extension pages, so the receiver needs a way to figure out if the
@@ -105,16 +106,14 @@ const storeTabData = once(async () => {
     }
     catch (error) {
         tabDataStatus = "error";
-        throw new MessengerError("Tab registration failed. This page won’t be able to receive messages that require tab information", 
-        // @ts-expect-error TODO: update lib to accept Error#cause
-        { cause: error });
+        throw new MessengerError("Tab registration failed. This page won’t be able to receive messages that require tab information", { cause: error });
     }
 });
 export function __getTabData() {
     return { tabId: this.trace[0]?.tab?.id, frameId: this.trace[0]?.frameId };
 }
 export async function getThisFrame() {
-    await storeTabData(); // It should already have been called by we still need to await it
+    await storeTabData(); // It should already have been called but we still need to await it
     const { tabId, frameId } = thisTarget;
     if (typeof tabId !== "number" || typeof frameId !== "number") {
         throw new TypeError("This target is not in a frame");
@@ -130,6 +129,16 @@ export async function getTopLevelFrame() {
     };
 }
 export function initPrivateApi() {
+    // Improve DX by informing the developer that it's being loaded the wrong way
+    // https://github.com/pixiebrix/webext-messenger/issues/88
+    if (globalThis.__webextMessenger) {
+        // TODO: Use Error#cause after https://bugs.chromium.org/p/chromium/issues/detail?id=1211260
+        console.log(globalThis.__webextMessenger.replace(/^Error/, "webext-messenger"));
+        console.error("webext-messenger: Duplicate execution. This is a fatal error.\nhttps://github.com/pixiebrix/webext-messenger/issues/88");
+        return;
+    }
+    // Use Error to capture the stack and make it easier to find the cause
+    globalThis.__webextMessenger = new Error("First execution").stack;
     if (isExtensionContext()) {
         // Only `runtime` pages can handle this message but I can't remove it because its listener
         // also serves the purpose of throwing a specific error when no methods have been registered.

package/package.json

@@ -1,13 +1,19 @@
 {
   "name": "webext-messenger",
-  "version": "0.23.1",
+  "version": "0.25.0-0",
   "description": "Browser Extension component messaging framework",
   "keywords": [],
   "repository": "pixiebrix/webext-messenger",
   "license": "MIT",
   "author": "Federico Brigante for PixieBrix <federico@pixiebrix.com> (https://www.pixiebrix.com)",
   "type": "module",
-  "main": "distribution/index.js",
+  "exports": {
+    ".": {
+      "types": "./distribution/index.js",
+      "default": "./distribution/index.js"
+    },
+    "./*": "./distribution/*"
+  },
   "scripts": {
     "build": "tsc",
     "demo:watch": "parcel watch --no-cache --no-hmr",
@@ -21,25 +27,25 @@
   "dependencies": {
     "p-retry": "^6.0.0",
     "serialize-error": "^11.0.2",
-    "type-fest": "^4.3.1",
+    "type-fest": "^4.6.0",
     "webext-detect-page": "^4.1.1"
   },
   "devDependencies": {
     "@parcel/config-webextension": "^2.6.2",
-    "@sindresorhus/tsconfig": "^4.0.0",
-    "@types/chrome": "^0.0.245",
-    "@types/tape": "^5.6.1",
-    "@types/webextension-polyfill": "^0.10.2",
+    "@sindresorhus/tsconfig": "^5.0.0",
+    "@types/chrome": "^0.0.248",
+    "@types/tape": "^5.6.3",
+    "@types/webextension-polyfill": "^0.10.5",
     "buffer": "^6.0.3",
-    "eslint": "^8.50.0",
-    "eslint-config-pixiebrix": "^0.27.2",
+    "eslint": "^8.52.0",
+    "eslint-config-pixiebrix": "^0.29.1",
     "events": "^3.3.0",
     "npm-run-all": "^4.1.5",
     "parcel": "^2.6.2",
     "path-browserify": "^1.0.1",
     "process": "^0.11.10",
     "stream-browserify": "^3.0.0",
-    "tape": "^5.7.0",
+    "tape": "^5.7.2",
     "typescript": "^5.2.2",
     "webext-content-scripts": "^2.5.5",
     "webextension-polyfill": "^0.10.0"