webext-messenger 0.23.0 → 0.24.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,6 @@ 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";
 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.d.ts

@@ -2,6 +2,7 @@ import { type PublicMethod, type PublicMethodWithTarget, type Options, type Targ
 import { type SetReturnType } from "type-fest";
 export declare const errorTargetClosedEarly = "The target was closed before receiving a response";
 export declare const errorTabDoesntExist = "The tab doesn't exist";
+export declare const errorTabWasDiscarded = "The tab was discarded";
 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,14 +1,15 @@
 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, 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
 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";
+export const errorTabWasDiscarded = "The tab was discarded";
 function isMessengerResponse(response) {
     return isObject(response) && response["__webextMessenger"] === true;
 }
@@ -65,23 +66,29 @@ async function manageMessage(type, target, seq, sendMessage) {
             if (error.message === _errorTargetClosedEarly) {
                 throw new Error(errorTargetClosedEarly);
             }
-            if (
+            if (!(
+            // If NONE of these conditions is true, stop retrying
             // Don't retry sending to the background page unless it really hasn't loaded yet
-            (target.page !== "background" && error instanceof MessengerError) ||
+            ((target.page !== "background" &&
+                error instanceof MessengerError) ||
                 // Page or its content script not yet loaded
                 error.message === _errorNonExistingTarget ||
                 // `registerMethods` not yet loaded
-                String(error.message).startsWith("No handlers registered in ")) {
-                if (browser.tabs &&
-                    typeof target.tabId === "number" &&
-                    !(await doesTabExist(target.tabId))) {
+                String(error.message).startsWith("No handlers registered in ")))) {
+                throw error;
+            }
+            if (browser.tabs && typeof target.tabId === "number") {
+                try {
+                    const tabInfo = await browser.tabs.get(target.tabId);
+                    if (tabInfo.discarded) {
+                        throw new Error(errorTabWasDiscarded);
+                    }
+                }
+                catch {
                     throw new Error(errorTabDoesntExist);
                 }
-                log.debug(type, seq, "will retry. Attempt", error.attemptNumber);
-            }
-            else {
-                throw error;
             }
+            log.debug(type, seq, "will retry. Attempt", error.attemptNumber);
         },
     }).catch((error) => {
         if (error?.message === _errorNonExistingTarget) {

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,9 +3,6 @@ export const __webextMessenger = true;
 export function isObject(value) {
     return typeof value === "object" && value !== null;
 }
-function noop() {
-    /* */
-}
 export class MessengerError extends Error {
     constructor() {
         super(...arguments);
@@ -19,16 +16,6 @@ export class MessengerError extends Error {
 }
 // @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
@@ -114,7 +115,7 @@ 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");

package/package.json

@@ -1,13 +1,19 @@
 {
   "name": "webext-messenger",
-  "version": "0.23.0",
+  "version": "0.24.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",
@@ -22,8 +28,7 @@
     "p-retry": "^6.0.0",
     "serialize-error": "^11.0.2",
     "type-fest": "^4.3.1",
-    "webext-detect-page": "^4.1.1",
-    "webext-tools": "^1.1.3"
+    "webext-detect-page": "^4.1.1"
   },
   "devDependencies": {
     "@parcel/config-webextension": "^2.6.2",
@@ -32,7 +37,7 @@
     "@types/tape": "^5.6.1",
     "@types/webextension-polyfill": "^0.10.2",
     "buffer": "^6.0.3",
-    "eslint": "^8.29.0",
+    "eslint": "^8.50.0",
     "eslint-config-pixiebrix": "^0.27.2",
     "events": "^3.3.0",
     "npm-run-all": "^4.1.5",
@@ -40,7 +45,7 @@
     "path-browserify": "^1.0.1",
     "process": "^0.11.10",
     "stream-browserify": "^3.0.0",
-    "tape": "^5.6.6",
+    "tape": "^5.7.0",
     "typescript": "^5.2.2",
     "webext-content-scripts": "^2.5.5",
     "webextension-polyfill": "^0.10.0"