@piwitests/reporter 0.54.0 → 0.56.0

package/dist/global-setup-module.js

@@ -35,7 +35,7 @@ __export(global_setup_module_exports, {
 module.exports = __toCommonJS(global_setup_module_exports);
 
 // src/public/global-setup.ts
-var path5 = __toESM(require("path"));
+var path7 = __toESM(require("path"));
 
 // src/internal/support/errors.ts
 function errorMessage(error) {
@@ -44,7 +44,7 @@ function errorMessage(error) {
 }
 
 // src/public/global-setup.ts
-var fs5 = __toESM(require("fs"));
+var fs6 = __toESM(require("fs"));
 
 // src/internal/config/desktop.ts
 var fs = __toESM(require("fs"));
@@ -274,11 +274,15 @@ var HttpClient = class {
    * @param logger    Prefixed logger for verbose diagnostics.
    * @param timeout   Socket inactivity timeout in ms (default 30s), so a hung
    *                  server fails fast rather than stalling the reporter.
+   * @param uploadTimeout Socket inactivity timeout of a multipart upload in ms
+   *                  (default 10 min): the dashboard answers one only once it
+   *                  has stored every report and trace in it.
    */
-  constructor(serverUrl, logger = new Logger(), timeout = 3e4) {
+  constructor(serverUrl, logger = new Logger(), timeout = 3e4, uploadTimeout = 10 * 60 * 1e3) {
     this.serverUrl = serverUrl;
     this.logger = logger;
     this.timeout = timeout;
+    this.uploadTimeout = uploadTimeout;
     /** Requests in flight, so `close` can abort them. */
     this.inFlight = /* @__PURE__ */ new Set();
     /** Set by `close`: every later request fails with this reason. */
@@ -426,7 +430,7 @@ var HttpClient = class {
   /** Send a multipart form-data POST request. Used for report and trace uploads. */
   async postFormData(pathname, form, auth) {
     const headers = form.getHeaders();
-    const res = await this.request("POST", pathname, { headers, form, auth });
+    const res = await this.request("POST", pathname, { headers, form, auth, timeout: this.uploadTimeout });
     if (res.status < 200 || res.status >= 300) {
       this.logger.debugError(`Response: ${res.text}`);
       const detail = parseErrorMessage(res.text);
@@ -443,7 +447,7 @@ var HttpClient = class {
   }
   /** Unified request core: transport, headers, auth, response accumulation, timeout. */
   request(method, pathname, opts) {
-    return new Promise((resolve2, reject) => {
+    return new Promise((resolve3, reject) => {
       if (this.closedReason !== null) {
         reject(new Error(this.closedReason));
         return;
@@ -466,7 +470,7 @@ var HttpClient = class {
             data += chunk;
           });
           res.on("end", () => {
-            resolve2({ status: res.statusCode ?? 0, text: data, headers: res.headers });
+            resolve3({ status: res.statusCode ?? 0, text: data, headers: res.headers });
           });
           res.on("error", reject);
           res.on("close", () => {
@@ -479,8 +483,9 @@ var HttpClient = class {
       this.inFlight.add(req);
       req.on("close", () => this.inFlight.delete(req));
       req.on("error", reject);
-      req.setTimeout(this.timeout, () => {
-        req.destroy(new Error(`Request to ${pathname} timed out after ${this.timeout}ms`));
+      const timeout = opts.timeout ?? this.timeout;
+      req.setTimeout(timeout, () => {
+        req.destroy(new Error(`Request to ${pathname} timed out after ${timeout}ms`));
       });
       if (opts.form) {
         opts.form.on("error", (error) => req.destroy(error));
@@ -556,6 +561,16 @@ function resolveShardInfo(config, env = process.env) {
 
 // src/internal/collect/metadata-collector.ts
 var import_node_child_process = require("child_process");
+
+// src/internal/support/test-paths.ts
+var path2 = __toESM(require("path"));
+function configDirFromConfig(config) {
+  if (config?.configFile) return path2.dirname(config.configFile);
+  if (config?.rootDir) return config.rootDir;
+  return process.cwd();
+}
+
+// src/internal/collect/metadata-collector.ts
 var DETACHED_HEAD = "HEAD";
 function resolveScmBranch(env, gitBranch) {
   const pick = (...names) => {
@@ -585,22 +600,22 @@ function normalizeRef(ref) {
 }
 
 // src/internal/support/setup-file.ts
-var path2 = __toESM(require("path"));
+var path3 = __toESM(require("path"));
 var os3 = __toESM(require("os"));
 var fs2 = __toESM(require("fs"));
 function getSetupFilePath(projectName) {
-  return path2.join(os3.tmpdir(), `piwi-dashboard-setup-${hashForProject(projectName)}.json`);
+  return path3.join(os3.tmpdir(), `piwi-dashboard-setup-${hashForProject(projectName)}.json`);
 }
 
 // src/internal/support/aria-sampling.ts
-var path3 = __toESM(require("path"));
+var path4 = __toESM(require("path"));
 var os4 = __toESM(require("os"));
 var fs3 = __toESM(require("fs"));
 function ariaSampleIdentity(filePath, title) {
   return `${filePath}\0${title}`;
 }
 function getAriaSampleFilePath(projectName) {
-  return path3.join(os4.tmpdir(), `piwi-dashboard-aria-sample-${hashForProject(projectName)}.json`);
+  return path4.join(os4.tmpdir(), `piwi-dashboard-aria-sample-${hashForProject(projectName)}.json`);
 }
 function writeAriaSampleFile(projectName, identities) {
   try {
@@ -713,8 +728,8 @@ function requestError(error) {
   return first.replace(/^apiRequestContext\.\w+:\s*/, "");
 }
 var playwrightProbe = async (target, timeoutMs) => {
-  const { request } = await import("@playwright/test");
-  const context = await request.newContext({ ignoreHTTPSErrors: target.ignoreHTTPSErrors, proxy: target.proxy });
+  const { request: request3 } = await import("@playwright/test");
+  const context = await request3.newContext({ ignoreHTTPSErrors: target.ignoreHTTPSErrors, proxy: target.proxy });
   try {
     const response = await context.get(target.url, { timeout: timeoutMs, maxRedirects: 0, failOnStatusCode: false });
     return { status: response.status() };
@@ -740,7 +755,7 @@ async function checkBaseUrl(target, options = {}) {
     } else {
       reason = outcome.error;
     }
-    if (attempt < attempts) await new Promise((resolve2) => setTimeout(resolve2, delayMs));
+    if (attempt < attempts) await new Promise((resolve3) => setTimeout(resolve3, delayMs));
   }
   return `${reason} (${attempts} ${attempts === 1 ? "attempt" : "attempts"})`;
 }
@@ -765,7 +780,13 @@ async function checkBaseUrls(config, options = {}) {
 
 // src/internal/manifest/collect.ts
 var fs4 = __toESM(require("fs"));
-var path4 = __toESM(require("path"));
+var path5 = __toESM(require("path"));
+
+// src/internal/transport/backend-request.ts
+var http2 = __toESM(require("http"));
+var https2 = __toESM(require("https"));
+
+// src/internal/manifest/collect.ts
 var COMMITTED_MANIFEST_FILE = "piwi.manifest.json";
 var INSTRUMENTATION_MANIFEST_PATH = "/__piwi/manifest";
 var INSTRUMENTATION_HEADERS = ["x-piwi-logs", "x-piwi-trace"];
@@ -793,7 +814,7 @@ function hasInstrumentationHeader(headers) {
   return INSTRUMENTATION_HEADERS.some((h) => get(h) != null && get(h) !== "");
 }
 function readCommittedManifest(configDir) {
-  const file = path4.join(configDir, COMMITTED_MANIFEST_FILE);
+  const file = path5.join(configDir, COMMITTED_MANIFEST_FILE);
   try {
     if (!fs4.existsSync(file)) return null;
     return parseManifestJson(fs4.readFileSync(file, "utf8"));
@@ -801,34 +822,20 @@ function readCommittedManifest(configDir) {
     return null;
   }
 }
-function configDirFromConfig(config) {
-  if (config?.configFile) return path4.dirname(config.configFile);
-  if (config?.rootDir) return config.rootDir;
-  return process.cwd();
-}
-function baseUrlFromConfig(config) {
-  const top = config?.use?.baseURL;
-  if (typeof top === "string" && top) return top;
-  for (const project of config?.projects ?? []) {
-    const url = project?.use?.baseURL;
-    if (typeof url === "string" && url) return url;
-  }
-  return null;
-}
 var INSTRUMENTATION_FETCH_TIMEOUT_MS = 5e3;
+var MAX_MANIFEST_BYTES = 4 * 1024 * 1024;
 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];
+  const path8 = base.pathname.replace(/\/+$/, "");
+  return path8 ? [new URL(`${path8}${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;
     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;
+      const manifest = await fetchManifestAt(manifestUrl, fetchImpl);
       if (manifest) return manifest;
     }
     return null;
@@ -836,18 +843,55 @@ async function fetchInstrumentationManifest(baseUrl, fetchImpl = fetch) {
     return null;
   }
 }
+async function fetchManifestAt(manifestUrl, fetchImpl) {
+  const res = await fetchImpl(manifestUrl, { signal: AbortSignal.timeout(INSTRUMENTATION_FETCH_TIMEOUT_MS) });
+  return res.ok ? parseManifestJson(await res.text()) : null;
+}
+
+// src/internal/manifest/run-manifests.ts
+async function lookupProjectId(httpClient, auth, projectName) {
+  const menu = await httpClient.getJSON("/api/projects/menu", auth);
+  return menu?.items?.find(
+    (p) => p.name.toLowerCase() === projectName.toLowerCase()
+  )?.id;
+}
+async function uploadManifest(httpClient, auth, projectId, upload, logger) {
+  await httpClient.putJSON(`/api/projects/${projectId}/surface/manifest`, upload, auth).catch((e) => logger.debug(`Manifest upload (${upload.source}) skipped: ${errorMessage(e)}`));
+}
+
+// src/internal/collect/source-checksums.ts
+var crypto2 = __toESM(require("crypto"));
+var fs5 = __toESM(require("fs"));
+var path6 = __toESM(require("path"));
+
+// src/internal/collect/server-coverage.ts
+var DEFAULT_COLLECTOR_LIMITS = {
+  batchTests: 25,
+  batchDelayMs: 1e3,
+  callTimeoutMs: 1e4,
+  runTimeoutMs: 3e4,
+  maxIdsPerCall: 1e4,
+  maxBodyBytes: 1024 * 1024 - 4096,
+  maxIdsPerTest: 5e4,
+  concurrency: 2
+};
+var MAX_ANSWER_BYTES = 64 * 1024 * 1024;
+function baseUrlsFromConfig(config) {
+  const urls = [config?.use?.baseURL, ...(config?.projects ?? []).map((project) => project?.use?.baseURL)];
+  return [...new Set(urls.filter((url) => typeof url === "string" && url !== ""))];
+}
 
 // src/public/global-setup.ts
 function createGlobalSetup(options, userSetup) {
   return async function globalSetupFn(config) {
-    const piwiReporterPath = path5.resolve(__dirname, "./index.js");
+    const piwiReporterPath = path7.resolve(__dirname, "./index.js");
     let inlineReporterOptions = {};
     if (Array.isArray(config?.reporter)) {
       for (const r of config.reporter) {
         if (!Array.isArray(r) || typeof r[0] !== "string") continue;
         const isPiwi = r[0].toLowerCase().includes("piwi") || (() => {
           try {
-            return path5.resolve(require.resolve(r[0])) === piwiReporterPath;
+            return path7.resolve(require.resolve(r[0])) === piwiReporterPath;
           } catch {
             return false;
           }
@@ -883,7 +927,7 @@ function createGlobalSetup(options, userSetup) {
       if (!Array.isArray(r) || typeof r[0] !== "string") return false;
       if (r[0].toLowerCase().includes("piwi")) return true;
       try {
-        return path5.resolve(require.resolve(r[0])) === piwiReporterPath;
+        return path7.resolve(require.resolve(r[0])) === piwiReporterPath;
       } catch {
         return false;
       }
@@ -913,7 +957,7 @@ function createGlobalSetup(options, userSetup) {
         auth
       );
       if (response?.runId && response?.setupToken) {
-        fs5.writeFileSync(
+        fs6.writeFileSync(
           getSetupFilePath(opts.projectName),
           JSON.stringify({
             runId: response.runId,
@@ -926,14 +970,11 @@ function createGlobalSetup(options, userSetup) {
       if (opts.projectName) clearAriaSampleFile(opts.projectName);
       const wantsAria = opts.sampleAriaOnPass !== false && !!opts.projectName;
       const committedManifest = opts.uploadManifest !== false ? readCommittedManifest(configDirFromConfig(config)) : null;
-      const manifestBaseUrl = opts.uploadManifest !== false ? baseUrlFromConfig(config) : null;
-      const wantsManifest = opts.uploadManifest !== false && !!opts.projectName && (!!committedManifest || !!manifestBaseUrl);
+      const manifestBaseUrls = opts.uploadManifest !== false ? baseUrlsFromConfig(config) : [];
+      const wantsManifest = opts.uploadManifest !== false && !!opts.projectName && (!!committedManifest || manifestBaseUrls.length > 0);
       let projectId;
       if ((wantsAria || wantsManifest) && opts.projectName) {
-        const menu = await httpClient.getJSON("/api/projects/menu", auth);
-        projectId = menu?.items?.find(
-          (p) => p.name.toLowerCase() === opts.projectName.toLowerCase()
-        )?.id;
+        projectId = await lookupProjectId(httpClient, auth, opts.projectName);
       }
       if (wantsAria && projectId != null) {
         const sampling = await httpClient.getJSON(`/api/projects/${projectId}/aria-sampling`, auth);
@@ -947,20 +988,18 @@ function createGlobalSetup(options, userSetup) {
       if (wantsManifest && projectId != null) {
         const branch = resolveScmBranch(process.env) ?? null;
         if (committedManifest) {
-          await httpClient.putJSON(
-            `/api/projects/${projectId}/surface/manifest`,
+          await uploadManifest(
+            httpClient,
+            auth,
+            projectId,
             { source: "committed", branch, manifest: committedManifest },
-            auth
-          ).catch((e) => logger.debug(`Manifest upload (committed) skipped: ${errorMessage(e)}`));
+            logger
+          );
         }
-        if (manifestBaseUrl) {
-          const declared = await fetchInstrumentationManifest(manifestBaseUrl);
-          if (declared) {
-            await httpClient.putJSON(
-              `/api/projects/${projectId}/surface/manifest`,
-              { source: "instrumentation", branch, manifest: declared },
-              auth
-            ).catch((e) => logger.debug(`Manifest upload (instrumentation) skipped: ${errorMessage(e)}`));
+        const declared = await Promise.all(manifestBaseUrls.map((url) => fetchInstrumentationManifest(url)));
+        for (const manifest of declared) {
+          if (manifest) {
+            await uploadManifest(httpClient, auth, projectId, { source: "instrumentation", branch, manifest }, logger);
           }
         }
       }

package/dist/index.d.ts

@@ -90,8 +90,14 @@ interface PiwiDashboardOptions {
      * 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']`).
+     *
+     * An object gives directories per origin instead, for an application whose
+     * tests reach several dev servers that serve modules at the same paths (one per
+     * portal): a script resolves against the directories of its own origin, else
+     * of the origin of the page that loaded it, then those under `'*'`
+     * (`{ 'http://localhost:3001': 'portals/admin', '*': ['app'] }`).
      */
-    codeReachRoots?: string[];
+    codeReachRoots?: string[] | Record<string, string | 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
@@ -102,10 +108,13 @@ interface PiwiDashboardOptions {
         /**
          * 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`.
+         * `captureCodeReach: true` records; `'functions'` adds the start and end
+         * line of each function that ran, read through the dev server's modules or
+         * the bundle's source maps; `'off'` records nothing. Paths, and line numbers
+         * with `'functions'`, are sent, never source code or hit counts. Defaults to
+         * `'off'`. Can also be set with `PIWI_COVERAGE_BROWSER`.
          */
-        browser?: 'off' | 'files';
+        browser?: 'off' | 'files' | 'functions';
         /**
          * What the server side records, from a backend built with Piwi's coverage
          * instrumentation (ASP.NET Core: `-p:PiwiCoverage=true`), which names each
@@ -170,10 +179,11 @@ interface PiwiDashboardOptions {
      */
     sampleAriaOnPass?: boolean;
     /**
-     * Upload the application's declared surface at run start: a committed
-     * `piwi.manifest.json` next to the Playwright config, and — when the base URL's
-     * first response carries an instrumentation header — the instrumentation
-     * package's `/__piwi/manifest`. A route or page the manifest declares that no
+     * Upload the application's declared surface: at run start, a committed
+     * `piwi.manifest.json` next to the Playwright config and the instrumentation
+     * package's `/__piwi/manifest` of each `baseURL` whose first response carries an
+     * instrumentation header; as the run's last test ends, the manifest of every
+     * other origin whose responses carried one. A route or page the manifest declares that no
      * test reaches becomes a "declared, never hit" gap. Defaults to `true`; set to
      * `false` (or `PIWI_UPLOAD_MANIFEST=false`) to never upload.
      */
@@ -441,6 +451,8 @@ declare class PiwiDashboardReporter {
     private reportedTestIds;
     /** 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`. */
+    private testPathBase;
     /** Derived in `onBegin`, once the shard is known. */
     private instanceId;
     private shardInfo;
@@ -476,8 +488,10 @@ declare class PiwiDashboardReporter {
     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. */
+    /** Tells when the run's last test ended, while server coverage needs it. */
     private lastTestWatch;
+    /** The manifests of the instrumented origins the run reaches beyond its base URLs. */
+    private manifests;
     /** Result events that stream once their test's server coverage is in. */
     private coverageSends;
     private httpClient;
@@ -492,6 +506,13 @@ declare class PiwiDashboardReporter {
     static wrapConfig: typeof wrapConfig;
     static createGlobalSetup: typeof createGlobalSetup;
     constructor(rawOptions?: Record<string, any>);
+    /**
+     * Playwright reporter hook: whether this reporter writes the run's progress to
+     * the terminal. It does not (it prints only its own `[Piwi Dashboard]` lines),
+     * so Playwright keeps its own terminal reporter when Piwi is the only one
+     * configured.
+     */
+    printsToStdio(): boolean;
     /** Playwright reporter hook: called once at the start of the test run */
     onBegin(config: FullConfig, suite: Suite): void;
     /** Playwright reporter hook: called when an individual test begins */