@piwitests/reporter 0.39.0 → 0.41.0

package/dist/global-setup-module.js

@@ -80,6 +80,8 @@ var DEFAULTS = {
   // Off by default: the page inventory reads control and link names from every
   // visited page, so it stays opt-in until a project turns it on.
   capturePageInventory: false,
+  // Off by default: JavaScript coverage slows the page, so a scheduled job opts in.
+  captureCodeReach: false,
   captureServerTraces: true,
   sampleAriaOnPass: true,
   uploadManifest: true,
@@ -116,6 +118,8 @@ var PIWI_ENV_KEYS = {
   captureLocators: "PIWI_CAPTURE_LOCATORS",
   capturePageState: "PIWI_CAPTURE_PAGE_STATE",
   capturePageInventory: "PIWI_CAPTURE_PAGE_INVENTORY",
+  captureCodeReach: "PIWI_CAPTURE_CODE_REACH",
+  codeReachRoots: "PIWI_CODE_REACH_ROOTS",
   captureServerTraces: "PIWI_CAPTURE_SERVER_TRACES",
   sampleAriaOnPass: "PIWI_SAMPLE_ARIA_ON_PASS",
   uploadManifest: "PIWI_UPLOAD_MANIFEST",
@@ -158,6 +162,7 @@ var ENV_FALLBACK_SPECS = [
   { option: "captureLocators", env: PIWI_ENV_KEYS.captureLocators, kind: "bool" },
   { option: "capturePageState", env: PIWI_ENV_KEYS.capturePageState, kind: "bool" },
   { option: "capturePageInventory", env: PIWI_ENV_KEYS.capturePageInventory, kind: "bool" },
+  { option: "captureCodeReach", env: PIWI_ENV_KEYS.captureCodeReach, kind: "bool" },
   { option: "captureServerTraces", env: PIWI_ENV_KEYS.captureServerTraces, kind: "bool" },
   { option: "sampleAriaOnPass", env: PIWI_ENV_KEYS.sampleAriaOnPass, kind: "bool" },
   { option: "uploadManifest", env: PIWI_ENV_KEYS.uploadManifest, kind: "bool" },

package/dist/index.d.ts

@@ -3,6 +3,8 @@ import { PlaywrightTestConfig, Locator, TestType, Page, Fixtures, PlaywrightTest
 export { PlaywrightTestConfig } from '@playwright/test';
 export { PiwiFixtures, extendPiwiFixtures, piwiFixtures } from './internal/capture/capture-fixtures.js';
 import '@piwitests/picker-dom';
+import '@piwitests/core/wire';
+import '@piwitests/core/code-reach';
 
 /**
  * Options for configuring the Piwi Dashboard reporter.
@@ -59,6 +61,26 @@ interface PiwiDashboardOptions {
      * Automatically disabled when `collectPerformanceMetrics` is `false`.
      */
     capturePageInventory?: boolean;
+    /**
+     * Record which application source files each test executes: the files whose
+     * functions ran, from Chromium's JavaScript coverage, resolved through the
+     * dev server's module URLs or the bundle's source maps. It answers "which
+     * tests reach this file?" for test selection, change coverage and
+     * `piwi preflight`. Only repository-relative file paths are sent. Chromium only;
+     * other browsers record nothing. It slows the page's JavaScript, so run it on
+     * one scheduled job rather than every run. **Defaults to `false`** — opt in
+     * with `captureCodeReach: true` (or `PIWI_CAPTURE_CODE_REACH=true`).
+     * Automatically disabled when `collectPerformanceMetrics` is `false`.
+     */
+    captureCodeReach?: boolean;
+    /**
+     * The directories module paths and source-map sources are resolved against
+     * for `captureCodeReach`, relative to the Playwright config, before the
+     * repository root, which is always tried last. Defaults to the Playwright
+     * config's directory. Set it to the dev server's root when that is not the
+     * config's directory (Nuxt: `['app']`).
+     */
+    codeReachRoots?: string[];
     /**
      * Capture server-side spans for each API/document request the test makes,
      * read from the `X-Piwi-Trace` response header emitted by a Piwi
@@ -175,8 +197,8 @@ interface PiwiDashboardOptions {
     label?: string;
     /**
      * Keep this run forever: the dashboard's retention never deletes it. Set it
-     * for the runs worth keeping, such as release or tag builds. Can also be set
-     * with `PIWI_KEEP=true`.
+     * for the runs worth keeping, such as release or tag builds. Defaults to
+     * `false`. Can also be set with `PIWI_KEEP=true`.
      */
     keep?: boolean;
     /** Related issue reference, e.g. `"JIRA-123"` */