@piwitests/reporter 0.62.0 → 0.64.0

package/README.md

@@ -67,7 +67,7 @@ Most options can also be set via a `PIWI_*` environment variable (config wins ov
 ## Requirements
 
 - Node.js 20 or higher (the reporter runs inside your test project — the dashboard *server* itself targets Node 22+, or use its Docker image)
-- Playwright Test 1.61.1 or higher
+- Playwright Test 1.59 or higher (a few features need a later version, named in their docs)
 - A running Piwi Dashboard server
 
 ## Contributing

package/dist/cli/index.js

@@ -36,6 +36,7 @@ var path2 = __toESM(require("path"));
 
 // src/internal/capture/locator-healing.ts
 var path = __toESM(require("path"));
+var import_node_url = require("url");
 
 // ../core/src/locator-chain.ts
 var LOCATING_METHODS = /* @__PURE__ */ new Set([
@@ -1191,9 +1192,9 @@ function realFolder(dir) {
   return path10.join(fs7.realpathSync(current), ...rest);
 }
 function folderInRepository(root, dir) {
-  const relative9 = path10.relative(realFolder(root), realFolder(dir));
-  if (relative9.startsWith("..") || path10.isAbsolute(relative9)) return void 0;
-  return relative9.split(path10.sep).join("/");
+  const relative8 = path10.relative(realFolder(root), realFolder(dir));
+  if (relative8.startsWith("..") || path10.isAbsolute(relative8)) return void 0;
+  return relative8.split(path10.sep).join("/");
 }
 function fileFilter(file) {
   const escape = (text) => text.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
@@ -1843,13 +1844,27 @@ function safeLocator(expr) {
   if (!chain || !chainIsSafe(chain)) return null;
   return { chain, text: renderLocatorChain(chain) };
 }
-function chooseLocator(target, options) {
+var TEXT_CHECKS = /* @__PURE__ */ new Set(["toHaveText", "toContainText"]);
+function checkedText(step) {
+  const assertion = step?.action === "assert" ? step.assertion : null;
+  if (!assertion || !TEXT_CHECKS.has(assertion.matcher)) return null;
+  const text = assertion.expected?.replace(/\s+/g, " ").trim();
+  return text ? text : null;
+}
+function findsByText(chain, text) {
+  const holds = (arg) => arg?.type === "string" && arg.value.replace(/\s+/g, " ").trim().includes(text);
+  const option = (arg, key) => arg?.type === "object" ? arg.entries.find(([name]) => name === key)?.[1] : void 0;
+  return chain.calls.some(
+    (call) => call.method === "getByText" && holds(call.args[0]) || call.method === "getByRole" && holds(option(call.args[1], "name")) || call.args.some((arg) => holds(option(arg, "hasText")))
+  );
+}
+function chooseLocator(target, options, check) {
   if (!target) return null;
-  const candidates = target.alternatives.flatMap((alt) => {
+  const recorded = target.alternatives.flatMap((alt) => {
     const safe = safeLocator(alt.locator);
     return safe ? [safe] : [];
   });
-  if (candidates.length === 0) return null;
+  if (recorded.length === 0) return null;
   const levels = /* @__PURE__ */ new Map();
   const levelOf = (c) => {
     let level = levels.get(c.text);
@@ -1859,6 +1874,9 @@ function chooseLocator(target, options) {
     }
     return level;
   };
+  const text = checkedText(check);
+  const apart = text ? recorded.filter((c) => !findsByText(c.chain, text) && levelOf(c) !== "brittle") : [];
+  const candidates = apart.length ? apart : recorded;
   const prefer = options.preferLocators;
   if (prefer && prefer.size > 0) {
     const known = candidates.find((c) => prefer.has(c.text) && levelOf(c) !== "brittle");
@@ -1939,7 +1957,7 @@ function urlForCode(url, ctx) {
   return isPath && ctx.origin ? `${ctx.origin}${url}` : url;
 }
 function locatorForStep(step, index, ctx) {
-  const chosen = chooseLocator(step.target, ctx.options);
+  const chosen = chooseLocator(step.target, ctx.options, step);
   if (!chosen) {
     ctx.warnings.push({ step: index, code: "no-locator", message: "No locator was captured for this element." });
     return `${ctx.page}.locator(${quote("/* no locator captured */")})`;
@@ -2406,19 +2424,11 @@ function renderSpec(session, options = {}) {
     const needs = needsLines("");
     return result([...needs, ...testOpening, ...testBody, `});`, ``], needs.length + testOpening.length);
   }
-  const lines = [
-    // Package name interpolated rather than adjoining the preceding keyword
-    // directly, so this generated-code line does not itself look like a real
-    // import to the boundary test in tests/boundary.test.ts.
-    `import { test, expect } from ${quote(options.testImport?.trim() || "@playwright/test")};`,
-    ...importLines,
-    ``,
-    ...testOpening,
-    ...testBody,
-    `});`,
-    ``
-  ];
-  return result(lines, 1 + importLines.length + 1 + testOpening.length);
+  const testModule = options.testImport?.trim() || "@playwright/test";
+  const expectModule = options.expectImport?.trim() || testModule;
+  const testImports = expectModule === testModule ? [`import { test, expect } from ${quote(testModule)};`] : [`import { test } from ${quote(testModule)};`, `import { expect } from ${quote(expectModule)};`];
+  const lines = [...testImports, ...importLines, ``, ...testOpening, ...testBody, `});`, ``];
+  return result(lines, testImports.length + importLines.length + 1 + testOpening.length);
 }
 
 // ../core/src/steps.ts
@@ -3177,14 +3187,23 @@ var DEFAULT_COVERAGE_EXCLUDES = [
   "tests/",
   "test/",
   "__tests__/",
+  "playwright.config.*",
   "*Tests/",
   "*.Tests/",
   "obj/",
   "bin/",
   "node_modules/",
+  "dist/",
+  ".next/",
+  ".nuxt/",
+  ".output/",
+  ".svelte-kit/",
   "*.g.cs",
   "*.Designer.cs",
-  "*.generated.*"
+  "*.generated.*",
+  "*.gen.*",
+  "__generated__/",
+  "*.d.ts"
 ];
 var DEFAULT_COVERAGE_SCOPE = { include: [], exclude: [...DEFAULT_COVERAGE_EXCLUDES] };
 var MAX_SCOPE_PATTERNS = 200;
@@ -3825,8 +3844,8 @@ function relativeTo(path25, root) {
   const head = path25.slice(0, base.length);
   const inside = drive ? head.toLowerCase() === base.toLowerCase() : head === base;
   if (!inside) return null;
-  const relative9 = path25.slice(base.length);
-  return relative9 || null;
+  const relative8 = path25.slice(base.length);
+  return relative8 || null;
 }
 function reportPathCandidates(raw, { repoRoot, bases }) {
   const slash = (value) => value.replace(/\\/g, "/");
@@ -3837,8 +3856,8 @@ function reportPathCandidates(raw, { repoRoot, bases }) {
   const add = (absolute) => {
     const normalized = normalizeSlashPath(absolute);
     if (!normalized) return;
-    const relative9 = normalized.startsWith("/_/") ? normalized.slice(3) : relativeTo(normalized, root);
-    if (relative9 && !out.includes(relative9)) out.push(relative9);
+    const relative8 = normalized.startsWith("/_/") ? normalized.slice(3) : relativeTo(normalized, root);
+    if (relative8 && !out.includes(relative8)) out.push(relative8);
   };
   if (isAbsolutePath(path25)) {
     add(path25);
@@ -6106,9 +6125,9 @@ function pathGlobToRegExp(glob) {
   return new RegExp(`^(?:${parts.join("|")})$`);
 }
 function isTranslationFile(path25, globs = DEFAULT_TRANSLATION_GLOBS) {
-  const posix = path25.replace(/\\/g, "/");
-  if (!TRANSLATION_EXTENSIONS.test(posix)) return false;
-  return globs.some((g) => pathGlobToRegExp(g).test(posix));
+  const posix2 = path25.replace(/\\/g, "/");
+  if (!TRANSLATION_EXTENSIONS.test(posix2)) return false;
+  return globs.some((g) => pathGlobToRegExp(g).test(posix2));
 }
 function keepable(value) {
   const v = value.trim();
@@ -6824,15 +6843,22 @@ function diffImpactInput(files) {
 var fs17 = __toESM(require("fs"));
 var path21 = __toESM(require("path"));
 var import_node_module2 = require("module");
+
+// src/internal/support/playwright-version.ts
+function playwrightVersionAtLeast(version, minimum) {
+  const have = version ? /^(\d+)\.(\d+)/.exec(version) : null;
+  const want = /^(\d+)\.(\d+)/.exec(minimum);
+  if (!have || !want) return false;
+  const major = Number(have[1]);
+  const wantMajor = Number(want[1]);
+  return major > wantMajor || major === wantMajor && Number(have[2]) >= Number(want[2]);
+}
+
+// src/cli/add-reporter.ts
 var REPORTER_PACKAGE2 = "@piwitests/reporter";
 var ADD_REPORTER_FLAG = "--add-reporter";
-var ADD_REPORTER_MIN = { major: 1, minor: 63 };
 function playwrightSupportsAddReporter(version) {
-  const match = version ? /^(\d+)\.(\d+)/.exec(version) : null;
-  if (!match) return false;
-  const major = Number(match[1]);
-  const minor = Number(match[2]);
-  return major > ADD_REPORTER_MIN.major || major === ADD_REPORTER_MIN.major && minor >= ADD_REPORTER_MIN.minor;
+  return playwrightVersionAtLeast(version, "1.63");
 }
 function configHasPiwiReporter(source) {
   return new RegExp(REPORTER_PACKAGE2.replace(/[/\\]/g, "\\$&")).test(source);
@@ -7789,10 +7815,19 @@ function readOption9(argv, name) {
 function escapeRegex2(s) {
   return s.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
 }
+function probePlaywrightArgs(playwrightArgs2, testTitles) {
+  const given = (...flags) => playwrightArgs2.some((arg) => flags.some((flag) => arg === flag || arg.startsWith(`${flag}=`)));
+  const grep = testTitles.filter((t) => !!t).map(escapeRegex2).join("|");
+  const args = [...playwrightArgs2];
+  if (grep && !given("--grep", "-g")) args.push("--grep", grep);
+  if (!given("--retries")) args.push("--retries=0");
+  if (!given("--max-failures", "-x")) args.push("--max-failures=0");
+  return args;
+}
 async function runProbe(argv) {
-  const sep7 = argv.indexOf("--");
-  const own = sep7 < 0 ? argv : argv.slice(0, sep7);
-  const playwrightArgs2 = sep7 < 0 ? [] : argv.slice(sep7 + 1);
+  const sep6 = argv.indexOf("--");
+  const own = sep6 < 0 ? argv : argv.slice(0, sep6);
+  const playwrightArgs2 = sep6 < 0 ? [] : argv.slice(sep6 + 1);
   if (own.includes("-h") || own.includes("--help")) {
     console.log(USAGE11);
     return EXIT_OK8;
@@ -7843,9 +7878,10 @@ async function runProbe(argv) {
   const runOutputFile = path24.join(dir, "run.json");
   fs20.writeFileSync(planFile, JSON.stringify(plan));
   fs20.writeFileSync(resultsFile, "");
-  const grep = plan.items.map((i) => i.testTitle).filter(Boolean).map(escapeRegex2).join("|");
-  const pwArgs = [...playwrightArgs2];
-  if (grep && !playwrightArgs2.includes("--grep") && !playwrightArgs2.includes("-g")) pwArgs.push("--grep", grep);
+  const pwArgs = probePlaywrightArgs(
+    playwrightArgs2,
+    plan.items.map((i) => i.testTitle)
+  );
   const childEnv = {
     ...env,
     [PIWI_PROBE_ENV.flag]: "1",

package/dist/global-setup-module.js

@@ -43,9 +43,6 @@ function errorMessage(error) {
   return String(error);
 }
 
-// src/public/global-setup.ts
-var fs7 = __toESM(require("fs"));
-
 // src/internal/config/env.ts
 var path2 = __toESM(require("path"));
 
@@ -228,7 +225,7 @@ var PIWI_DESKTOP_CONFIG_ENV = "PIWI_DESKTOP_CONFIG";
 var PIWI_SHARD_ENV = "PIWI_SHARD";
 function readBool(val) {
   if (val === void 0) return void 0;
-  return val === "true";
+  return ["true", "1", "yes", "on"].includes(val.trim().toLowerCase());
 }
 var ENV_FALLBACK_SPECS = [
   { option: "serverUrl", env: PIWI_ENV_KEYS.serverUrl, kind: "string" },
@@ -338,7 +335,7 @@ function resolveOptions(raw, configDir) {
     externalId.onDuplicate = externalIdOnDuplicate;
   if (Object.keys(externalId).length > 0) mergedRaw.externalId = externalId;
   const opts = { ...DEFAULTS, ...mergedRaw };
-  if (env[PIWI_ENV_KEYS.verbose] !== void 0) opts.verbose = env[PIWI_ENV_KEYS.verbose] === "true";
+  if (env[PIWI_ENV_KEYS.verbose] !== void 0) opts.verbose = readBool(env[PIWI_ENV_KEYS.verbose]);
   return opts;
 }
 
@@ -693,6 +690,75 @@ function normalizeRef(ref) {
   return ref.replace(/^refs\/heads\//, "");
 }
 
+// ../core/src/locator-chain.ts
+var LOCATING_METHODS = /* @__PURE__ */ new Set([
+  "getByRole",
+  "getByTestId",
+  "getByText",
+  "getByLabel",
+  "getByPlaceholder",
+  "getByAltText",
+  "getByTitle",
+  "locator",
+  "frameLocator"
+]);
+var NARROWING_METHODS = /* @__PURE__ */ new Set([
+  "filter",
+  "first",
+  "last",
+  "nth",
+  "and",
+  "or",
+  "visible",
+  "contentFrame",
+  "owner"
+]);
+var LOCATOR_CHAIN_METHODS = /* @__PURE__ */ new Set([...LOCATING_METHODS, ...NARROWING_METHODS]);
+
+// ../core/src/mask.ts
+var SECRET_AUTOCOMPLETE = [
+  "current-password",
+  "new-password",
+  "one-time-code",
+  "cc-number",
+  "cc-csc"
+];
+var SECRET_FIELD_SELECTOR = [
+  'input[type="password" i]',
+  ...SECRET_AUTOCOMPLETE.flatMap((token) => [
+    `input[autocomplete~="${token}" i]`,
+    `textarea[autocomplete~="${token}" i]`
+  ])
+].join(", ");
+var SECRET_SHAPES = [
+  /\beyJ[\w-]{5,}\.[\w-]{5,}\.[\w-]*/g,
+  /\bBearer(?:\s+|%20)[\w.~+/-]{8,}=*/gi,
+  /\b(?:sk|rk)_(?:live|test)_[A-Za-z0-9]{8,}/g,
+  /\bwhsec_[A-Za-z0-9]{20,}/g,
+  /\bsk-(?=[\w-]{0,200}\d)(?=[\w-]{0,200}[A-Z])[\w-]{32,}/g,
+  /\bglpat-[\w-]{20,}/g,
+  /\bnpm_[A-Za-z0-9]{36}\b/g,
+  /\bSK[0-9a-f]{32}\b/g,
+  /\bAKIA[0-9A-Z]{16}\b/g,
+  /\bAIza[\w-]{30,}/g,
+  /\bgh[opsu]_[A-Za-z0-9]{20,}/g,
+  /\bgithub_pat_\w{20,}/g,
+  /\bxox[abprs]-[\w-]{8,}/g
+];
+var WHOLE_SHAPES = SECRET_SHAPES.map(
+  (re) => new RegExp(`^(?:${re.source})$`, re.flags.replace("g", ""))
+);
+
+// ../core/src/live-view.ts
+var LIVE_FRAME_BYTE_RATE = 256 * 1024;
+var MAX_LIVE_FRAME = 192 * 1024;
+var MAX_LIVE_FRAME_BASE64 = 4 * Math.ceil(MAX_LIVE_FRAME / 3);
+var MAX_LIVE_MESSAGE = MAX_LIVE_FRAME_BASE64 + 8 * 1024;
+var KEY = /^pdl_[A-Za-z0-9_-]{43}$/;
+function isLiveViewKey(value) {
+  return typeof value === "string" && KEY.test(value);
+}
+
 // src/internal/support/setup-file.ts
 var path4 = __toESM(require("path"));
 var os3 = __toESM(require("os"));
@@ -700,6 +766,10 @@ var fs3 = __toESM(require("fs"));
 function getSetupFilePath(projectName) {
   return path4.join(os3.tmpdir(), `piwi-dashboard-setup-${hashForProject(projectName)}.json`);
 }
+function writeSetupInfo(info) {
+  const setupFile = getSetupFilePath(info.projectName);
+  fs3.writeFileSync(setupFile, JSON.stringify(info), { mode: 384 });
+}
 
 // src/internal/support/aria-sampling.ts
 var path5 = __toESM(require("path"));
@@ -1101,19 +1171,23 @@ function createGlobalSetup(options, userSetup) {
           startTime: (/* @__PURE__ */ new Date()).toISOString(),
           instanceId: computeInstanceId(opts.projectName, resolveRunLabel(opts.runLabel, shard !== null)),
           shardIndex: shard?.current,
-          shardTotal: shard?.total
+          shardTotal: shard?.total,
+          // A key for the run's live view: the instance hands one out only for a project that turned it on, and the
+          // desktop app none. A CI run's workers stream with it at once; a run outside CI sends nothing with it until a
+          // person shares the run.
+          liveView: true
         },
         auth
       );
       if (response?.runId && response?.setupToken) {
-        fs7.writeFileSync(
-          getSetupFilePath(opts.projectName),
-          JSON.stringify({
-            runId: response.runId,
-            setupToken: response.setupToken,
-            projectName: opts.projectName
-          })
-        );
+        const liveViewKey = response.liveView?.key;
+        writeSetupInfo({
+          runId: response.runId,
+          setupToken: response.setupToken,
+          projectName: opts.projectName,
+          ...isLiveViewKey(liveViewKey) ? { liveViewKey } : {},
+          ...response.liveView?.refused === "local" ? { liveViewLocal: true } : {}
+        });
         logger.debug(`Global setup: initializing run #${response.runId}`);
       }
       if (opts.projectName) clearAriaSampleFile(opts.projectName);

package/dist/index.d.ts

@@ -2,11 +2,8 @@ import { FullConfig, Suite, TestCase, TestResult, FullResult } from '@playwright
 import { PlaywrightTestConfig, Locator, TestType, Page, Fixtures, PlaywrightTestArgs, PlaywrightTestOptions, PlaywrightWorkerArgs, PlaywrightWorkerOptions } from '@playwright/test';
 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/run-channel';
-import '@piwitests/core/code-reach';
+import './types-CGr9jJZ_.js';
+import './wire-7zsqlBoY.js';
 
 /**
  * Options for configuring the Piwi Dashboard reporter.
@@ -59,8 +56,9 @@ interface PiwiDashboardOptions {
     collectPerformanceMetrics?: boolean;
     /**
      * Capture per-action locator snapshots that power failure-time healing
-     * suggestions. Adds a small per-action cost (one DOM read, sometimes an ARIA
-     * snapshot) in the test worker. Defaults to `true`; automatically disabled
+     * suggestions. Adds a small per-action cost (one DOM read, rarely two,
+     * sometimes an ARIA snapshot) and one DOM read per new document in the test
+     * worker. Defaults to `true`; automatically disabled
      * when `collectPerformanceMetrics` is `false` (the reporter discards the data
      * in that case anyway). Can also be forced off with `PIWI_CAPTURE_LOCATORS=false`.
      */
@@ -324,7 +322,7 @@ interface PiwiDashboardOptions {
      */
     maxStreamBufferBytes?: number;
     /**
-     * Fail the run when any test was flaky (passed only after a retry). Forwarded
+     * Fail the run when any test was flaky (one attempt failed and another passed). Forwarded
      * to Playwright's native `failOnFlakyTests` config option (Playwright 1.52+)
      * when the reporter is installed via `wrapConfig`, so a flaky-only run exits
      * non-zero without any server round-trip. Defaults to `false`. Can also be
@@ -505,6 +503,10 @@ declare class PiwiDashboardReporter {
     private plannedTests;
     /** Ids of tests that actually reported via `onTestEnd`, to find the ones that never ran. */
     private reportedTestIds;
+    /** The spec files said to have run without the capture fixtures in a run that can stop (`noteUncaptured`). */
+    private uncapturedSpecs;
+    /** The live steps begun and not ended, by step, sent again when someone opens the run (`onWatched`). */
+    private openSteps;
     /** Per-test attempt history, keyed by `test.id`; snapshotted onto every attempt's payload. */
     private attemptsByTest;
     /** The folder test files are named relative to: the Playwright config's, set in `onBegin`. */
@@ -579,6 +581,14 @@ declare class PiwiDashboardReporter {
     printsToStdio(): boolean;
     /** Playwright reporter hook: called once at the start of the test run */
     onBegin(config: FullConfig, suite: Suite): void;
+    /**
+     * Name the run's live view on the instance for the workers, which Playwright starts after this hook with this
+     * environment: the key the instance gave the global setup, for a project that turned its live view on, for this run
+     * alone. A CI run's workers stream with it at once; a run outside CI's hold it until a person shares the run (Share
+     * live), and such a run without a key names why instead, for the surfaces that would share it; a CI run without one
+     * says why in its log (`ciLiveViewNote`). Read before the stream starts, which takes the setup file.
+     */
+    private shareLiveView;
     /**
      * Settle each planned test's external ID before any test runs, name the IDs two tests share, and record them on
      * the run so the dashboard lists them too.
@@ -599,6 +609,15 @@ declare class PiwiDashboardReporter {
      * human watches; the meaningful readout is the assertion around them.
      */
     private static isLiveStep;
+    /**
+     * In a run that can stop (breakpoints, or a run channel to an editor or the desktop app), say of the first spec file
+     * whose test made Playwright calls without the capture fixtures, where the stops happen, that it never stops at a
+     * breakpoint nor at Pause, which nothing else says; the others are named in one line as the run ends
+     * (`noteOtherUncaptured`).
+     */
+    private noteUncaptured;
+    /** The spec files past the first that ran without the capture fixtures, in one line (`noteUncaptured`). */
+    private noteOtherUncaptured;
     /** Playwright reporter hook: called when a step (including hook/fixture) begins */
     onStepBegin(test: TestCase | undefined, _result: TestResult | undefined, step: any): void;
     /** Playwright reporter hook: called when a step (including hook/fixture) ends */