Drop webextension-polyfill (#313)

Author: fregante

package-lock.json

@@ -40,7 +40,6 @@
     "@sindresorhus/tsconfig": "^7.0.0",
     "@types/chrome": "^0.0.307",
     "@types/tape": "^5.8.1",
-    "@types/webextension-polyfill": "^0.12.2",
     "buffer": "^6.0.3",
     "eslint": "^8.57.0",
     "eslint-config-pixiebrix": "^0.41.1",
@@ -52,8 +51,7 @@
     "stream-browserify": "^3.0.0",
     "tape": "^5.9.0",
     "typescript": "^5.8.2",
-    "vitest": "^3.0.7",
-    "webextension-polyfill": "^0.12.0"
+    "vitest": "^3.0.7"
   },
   "targets": {
     "main": false,

package.json

@@ -1,5 +1,3 @@
-/* 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:");

source/logging.ts

@@ -1,4 +1,3 @@
-import browser from "webextension-polyfill";
 import { serializeError } from "serialize-error";
 import { getContextName } from "webext-detect";
 
@@ -24,11 +23,11 @@ export function isMessengerMessage(message: unknown): message is Message {
   );
 }
 
-// MUST NOT be `async` or Promise-returning-only
 function onMessageListener(
   message: unknown,
   sender: Sender,
-): Promise<unknown> | undefined {
+  sendResponse: (response: unknown) => void,
+): true | undefined {
   if (!isMessengerMessage(message)) {
     // TODO: Add test for this eventuality: ignore unrelated messages
     return;
@@ -45,7 +44,17 @@ function onMessageListener(
     return;
   }
 
-  return handleMessage(message, sender, action);
+  (async () => {
+    try {
+      sendResponse(await handleMessage(message, sender, action));
+    } catch (error) {
+      sendResponse({ __webextMessenger: true, error: serializeError(error) });
+    }
+  })();
+
+  // Make `sendMessage` wait for an async response. This stops other `onMessage` listeners from being called.
+  // TODO: Just return a promise if this is ever implemented https://issues.chromium.org/issues/40753031
+  return true;
 }
 
 // This function can only be called when the message *will* be handled locally.
@@ -97,7 +106,6 @@ async function handleMessage(
     (value) => ({ value }),
     (error: unknown) => ({
       // Errors must be serialized because the stack traces are currently lost on Chrome
-      // and https://github.com/mozilla/webextension-polyfill/issues/210
       error: serializeError(error),
     }),
   );
@@ -116,7 +124,7 @@ export function registerMethods(methods: Partial<MessengerMethods>): void {
     handlers.set(type, method as Method);
   }
 
-  browser.runtime.onMessage.addListener(onMessageListener);
+  chrome.runtime.onMessage.addListener(onMessageListener);
 }
 
 /** Ensure/document that the current function was called via Messenger */

source/receiver.ts

@@ -1,4 +1,3 @@
-import browser from "webextension-polyfill";
 import pRetry from "p-retry";
 import { isBackground } from "webext-detect";
 import { deserializeError } from "serialize-error";
@@ -22,7 +21,6 @@ import { events } from "./events.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";
 
@@ -166,9 +164,9 @@ async function manageMessage(
           throw error;
         }
 
-        if (browser.tabs && typeof target.tabId === "number") {
+        if (chrome.tabs && typeof target.tabId === "number") {
           try {
-            const tabInfo = await browser.tabs.get(target.tabId);
+            const tabInfo = await chrome.tabs.get(target.tabId);
             if (tabInfo.discarded) {
               throw new Error(errorTabWasDiscarded);
             }
@@ -270,7 +268,7 @@ function messenger<
         "↗️ sending message to runtime",
         attemptLog(attemptCount),
       );
-      return browser.runtime.sendMessage(
+      return chrome.runtime.sendMessage(
         makeMessage(type, args, target, options),
       );
     };
@@ -279,7 +277,7 @@ function messenger<
   }
 
   // Contexts without direct Tab access must go through background
-  if (!browser.tabs) {
+  if (!chrome.tabs) {
     return manageConnection(
       type,
       options,
@@ -291,7 +289,7 @@ function messenger<
           "↗️ sending message to runtime",
           attemptLog(attemptCount),
         );
-        return browser.runtime.sendMessage(
+        return chrome.runtime.sendMessage(
           makeMessage(type, args, target, options),
         );
       },
@@ -316,7 +314,7 @@ function messenger<
         frameId,
         attemptLog(attemptCount),
       );
-      return browser.tabs.sendMessage(
+      return chrome.tabs.sendMessage(
         tabId,
         makeMessage(type, args, target, options),
         frameId === "allFrames"

source/sender.ts

@@ -1,6 +1,5 @@
 import { assert, describe, test, vi } from "vitest";
 import { getActionForMessage } from "./targetLogic.js";
-import { type Tabs } from "webextension-polyfill";
 import { isContentScript, isBackground } from "webext-detect";
 
 vi.mock("webext-detect");
@@ -14,7 +13,12 @@ const tab = {
   pinned: false,
   highlighted: true,
   incognito: false,
-} satisfies Tabs.Tab;
+  discarded: false,
+  frozen: false,
+  selected: true,
+  autoDiscardable: false,
+  groupId: -1,
+} satisfies chrome.tabs.Tab;
 
 const senders = {
   background: { page: "background" },

source/targetLogic.test.ts

@@ -1,8 +1,7 @@
-import browser from "webextension-polyfill";
 import { once } from "webext-messenger/shared.js";
 
 export async function ensureScripts(tabId: number): Promise<void> {
-  await browser.scripting.executeScript({
+  await chrome.scripting.executeScript({
     target: { tabId },
     files: ["contentscript/registration.js"],
   });
@@ -34,7 +33,7 @@ export async function createTargets(): Promise<Targets> {
   let frames;
   while (limit--) {
     // eslint-disable-next-line no-await-in-loop -- It's a retry loop
-    frames = (await browser.webNavigation.getAllFrames({
+    frames = (await chrome.webNavigation.getAllFrames({
       tabId,
     }))!;
 
@@ -60,15 +59,15 @@ export async function createTargets(): Promise<Targets> {
 }
 
 const getHiddenWindow = once(async (): Promise<number> => {
-  const { id } = await browser.windows.create({
+  const { id } = await chrome.windows.create({
     focused: false,
     state: "minimized",
   });
   return id!;
 });
 
 export async function openTab(url: string): Promise<number> {
-  const tab = await browser.tabs.create({
+  const tab = await chrome.tabs.create({
     windowId: await getHiddenWindow(),
     active: false,
     url,
@@ -77,9 +76,9 @@ export async function openTab(url: string): Promise<number> {
 }
 
 export async function closeHiddenWindow(): Promise<void> {
-  return browser.windows.remove(await getHiddenWindow());
+  return chrome.windows.remove(await getHiddenWindow());
 }
 
 export async function closeTab(tabId: number): Promise<void> {
-  await browser.tabs.remove(tabId);
+  await chrome.tabs.remove(tabId);
 }

source/test/background/testingApi.ts

@@ -1,4 +1,3 @@
-import browser from "webextension-polyfill";
 import test from "tape";
 import { isBackground, isContentScript, isWebPage } from "webext-detect";
 import { type PageTarget, type Target } from "webext-messenger";
@@ -184,7 +183,7 @@ async function testEveryTarget() {
     await closeSelf({ tabId, frameId: parentFrame });
     try {
       // Since the tab was closed, this is expected to throw
-      t.notOk(await browser.tabs.get(tabId), "The tab should not be open");
+      t.notOk(await chrome.tabs.get(tabId), "The tab should not be open");
     } catch {
       t.pass("The tab was closed");
     }

source/test/contentscript/api.test.ts

@@ -1,14 +1,15 @@
-import browser from "webextension-polyfill";
-
-browser.runtime.onMessage.addListener(
-  (message: unknown): Promise<string> | undefined => {
+chrome.runtime.onMessage.addListener(
+  (message: unknown, _sender, sendResponse): boolean | undefined => {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     if ((message as any)?.type === "sleep") {
       console.log(
         "I’m an unrelated message listener, but I'm replying anyway to",
         { message },
       );
-      return Promise.resolve("/r/nosleep");
+
+      void Promise.resolve("Buonanotte").then(sendResponse);
+
+      return true;
     }
 
     console.log("I’m an unrelated message listener. I’ve seen", { message });

source/test/contentscript/fixtures/unrelatedMessageListener.ts

@@ -1,4 +1,3 @@
-import { type Runtime } from "webextension-polyfill";
 import { type Asyncify, type ValueOf } from "type-fest";
 import { type ErrorObject } from "serialize-error";
 
@@ -83,7 +82,7 @@ export type Message<LocalArguments extends Arguments = Arguments> = {
   options?: Options;
 };
 
-export type Sender = Runtime.MessageSender & { origin?: string }; // Chrome includes the origin
+export type Sender = chrome.runtime.MessageSender;
 
 export type MessengerMessage = Message & {
   /** Guarantees that a message is meant to be handled by this library */