@piwitests/reporter 0.26.1 → 0.27.0

package/dist/internal/capture/attachments.d.ts

@@ -8,7 +8,9 @@
 declare const ATTACHMENT_NAMES: {
     readonly locators: "piwi-locators";
     readonly ariaSnapshot: "piwi-aria-snapshot";
+    readonly ariaSnapshotJson: "piwi-aria-snapshot-json";
     readonly console: "piwi-console";
+    readonly dialogs: "piwi-dialogs";
     readonly network: "piwi-network";
     readonly webVitals: "piwi-web-vitals";
     readonly locatorSuggestion: "piwi-locator-suggestion";

package/dist/internal/capture/attachments.js

@@ -29,7 +29,9 @@ module.exports = __toCommonJS(attachments_exports);
 var ATTACHMENT_NAMES = {
   locators: "piwi-locators",
   ariaSnapshot: "piwi-aria-snapshot",
+  ariaSnapshotJson: "piwi-aria-snapshot-json",
   console: "piwi-console",
+  dialogs: "piwi-dialogs",
   network: "piwi-network",
   webVitals: "piwi-web-vitals",
   locatorSuggestion: "piwi-locator-suggestion",

package/dist/internal/capture/capture-fixtures.d.ts

@@ -93,6 +93,13 @@ declare const CAPTURED_ATTRS_ARG: ProbeArg;
  *   - < 1.49: `locator.ariaSnapshot` does not exist — returns null up front.
  */
 declare function ariaSnapshotBestEffort(target: Locator, timeout?: number): Promise<string | null>;
+/**
+ * The aria tree as JSON (Playwright ≥ 1.63's `ariaSnapshotJSON()`), stringified,
+ * or null on any older Playwright or on failure. Feature-detected the same way
+ * as `ariaSnapshotBestEffort`, so an older Playwright without the method simply
+ * yields null and the capture proceeds with the YAML alone.
+ */
+declare function ariaSnapshotJSONBestEffort(target: Locator, timeout?: number): Promise<string | null>;
 /**
  * The fixtures `piwiFixtures` / `extendPiwiFixtures` contribute. The single
  * added fixture is `piwiCapture`: an auto, test-scoped teardown hook that
@@ -132,4 +139,4 @@ declare const piwiFixtures: Fixtures<PiwiFixtures, {}, PlaywrightTestArgs & Play
  */
 declare function extendPiwiFixtures<TestArgs extends FixtureArgs, WorkerArgs extends FixtureArgs>(test: TestType<TestArgs, WorkerArgs>): TestType<TestArgs & PiwiFixtures, WorkerArgs>;
 
-export { CAPTURED_ATTRS_ARG, type PageState, type PiwiFixtures, type RawPageState, type RawVitalEntry, ariaSnapshotBestEffort, buildPageState, computeCoreVitals, extendPiwiFixtures, piwiFixtures };
+export { CAPTURED_ATTRS_ARG, type PageState, type PiwiFixtures, type RawPageState, type RawVitalEntry, ariaSnapshotBestEffort, ariaSnapshotJSONBestEffort, buildPageState, computeCoreVitals, extendPiwiFixtures, piwiFixtures };

package/dist/internal/capture/capture-fixtures.js

@@ -32,6 +32,7 @@ var capture_fixtures_exports = {};
 __export(capture_fixtures_exports, {
   CAPTURED_ATTRS_ARG: () => CAPTURED_ATTRS_ARG,
   ariaSnapshotBestEffort: () => ariaSnapshotBestEffort,
+  ariaSnapshotJSONBestEffort: () => ariaSnapshotJSONBestEffort,
   buildPageState: () => buildPageState,
   computeCoreVitals: () => computeCoreVitals,
   extendPiwiFixtures: () => extendPiwiFixtures,
@@ -169,15 +170,24 @@ function probeElementAttrs(el, arg) {
         let index = -1;
         let levelCount = 0;
         let roleNameCount = 0;
+        let visibleRoleNameCount = 0;
         for (let i = 0; i < nodes.length; i++) {
           const n = nodes[i];
           if (roleOf(n) !== targetRole) continue;
           if (n === el) index = roleCountAll;
           roleCountAll++;
           if (targetLevel != null && levelOf(n) === targetLevel) levelCount++;
-          if (targetName != null && nameOf(n) === targetName) roleNameCount++;
+          if (targetName != null && nameOf(n) === targetName) {
+            roleNameCount++;
+            const node = n;
+            const box = typeof node.getBoundingClientRect === "function" ? node.getBoundingClientRect() : null;
+            if (node.offsetParent != null || !!box && box.width > 0 && box.height > 0) visibleRoleNameCount++;
+          }
+        }
+        if (targetName != null) {
+          selectorCounts.roleName = roleNameCount;
+          selectorCounts.visibleRoleName = visibleRoleNameCount;
         }
-        if (targetName != null) selectorCounts.roleName = roleNameCount;
         if (index !== -1) {
           rolePosition = {
             role: targetRole,
@@ -1488,6 +1498,7 @@ var CHAIN_METHODS = [
   "nth",
   "last",
   "filter",
+  "visible",
   "and",
   "or",
   "locator",
@@ -1727,7 +1738,9 @@ function captureCallerLocation(stack = new Error().stack ?? "") {
 var ATTACHMENT_NAMES = {
   locators: "piwi-locators",
   ariaSnapshot: "piwi-aria-snapshot",
+  ariaSnapshotJson: "piwi-aria-snapshot-json",
   console: "piwi-console",
+  dialogs: "piwi-dialogs",
   network: "piwi-network",
   webVitals: "piwi-web-vitals",
   locatorSuggestion: "piwi-locator-suggestion",
@@ -2018,6 +2031,52 @@ function applyPickToSnapshots(snapshots, pick) {
   return true;
 }
 
+// src/internal/support/aria-sampling.ts
+var path3 = __toESM(require("path"));
+var os2 = __toESM(require("os"));
+var fs = __toESM(require("fs"));
+
+// src/internal/support/instance-id.ts
+var crypto = __toESM(require("crypto"));
+var os = __toESM(require("os"));
+function hashForProject(projectName) {
+  return crypto.createHash("sha1").update(projectName).digest("hex").slice(0, 16);
+}
+
+// src/internal/support/aria-sampling.ts
+function ariaSampleIdentity(filePath, title) {
+  return `${filePath}\0${title}`;
+}
+function getAriaSampleFilePath(projectName) {
+  return path3.join(os2.tmpdir(), `piwi-dashboard-aria-sample-${hashForProject(projectName)}.json`);
+}
+var cachedSets = /* @__PURE__ */ new Map();
+function loadAriaSampleSet(projectName) {
+  if (cachedSets.has(projectName)) return cachedSets.get(projectName);
+  let set = null;
+  try {
+    const raw = fs.readFileSync(getAriaSampleFilePath(projectName), "utf8");
+    const parsed = JSON.parse(raw);
+    if (parsed.projectName === projectName && Array.isArray(parsed.identities)) {
+      set = new Set(parsed.identities.filter((x) => typeof x === "string"));
+    }
+  } catch {
+    set = null;
+  }
+  cachedSets.set(projectName, set);
+  return set;
+}
+function relativeTestFile(file) {
+  return path3.relative(process.cwd(), file).split(path3.sep).join("/");
+}
+function isDueForAriaSample(testInfo) {
+  const projectName = process.env.PIWI_PROJECT_NAME;
+  if (!projectName) return false;
+  const set = loadAriaSampleSet(projectName);
+  if (!set || set.size === 0) return false;
+  return set.has(ariaSampleIdentity(relativeTestFile(testInfo.file), testInfo.title));
+}
+
 // src/internal/capture/capture-fixtures.ts
 function computeCoreVitals(lcpEntries, shiftEntries, eventEntries) {
   const lastLcp = lcpEntries && lcpEntries.length > 0 ? lcpEntries[lcpEntries.length - 1] : null;
@@ -2052,6 +2111,7 @@ function createSink() {
   return {
     networkRequests: [],
     consoleEntries: [],
+    dialogs: [],
     pendingHandlers: [],
     capturedLocators: [],
     capturePromises: [],
@@ -2062,6 +2122,7 @@ function createSink() {
     stashedWebVitals: null,
     stashedPageState: null,
     stashedAria: null,
+    stashedAriaJson: null,
     pickOffered: false,
     userPick: null
   };
@@ -2250,9 +2311,17 @@ async function stashPageState(sink, closing) {
     if (pageState) sink.stashedPageState = pageState;
   }
   const status = sink.testInfo?.status;
-  if (status === "failed" || status === "timedOut" || status === "interrupted") {
-    const aria = await ariaSnapshotBestEffort(page.locator(":root"), 1e3);
+  const sampleAria = async () => {
+    const root = page.locator(":root");
+    const aria = await ariaSnapshotBestEffort(root, 1e3);
     if (aria) sink.stashedAria = aria;
+    const ariaJson = await ariaSnapshotJSONBestEffort(root, 1e3);
+    if (ariaJson) sink.stashedAriaJson = ariaJson;
+  };
+  if (status === "failed" || status === "timedOut" || status === "interrupted") {
+    await sampleAria();
+  } else if (status === "passed" && process.env.PIWI_SAMPLE_ARIA_ON_PASS !== "false" && sink.testInfo && isDueForAriaSample(sink.testInfo)) {
+    await sampleAria();
   }
 }
 async function maybeOpenPicker(sink, closing) {
@@ -2283,6 +2352,7 @@ var INSTRUMENTED_CONTEXTS = /* @__PURE__ */ new WeakSet();
 var PATCHED_BROWSERS = /* @__PURE__ */ new WeakSet();
 var CHAIN_METHOD_SET = new Set(CHAIN_METHODS);
 var ACTION_METHOD_SET = new Set(ACTION_METHODS);
+var LOCATOR_METHOD_SET = new Set(LOCATOR_METHODS);
 var CAPTURED_ATTRS_ARG = {
   keep: [...CAPTURED_ATTRIBUTES],
   tagRoles: TAG_TO_ROLE,
@@ -2335,6 +2405,16 @@ async function ariaSnapshotBestEffort(target, timeout) {
     }
   }
 }
+async function ariaSnapshotJSONBestEffort(target, timeout) {
+  const fn = target.ariaSnapshotJSON;
+  if (typeof fn !== "function") return null;
+  try {
+    const tree = await fn.call(target, timeout != null ? { timeout } : {});
+    return tree == null ? null : JSON.stringify(tree);
+  } catch {
+    return null;
+  }
+}
 function startElementCapture(sink, page, target, seq, callerLocation, used) {
   const probe = probeElement(page, target);
   const settledProbe = probe.then(
@@ -2469,6 +2549,20 @@ function wrapLocator(page, locator, originMethod, originArgs) {
     }
   });
 }
+function wrapFrameLocator(page, frameLocator) {
+  return new Proxy(frameLocator, {
+    get(target, prop) {
+      const original = Reflect.get(target, prop);
+      if (typeof original !== "function") return original;
+      const fn = original;
+      if (!LOCATOR_METHOD_SET.has(prop)) return original;
+      return (...args) => {
+        if (currentSink) currentSink.lastActivePage = page;
+        return wrapLocator(page, fn.apply(target, args), String(prop), args);
+      };
+    }
+  });
+}
 function instrumentPage(page) {
   if (!page || INSTRUMENTED_PAGES.has(page)) return;
   INSTRUMENTED_PAGES.add(page);
@@ -2496,6 +2590,13 @@ function instrumentPage(page) {
         return wrapLocator(page, original(...args), method, args);
       };
     }
+    const originalFrameLocator = typeof page.frameLocator === "function" ? page.frameLocator.bind(page) : null;
+    if (originalFrameLocator) {
+      page.frameLocator = (...args) => {
+        const frame = originalFrameLocator(...args);
+        return args.length === 0 ? wrapFrameLocator(page, frame) : frame;
+      };
+    }
     if (typeof page.on === "function") {
       page.on("framenavigated", () => PROBE_UNSEEDED_PAGES.delete(page));
     }
@@ -2514,6 +2615,24 @@ function instrumentPage(page) {
       });
     }
   });
+  if (typeof page.on === "function") {
+    try {
+      page.on("dialogclosed", (dialog) => {
+        const sink = currentSink;
+        if (!sink) return;
+        try {
+          sink.dialogs.push({
+            type: typeof dialog.type === "function" ? dialog.type() : null,
+            message: typeof dialog.message === "function" ? dialog.message() : null,
+            defaultValue: typeof dialog.defaultValue === "function" ? dialog.defaultValue() || null : null,
+            closedAt: Date.now()
+          });
+        } catch {
+        }
+      });
+    } catch {
+    }
+  }
   page.on("requestfinished", (request) => {
     const sink = currentSink;
     if (!sink) return;
@@ -2640,6 +2759,13 @@ async function flushSink(sink, testInfo) {
           contentType: "text/plain",
           body: snapshot
         });
+        const snapshotJson = (pageReadable ? await ariaSnapshotJSONBestEffort(page.locator(":root")) : null) ?? sink.stashedAriaJson;
+        if (snapshotJson) {
+          await testInfo.attach(ATTACHMENT_NAMES.ariaSnapshotJson, {
+            contentType: "application/json",
+            body: snapshotJson
+          });
+        }
         const failed = sink.failedLocators[sink.failedLocators.length - 1];
         const suggestion = failed ? suggestLocatorsFromAria(failed, snapshot) : null;
         if (suggestion) {
@@ -2656,6 +2782,25 @@ async function flushSink(sink, testInfo) {
     } catch {
     }
   }
+  if (testInfo.status === "passed" && process.env.PIWI_SAMPLE_ARIA_ON_PASS !== "false" && isDueForAriaSample(testInfo)) {
+    try {
+      const snapshot = (pageReadable ? await ariaSnapshotBestEffort(page.locator(":root")) : null) ?? sink.stashedAria;
+      if (snapshot) {
+        await testInfo.attach(ATTACHMENT_NAMES.ariaSnapshot, {
+          contentType: "text/plain",
+          body: snapshot
+        });
+        const snapshotJson = (pageReadable ? await ariaSnapshotJSONBestEffort(page.locator(":root")) : null) ?? sink.stashedAriaJson;
+        if (snapshotJson) {
+          await testInfo.attach(ATTACHMENT_NAMES.ariaSnapshotJson, {
+            contentType: "application/json",
+            body: snapshotJson
+          });
+        }
+      }
+    } catch {
+    }
+  }
   if (sink.userPick) {
     const pick = sink.userPick;
     testInfo.annotations.push({
@@ -2679,6 +2824,12 @@ async function flushSink(sink, testInfo) {
       body: Buffer.from(JSON.stringify(sink.consoleEntries))
     });
   }
+  if (sink.dialogs.length > 0) {
+    await testInfo.attach(ATTACHMENT_NAMES.dialogs, {
+      contentType: "application/json",
+      body: Buffer.from(JSON.stringify(sink.dialogs))
+    });
+  }
   if (sink.networkRequests.length > 0) {
     await testInfo.attach(ATTACHMENT_NAMES.network, {
       contentType: "application/json",
@@ -2744,6 +2895,7 @@ function extendPiwiFixtures(test) {
 0 && (module.exports = {
   CAPTURED_ATTRS_ARG,
   ariaSnapshotBestEffort,
+  ariaSnapshotJSONBestEffort,
   buildPageState,
   computeCoreVitals,
   extendPiwiFixtures,

package/dist/internal/capture/locator-healing.js

@@ -507,6 +507,7 @@ var CHAIN_METHODS = [
   "nth",
   "last",
   "filter",
+  "visible",
   "and",
   "or",
   "locator",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@piwitests/reporter",
-  "version": "0.26.1",
+  "version": "0.27.0",
   "description": "Playwright reporter that streams results, traces and HTML reports to a Piwi Dashboard instance",
   "url": "https://github.com/PiwiTests/platform",
   "homepage": "https://piwitests.dev",