@piwitests/reporter 0.5.0 → 0.6.0

package/dist/{reporter.js → public/reporter.js}

@@ -34,45 +34,37 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PiwiDashboardReporter = void 0;
-const path = __importStar(require("path"));
-const config_js_1 = require("./config.js");
-const http_client_js_1 = require("./http-client.js");
-const uploader_js_1 = require("./uploader.js");
-const stream_buffer_js_1 = require("./stream-buffer.js");
-const crash_recovery_js_1 = require("./crash-recovery.js");
-const file_handler_js_1 = require("./file-handler.js");
-const metadata_collector_js_1 = require("./metadata-collector.js");
-const stream_manager_js_1 = require("./stream-manager.js");
-const step_analyzer_js_1 = require("./step-analyzer.js");
-const helpers_js_1 = require("./helpers.js");
+const path = __importStar(require("node:path"));
+const env_js_1 = require("../internal/config/env.js");
+const http_client_js_1 = require("../internal/transport/http-client.js");
+const uploader_js_1 = require("../internal/submit/uploader.js");
+const stream_buffer_js_1 = require("../internal/streaming/stream-buffer.js");
+const crash_recovery_js_1 = require("../internal/streaming/crash-recovery.js");
+const file_handler_js_1 = require("../internal/files/file-handler.js");
+const attachments_js_1 = require("../internal/capture/attachments.js");
+const metadata_collector_js_1 = require("../internal/collect/metadata-collector.js");
+const stream_manager_js_1 = require("../internal/streaming/stream-manager.js");
+const step_analyzer_js_1 = require("../internal/collect/step-analyzer.js");
+const instance_id_js_1 = require("../internal/support/instance-id.js");
+const source_snippet_js_1 = require("../internal/support/source-snippet.js");
+const ci_js_1 = require("../internal/support/ci.js");
+const worker_index_js_1 = require("../internal/support/worker-index.js");
+const cli_filters_js_1 = require("../internal/support/cli-filters.js");
+const global_setup_js_1 = require("./global-setup.js");
 const config_wrapper_js_1 = require("./config-wrapper.js");
-const serializer_js_1 = require("./serializer.js");
-const skip_classify_js_1 = require("./skip-classify.js");
-const run_submitter_js_1 = require("./run-submitter.js");
-const logger_js_1 = require("./logger.js");
+const serializer_js_1 = require("../internal/submit/serializer.js");
+const skip_classify_js_1 = require("../internal/collect/skip-classify.js");
+const error_text_js_1 = require("../internal/collect/error-text.js");
+const run_submitter_js_1 = require("../internal/submit/run-submitter.js");
+const logger_js_1 = require("../internal/support/logger.js");
 /**
- * Build the stored error text for a test result.
- *
- * Playwright's `error.message` carries the failure message and call log but no
- * stack frames — those live on `error.stack`/`error.location`. The server's
- * locator-healing lookup needs the failing call site to find the pre-captured
- * snapshot for that locator, so when the message has no `at …` frame we append
- * a synthetic one from `error.location`, relativized to the cwd so it matches
- * the format the fixture records at capture time. The frame is appended after
- * the message, where `extractMessageHead` already trims it off before
- * fingerprinting — so failure clustering is unaffected.
+ * Relative `file:line:column` location string for a test, normalized to POSIX
+ * path separators so Playwright's CLI file filter (and the dashboard's copyable
+ * retry command) match on every platform — `path.relative` yields backslashes on Windows.
  */
