@piwitests/reporter 0.44.0 → 0.45.0

package/dist/cli/index.js

@@ -2514,6 +2514,8 @@ var DEFAULTS = {
   // Off by default: JavaScript coverage slows the page, so a scheduled job opts in.
   captureCodeReach: false,
   captureServerTraces: true,
+  captureResources: true,
+  leakCheck: "report",
   sampleAriaOnPass: true,
   uploadManifest: true,
   defaultCapture: true,
@@ -2554,6 +2556,8 @@ var PIWI_ENV_KEYS = {
   captureCodeReach: "PIWI_CAPTURE_CODE_REACH",
   codeReachRoots: "PIWI_CODE_REACH_ROOTS",
   captureServerTraces: "PIWI_CAPTURE_SERVER_TRACES",
+  captureResources: "PIWI_CAPTURE_RESOURCES",
+  leakCheck: "PIWI_LEAK_CHECK",
   sampleAriaOnPass: "PIWI_SAMPLE_ARIA_ON_PASS",
   uploadManifest: "PIWI_UPLOAD_MANIFEST",
   defaultCapture: "PIWI_DEFAULT_CAPTURE",
@@ -2605,6 +2609,8 @@ var ENV_FALLBACK_SPECS = [
   { 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: "captureResources", env: PIWI_ENV_KEYS.captureResources, kind: "bool" },
+  { option: "leakCheck", env: PIWI_ENV_KEYS.leakCheck, kind: "string" },
   { option: "sampleAriaOnPass", env: PIWI_ENV_KEYS.sampleAriaOnPass, kind: "bool" },
   { option: "uploadManifest", env: PIWI_ENV_KEYS.uploadManifest, kind: "bool" },
   { option: "defaultCapture", env: PIWI_ENV_KEYS.defaultCapture, kind: "bool" },
@@ -3464,6 +3470,10 @@ function formatGateResult(result) {
       `  ${facts.quarantinedFailures} failing ${facts.quarantinedFailures === 1 ? "test is" : "tests are"} quarantined and did not count`
     );
   }
+  if (facts.resources?.reported) {
+    const { leaks, newLeaks } = facts.resources;
+    lines.push(`  ${leaks.length} ${leaks.length === 1 ? "leak" : "leaks"}, ${newLeaks.length} new`);
+  }
   for (const violation of result.violations) lines.push(`  \u2716 ${violation.message}`);
   for (const warning of result.warnings ?? []) lines.push(`  \u26A0 ${warning}`);
   lines.push(`  ${facts.runUrl}`);
@@ -3499,6 +3509,8 @@ Policy (at least one is required):
   --fail-on-new-cluster    Fail when this run introduced a new failure cluster
   --fail-on-flaky          Fail when this run contains any flaky test
   --require-selection <key>  Fail when a test the named selection matches did not run or failed
+  --max-leaks <n>          Fail when the run left more than n browsers, contexts or pages open (per opening line)
+  --max-new-leaks <n>      Fail when more than n of those were never seen on the base branch
 
 Warn-only (reported, never fails the build):
   --max-uncovered-changes <n>  Warn when more than n changed files have no observed test reach
@@ -3555,7 +3567,9 @@ function parseGateArgs(argv, env) {
     maxQuarantined: readCount(argv, "--max-quarantined"),
     failOnNewCluster: argv.includes("--fail-on-new-cluster"),
     failOnFlaky: argv.includes("--fail-on-flaky"),
-    requireSelection: readOption4(argv, "--require-selection")
+    requireSelection: readOption4(argv, "--require-selection"),
+    maxLeaks: readCount(argv, "--max-leaks"),
+    maxNewLeaks: readCount(argv, "--max-new-leaks")
   };
   return {
     serverUrl,

package/dist/global-setup-module.js

@@ -83,6 +83,8 @@ var DEFAULTS = {
   // Off by default: JavaScript coverage slows the page, so a scheduled job opts in.
   captureCodeReach: false,
   captureServerTraces: true,
+  captureResources: true,
+  leakCheck: "report",
   sampleAriaOnPass: true,
   uploadManifest: true,
   defaultCapture: true,
@@ -123,6 +125,8 @@ var PIWI_ENV_KEYS = {
   captureCodeReach: "PIWI_CAPTURE_CODE_REACH",
   codeReachRoots: "PIWI_CODE_REACH_ROOTS",
   captureServerTraces: "PIWI_CAPTURE_SERVER_TRACES",
+  captureResources: "PIWI_CAPTURE_RESOURCES",
+  leakCheck: "PIWI_LEAK_CHECK",
   sampleAriaOnPass: "PIWI_SAMPLE_ARIA_ON_PASS",
   uploadManifest: "PIWI_UPLOAD_MANIFEST",
   defaultCapture: "PIWI_DEFAULT_CAPTURE",
@@ -168,6 +172,8 @@ var ENV_FALLBACK_SPECS = [
   { 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: "captureResources", env: PIWI_ENV_KEYS.captureResources, kind: "bool" },
+  { option: "leakCheck", env: PIWI_ENV_KEYS.leakCheck, kind: "string" },
   { option: "sampleAriaOnPass", env: PIWI_ENV_KEYS.sampleAriaOnPass, kind: "bool" },
   { option: "uploadManifest", env: PIWI_ENV_KEYS.uploadManifest, kind: "bool" },
   { option: "defaultCapture", env: PIWI_ENV_KEYS.defaultCapture, kind: "bool" },

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { FullConfig, Suite, TestCase, TestResult, FullResult } from '@playwright/test/reporter';
 import { PlaywrightTestConfig, Locator, TestType, Page, Fixtures, PlaywrightTestArgs, PlaywrightTestOptions, PlaywrightWorkerArgs, PlaywrightWorkerOptions } from '@playwright/test';
 export { PlaywrightTestConfig } from '@playwright/test';
-export { PiwiFixtures, extendPiwiFixtures, piwiFixtures } from './internal/capture/capture-fixtures.js';
+export { PiwiFixtures, PiwiWorkerFixtures, extendPiwiFixtures, piwiFixtures } from './internal/capture/capture-fixtures.js';
 import '@piwitests/picker-dom';
 import '@piwitests/core/wire';
 import '@piwitests/core/code-reach';
@@ -100,6 +100,35 @@ interface PiwiDashboardOptions {
      * `false`. Can also be forced off with `PIWI_CAPTURE_SERVER_TRACES=false`.
      */
     captureServerTraces?: boolean;
+    /**
+     * Keep a ledger of the browsers, contexts, pages and API request contexts each
+     * test opens, and list at the end of the run the ones left open after the
+     * scope that created them ended (a context a test never closed, a `beforeAll`
+     * context no `afterAll` closes, a browser a test launched itself), the pages
+     * opened and never used, and the pages, listeners and route handlers piling up
+     * on a page or context that lives across tests. Each finding names the line or
+     * the fixture that opened the object. Rides the capture fixtures and costs a
+     * few bookkeeping steps per test. Also samples the run's processes and the
+     * machine, with or without the fixtures, and prints what the run cost: CPU by
+     * process, time spent waiting for a CPU, peak memory and disk. The findings,
+     * the run's cost and each test's go to the dashboard with the run, on its
+     * Resources tab. Defaults to `true`. Set to `false` (or
+     * `PIWI_CAPTURE_RESOURCES=false`) to turn both off.
+     */
+    captureResources?: boolean;
+    /**
+     * What the capture fixtures do when a test leaves open a browser, context,
+     * page or API request context that the test itself opened (its body or its
+     * `beforeEach`/`afterEach` hooks; a fixture's objects are the fixture's):
+     * `'report'` lists it in the end-of-run summary, `'fail'` also fails the test
+     * with the line that opened it, and `'close'` closes it when the test ends and
+     * still lists it. A `beforeAll` object left open is only ever reported. Each
+     * test is judged when it ends, so a test that hands what it opened to the next
+     * one fails under `'fail'` and loses it under `'close'`: open such objects in
+     * `beforeAll` and close them in `afterAll`. Defaults to `'report'`. Can also
+     * be set with `PIWI_LEAK_CHECK`.
+     */
+    leakCheck?: 'report' | 'fail' | 'close';
     /**
      * Sample the ARIA snapshot at the end of a *passing* test, so a later failure
      * can be diffed against the page as it last looked when green. Rate-limited by
@@ -375,6 +404,20 @@ declare class PiwiDashboardReporter {
     private filterDetails;
     /** Configured `maxFailures` (0 = unlimited) — disambiguates an interrupted run's unrun reason. */
     private maxFailures;
+    /** The resource censuses the capture fixtures attached, one per test attempt. */
+    private resourceCensuses;
+    /** Lifecycle steps of the tests that ran without the fixtures. */
+    private lifecycleTallies;
+    /** The user fixtures set up by the tests that left a page unused, by test id. */
+    private fixturesByTest;
+    /** The file workers append their shutdown census to, set in `onBegin`. */
+    private resourcesFile;
+    /** Samples the run's processes and the machine from `onBegin` to `onEnd`. */
+    private sampler;
+    /** Bytes of the files the tests attached, by kind. */
+    private artifactBytes;
+    /** The run's resource report for the dashboard, built in `onEnd`. */
+    private resourceReport;
     private httpClient;
     private uploader;
     private fileHandler;
@@ -408,6 +451,17 @@ declare class PiwiDashboardReporter {
     onStepEnd(test: TestCase | undefined, _result: TestResult | undefined, step: any): void;
     /** Playwright reporter hook: called when an individual test finishes */
     onTestEnd(test: TestCase, result: TestResult): void;
+    /**
+     * Add up the files a test attached, and keep its resource census; for a test
+     * that ran without the capture fixtures, tally the browsers and contexts its
+     * steps opened and closed.
+     */
+    private collectResources;
+    /**
+     * Print what the run left open or opened for nothing, from the censuses and
+     * the workers' shutdown file, then what the run cost the machine.
+     */
+    private reportResources;
     /**
      * Synthesize `didnotrun` cases for tests Playwright planned but never reported
      * (no `onTestEnd`) — typically because `maxFailures` cut the run short. These