#6649: Exclude navigation events that should not trigger page updates

jest.config.js

@@ -36,7 +36,7 @@ const config = {
     "^.+\\.txt$": "<rootDir>/src/testUtils/rawJestTransformer.mjs",
   },
   transformIgnorePatterns: [
-    "node_modules/(?!@cfworker|escape-string-regex|filename-reserved-regex|filenamify|idb|webext-|p-timeout|p-retry|p-defer|p-memoize|serialize-error|strip-outer|trim-repeated|mimic-fn|urlpattern-polyfill|url-join|uuid|nanoid|use-debounce|copy-text-to-clipboard|linkify-urls|create-html-element|stringify-attributes|escape-goat|stemmer|uint8array-extras)",
+    "node_modules/(?!@cfworker|escape-string-regex|filename-reserved-regex|filenamify|idb|webext-|p-timeout|p-retry|p-defer|p-memoize|serialize-error|strip-outer|trim-repeated|mimic-fn|urlpattern-polyfill|url-join|uuid|nanoid|use-debounce|copy-text-to-clipboard|linkify-urls|create-html-element|stringify-attributes|escape-goat|stemmer|uint8array-extras|one-event)",
   ],
   setupFiles: [
     "dotenv/config",

package.json

@@ -104,6 +104,7 @@
     "mustache": "^4.2.0",
     "nunjucks": "^3.2.4",
     "object-hash": "^2.2.0",
+    "one-event": "^4.2.0",
     "one-mutation": "^2.1.0",
     "p-defer": "^4.0.0",
     "p-memoize": "^7.0.0",

src/contentScript/contentScriptCore.ts

@@ -26,7 +26,7 @@ import registerMessenger from "@/contentScript/messenger/registration";
 import registerBuiltinBricks from "@/bricks/registerBuiltinBricks";
 import registerContribBlocks from "@/contrib/registerContribBlocks";
 import brickRegistry from "@/bricks/registry";
-import { handleNavigate, initNavigation } from "@/contentScript/lifecycle";
+import { initNavigation } from "@/contentScript/lifecycle";
 import { initTelemetry } from "@/background/messenger/api";
 import { ENSURE_CONTENT_SCRIPT_READY } from "@/contentScript/ready";
 import { initToaster } from "@/utils/notify";
@@ -65,8 +65,7 @@ export async function init(): Promise<void> {
   initTelemetry();
   initToaster();
 
-  await handleNavigate();
-  initNavigation();
+  void initNavigation();
 
   void initSidebarActivation();
 

src/contentScript/lifecycle.ts

@@ -23,6 +23,7 @@ import { NAVIGATION_RULES } from "@/contrib/navigationRules";
 import { testMatchPatterns } from "@/bricks/available";
 import reportError from "@/telemetry/reportError";
 import { compact, groupBy, intersection, uniq } from "lodash";
+import oneEvent from "one-event";
 import { resolveExtensionInnerDefinitions } from "@/registry/internal";
 import { traces } from "@/background/messenger/api";
 import { isDeploymentActive } from "@/utils/deploymentUtils";
@@ -639,9 +640,31 @@ export async function reactivateTab(): Promise<void> {
   await handleNavigate({ force: true });
 }
 
-export function initNavigation() {
-  window.navigation?.addEventListener("navigate", async (event) => {
-    // Delay slightly to avoid catching events that navigate away from the page
-    setTimeout(handleNavigate, 0);
-  });
+// Ideally we only want to catch local URL changes, but there's no way to discern
+// navigation events that cause the current document to unload in the `navigate ` event.
+async function onNavigate(event: NavigateEvent): Promise<void> {
+  // Ignore navigations to external pages
+  if (
+    !event.destination.url.startsWith(location.origin) ||
+    event.downloadRequest !== null // Specifically `null` and not `''`
+  ) {
+    return;
+  }
+
+  try {
+    await oneEvent(window, "beforeunload", {
+      signal: AbortSignal.timeout(0),
+    });
+  } catch {
+    // It timed out before the "beforeunload" event, so this is a same-document navigation
+    await handleNavigate();
+  }
+}
+
+export async function initNavigation() {
+  // Initiate PB for the current page
+  await handleNavigate();
+
+  // Listen to page URL changes
+  window.navigation?.addEventListener("navigate", onNavigate);
 }