@piwitests/reporter 0.48.0 → 0.49.0

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

@@ -29,6 +29,8 @@ interface InspectionGate {
     /** Configured retry count for the project (`testInfo.project.retries`). */
     retries: number;
 }
+/** True when this raw `CI` env value counts as "running under CI". */
+declare function isCi(ci: string | undefined): boolean;
 /** Decide whether the failing page should be handed to the Inspector. */
 declare function shouldInspectOnFailure(gate: InspectionGate): boolean;
 /**
@@ -47,4 +49,4 @@ declare function environmentalSkipReason(gate: InspectionGate): string | null;
  */
 declare function inspectionGateFromTestInfo(testInfo: TestInfo, enabled?: string | undefined): InspectionGate;
 
-export { type InspectionGate, environmentalSkipReason, inspectionGateFromTestInfo, shouldInspectOnFailure };
+export { type InspectionGate, environmentalSkipReason, inspectionGateFromTestInfo, isCi, shouldInspectOnFailure };

package/dist/internal/capture/inspect-on-failure.js

@@ -22,6 +22,7 @@ var inspect_on_failure_exports = {};
 __export(inspect_on_failure_exports, {
   environmentalSkipReason: () => environmentalSkipReason,
   inspectionGateFromTestInfo: () => inspectionGateFromTestInfo,
+  isCi: () => isCi,
   shouldInspectOnFailure: () => shouldInspectOnFailure
 });
 module.exports = __toCommonJS(inspect_on_failure_exports);
@@ -62,5 +63,6 @@ function inspectionGateFromTestInfo(testInfo, enabled = process.env.PIWI_INSPECT
 0 && (module.exports = {
   environmentalSkipReason,
   inspectionGateFromTestInfo,
+  isCi,
   shouldInspectOnFailure
 });

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

@@ -1,5 +1,5 @@
 import { TestInfo, Page } from '@playwright/test';
-import { ProbeArg, ProbedAttrs, PickedAnchorInfo } from '@piwitests/picker-dom';
+import { PickedAnchorInfo, ProbeArg, ProbedAttrs } from '@piwitests/picker-dom';
 export { PickedAnchorInfo, PickedLeafInfo, generateAnchoredAlternatives, installPickerOverlay, mergeCandidates, showAnchorPicker, showPickerChoices } from '@piwitests/picker-dom';
 import { FailedLocatorInfo } from './locator-healing.js';
 import { RankedLocator, LocatorSnapshot } from '@piwitests/core/locator-healing-types';
@@ -55,13 +55,21 @@ declare function parseLeafLocatorExpression(rawExpr: string): {
  * when no locator can be identified. Exported for tests.
  */
 declare function deriveFailedLocator(testInfo: TestInfo): FailedLocatorInfo | null;
+/** What the element → anchors → confirm flow yields: the confirmed locator, its alternatives and the element. */
+type PickedLocator = Omit<UserPickResult, 'failing'>;
 /**
- * Drive the full pick flow on the failing page: element pick (snap +
- * tree-walk), optional stable-parent anchoring with live match counts, ranked
+ * Run the element → anchors → confirm flow on a live page: element pick (snap
+ * + tree-walk), optional stable-parent anchoring with live match counts, ranked
  * candidates (standard generation merged with anchor-scoped chains), and a
- * final confirmation. The test timeout is lifted while waiting. Returns null
- * when skipped or when anything breaks — the picker must never mask the
- * test's own failure.
+ * final confirmation. `failing` is the locator the pick replaces, rendered, for
+ * the overlay's headings; null to pick any element. Returns null when the
+ * human skips or no locator could be generated; throws when the page breaks.
+ */
+declare function pickLocator(page: Page, probe: PickerProbe, failing: string | null): Promise<PickedLocator | null>;
+/**
+ * Drive the full pick flow on the failing page (`pickLocator`), the test
+ * timeout lifted while waiting. Returns null when skipped or when anything
+ * breaks — the picker must never mask the test's own failure.
  */
 declare function runLocatorPicker(page: Page, testInfo: TestInfo, failed: FailedLocatorInfo | null, probe: PickerProbe): Promise<UserPickResult | null>;
 /**
@@ -80,4 +88,4 @@ declare function runLocatorPicker(page: Page, testInfo: TestInfo, failed: Failed
  */
 declare function applyPickToSnapshots(snapshots: LocatorSnapshot[], pick: UserPickResult): boolean;
 
-export { type PickerProbe, type UserPickResult, applyPickToSnapshots, deriveFailedLocator, parseLeafLocatorExpression, runLocatorPicker };
+export { type PickedLocator, type PickerProbe, type UserPickResult, applyPickToSnapshots, deriveFailedLocator, parseLeafLocatorExpression, pickLocator, runLocatorPicker };

package/dist/internal/capture/pick-on-failure.js

@@ -36,6 +36,7 @@ __export(pick_on_failure_exports, {
   installPickerOverlay: () => installPickerOverlay,
   mergeCandidates: () => mergeCandidates,
   parseLeafLocatorExpression: () => parseLeafLocatorExpression,
+  pickLocator: () => pickLocator,
   runLocatorPicker: () => runLocatorPicker,
   showAnchorPicker: () => showAnchorPicker,
   showPickerChoices: () => showPickerChoices
@@ -1544,25 +1545,16 @@ async function cleanupPicker(page) {
   } catch {
   }
 }
-async function runLocatorPicker(page, testInfo, failed, probe) {
+async function pickLocator(page, probe, failing) {
   try {
-    testInfo.setTimeout(0);
-    const rendered = failed ? renderFailing(failed) : null;
-    console.log(
-      `
-[piwi] "${testInfo.title}" ${testInfo.status} \u2014 ${rendered ? "locator picker" : "inspector"} open in the browser: ${rendered ? `click the element that should replace ${rendered}` : "click any element to generate locators for it"} (\u2191/\u2193 to select a parent/child, Esc to skip).`
-    );
-    const overlayArg = { transport: "global", failing: rendered };
+    const overlayArg = { transport: "global", failing };
     await page.evaluate(installPickerOverlay, overlayArg);
     await page.waitForFunction(() => globalThis.__piwiPickState !== void 0, void 0, {
       timeout: 0,
       polling: 250
     });
     const state = await page.evaluate(() => globalThis.__piwiPickState);
-    if (state !== "picked") {
-      await cleanupPicker(page);
-      return null;
-    }
+    if (state !== "picked") return null;
     const handle = await page.evaluateHandle(() => globalThis.__piwiPickedElement);
     const attrs = await handle.evaluate(probe.fn, probe.arg);
     await handle.dispose();
@@ -1600,11 +1592,10 @@ async function runLocatorPicker(page, testInfo, failed, probe) {
     );
     if (ranked.length === 0) {
       console.log("[piwi] No stable locator could be generated for the picked element \u2014 nothing recorded.");
-      await cleanupPicker(page);
       return null;
     }
     await page.evaluate(showPickerChoices, {
-      failing: rendered,
+      failing,
       choices: ranked.map((r) => ({ locator: r.locator, score: r.score }))
     });
     await page.waitForFunction(() => globalThis.__piwiPickChoice !== void 0, void 0, {
@@ -1612,31 +1603,45 @@ async function runLocatorPicker(page, testInfo, failed, probe) {
       polling: 250
     });
     const choice = await page.evaluate(() => globalThis.__piwiPickChoice);
-    await cleanupPicker(page);
     if (typeof choice !== "number" || choice < 0 || choice >= ranked.length) return null;
     const picked = { ...ranked[choice], pickedByUser: true };
-    const alternatives = [picked, ...ranked.filter((_, i) => i !== choice)];
-    const element = {
-      tagName: attrs.tagName,
-      attributes: attrs.attributes,
-      textContent: attrs.textContent,
-      accessibleName,
-      center: attrs.center,
-      ...attrs.rolePosition ? { rolePosition: attrs.rolePosition } : {},
-      ...attrs.ancestors && attrs.ancestors.length > 0 ? { ancestors: attrs.ancestors } : {}
+    return {
+      picked,
+      alternatives: [picked, ...ranked.filter((_, i) => i !== choice)],
+      element: {
+        tagName: attrs.tagName,
+        attributes: attrs.attributes,
+        textContent: attrs.textContent,
+        accessibleName,
+        center: attrs.center,
+        ...attrs.rolePosition ? { rolePosition: attrs.rolePosition } : {},
+        ...attrs.ancestors && attrs.ancestors.length > 0 ? { ancestors: attrs.ancestors } : {}
+      },
+      ...anchors.length > 0 ? { anchors } : {}
     };
+  } finally {
+    await cleanupPicker(page);
+  }
+}
+async function runLocatorPicker(page, testInfo, failed, probe) {
+  try {
+    testInfo.setTimeout(0);
+    const rendered = failed ? renderFailing(failed) : null;
+    console.log(
+      `
+[piwi] "${testInfo.title}" ${testInfo.status} \u2014 ${rendered ? "locator picker" : "inspector"} open in the browser: ${rendered ? `click the element that should replace ${rendered}` : "click any element to generate locators for it"} (\u2191/\u2193 to select a parent/child, Esc to skip).`
+    );
+    const pick = await pickLocator(page, probe, rendered);
+    if (!pick) return null;
     const location = failed?.location ?? null;
     console.log(
       failed ? `[piwi] Replacement picked for ${rendered}${location ? ` at ${location}` : ""}:
-[piwi]   ${picked.locator}` : `[piwi] Locator picked while inspecting:
-[piwi]   ${picked.locator}`
+[piwi]   ${pick.picked.locator}` : `[piwi] Locator picked while inspecting:
+[piwi]   ${pick.picked.locator}`
     );
     return {
       failing: failed ? { method: failed.method, args: failed.args, rendered, location } : null,
-      picked,
-      alternatives,
-      element,
-      ...anchors.length > 0 ? { anchors } : {}
+      ...pick
     };
   } catch {
     return null;
@@ -1676,6 +1681,7 @@ function applyPickToSnapshots(snapshots, pick) {
   installPickerOverlay,
   mergeCandidates,
   parseLeafLocatorExpression,
+  pickLocator,
   runLocatorPicker,
   showAnchorPicker,
   showPickerChoices

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@piwitests/reporter",
-  "version": "0.48.0",
+  "version": "0.49.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",