@piwitests/reporter 0.52.0 → 0.54.0

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

@@ -1,3 +1,5 @@
+export { FAILURE_SCREENSHOT_ATTACHMENT } from '@piwitests/core/wire';
+
 /**
  * Names of the `testInfo` attachments the dashboard fixtures produce and the
  * reporter parses. Single source of truth — imported by the producer
@@ -15,6 +17,7 @@ declare const ATTACHMENT_NAMES: {
     readonly pageInventory: "piwi-page-inventory";
     readonly locatorPages: "piwi-locator-pages";
     readonly codeReach: "piwi-code-reach";
+    readonly serverCoverageRequests: "piwi-server-coverage-requests";
     readonly webVitals: "piwi-web-vitals";
     readonly locatorSuggestion: "piwi-locator-suggestion";
     readonly pageState: "piwi-page-state";
@@ -25,6 +28,7 @@ declare const ATTACHMENT_NAMES: {
 };
 /** Set of every internal attachment name — used to skip them when collecting user attachments. */
 declare const INTERNAL_ATTACHMENT_NAMES: ReadonlySet<string>;
+
 /** Annotation type that surfaces a locator-healing suggestion in the report/trace. */
 declare const LOCATOR_SUGGESTION_ANNOTATION: "piwi-locator-suggestion";
 /** Annotation type that surfaces a human-confirmed replacement locator in the report/trace. */

package/dist/internal/capture/attachments.js

@@ -21,11 +21,17 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var attachments_exports = {};
 __export(attachments_exports, {
   ATTACHMENT_NAMES: () => ATTACHMENT_NAMES,
+  FAILURE_SCREENSHOT_ATTACHMENT: () => FAILURE_SCREENSHOT_ATTACHMENT,
   INTERNAL_ATTACHMENT_NAMES: () => INTERNAL_ATTACHMENT_NAMES,
   LOCATOR_SUGGESTION_ANNOTATION: () => LOCATOR_SUGGESTION_ANNOTATION,
   USER_PICK_ANNOTATION: () => USER_PICK_ANNOTATION
 });
 module.exports = __toCommonJS(attachments_exports);