-function buildErrorText(result) {
-    const err = result.error;
-    if (!err)
-        return null;
-    let text = err.message ?? '';
-    const loc = err.location;
-    if (loc?.file && !/\n\s+at\s/.test(text)) {
-        const rel = path.relative(process.cwd(), loc.file).split(path.sep).join('/');
-        text += `\n    at ${rel}:${loc.line}:${loc.column}`;
-    }
-    return text;
+function testLocation(test) {
+    const relativeFilePath = path.relative(process.cwd(), test.location.file).split(path.sep).join('/');
+    return `${relativeFilePath}:${test.location.line}:${test.location.column}`;
 }
 /**
  * Piwi Dashboard Playwright reporter.
@@ -105,10 +97,10 @@ class PiwiDashboardReporter {
         this.streamManager = null;
         /** Track suite-level setup steps (beforeAll/afterAll) not tied to any test */
         this.setupSteps = [];
-        this.options = (0, config_js_1.resolveOptions)(rawOptions);
+        this.options = (0, env_js_1.resolveOptions)(rawOptions);
         this.enabled = this.options.enabled !== false && !!this.options.serverUrl;
-        this.runLabel = this.options.runLabel || (0, helpers_js_1.detectCiRunLabel)();
-        this.instanceId = (0, helpers_js_1.computeInstanceId)(this.options.projectName, this.runLabel);
+        this.runLabel = this.options.runLabel || (0, ci_js_1.detectCiRunLabel)();
+        this.instanceId = (0, instance_id_js_1.computeInstanceId)(this.options.projectName, this.runLabel);
         const logger = new logger_js_1.Logger(this.options.verbose ?? false);
         this.logger = logger;
         this.httpClient = new http_client_js_1.HttpClient(this.options.serverUrl ?? 'http://localhost:3000', logger);
@@ -140,7 +132,7 @@ class PiwiDashboardReporter {
         const grep = grepRe && grepRe.source !== '.*' ? grepRe.source : undefined;
         const grepInvert = grepInvertRe?.source;
         // File/path filters come from the CLI invocation, not config.grep.
-        const fileFilters = (0, helpers_js_1.detectCliFileFilters)();
+        const fileFilters = (0, cli_filters_js_1.detectCliFileFilters)();
         if (grep || grepInvert || fileFilters.length > 0) {
             this.isFullRun = false;
             this.filterDetails = {
@@ -166,13 +158,12 @@ class PiwiDashboardReporter {
     }
     /** Playwright reporter hook: called when an individual test begins */
     onTestBegin(test, result) {
-        const relativeFilePath = path.relative(process.cwd(), test.location.file);
         const { suitePath, suiteConfig } = this.metadataCollector.getSuiteInfo(test);
         const beginEvent = {
             type: 'begin',
             title: test.title,
-            location: `${relativeFilePath}:${test.location.line}:${test.location.column}`,
-            workerIndex: (0, helpers_js_1.workerIndexOf)(result),
+            location: testLocation(test),
+            workerIndex: (0, worker_index_js_1.workerIndexOf)(result),
             shardIndex: this.shardInfo?.current ?? null,
             browser: this.metadataCollector.getBrowserConfig(test) || undefined,
             suitePath,
@@ -195,7 +186,7 @@ class PiwiDashboardReporter {
             location: step.location ? `${step.location.file}:${step.location.line}:${step.location.column}` : 'unknown',
             stepCategory: cat,
             parentTitle: test?.title || null,
-            workerIndex: (0, helpers_js_1.workerIndexOf)(_result),
+            workerIndex: (0, worker_index_js_1.workerIndexOf)(_result),
             startedAt: step.startTime instanceof Date ? step.startTime.getTime() : null,
         };
         this.streamManager?.queueBeginEvent(event);
@@ -209,7 +200,7 @@ class PiwiDashboardReporter {
             return;
         if (cat !== 'hook' && cat !== 'fixture')
             return;
-        const workerIndex = (0, helpers_js_1.workerIndexOf)(_result);
+        const workerIndex = (0, worker_index_js_1.workerIndexOf)(_result);
         const startedAt = step.startTime instanceof Date ? step.startTime.getTime() : null;
         const event = {
             type: 'step-end',
@@ -239,7 +230,6 @@ class PiwiDashboardReporter {
     /** Playwright reporter hook: called when an individual test finishes */
     onTestEnd(test, result) {
         this.totalTests++;
-        const relativeFilePath = path.relative(process.cwd(), test.location.file);
         this.reportedTestIds.add(test.id);
         const { suitePath, suiteConfig } = this.metadataCollector.getSuiteInfo(test);
         const annotations = (0, skip_classify_js_1.mergeAnnotations)(test, result);
@@ -247,12 +237,12 @@ class PiwiDashboardReporter {
         const testCase = {
             type: 'complete',
             title: test.title,
-            location: `${relativeFilePath}:${test.location.line}:${test.location.column}`,
+            location: testLocation(test),
             status,
             duration: result.duration,
-            error: buildErrorText(result),
+            error: (0, error_text_js_1.buildErrorText)(result),
             retries: result.retry,
-            workerIndex: (0, helpers_js_1.workerIndexOf)(result),
+            workerIndex: (0, worker_index_js_1.workerIndexOf)(result),
             shardIndex: this.shardInfo?.current ?? null,
             startedAt: result.startTime ? result.startTime.getTime() : null,
             attachments: result.attachments || [],
@@ -262,7 +252,8 @@ class PiwiDashboardReporter {
             testAnnotations: annotations.length ? annotations : null,
         };
         if (result.status === 'failed' || result.status === 'timedOut') {
-            const snippet = (0, helpers_js_1.readSourceSnippet)(test.location.file, test.location.line, 30);
+            const failingLine = (0, source_snippet_js_1.extractFailingLine)(testCase.error, test.location.file, test.location.line);
+            const snippet = (0, source_snippet_js_1.readSourceSnippet)(test.location.file, test.location.line, 30, failingLine);
             if (snippet)
                 testCase.testSource = snippet;
         }
@@ -280,7 +271,7 @@ class PiwiDashboardReporter {
             // (captured in the fixture at action call time). No index correlation
             // with pw:api steps — that was unreliable across workers/concurrent calls.
             const locatorAttachment = this.options.captureLocators !== false
-                ? result.attachments.find((a) => a.name === 'piwi-dashboard-locators')
+                ? result.attachments.find((a) => a.name === attachments_js_1.ATTACHMENT_NAMES.locators)
                 : undefined;
             if (locatorAttachment?.body) {
                 try {
@@ -326,12 +317,11 @@ class PiwiDashboardReporter {
         for (const test of this.plannedTests) {
             if (this.reportedTestIds.has(test.id))
                 continue;
-            const relativeFilePath = path.relative(process.cwd(), test.location.file);
             const { suitePath, suiteConfig } = this.metadataCollector.getSuiteInfo(test);
             const testCase = {
                 type: 'complete',
                 title: test.title,
-                location: `${relativeFilePath}:${test.location.line}:${test.location.column}`,
+                location: testLocation(test),
                 status: 'didnotrun',
                 duration: 0,
                 error: null,
@@ -380,4 +370,4 @@ class PiwiDashboardReporter {
 }
 exports.PiwiDashboardReporter = PiwiDashboardReporter;
 PiwiDashboardReporter.wrapConfig = config_wrapper_js_1.wrapConfig;
-PiwiDashboardReporter.createGlobalSetup = helpers_js_1.createGlobalSetup;
+PiwiDashboardReporter.createGlobalSetup = global_setup_js_1.createGlobalSetup;

package/dist/types/collected.d.ts

@@ -0,0 +1,96 @@
+/**
+ * Internal collection model — the shapes the reporter accumulates *in process*
+ * while a run executes.
+ *
+ * These are NOT sent to the server verbatim: the wire projection happens in
+ * `serializer.ts` (`toWireTestCase` / `serializeRun`) at the JSON boundary. For
+ * the external server contract, see `./wire.ts`.
+ */
+import type { BrowserConfig, SuiteConfigEntry, TestAnnotation, TestStepEvent } from './wire.js';
+import type { LocatorSnapshot } from '../internal/capture/locator-healing.js';
+/**
+ * A raw Playwright attachment as exposed on `TestResult.attachments`.
+ * Carried verbatim on `CollectedTestCase.attachments` so `FileHandler` can
+ * resolve trace/attachment paths; never sent to the server.
+ */
+export interface RawAttachment {
+    name: string;
+    path?: string;
+    contentType?: string;
+    body?: Buffer;
+    originalName?: string;
+}
+/** Performance metrics collected from `result.steps` by `step-analyzer`. */
+export interface CollectedPerformanceMetrics {
+    steps: Array<{
+        title: string;
+        duration: number;
+        category: string;
+        error?: {
+            message: string;
+        };
+        failed?: boolean;
+    }>;
+    totalStepDuration: number;
+    slowestStep: {
+        title: string;
+        duration: number;
+    } | null;
+    navigationCount: number;
+    navigationTotalDuration: number;
+    waitTotalDuration: number;
+    waitCount: number;
+}
+/**
+ * What `onTestEnd` accumulates per test case. Mixes three concerns that the
+ * reporter must keep together during a run:
+ *  - **wire fields** (`title`, `status`, `duration`, …) that `toWireTestCase`
+ *    projects onto `WireTestCase` before sending,
+ *  - **collection-only state** (`attachments`, `performanceMetrics`,
+ *    `stepEvents`) consumed by `FileHandler` and the run-level summary,
+ *  - the `type` discriminant so the same collected object can be queued as a
+ *    stream event.
+ *
+ * Upload bookkeeping (`_filesUploaded`) is deliberately NOT on this object —
+ * `StreamManager` tracks it in a side `Set` so the data model stays clean.
+ */
+export interface CollectedTestCase {
+    /** Stream-event discriminant: `'begin'` or `'complete'`. Omitted for batch-only runs. */
+    type?: 'begin' | 'complete';
+    title: string;
+    location: string;
+    status?: string;
+    duration?: number;
+    error?: string | null;
+    retries?: number;
+    workerIndex?: number | null;
+    shardIndex?: number | null;
+    startedAt?: number | null;
+    /** Raw Playwright attachments — never sent on the wire. */
+    attachments?: RawAttachment[];
+    browser?: BrowserConfig | null;
+    suitePath?: string[] | null;
+    suiteConfig?: SuiteConfigEntry[] | null;
+    testAnnotations?: TestAnnotation[] | null;
+    /** Source snippet around the failing line (failed/timedOut only). */
+    testSource?: string;
+    /** Step metrics from `collectStepMetrics`. Consumed by the run summary + `toWireTestCase`. */
+    performanceMetrics?: CollectedPerformanceMetrics;
+    stepEvents?: TestStepEvent[];
+    /** Parsed from `piwi-network` attachments by `FileHandler`. */
+    networkRequests?: unknown;
+    /** Parsed from `piwi-web-vitals` attachments. */
+    webVitals?: unknown;
+    /** Parsed from `piwi-console` attachments. */
+    consoleLogs?: unknown;
+    /** Parsed from `piwi-aria-snapshot` attachment. */
+    ariaSnapshot?: string;
+    /** Parsed from `piwi-locators` attachment. */
+    locatorSnapshots?: LocatorSnapshot[];
+}
+/** Hash + size of a single trace file, used for dedup against the server. */
+export interface TraceHashInfo {
+    tracePath: string;
+    hash: string;
+    size: number;
+}

package/dist/types/collected.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * Internal collection model — the shapes the reporter accumulates *in process*
+ * while a run executes.
+ *
+ * These are NOT sent to the server verbatim: the wire projection happens in
+ * `serializer.ts` (`toWireTestCase` / `serializeRun`) at the JSON boundary. For
+ * the external server contract, see `./wire.ts`.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/wire.d.ts

@@ -0,0 +1,174 @@
+/**
+ * Wire contract — the **external** shapes sent to / received from the Piwi
+ * Dashboard server.
+ *
+ * These structurally mirror — but do not import — `application/shared/types.ts`
+ * (`TestCasePayload`, `StreamEventPayload`, `TestRunFinishPayload`). Importing
+ * that module would leak the monorepo path into the published `.d.ts` files; the
+ * constraint forbids the import, not the types. **Any change here is a change to
+ * the server contract** — keep both sides structurally compatible.
+ *
+ * For the in-process collection model (never sent verbatim), see `./collected.ts`.
+ */
+export interface SuiteConfigEntry {
+    mode: 'parallel' | 'serial' | 'default';
+    annotations: Array<{
+        type: string;
+        description?: string;
+    }>;
+}
+export interface TestAnnotation {
+    type: string;
+    description?: string;
+}
+/**
+ * Filter that narrowed a run to a subset of tests, recorded when `isFullRun`
+ * is false. Mirrors `FilterDetails` in `application/shared/types.ts`.
+ */
+export interface FilterDetails {
+    /** A non-default `--grep` pattern (Playwright's default `.*` is excluded). */
+    grep?: string;
+    /** A `--grep-invert` pattern. */
+    grepInvert?: string;
+    /** Positional file/path filters from the CLI invocation (e.g. ["tests/login.spec.ts"]). */
+    files?: string[];
+}
+export interface BrowserConfig {
+    projectName?: string;
+    browserName?: string | null;
+    channel?: string | null;
+    viewport?: {
+        width: number;
+        height: number;
+    } | null;
+    deviceScaleFactor?: number | null;
+    isMobile?: boolean | null;
+    hasTouch?: boolean | null;
+    locale?: string | null;
+    timezoneId?: string | null;
+    geolocation?: {
+        longitude: number;
+        latitude: number;
+        accuracy?: number;
+    } | null;
+    colorScheme?: string | null;
+    reducedMotion?: string | null;
+    forcedColors?: string | null;
+    offline?: boolean | null;
+    bypassCSP?: boolean | null;
+    javaScriptEnabled?: boolean | null;
+    serviceWorkers?: string | null;
+    userAgent?: string | null;
+}
+/** A hook/fixture step event with absolute timings (for the workers timeline). */
+export interface TestStepEvent {
+    title: string;
+    category: 'hook' | 'fixture' | 'test.step' | 'expect' | 'wait';
+    startedAt: number;
+    duration: number;
+    status: string;
+    location?: string | null;
+}
+/**
+ * The per-case wire shape that `toWireTestCase` produces and the server
+ * receives. Structurally compatible with `TestCasePayload` and the per-event
+ * `StreamEventPayload`.
+ */
+export interface WireTestCase {
+    type?: 'begin' | 'complete' | 'step-begin' | 'step-end';
+    title: string;
+    location: string;
+    status?: string;
+    duration?: number;
+    error?: string | null;
+    retries?: number;
+    workerIndex?: number | null;
+    shardIndex?: number | null;
+    startedAt?: number | null;
+    steps?: unknown;
+    stepEvents?: TestStepEvent[] | null;
+    slowestStep?: string | null;
+    slowestStepDuration?: number | null;
+    wastedTimeMs?: number | null;
+    networkRequests?: unknown;
+    webVitals?: unknown;
+    consoleLogs?: unknown;
+    ariaSnapshot?: unknown;
+    testSource?: string | null;
+    browser?: BrowserConfig | null;
+    suitePath?: string[] | null;
+    suiteConfig?: SuiteConfigEntry[] | null;
+    testAnnotations?: TestAnnotation[] | null;
+    /** Step-event discriminant (only for `step-begin`/`step-end` events). */
+    stepCategory?: string | null;
+    parentTitle?: string | null;
+    /** Per-element locator snapshots with ranked alternatives (transient — not stored per-run). */
+    locatorSnapshots?: unknown;
+}
+export interface BeginStreamEvent {
+    type: 'begin';
+    title: string;
+    location: string;
+    workerIndex: number | null;
+    shardIndex: number | null;
+    browser?: BrowserConfig | null;
+    suitePath?: string[] | null;
+    suiteConfig?: SuiteConfigEntry[] | null;
+}
+export interface CompleteStreamEvent {
+    type: 'complete';
+    title: string;
+    location: string;
+    status: string;
+    duration: number;
+    error: string | null;
+    retries: number;
+    workerIndex: number | null;
+    shardIndex: number | null;
+    startedAt: number | null;
+    browser?: BrowserConfig | null;
+    suitePath?: string[] | null;
+    suiteConfig?: SuiteConfigEntry[] | null;
+    testAnnotations?: TestAnnotation[] | null;
+    steps?: unknown;
+    stepEvents?: TestStepEvent[] | null;
+    slowestStep?: string | null;
+    slowestStepDuration?: number | null;
+    networkRequests?: unknown;
+    webVitals?: unknown;
+    consoleLogs?: unknown;
+    ariaSnapshot?: unknown;
+    testSource?: string | null;
+    locatorSnapshots?: unknown;
+}
+export interface StepBeginStreamEvent {
+    type: 'step-begin';
+    title: string;
+    location: string;
+    stepCategory: 'hook' | 'fixture';
+    parentTitle: string | null;
+    workerIndex: number | null;
+    startedAt: number | null;
+}
+export interface StepEndStreamEvent {
+    type: 'step-end';
+    title: string;
+    location: string;
+    status: string;
+    duration: number;
+    stepCategory: 'hook' | 'fixture';
+    parentTitle: string | null;
+    workerIndex: number | null;
+    startedAt: number | null;
+}
+/** Discriminated union of events queued to `StreamManager` and persisted by `StreamBuffer`. */
+export type StreamEvent = BeginStreamEvent | CompleteStreamEvent | StepBeginStreamEvent | StepEndStreamEvent;
+export interface SetupStep {
+    title: string;
+    category: string;
+    startedAt: number;
+    duration: number;
+    status: string;
+    location?: string | null;
+    workerIndex?: number | null;
+}

package/dist/types/wire.js

@@ -0,0 +1,14 @@
+"use strict";
+/**
+ * Wire contract — the **external** shapes sent to / received from the Piwi
+ * Dashboard server.
+ *
+ * These structurally mirror — but do not import — `application/shared/types.ts`
+ * (`TestCasePayload`, `StreamEventPayload`, `TestRunFinishPayload`). Importing
+ * that module would leak the monorepo path into the published `.d.ts` files; the
+ * constraint forbids the import, not the types. **Any change here is a change to
+ * the server contract** — keep both sides structurally compatible.
+ *
+ * For the in-process collection model (never sent verbatim), see `./collected.ts`.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });