@piwitests/reporter 0.51.0 → 0.53.0

package/dist/cli/index.js

@@ -480,7 +480,7 @@ 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.
+  // Off by default: JavaScript coverage adds time to every test, so a scheduled job opts in.
   captureCodeReach: false,
   captureServerTraces: true,
   captureResources: true,
@@ -525,6 +525,8 @@ var PIWI_ENV_KEYS = {
   capturePageInventory: "PIWI_CAPTURE_PAGE_INVENTORY",
   captureCodeReach: "PIWI_CAPTURE_CODE_REACH",
   codeReachRoots: "PIWI_CODE_REACH_ROOTS",
+  coverageBrowser: "PIWI_COVERAGE_BROWSER",
+  coverageServer: "PIWI_COVERAGE_SERVER",
   captureServerTraces: "PIWI_CAPTURE_SERVER_TRACES",
   captureResources: "PIWI_CAPTURE_RESOURCES",
   leakCheck: "PIWI_LEAK_CHECK",

package/dist/global-setup-module.js

@@ -80,7 +80,7 @@ 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.
+  // Off by default: JavaScript coverage adds time to every test, so a scheduled job opts in.
   captureCodeReach: false,
   captureServerTraces: true,
   captureResources: true,
@@ -125,6 +125,8 @@ var PIWI_ENV_KEYS = {
   capturePageInventory: "PIWI_CAPTURE_PAGE_INVENTORY",
   captureCodeReach: "PIWI_CAPTURE_CODE_REACH",
   codeReachRoots: "PIWI_CODE_REACH_ROOTS",
+  coverageBrowser: "PIWI_COVERAGE_BROWSER",
+  coverageServer: "PIWI_COVERAGE_SERVER",
   captureServerTraces: "PIWI_CAPTURE_SERVER_TRACES",
   captureResources: "PIWI_CAPTURE_RESOURCES",
   leakCheck: "PIWI_LEAK_CHECK",
@@ -208,6 +210,13 @@ function resolveOptions(raw) {
       desktopDiscovered = true;
     }
   }
+  const coverage = { ...mergedRaw.coverage };
+  const coverageBrowser = env[PIWI_ENV_KEYS.coverageBrowser];
+  const coverageServer = env[PIWI_ENV_KEYS.coverageServer];
+  if (coverage.browser === void 0 && coverageBrowser)
+    coverage.browser = coverageBrowser;
+  if (coverage.server === void 0 && coverageServer) coverage.server = coverageServer;
+  if (coverage.browser !== void 0 || coverage.server !== void 0) mergedRaw.coverage = coverage;
   const opts = { ...DEFAULTS, ...mergedRaw };
   if (env[PIWI_ENV_KEYS.verbose] !== void 0) opts.verbose = env[PIWI_ENV_KEYS.verbose] === "true";
   return opts;
@@ -807,14 +816,22 @@ function baseUrlFromConfig(config) {
   return null;
 }
 var INSTRUMENTATION_FETCH_TIMEOUT_MS = 5e3;
+function instrumentationManifestUrls(baseUrl) {
+  const base = new URL(baseUrl);
+  const root = new URL(INSTRUMENTATION_MANIFEST_PATH, base).toString();
+  const path6 = base.pathname.replace(/\/+$/, "");
+  return path6 ? [new URL(`${path6}${INSTRUMENTATION_MANIFEST_PATH}`, base).toString(), root] : [root];
+}
 async function fetchInstrumentationManifest(baseUrl, fetchImpl = fetch) {
   try {
     const probe = await fetchImpl(baseUrl, { signal: AbortSignal.timeout(INSTRUMENTATION_FETCH_TIMEOUT_MS) });
     if (!hasInstrumentationHeader(probe.headers)) return null;
-    const manifestUrl = new URL(INSTRUMENTATION_MANIFEST_PATH, baseUrl).toString();
-    const res = await fetchImpl(manifestUrl, { signal: AbortSignal.timeout(INSTRUMENTATION_FETCH_TIMEOUT_MS) });
-    if (!res.ok) return null;
-    return parseManifestJson(await res.text());
+    for (const manifestUrl of instrumentationManifestUrls(baseUrl)) {
+      const res = await fetchImpl(manifestUrl, { signal: AbortSignal.timeout(INSTRUMENTATION_FETCH_TIMEOUT_MS) });
+      const manifest = res.ok ? parseManifestJson(await res.text()) : null;
+      if (manifest) return manifest;
+    }
+    return null;
   } catch {
     return null;
   }

package/dist/index.d.ts

@@ -3,6 +3,7 @@ import { PlaywrightTestConfig, Locator, TestType, Page, Fixtures, PlaywrightTest
 export { PlaywrightTestConfig } from '@playwright/test';
 export { PiwiFixtures, PiwiWorkerFixtures, extendPiwiFixtures, piwiFixtures } from './internal/capture/capture-fixtures.js';
 import '@piwitests/picker-dom';
+import '@piwitests/core/page-interaction';
 import '@piwitests/core/wire';
 import '@piwitests/core/code-reach';
 
@@ -76,10 +77,11 @@ interface PiwiDashboardOptions {
      * 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
+     * other browsers record nothing. It adds time to every test, 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`.
+     * with `captureCodeReach: true` (or `PIWI_CAPTURE_CODE_REACH=true`), the
+     * same as `coverage.browser: 'files'`. Automatically disabled when
+     * `collectPerformanceMetrics` is `false`.
      */
     captureCodeReach?: boolean;
     /**
@@ -90,6 +92,34 @@ interface PiwiDashboardOptions {
      * config's directory (Nuxt: `['app']`).
      */
     codeReachRoots?: string[];
+    /**
+     * Record, per test, which source code ran, in the browser and in the
+     * backend, and send it with the test as its coverage. Rides the capture
+     * fixtures. Off on both sides unless set, and automatically disabled when
+     * `collectPerformanceMetrics` is `false`.
+     */
+    coverage?: {
+        /**
+         * What the browser side records: `'files'`, the application files whose
+         * functions ran, from Chromium's JavaScript coverage, which is what
+         * `captureCodeReach: true` records; `'off'` records nothing. Only paths are
+         * sent. Defaults to `'off'`. Can also be set with `PIWI_COVERAGE_BROWSER`.
+         */
+        browser?: 'off' | 'files';
+        /**
+         * What the server side records, from a backend built with Piwi's coverage
+         * instrumentation (ASP.NET Core: `-p:PiwiCoverage=true`), which names each
+         * request's coverage on its response: `'files'` sends the backend files
+         * each test ran, `'functions'` adds the start and end line of each function
+         * that ran, `'lines'` adds the executed lines. The reporter collects a
+         * test's coverage from the backend after the test ends, never in the test,
+         * and at the end of the run sends the run's coverage of the backend too.
+         * Line numbers are sent with `'functions'` and `'lines'` only, never source
+         * code or hit counts. Defaults to `'off'`. Can also be set with
+         * `PIWI_COVERAGE_SERVER`.
+         */
+        server?: 'off' | 'files' | 'functions' | 'lines';
+    };
     /**
      * Capture server-side spans for each API/document request the test makes,
      * read from the `X-Piwi-Trace` response header emitted by a Piwi
@@ -442,6 +472,14 @@ declare class PiwiDashboardReporter {
     private artifactBytes;
     /** The run's resource report for the dashboard, built in `onEnd`. */
     private resourceReport;
+    /** The coverage the options switch on, per runtime. */
+    private readonly coverageSettings;
+    /** Each test's coverage, when browser or server coverage is on; set in `onBegin`. */
+    private coverage;
+    /** Tells when the run's last test ended, while server coverage is on. */
+    private lastTestWatch;
+    /** Result events that stream once their test's server coverage is in. */
+    private coverageSends;
     private httpClient;
     private uploader;
     private fileHandler;