@lullabot/playwright-testing 1.1.0 → 1.2.0

package/README.md

@@ -1,7 +1,8 @@
 # `@lullabot/playwright-testing`
 
 Framework-neutral utilities for stable Playwright screenshots, accessibility
-baselines, URL-driven visual comparisons, and GitHub reporting.
+baselines, URL-driven visual comparisons, WebKit autofocus stabilization, and
+GitHub reporting.
 
 This package is developed in the
 [`playwright-drupal` monorepo](https://github.com/Lullabot/playwright-drupal),
@@ -24,7 +25,8 @@ version.
 
 - `@lullabot/playwright-testing` exports screenshot stabilization,
   accessibility checks and baselines, visual-diff definitions, interaction and
-  pseudo-state helpers, and reusable mocks.
+  pseudo-state helpers, reusable mocks, and the `suppressWebKitAutofocus()` init
+  script (installed explicitly in WebKit contexts).
 - `@lullabot/playwright-testing/github` exports the optional GitHub report,
   attachment-upload, and path-remapping APIs.
 - `playwright-testing-a11y-summary` and
@@ -47,9 +49,10 @@ test('home page', async ({ page }, testInfo) => {
 
 ## Guides
 
-- [Accessibility testing](https://github.com/Lullabot/playwright-drupal/blob/main/packages/playwright-testing/docs/accessibility.md)
-- [Stable screenshots and visual comparisons](https://github.com/Lullabot/playwright-drupal/blob/main/packages/playwright-testing/docs/screenshots-and-visual-comparisons.md)
-- [GitHub reporting](https://github.com/Lullabot/playwright-drupal/blob/main/packages/playwright-testing/docs/github-reporting.md)
+- [Accessibility testing][testing-accessibility]
+- [Stable screenshots and visual comparisons][testing-screenshots]
+- [WebKit native autofocus workaround][testing-webkit-autofocus]
+- [GitHub reporting][testing-github-reporting]
 
 ## Drupal compatibility
 
@@ -59,3 +62,8 @@ visual-diff calls with its Drupal preset. New framework-neutral code can import
 this package directly; Drupal tests that depend on database isolation, Drush,
 login helpers, or the `a11y` fixture should continue importing the Drupal
 package.
+
+[testing-accessibility]: https://github.com/Lullabot/playwright-drupal/blob/main/packages/playwright-testing/docs/accessibility.md
+[testing-screenshots]: https://github.com/Lullabot/playwright-drupal/blob/main/packages/playwright-testing/docs/screenshots-and-visual-comparisons.md
+[testing-github-reporting]: https://github.com/Lullabot/playwright-drupal/blob/main/packages/playwright-testing/docs/github-reporting.md
+[testing-webkit-autofocus]: https://github.com/Lullabot/playwright-drupal/blob/main/packages/playwright-testing/docs/webkit-autofocus.md

package/lib/index.d.ts

@@ -11,3 +11,4 @@ export * from "./pseudo-state.js";
 export * from "./videos.js";
 export * from "./visualdiff.js";
 export * from "./mock/index.js";
+export * from "./webkit-autofocus.js";

package/lib/index.js

@@ -27,3 +27,4 @@ __exportStar(require("./pseudo-state.js"), exports);
 __exportStar(require("./videos.js"), exports);
 __exportStar(require("./visualdiff.js"), exports);
 __exportStar(require("./mock/index.js"), exports);
+__exportStar(require("./webkit-autofocus.js"), exports);

package/lib/webkit-autofocus.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Runs in each document via BrowserContext.addInitScript(). Keep self-contained.
+ *
+ * WebKit queues autofocus on insertion, without rechecking the attribute later.
+ * Make candidates unfocusable until flushAutofocusCandidates has discarded them.
+ * Page::updateRendering flushes autofocus BEFORE animation-frame callbacks; a
+ * parser waiting for stylesheets can defer that flush, so wait for the top
+ * document's DOMContentLoaded first. This intentionally suppresses document
+ * autofocus, rather than replacing Playwright's focus/selection/input behavior.
+ *
+ * See docs/webkit-autofocus.md for scope and tradeoffs.
+ *
+ * Install only in WebKit contexts, before pages navigate:
+ * `await context.addInitScript(suppressWebKitAutofocus)`.
+ */
+export declare function suppressWebKitAutofocus(): void;

package/lib/webkit-autofocus.js

@@ -0,0 +1,136 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.suppressWebKitAutofocus = suppressWebKitAutofocus;
+/**
+ * Runs in each document via BrowserContext.addInitScript(). Keep self-contained.
+ *
+ * WebKit queues autofocus on insertion, without rechecking the attribute later.
+ * Make candidates unfocusable until flushAutofocusCandidates has discarded them.
+ * Page::updateRendering flushes autofocus BEFORE animation-frame callbacks; a
+ * parser waiting for stylesheets can defer that flush, so wait for the top
+ * document's DOMContentLoaded first. This intentionally suppresses document
+ * autofocus, rather than replacing Playwright's focus/selection/input behavior.
+ *
+ * See docs/webkit-autofocus.md for scope and tradeoffs.
+ *
+ * Install only in WebKit contexts, before pages navigate:
+ * `await context.addInitScript(suppressWebKitAutofocus)`.
+ */
+function suppressWebKitAutofocus() {
+    let topDocument;
+    try {
+        topDocument = window.top.document;
+    }
+    catch {
+        // WebKit already rejects native autofocus candidates in cross-origin frames.
+        return;
+    }
+    const pending = new Map();
+    const candidates = new WeakSet();
+    let scheduled = false;
+    function restoreAfterFlush() {
+        requestAnimationFrame(() => {
+            scheduled = false;
+            for (const [element, original] of pending) {
+                if (element.style.getPropertyValue(original.property) ===
+                    original.temporary &&
+                    element.style.getPropertyPriority(original.property) === "important") {
+                    if (original.value) {
+                        element.style.setProperty(original.property, original.value, original.priority);
+                    }
+                    else {
+                        element.style.removeProperty(original.property);
+                    }
+                    // Synchronize WebKit's serialized style attribute before removing it.
+                    if (!original.hadStyle && !element.getAttribute("style")) {
+                        element.removeAttribute("style");
+                    }
+                }
+            }
+            pending.clear();
+        });
+    }
+    function quarantine(element) {
+        if (element.namespaceURI !== "http://www.w3.org/1999/xhtml")
+            return;
+        // Remember detached candidates too: the parser may still be blocking their
+        // queued opportunity when they are reinserted without the attribute.
+        candidates.add(element);
+        if (!element.isConnected)
+            return;
+        const candidate = element;
+        if (!pending.has(candidate)) {
+            // Keep normal form controls in layout. Hide other candidates' subtrees
+            // entirely, including hosts whose shadow roots might delegate focus.
+            const isControl = /^(input|textarea|select|button)$/.test(candidate.localName);
+            const property = isControl ? "visibility" : "display";
+            const temporary = isControl ? "hidden" : "none";
+            // Capture attribute presence before changing its CSSStyleDeclaration.
+            const hadStyle = candidate.hasAttribute("style");
+            pending.set(candidate, {
+                property,
+                temporary,
+                value: candidate.style.getPropertyValue(property),
+                priority: candidate.style.getPropertyPriority(property),
+                hadStyle,
+            });
+            candidate.style.setProperty(property, temporary, "important");
+        }
+        if (scheduled)
+            return;
+        scheduled = true;
+        if (topDocument.readyState === "loading") {
+            topDocument.addEventListener("DOMContentLoaded", restoreAfterFlush, {
+                once: true,
+            });
+        }
+        else {
+            restoreAfterFlush();
+        }
+    }
+    function scan(node) {
+        if (node.nodeType !== Node.ELEMENT_NODE)
+            return;
+        const element = node;
+        if (element.hasAttribute("autofocus") || candidates.has(element))
+            quarantine(element);
+        element.querySelectorAll("*").forEach((descendant) => {
+            if (descendant.hasAttribute("autofocus") || candidates.has(descendant))
+                quarantine(descendant);
+        });
+    }
+    new MutationObserver((records) => {
+        for (const record of records) {
+            if (record.type === "childList") {
+                record.addedNodes.forEach(scan);
+            }
+            else if (record.attributeName === "style") {
+                const element = record.target;
+                const original = pending.get(element);
+                if (original &&
+                    (element.style.getPropertyValue(original.property) !==
+                        original.temporary ||
+                        element.style.getPropertyPriority(original.property) !==
+                            "important")) {
+                    // Keep the candidate hidden through the flush even if application
+                    // code changes its styles in the meantime. Restore the latest value.
+                    original.value = element.style.getPropertyValue(original.property);
+                    original.priority = element.style.getPropertyPriority(original.property);
+                    original.hadStyle = element.hasAttribute("style");
+                    element.style.setProperty(original.property, original.temporary, "important");
+                }
+            }
+            else {
+                // Also catch an attribute removed synchronously after insertion, before
+                // observer delivery: its native candidate is still in WebKit's queue.
+                quarantine(record.target);
+            }
+        }
+    }).observe(document, {
+        childList: true,
+        subtree: true,
+        attributes: true,
+        attributeFilter: ["autofocus", "style"],
+    });
+    document.querySelectorAll("[autofocus]").forEach(quarantine);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lullabot/playwright-testing",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Framework-neutral Playwright testing utilities",
   "license": "Apache-2.0",
   "repository": {
@@ -33,7 +33,8 @@
   "scripts": {
     "build": "tsc",
     "prepack": "npm run build",
-    "test": "vitest run --passWithNoTests"
+    "test": "vitest run --passWithNoTests",
+    "test:autofocus": "playwright test --config tests/webkit-autofocus/playwright.config.ts"
   },
   "dependencies": {
     "@axe-core/playwright": "^4.8.5",

package/src/index.ts

@@ -11,3 +11,4 @@ export * from "./pseudo-state.js";
 export * from "./videos.js";
 export * from "./visualdiff.js";
 export * from "./mock/index.js";
+export * from "./webkit-autofocus.js";

package/src/webkit-autofocus.ts

@@ -0,0 +1,154 @@
+/**
+ * Runs in each document via BrowserContext.addInitScript(). Keep self-contained.
+ *
+ * WebKit queues autofocus on insertion, without rechecking the attribute later.
+ * Make candidates unfocusable until flushAutofocusCandidates has discarded them.
+ * Page::updateRendering flushes autofocus BEFORE animation-frame callbacks; a
+ * parser waiting for stylesheets can defer that flush, so wait for the top
+ * document's DOMContentLoaded first. This intentionally suppresses document
+ * autofocus, rather than replacing Playwright's focus/selection/input behavior.
+ *
+ * See docs/webkit-autofocus.md for scope and tradeoffs.
+ *
+ * Install only in WebKit contexts, before pages navigate:
+ * `await context.addInitScript(suppressWebKitAutofocus)`.
+ */
+export function suppressWebKitAutofocus(): void {
+  let topDocument: Document;
+  try {
+    topDocument = window.top!.document;
+  } catch {
+    // WebKit already rejects native autofocus candidates in cross-origin frames.
+    return;
+  }
+
+  const pending = new Map<
+    HTMLElement,
+    {
+      property: "visibility" | "display";
+      temporary: "hidden" | "none";
+      value: string;
+      priority: string;
+      hadStyle: boolean;
+    }
+  >();
+  const candidates = new WeakSet<Element>();
+  let scheduled = false;
+
+  function restoreAfterFlush(): void {
+    requestAnimationFrame(() => {
+      scheduled = false;
+      for (const [element, original] of pending) {
+        if (
+          element.style.getPropertyValue(original.property) ===
+            original.temporary &&
+          element.style.getPropertyPriority(original.property) === "important"
+        ) {
+          if (original.value) {
+            element.style.setProperty(
+              original.property,
+              original.value,
+              original.priority,
+            );
+          } else {
+            element.style.removeProperty(original.property);
+          }
+          // Synchronize WebKit's serialized style attribute before removing it.
+          if (!original.hadStyle && !element.getAttribute("style")) {
+            element.removeAttribute("style");
+          }
+        }
+      }
+      pending.clear();
+    });
+  }
+
+  function quarantine(element: Element): void {
+    if (element.namespaceURI !== "http://www.w3.org/1999/xhtml") return;
+    // Remember detached candidates too: the parser may still be blocking their
+    // queued opportunity when they are reinserted without the attribute.
+    candidates.add(element);
+    if (!element.isConnected) return;
+    const candidate = element as HTMLElement;
+    if (!pending.has(candidate)) {
+      // Keep normal form controls in layout. Hide other candidates' subtrees
+      // entirely, including hosts whose shadow roots might delegate focus.
+      const isControl = /^(input|textarea|select|button)$/.test(
+        candidate.localName,
+      );
+      const property = isControl ? "visibility" : "display";
+      const temporary = isControl ? "hidden" : "none";
+      // Capture attribute presence before changing its CSSStyleDeclaration.
+      const hadStyle = candidate.hasAttribute("style");
+      pending.set(candidate, {
+        property,
+        temporary,
+        value: candidate.style.getPropertyValue(property),
+        priority: candidate.style.getPropertyPriority(property),
+        hadStyle,
+      });
+      candidate.style.setProperty(property, temporary, "important");
+    }
+    if (scheduled) return;
+    scheduled = true;
+    if (topDocument.readyState === "loading") {
+      topDocument.addEventListener("DOMContentLoaded", restoreAfterFlush, {
+        once: true,
+      });
+    } else {
+      restoreAfterFlush();
+    }
+  }
+
+  function scan(node: Node): void {
+    if (node.nodeType !== Node.ELEMENT_NODE) return;
+    const element = node as Element;
+    if (element.hasAttribute("autofocus") || candidates.has(element))
+      quarantine(element);
+    element.querySelectorAll("*").forEach((descendant) => {
+      if (descendant.hasAttribute("autofocus") || candidates.has(descendant))
+        quarantine(descendant);
+    });
+  }
+
+  new MutationObserver((records) => {
+    for (const record of records) {
+      if (record.type === "childList") {
+        record.addedNodes.forEach(scan);
+      } else if (record.attributeName === "style") {
+        const element = record.target as HTMLElement;
+        const original = pending.get(element);
+        if (
+          original &&
+          (element.style.getPropertyValue(original.property) !==
+            original.temporary ||
+            element.style.getPropertyPriority(original.property) !==
+              "important")
+        ) {
+          // Keep the candidate hidden through the flush even if application
+          // code changes its styles in the meantime. Restore the latest value.
+          original.value = element.style.getPropertyValue(original.property);
+          original.priority = element.style.getPropertyPriority(
+            original.property,
+          );
+          original.hadStyle = element.hasAttribute("style");
+          element.style.setProperty(
+            original.property,
+            original.temporary,
+            "important",
+          );
+        }
+      } else {
+        // Also catch an attribute removed synchronously after insertion, before
+        // observer delivery: its native candidate is still in WebKit's queue.
+        quarantine(record.target as Element);
+      }
+    }
+  }).observe(document, {
+    childList: true,
+    subtree: true,
+    attributes: true,
+    attributeFilter: ["autofocus", "style"],
+  });
+  document.querySelectorAll("[autofocus]").forEach(quarantine);
+}