@piwitests/reporter 0.53.0 → 0.55.0

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

@@ -17,6 +17,8 @@ declare const ATTACHMENT_NAMES: {
     readonly pageInventory: "piwi-page-inventory";
     readonly locatorPages: "piwi-locator-pages";
     readonly codeReach: "piwi-code-reach";
+    readonly browserCoverage: "piwi-browser-coverage";
+    readonly browserFunctions: "piwi-browser-functions";
     readonly serverCoverageRequests: "piwi-server-coverage-requests";
     readonly webVitals: "piwi-web-vitals";
     readonly locatorSuggestion: "piwi-locator-suggestion";

package/dist/internal/capture/attachments.js

@@ -42,6 +42,8 @@ var ATTACHMENT_NAMES = {
   pageInventory: "piwi-page-inventory",
   locatorPages: "piwi-locator-pages",
   codeReach: "piwi-code-reach",
+  browserCoverage: "piwi-browser-coverage",
+  browserFunctions: "piwi-browser-functions",
   serverCoverageRequests: "piwi-server-coverage-requests",
   webVitals: "piwi-web-vitals",
   locatorSuggestion: "piwi-locator-suggestion",

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

@@ -35,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
@@ -47,9 +54,17 @@ declare function internalCall<T>(owner: unknown, run: () => Promise<T>): Promise
 interface CodeReachRoots {
     /** Directories a module path or a map source is tried against, first match wins; the repository root is last. */
     roots: string[];
+    /**
+     * Directories tried before `roots` for the scripts an origin serves, or, when the script's own origin has none,
+     * that a page at the origin loads: an application served by several dev servers (one per portal) resolves each
+     * one's modules against its own directory.
+     */
+    byOrigin?: Map<string, string[]>;
     /** Paths go out relative to it. */
     repoRoot: string;
 }
+/** The `codeReachRoots` option: directories for every script, or directories per origin, `*` for the rest. */
+type CodeReachRootsOption = string[] | Record<string, string | string[]>;
 /** Fetches a source map's text; null when it cannot. */
 type MapFetcher = (url: string) => Promise<string | null>;
 /**
@@ -60,20 +75,30 @@ type MapFetcher = (url: string) => Promise<string | null>;
 interface CoveredScript extends JsCoverageEntry {
     /** V8's content hash of the script; without it, the version is a hash of `source`. */
     hash?: string;
+    /** The address of the page's document as it parsed the script, whose origin's roots it falls back on. */
+    pageUrl?: string;
 }
 /**
- * The roots for a test: `codeReachRoots` when set, else the Playwright config's
- * directory; the repository root always comes last, since bundlers name
- * sources from the project root (Turbopack's `[project]/`).
+ * The roots for a test: `codeReachRoots` when set (an array, or the `*` entry of
+ * an object), else the Playwright config's directory; the repository root always
+ * comes last, since bundlers name sources from the project root (Turbopack's
+ * `[project]/`). An object's other keys are origins, each with the directories
+ * tried first for its scripts. Relative directories resolve against the config's.
+ */
+declare function codeReachRoots(configDir: string, configured: CodeReachRootsOption | null | undefined): CodeReachRoots;
+/**
+ * The repository-relative files the covered scripts reached, sorted and capped.
+ * A script whose own origin has no roots takes those of its page's origin: the
+ * page's address as it parsed the script, else `pageUrl`.
  */
-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: CoveredScript[], roots: CodeReachRoots, fetchMap: MapFetcher): Promise<string[]>;
+declare function resolveCodeReach(entries: CoveredScript[], roots: CodeReachRoots, fetchMap: MapFetcher, pageUrl?: string): Promise<string[]>;
 /** A map fetcher through the page's request context, bounded in size and time. */
 declare function pageMapFetcher(page: Page): MapFetcher;
 /**
  * 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.
+ * script's version and to stop as each document is left (its `beforeunload`,
+ * from a listener the capture adds in an isolated world); false when the
+ * browser has none or it fails.
  */
 declare function startCodeReach(page: Page): Promise<boolean>;
 /**
@@ -474,8 +499,11 @@ declare function computeCoreVitals(lcpEntries: RawVitalEntry[] | null, shiftEntr
     cls: number | null;
     inp: number | null;
 } | null;
-/** The code reach roots from `PIWI_CODE_REACH_ROOTS` (a JSON array or a path list). */
-declare function configuredCodeReachRoots(): string[] | null;
+/**
+ * The code reach roots from `PIWI_CODE_REACH_ROOTS`: a JSON array, a JSON object
+ * of directories per origin (`*` for every other origin), or a path list.
+ */
+declare function configuredCodeReachRoots(): CodeReachRootsOption | null;
 /** Page state captured at test end. Storage values and cookie values are NEVER included. */
 interface PageState extends PageInteraction {
     url: string;
@@ -553,13 +581,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
@@ -575,9 +596,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;
@@ -588,8 +611,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>;
 /**