+
+// ../core/src/wire.ts
+var FAILURE_SCREENSHOT_ATTACHMENT = "piwi-failure-screenshot";
+
+// src/internal/capture/attachments.ts
 var ATTACHMENT_NAMES = {
   locators: "piwi-locators",
   ariaSnapshot: "piwi-aria-snapshot",
@@ -36,6 +42,7 @@ var ATTACHMENT_NAMES = {
   pageInventory: "piwi-page-inventory",
   locatorPages: "piwi-locator-pages",
   codeReach: "piwi-code-reach",
+  serverCoverageRequests: "piwi-server-coverage-requests",
   webVitals: "piwi-web-vitals",
   locatorSuggestion: "piwi-locator-suggestion",
   pageState: "piwi-page-state",
@@ -50,6 +57,7 @@ var USER_PICK_ANNOTATION = ATTACHMENT_NAMES.userPick;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ATTACHMENT_NAMES,
+  FAILURE_SCREENSHOT_ATTACHMENT,
   INTERNAL_ATTACHMENT_NAMES,
   LOCATOR_SUGGESTION_ANNOTATION,
   USER_PICK_ANNOTATION

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

@@ -1,5 +1,6 @@
 import { ProbeArg } from '@piwitests/picker-dom';
 export { ProbeArg, ProbedAttrs, probeElementAttrs } from '@piwitests/picker-dom';
+import { PageInteraction } from '@piwitests/core/page-interaction';
 import { Page, TestInfo, TestType, Fixtures, PlaywrightTestArgs, PlaywrightTestOptions, PlaywrightWorkerArgs, PlaywrightWorkerOptions, Locator } from '@playwright/test';
 import { LocatorPageUse, ProcessRole, RoleCost } from '@piwitests/core/wire';
 import { JsCoverageEntry } from '@piwitests/core/code-reach';
@@ -34,6 +35,13 @@ declare class LocatorPageLog {
  * layout leaves Playwright's defaults untouched.
  */
 declare function boxCaptureFrames(extraPrefixes?: readonly string[]): void;
+/**
+ * Call a Playwright method on its own receiver. Playwright names an API call
+ * after the method frame the call enters, so the call keeps its real name
+ * (`locator.fill: Timeout …`); a call through `Function.prototype.apply` is
+ * named `apply`.
+ */
+declare function callMethod(target: object, prop: string | symbol, args: unknown[]): unknown;
 /**
  * Run a page read as an internal Playwright call: every API call made inside
  * `run` is kept out of the test's steps and the trace. `owner` is the page (or
@@ -51,6 +59,15 @@ interface CodeReachRoots {
 }
 /** Fetches a source map's text; null when it cannot. */
 type MapFetcher = (url: string) => Promise<string | null>;
+/**
+ * One covered script: its function coverage (one range per function), V8's
+ * content hash, and its source, which is left out when the worker has already
+ * resolved that version of the script.
+ */
+interface CoveredScript extends JsCoverageEntry {
+    /** V8's content hash of the script; without it, the version is a hash of `source`. */
+    hash?: string;
+}
 /**
  * The roots for a test: `codeReachRoots` when set, else the Playwright config's
  * directory; the repository root always comes last, since bundlers name
@@ -58,13 +75,19 @@ type MapFetcher = (url: string) => Promise<string | null>;
  */
 declare function codeReachRoots(configDir: string, configured: string[] | null | undefined): CodeReachRoots;
 /** The repository-relative files the covered scripts reached, sorted and capped. */
-declare function resolveCodeReach(entries: JsCoverageEntry[], roots: CodeReachRoots, fetchMap: MapFetcher): Promise<string[]>;
+declare function resolveCodeReach(entries: CoveredScript[], roots: CodeReachRoots, fetchMap: MapFetcher): Promise<string[]>;
 /** A map fetcher through the page's request context, bounded in size and time. */
 declare function pageMapFetcher(page: Page): MapFetcher;
-/** Start JavaScript coverage on a page; false when the browser has none or it fails. */
+/**
+ * Start function coverage on a page, with the debugger on to learn each
+ * script's version; false when the browser has none or it fails.
+ */
 declare function startCodeReach(page: Page): Promise<boolean>;
-/** Stop JavaScript coverage and return its entries; null when it cannot be read. */
-declare function stopCodeReach(page: Page): Promise<JsCoverageEntry[] | null>;
+/**
+ * Stop the page's coverage and return the scripts parsed since it started,
+ * each with its functions and version; null when it cannot be read.
+ */
+declare function stopCodeReach(page: Page): Promise<CoveredScript[] | null>;
 
 interface ProcStat {
     pid: number;
@@ -424,6 +447,18 @@ declare function noteResourceUse(page: object): void;
  */
 declare function recordResourceCensus(testInfo: TestInfo): Promise<void>;
 
+/**
+ * Reads, in the page, what it is doing beyond its DOM: the element holding keyboard focus (and the caret or
+ * selected range of a text field), the element under the mouse, a text selection outside fields, and the
+ * checkboxes in the indeterminate state. Elements are named by element path and text by offset, the format
+ * `@piwitests/core/page-interaction` describes and the dashboard resolves in the failure-time DOM. Never reads
+ * a field's value or the selected text.
+ *
+ * Runs in the browser through `page.evaluate`, so it is self-contained: no reference to this module's scope,
+ * and `any` for the DOM this package has no types for.
+ */
+declare function readPageInteraction(): PageInteraction;
+
 type FixtureArgs = {
     [key: string]: any;
 };
@@ -449,7 +484,7 @@ declare function computeCoreVitals(lcpEntries: RawVitalEntry[] | null, shiftEntr
 /** The code reach roots from `PIWI_CODE_REACH_ROOTS` (a JSON array or a path list). */
 declare function configuredCodeReachRoots(): string[] | null;
 /** Page state captured at test end. Storage values and cookie values are NEVER included. */
-interface PageState {
+interface PageState extends PageInteraction {
     url: string;
     hash: string | null;
     /** `history.state` as JSON, capped and token-masked. */
@@ -489,11 +524,12 @@ interface RawPageState {
     }>;
 }
 /**
- * Assemble the wire page-state from the in-page reads and the context cookies.
- * Pure and Node-side so the sanitization (token masking, caps, value-free
- * cookies) is unit-testable.
+ * Assemble the wire page-state from the in-page reads, the context cookies and
+ * what the page was doing (`readPageInteraction`). Pure and Node-side so the
+ * sanitization (token masking, caps, value-free cookies, well-formed element
+ * paths) is unit-testable.
  */
-declare function buildPageState(raw: RawPageState, cookies: Array<Record<string, unknown>> | null): PageState;
+declare function buildPageState(raw: RawPageState, cookies: Array<Record<string, unknown>> | null, interaction?: unknown): PageState;
 /**
  * Everything the in-page probe needs, serialized into the browser on every
  * action. `tagRoles`/`inputRoles` are the shared role maps (single source of
@@ -524,13 +560,6 @@ declare function ariaSnapshotBestEffort(target: Locator, timeout?: number): Prom
  * yields null and the capture proceeds with the YAML alone.
  */
 declare function ariaSnapshotJSONBestEffort(target: Locator, timeout?: number): Promise<string | null>;
-/**
- * Call a Playwright method on its own receiver. Playwright names an API call
- * after the method frame the call enters, so the call keeps its real name
- * (`locator.fill: Timeout …`); a call through `Function.prototype.apply` is
- * named `apply`.
- */
-declare function callMethod(target: object, prop: string | symbol, args: unknown[]): unknown;
 /**
  * The fixtures `piwiFixtures` / `extendPiwiFixtures` contribute. The single
  * added fixture is `piwiCapture`: an auto, test-scoped teardown hook that
@@ -546,9 +575,11 @@ interface PiwiFixtures {
  * The worker fixture `piwiFixtures` / `extendPiwiFixtures` contribute:
  * `piwiResources`, an auto, worker-scoped fixture that keeps the worker's
  * resource ledger (the browsers, contexts, pages and API request contexts its
- * tests open) from before the first hook to the worker's shutdown. Its name is
- * **reserved** like `piwiCapture`'s: a fixture of your own with that name
- * replaces it and turns the ledger off.
+ * tests open) from before the first hook to the worker's shutdown, and records
+ * the calls tests make through the API request contexts `playwright.request`
+ * creates, the `request` fixture's among them. Its name is **reserved** like
+ * `piwiCapture`'s: a fixture of your own with that name replaces it and turns
+ * the ledger and those calls' capture off.
  */
 interface PiwiWorkerFixtures {
     piwiResources: void;
@@ -559,8 +590,11 @@ interface PiwiWorkerFixtures {
  *
  * Capture is wired at the `browser` level, so it works whether a test uses the
  * standard `page` fixture or builds its own pages from `browser` /
- * `browser.newContext()`. Collected data is attached as `piwi-*`
- * test-info attachments which the Piwi Dashboard reporter parses on `onTestEnd`.
+ * `browser.newContext()`. The calls a test makes through an API request
+ * context (the `request` fixture, `playwright.request.newContext()`,
+ * `page.request`) are recorded with its network requests. Collected data is
+ * attached as `piwi-*` test-info attachments which the Piwi Dashboard reporter
+ * parses on `onTestEnd`.
  */
 declare const piwiFixtures: Fixtures<PiwiFixtures, PiwiWorkerFixtures, PlaywrightTestArgs & PlaywrightTestOptions, PlaywrightWorkerArgs & PlaywrightWorkerOptions>;
 /**
@@ -581,4 +615,4 @@ declare const piwiFixtures: Fixtures<PiwiFixtures, PiwiWorkerFixtures, Playwrigh
  */
 declare function extendPiwiFixtures<TestArgs extends FixtureArgs, WorkerArgs extends FixtureArgs>(test: TestType<TestArgs, WorkerArgs>): TestType<TestArgs & PiwiFixtures, WorkerArgs & PiwiWorkerFixtures>;
 
-export { CAPTURED_ATTRS_ARG, LocatorPageLog, type PageState, type PiwiFixtures, type PiwiWorkerFixtures, type RawPageState, type RawVitalEntry, activeResourceLedger, ariaSnapshotBestEffort, ariaSnapshotJSONBestEffort, boxCaptureFrames, buildPageState, callMethod, codeReachRoots, computeCoreVitals, configuredCodeReachRoots, extendPiwiFixtures, internalCall, noteLocatorCall, noteNavigation, noteResourceUse, pageMapFetcher, piwiFixtures, recordResourceCensus, resolveCodeReach, startCodeReach, startResourceLedger, stopCodeReach, stopResourceLedger };
+export { CAPTURED_ATTRS_ARG, LocatorPageLog, type PageState, type PiwiFixtures, type PiwiWorkerFixtures, type RawPageState, type RawVitalEntry, activeResourceLedger, ariaSnapshotBestEffort, ariaSnapshotJSONBestEffort, boxCaptureFrames, buildPageState, callMethod, codeReachRoots, computeCoreVitals, configuredCodeReachRoots, extendPiwiFixtures, internalCall, noteLocatorCall, noteNavigation, noteResourceUse, pageMapFetcher, piwiFixtures, readPageInteraction, recordResourceCensus, resolveCodeReach, startCodeReach, startResourceLedger, stopCodeReach, stopResourceLedger };