@piwitests/reporter 0.19.0 → 0.21.0

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

@@ -146,6 +146,12 @@ var TAG_TO_ROLE = {
   figcaption: "caption",
   blockquote: "blockquote",
   table: "table",
+  caption: "caption",
+  thead: "rowgroup",
+  tbody: "rowgroup",
+  tfoot: "rowgroup",
+  tr: "row",
+  td: "cell",
   ul: "list",
   ol: "list",
   li: "listitem",
@@ -241,13 +247,19 @@ function classifyCssStability(className) {
 function isAutoGenerated(value) {
   if (/^[a-f0-9]{8}-([a-f0-9]{4}-){3}[a-f0-9]{12}$/i.test(value)) return true;
   if (/^[a-f0-9]{8,}$/i.test(value)) return true;
-  if (/^[a-z]+-\d+$/.test(value)) return true;
+  if (/^[a-z]+-\d{4,}$/.test(value)) return true;
+  if (/^(tab|panel|input|select|option|dialog|modal|popup|tooltip|menu|listbox|combobox|checkbox|radio|textarea|button|field|label|accordion|collapse|step|slider|toggle|switch|dropdown|overlay|portal|layer)-\d+$/i.test(
+    value
+  )) {
+    return true;
+  }
   if (/^(emotion-|styled-|css-|sc-)/.test(value)) return true;
   if (value.startsWith("ng-")) return true;
   if (/^(radix-|headlessui-|mui-|mantine-|chakra-)/i.test(value)) return true;
   if (/^:r[0-9a-z]+:$/i.test(value) || /^«r[0-9a-z]+»$/i.test(value)) return true;
   return false;
 }
+var TEST_DATA_ATTRS = /* @__PURE__ */ new Set(["data-test", "data-test-id", "data-qa", "data-qa-id", "data-cy", "data-e2e"]);
 function generateAlternatives(attrs) {
   const alts = [];
   const seen = /* @__PURE__ */ new Set();
@@ -262,6 +274,7 @@ function generateAlternatives(attrs) {
   const role = resolveAriaRole(attrs);
   const counts = attrs.selectorCounts;
   const isUnique = (n) => n == null || n <= 1;
+  const ambiguityPenalty = (n) => n != null && n > 1 ? 45 : 0;
   const text = attrs.textContent ? attrs.textContent.replace(/\s+/g, " ").trim() : null;
   const testId = attr(attrs, "data-testid");
   if (testId && isUnique(counts?.testId)) {
@@ -280,7 +293,7 @@ function generateAlternatives(attrs) {
       locator: `getByRole('${role}', { name: '${esc(accessibleName)}'${levelPart} })`,
       method: "getByRole",
       args: withLevel({ role, name: accessibleName }),
-      score: 90
+      score: 90 - ambiguityPenalty(counts?.roleName)
     });
   }
   const ariaLabel = attr(attrs, "aria-label");
@@ -289,7 +302,7 @@ function generateAlternatives(attrs) {
       locator: `getByRole('${role}', { name: '${esc(ariaLabel)}'${levelPart} })`,
       method: "getByRole",
       args: withLevel({ role, name: ariaLabel }),
-      score: 85
+      score: 85 - ambiguityPenalty(counts?.roleName)
     });
   }
   if (accessibleName && ["input", "select", "textarea"].includes(tag)) {
@@ -310,7 +323,7 @@ function generateAlternatives(attrs) {
       locator: `getByPlaceholder('${esc(placeholder)}')`,
       method: "getByPlaceholder",
       args: { placeholder },
-      score: 80
+      score: 80 - ambiguityPenalty(counts?.placeholder)
     });
   }
   if (text && text.length < 80) {
@@ -318,7 +331,7 @@ function generateAlternatives(attrs) {
       locator: `getByText('${esc(text)}')`,
       method: "getByText",
       args: { text },
-      score: 75
+      score: 75 - ambiguityPenalty(counts?.text)
     });
   }
   const id = attr(attrs, "id");
@@ -347,7 +360,7 @@ function generateAlternatives(attrs) {
       locator: `getByAltText('${esc(alt)}')`,
       method: "getByAltText",
       args: { text: alt },
-      score: 60
+      score: 60 - ambiguityPenalty(counts?.alt)
     });
   }
   const title = attr(attrs, "title");
@@ -356,48 +369,77 @@ function generateAlternatives(attrs) {
       locator: `getByTitle('${esc(title)}')`,
       method: "getByTitle",
       args: { title },
-      score: 50
+      score: 50 - ambiguityPenalty(counts?.title)
     });
   }
   const hasOwnTestId = !!(testId && isUnique(counts?.testId));
-  if (role && !hasOwnTestId) {
-    const rolePart = level != null ? `'${role}', { level: ${level} }` : `'${role}'`;
-    const leafArgs = withLevel({ role });
+  const addAnchoredChains = (leaf, scopedCount, scores) => {
     let testIdAnchorDone = false;
     let idAnchorDone = false;
     let roleAnchorDone = false;
+    let dataAnchorDone = false;
+    let filterAnchorDone = false;
     for (const anc of attrs.ancestors ?? []) {
-      if (anc.scopedRoleCount !== 1) continue;
+      if (scopedCount(anc) !== 1) continue;
       if (!testIdAnchorDone && anc.testId && anc.testIdCount === 1) {
         testIdAnchorDone = true;
         add({
-          locator: `getByTestId('${esc(anc.testId)}').getByRole(${rolePart})`,
-          method: "getByRole",
-          args: { ...leafArgs, anchorTestId: anc.testId },
-          score: 72
+          locator: `getByTestId('${esc(anc.testId)}').${leaf.expr}`,
+          method: leaf.method,
+          args: { ...leaf.args, anchorTestId: anc.testId },
+          score: scores.testId
         });
       }
       if (!idAnchorDone && anc.id && !isAutoGenerated(anc.id) && anc.idCount === 1) {
         idAnchorDone = true;
         const anchorSelector = isCssSafeId(anc.id) ? `#${anc.id}` : `[id="${escCssAttrValue(anc.id)}"]`;
         add({
-          locator: `locator('${esc(anchorSelector)}').getByRole(${rolePart})`,
-          method: "getByRole",
-          args: { ...leafArgs, anchorSelector },
-          score: 64
+          locator: `locator('${esc(anchorSelector)}').${leaf.expr}`,
+          method: leaf.method,
+          args: { ...leaf.args, anchorSelector },
+          score: scores.id
+        });
+      }
+      if (!dataAnchorDone && anc.dataAttr && anc.dataAttrCount === 1) {
+        dataAnchorDone = true;
+        const { name: name2, value } = anc.dataAttr;
+        const anchorSelector = `[${name2}="${escCssAttrValue(value)}"]`;
+        add({
+          locator: `locator('${esc(anchorSelector)}').${leaf.expr}`,
+          method: leaf.method,
+          args: { ...leaf.args, anchorSelector },
+          score: TEST_DATA_ATTRS.has(name2) ? scores.testData : scores.data
         });
       }
       const ancestorRole = anc.role || TAG_TO_ROLE[anc.tag] || null;
-      if (!roleAnchorDone && ancestorRole && ancestorRole !== role && anc.roleCount === 1) {
+      if (!roleAnchorDone && ancestorRole && ancestorRole !== leaf.role && anc.roleCount === 1) {
         roleAnchorDone = true;
         add({
-          locator: `getByRole('${esc(ancestorRole)}').getByRole(${rolePart})`,
-          method: "getByRole",
-          args: { ...leafArgs, anchorRole: ancestorRole },
-          score: 55
+          locator: `getByRole('${esc(ancestorRole)}').${leaf.expr}`,
+          method: leaf.method,
+          args: { ...leaf.args, anchorRole: ancestorRole },
+          score: scores.role
+        });
+      }
+      if (!filterAnchorDone && ancestorRole && anc.filterText && anc.filterRoleCount === 1) {
+        filterAnchorDone = true;
+        add({
+          locator: `getByRole('${esc(ancestorRole)}').filter({ hasText: '${esc(anc.filterText)}' }).${leaf.expr}`,
+          method: leaf.method,
+          args: { ...leaf.args, anchorRole: ancestorRole, anchorHasText: anc.filterText },
+          score: scores.filter
         });
       }
     }
+  };
+  if (role && !hasOwnTestId) {
+    const rolePart = level != null ? `'${role}', { level: ${level} }` : `'${role}'`;
+    const leafArgs = withLevel({ role });
+    addAnchoredChains(
+      { expr: `getByRole(${rolePart})`, method: "getByRole", args: leafArgs, role },
+      (anc) => anc.scopedRoleCount,
+      { testId: 72, testData: 70, id: 64, data: 60, role: 55, filter: 53 }
+    );
     const pos = attrs.rolePosition;
     if (pos && pos.role === role && (pos.count === 1 || level != null && pos.levelCount === 1)) {
       add({
@@ -407,6 +449,12 @@ function generateAlternatives(attrs) {
         score: 58
       });
     }
+  } else if (!role && text && text.length < 80 && !hasOwnTestId) {
+    addAnchoredChains(
+      { expr: `getByText('${esc(text)}')`, method: "getByText", args: { text }, role: null },
+      (anc) => anc.scopedTextCount,
+      { testId: 68, testData: 66, id: 60, data: 56, role: 51, filter: 49 }
+    );
   }
   const clsStr = attr(attrs, "class");
   if (clsStr) {

package/dist/internal/capture/pick-on-failure.d.ts

@@ -1,80 +1,18 @@
 import { TestInfo, Page } from '@playwright/test';
+import { ProbeArg, ProbedAttrs, PickedAnchorInfo } from '@piwitests/picker-dom';
+export { PickedAnchorInfo, PickedLeafInfo, generateAnchoredAlternatives, installPickerOverlay, mergeCandidates, showAnchorPicker, showPickerChoices } from '@piwitests/picker-dom';
 import { FailedLocatorInfo } from './locator-healing.js';
-import { SelectorCounts, RolePosition, AncestorAnchor, RankedLocator, LocatorSnapshot } from '@piwitests/core/locator-healing-types';
+import { RankedLocator, LocatorSnapshot } from '@piwitests/core/locator-healing-types';
 import '@piwitests/core/locator-generation';
 
-/**
- * Failure-time locator picker: when enabled (opt-in via the
- * `pickLocatorOnFailure` reporter option / `PIWI_PICK_LOCATOR_ON_FAIL`), a
- * test whose locator action failed gets a picker overlay injected into the
- * still-open page. The flow is guided:
- *
- *  1. **Element** — hover highlights, a click picks. The pick snaps to the
- *     nearest actionable ancestor (a click on the `<span>` inside a button
- *     picks the button), and ↑/↓ walk the DOM tree before the click commits.
- *  2. **Anchors** — the element's ancestors are listed; the human can bless
- *     one or more *stable parents* to scope the locator to, with a live
- *     "matches N" count for the current selection against the failing page.
- *  3. **Confirm** — ranked replacement locators (standard generation merged
- *     with the anchor-scoped candidates) are listed; the human confirms one.
- *
- * The confirmed pick is folded into the failing call site's locator snapshot
- * (so it rides the normal `piwi-locators` wire into the dashboard's healing
- * panel) and attached as `piwi-user-pick` plus a report annotation.
- *
- * Gated exactly like failure-time inspection (`inspect-on-failure.ts`):
- * headed browser, never CI, final attempt only.
- */
-/** Element shape the in-page probe returns — structural view of what the picker needs. */
-interface ProbedAttrs {
-    tagName: string;
-    attributes: Record<string, string | null>;
-    textContent: string | null;
-    center: {
-        x: number;
-        y: number;
-    } | null;
-    hasLabel?: boolean;
-    selectorCounts?: SelectorCounts;
-    rolePosition?: RolePosition | null;
-    ancestors?: AncestorAnchor[];
-}
 /**
  * The probe dependency, passed in by the capture fixture to avoid an import
  * cycle. `fn` is the fixture's in-page element probe (`probeElementAttrs`);
  * `el` is a browser-side element, hence `any` (no DOM lib in this package).
- * `arg` is the fixture's `CAPTURED_ATTRS_ARG` — its role maps also drive the
- * anchor step's in-page role resolution.
  */
 interface PickerProbe {
-    fn: (el: any, arg: any) => ProbedAttrs;
-    arg: unknown;
-}
-/** An ancestor the human blessed as an anchor, with its in-page uniqueness counts. */
-interface PickedAnchorInfo {
-    tag: string;
-    /** Hops from the picked element (1 = direct parent). */
-    depth: number;
-    testId: string | null;
-    id: string | null;
-    ariaLabel: string | null;
-    /** Resolved anchor role (explicit attribute or tag-implied). */
-    role: string | null;
-    /** Document-wide match count for the anchor's own data-testid. */
-    testIdCount?: number;
-    /** Document-wide match count for the anchor's own id. */
-    idCount?: number;
-    /** Document-wide count of same-role elements carrying the same aria-label. */
-    labeledRoleCount?: number;
-    /** Document-wide count of elements resolving to the anchor's role. */
-    roleCount?: number;
-    /** Leaf matches (picked element's identity) within this anchor's subtree. */
-    scopedLeafCount?: number;
-}
-/** The picked element's identity used for anchor-scoped candidates. */
-interface PickedLeafInfo {
-    role: string | null;
-    level: number | null;
+    fn: (el: any, arg: ProbeArg) => ProbedAttrs;
+    arg: ProbeArg;
 }
 /** A confirmed pick — everything the fixture records about the human's choice. */
 interface UserPickResult {
@@ -113,63 +51,6 @@ declare function parseLeafLocatorExpression(rawExpr: string): {
  * when no locator can be identified. Exported for tests.
  */
 declare function deriveFailedLocator(testInfo: TestInfo): FailedLocatorInfo | null;
-/**
- * Build anchor-scoped candidates from the human-blessed parents. Shapes stay
- * consistent with the heuristic chains in `generateAlternatives` — leaf method
- * `getByRole` with flat anchor args, no leaf `name` key. Single-anchor
- * candidates require the leaf to be unique inside that anchor; with two or
- * more anchors a combined chain is added when the whole chain resolves to
- * exactly one element (`chainLeafCount`). Pure — exported for tests.
- */
-declare function generateAnchoredAlternatives(leaf: PickedLeafInfo, anchors: PickedAnchorInfo[], chainLeafCount?: number): RankedLocator[];
-/** Merge candidate lists, first list winning duplicates, sorted by score. Exported for tests. */
-declare function mergeCandidates(base: RankedLocator[], extra: RankedLocator[]): RankedLocator[];
-/**
- * Runs inside the browser via `evaluate()` — installs the element-picking
- * overlay: a hover highlight, an instruction banner, and capture-phase
- * listeners that suppress the app's own handlers while picking. The hover
- * target snaps to the nearest actionable ancestor (button/link/field/role/
- * testid) and ↑/↓ walk the DOM chain before the click commits. Resolves
- * through `__piwiPickState` ('picked' | 'skipped') polled from Node; the
- * picked element is parked in `__piwiPickedElement` for an `evaluateHandle`
- * read. Must stay fully self-contained (no module-closure references).
- */
-declare function installPickerOverlay(arg: {
-    failing: string | null;
-}): void;
-/**
- * Runs inside the browser via `evaluate()` — the anchor step: lists the picked
- * element's ancestors so the human can bless one or more stable parents to
- * scope the locator to. Each row shows the ancestor's strongest hook and how
- * many leaf matches it contains; the footer shows a live "matches N" count for
- * the combined selection, recomputed against the real failing page on every
- * toggle (exactly 1 = green). Hovering a row outlines that ancestor in the
- * page. Resolves through `__piwiAnchorState` ('done' | 'skipped'); selected
- * anchors land in `__piwiPickAnchors` (+ `__piwiPickChainCount`). Role
- * resolution reuses the maps passed in `arg` (single source of truth in
- * locator-healing.ts). Must stay fully self-contained.
- */
-declare function showAnchorPicker(arg: {
-    tagRoles: Record<string, string>;
-    inputRoles: Record<string, string>;
-    roleSources: string;
-    leafRole: string;
-    leafLevel: number | null;
-    leafTestId: string | null;
-}): void;
-/**
- * Runs inside the browser via `evaluate()` — replaces the pick overlay with a
- * confirmation panel listing the ranked replacement locators. The chosen index
- * lands in `__piwiPickChoice` (-1 = skipped), polled from Node. Must stay
- * fully self-contained.
- */
-declare function showPickerChoices(arg: {
-    failing: string | null;
-    choices: Array<{
-        locator: string;
-        score: number;
-    }>;
-}): void;
 /**
  * Drive the full pick flow on the failing page: element pick (snap +
  * tree-walk), optional stable-parent anchoring with live match counts, ranked
@@ -195,4 +76,4 @@ declare function runLocatorPicker(page: Page, testInfo: TestInfo, failed: Failed
  */
 declare function applyPickToSnapshots(snapshots: LocatorSnapshot[], pick: UserPickResult): boolean;
 
-export { type PickedAnchorInfo, type PickedLeafInfo, type PickerProbe, type UserPickResult, applyPickToSnapshots, deriveFailedLocator, generateAnchoredAlternatives, installPickerOverlay, mergeCandidates, parseLeafLocatorExpression, runLocatorPicker, showAnchorPicker, showPickerChoices };
+export { type PickerProbe, type UserPickResult, applyPickToSnapshots, deriveFailedLocator, parseLeafLocatorExpression, runLocatorPicker };