@piwitests/reporter 0.12.0 → 0.13.0

package/dist/public/config-wrapper.js

@@ -1,64 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.wrapConfig = wrapConfig;
-const env_js_1 = require("../internal/config/env.js");
-const PIWI_MODULE = '@piwitests/reporter';
-function isPiwiReporterEntry(entry) {
-    if (typeof entry === 'string')
-        return entry.toLowerCase().includes('piwi');
-    if (Array.isArray(entry) && typeof entry[0] === 'string')
-        return entry[0].toLowerCase().includes('piwi');
-    return false;
-}
-function injectReporter(reporter, piwiOptions) {
-    const piwiEntry = piwiOptions ? [PIWI_MODULE, piwiOptions] : [PIWI_MODULE];
-    if (!reporter)
-        return [piwiEntry];
-    if (Array.isArray(reporter)) {
-        if (reporter.some(isPiwiReporterEntry))
-            return reporter;
-        return [...reporter, piwiEntry];
-    }
-    return [[reporter], piwiEntry];
-}
-function resolveSetupModule() {
-    try {
-        return require.resolve('../global-setup-module.js');
-    }
-    catch {
-        return require.resolve('../global-setup-module.ts');
-    }
-}
-/**
- * Wrap a Playwright config to auto-inject the Piwi Dashboard reporter and
- * chain its global setup module. Returns a new config object (shallow merge)
- * without mutating the original.
- *
- * The `globalSetup` field is set to a `string` (or `string[]` if the user
- * already has a global setup) referencing the Piwi global setup module,
- * which registers the run on the server. The original setup path(s) are
- * preserved and executed first.
- *
- * Playwright options required in `globalSetup` are forwarded via `PIWI_*`
- * environment variables (see `applyOptionsToEnv` in `config.ts` for the
- * supported set — `serverUrl`, `projectName`, `verbose`, `apiKey`,
- * `username`, `password`, `environment`, `label`, `runLabel`).
- *
- * @param config      The user's Playwright config.
- * @param piwiOptions Optional Piwi Dashboard options (serverUrl, projectName, …).
- */
-function wrapConfig(config, piwiOptions) {
-    if (piwiOptions)
-        (0, env_js_1.applyOptionsToEnv)(piwiOptions);
-    const globalSetupModules = [];
-    if (config.globalSetup) {
-        const orig = Array.isArray(config.globalSetup) ? config.globalSetup : [config.globalSetup];
-        globalSetupModules.push(...orig);
-    }
-    globalSetupModules.push(resolveSetupModule());
-    return {
-        ...config,
-        reporter: injectReporter(config.reporter, piwiOptions),
-        globalSetup: globalSetupModules.length === 1 ? globalSetupModules[0] : globalSetupModules,
-    };
-}

package/dist/public/global-setup.d.ts

@@ -1,13 +0,0 @@
-import type { PiwiDashboardOptions } from './options.js';
-/**
- * Create a Playwright `globalSetup` function that registers a test run on the
- * Piwi Dashboard server at the start of the run.  An optional `userSetup` is
- * called afterward so existing setup logic is preserved.
- *
- * The server-run ID and a one-time token are written to a temp file so the
- * reporter instance can pick them up during the streaming handshake.
- *
- * @param options   Piwi Dashboard options (uses `serverUrl`, `projectName`, …).
- * @param userSetup An existing global setup to chain after the Piwi registration.
- */
-export declare function createGlobalSetup(options?: PiwiDashboardOptions, userSetup?: (config: any) => any): (config: any) => Promise<any>;

package/dist/public/global-setup.js

@@ -1,146 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createGlobalSetup = createGlobalSetup;
-const path = __importStar(require("node:path"));
-const errors_js_1 = require("../internal/support/errors.js");
-const fs = __importStar(require("node:fs"));
-const env_js_1 = require("../internal/config/env.js");
-const http_client_js_1 = require("../internal/transport/http-client.js");
-const logger_js_1 = require("../internal/support/logger.js");
-const instance_id_js_1 = require("../internal/support/instance-id.js");
-const ci_js_1 = require("../internal/support/ci.js");
-const setup_file_js_1 = require("../internal/support/setup-file.js");
-/**
- * Create a Playwright `globalSetup` function that registers a test run on the
- * Piwi Dashboard server at the start of the run.  An optional `userSetup` is
- * called afterward so existing setup logic is preserved.
- *
- * The server-run ID and a one-time token are written to a temp file so the
- * reporter instance can pick them up during the streaming handshake.
- *
- * @param options   Piwi Dashboard options (uses `serverUrl`, `projectName`, …).
- * @param userSetup An existing global setup to chain after the Piwi registration.
- */
-function createGlobalSetup(options, userSetup) {
-    return async function globalSetupFn(config) {
-        // This module compiles to `dist/public/global-setup.js`; the package entry
-        // point is `dist/index.js`, one level up.
-        const piwiReporterPath = path.resolve(__dirname, '../index.js');
-        // Extract options from the Piwi reporter entry in the Playwright config so
-        // that serverUrl / projectName etc. set inline in the reporters array are
-        // visible here without requiring PIWI_* env vars or a separate wrapConfig call.
-        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 path.resolve(require.resolve(r[0])) === piwiReporterPath;
-                        }
-                        catch {
-                            return false;
-                        }
-                    })();
-                if (isPiwi && r[1] && typeof r[1] === 'object') {
-                    inlineReporterOptions = r[1];
-                    break;
-                }
-            }
-        }
-        const opts = (0, env_js_1.resolveOptions)({ ...inlineReporterOptions, ...options });
-        const logger = new logger_js_1.Logger(opts.verbose ?? false);
-        if (opts.enabled === false || !opts.serverUrl) {
-            logger.info('Not enabled — set PIWI_DASHBOARD_URL or serverUrl to enable.');
-            if (userSetup)
-                return userSetup(config);
-            return;
-        }
-        const hasPiwi = Object.keys(inlineReporterOptions).length > 0 ||
-            (Array.isArray(config?.reporter) &&
-                config.reporter.some((r) => {
-                    if (!Array.isArray(r) || typeof r[0] !== 'string')
-                        return false;
-                    if (r[0].toLowerCase().includes('piwi'))
-                        return true;
-                    try {
-                        return path.resolve(require.resolve(r[0])) === piwiReporterPath;
-                    }
-                    catch {
-                        return false;
-                    }
-                }));
-        if (!hasPiwi) {
-            logger.debug('Not reporting — Piwi is not in the Playwright reporters list.');
-            if (userSetup)
-                return userSetup(config);
-            return;
-        }
-        const httpClient = new http_client_js_1.HttpClient(opts.serverUrl, logger);
-        try {
-            const auth = await httpClient.resolveAuth(opts);
-            const runLabel = opts.runLabel || (0, ci_js_1.detectCiRunLabel)();
-            // Detect shard info from Playwright config (--shard=1/3)
-            const pwShard = config.shard;
-            const shardIndex = pwShard?.current;
-            const shardTotal = pwShard?.total;
-            const response = await httpClient.postJSON('/api/test-runs/setup', {
-                projectName: opts.projectName,
-                projectDescription: opts.projectDescription,
-                environment: opts.environment || null,
-                label: opts.label || null,
-                startTime: new Date().toISOString(),
-                instanceId: (0, instance_id_js_1.computeInstanceId)(opts.projectName, runLabel),
-                shardIndex,
-                shardTotal,
-            }, auth);
-            if (response?.runId && response?.setupToken) {
-                fs.writeFileSync((0, setup_file_js_1.getSetupFilePath)(opts.projectName), JSON.stringify({
-                    runId: response.runId,
-                    setupToken: response.setupToken,
-                    projectName: opts.projectName,
-                }));
-                logger.debug(`Global setup: initialising run #${response.runId}`);
-            }
-        }
-        catch (error) {
-            logger.warn(`Could not register global setup: ${(0, errors_js_1.errorMessage)(error)}`);
-        }
-        if (userSetup)
-            return userSetup(config);
-    };
-}

package/dist/public/options.d.ts

@@ -1,86 +0,0 @@
-import type { PlaywrightTestConfig } from '@playwright/test';
-export type { PlaywrightTestConfig } from '@playwright/test';
-/**
- * Playwright shard info — mirrors `config.shard` shape.
- *
- * Internal shape: it is NOT re-exported from the package entry point, but it
- * lives here next to the configuration types because it describes the same
- * `config.shard` surface the options come from. May move to `types/wire.ts`.
- */
-export interface ShardInfo {
-    current: number;
-    total: number;
-}
-/** Options for configuring the Piwi Dashboard reporter */
-export interface PiwiDashboardOptions extends PlaywrightTestConfig {
-    /** Explicitly enable or disable the reporter. Defaults to `true` when `serverUrl` is set. Set to `false` to disable even if `serverUrl` is provided. */
-    enabled?: boolean;
-    /** URL of the Piwi Dashboard server */
-    serverUrl?: string;
-    /** Name of the project to report results under. Defaults to `'default-project'`. */
-    projectName?: string;
-    /** Optional description of the project */
-    projectDescription?: string;
-    /** Upload trace files to the dashboard. Defaults to `true`. */
-    uploadTraces?: boolean;
-    /** Upload the Playwright HTML report. Defaults to `true`. */
-    uploadReport?: boolean;
-    /** Upload each test's trace and attachments as soon as the test finishes (streaming mode only). Defaults to `true`. */
-    liveFileUploads?: boolean;
-    /** Auto-collect git commit, branch, author. Defaults to `true`. */
-    collectScmInfo?: boolean;
-    /** Auto-collect CI environment info. Defaults to `true`. */
-    collectCiInfo?: boolean;
-    /** Collect step timings, network requests and web vitals. Defaults to `true`. */
-    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
-     * when `collectPerformanceMetrics` is `false` (the reporter discards the data
-     * in that case anyway). Can also be forced off with `PIWI_CAPTURE_LOCATORS=false`.
-     */
-    captureLocators?: boolean;
-    /**
-     * Capture the page's state at test end (URL, history state, localStorage/
-     * sessionStorage key names + value lengths, cookie names + flags). Values of
-     * storage entries and cookies are never captured. Defaults to `true`;
-     * automatically disabled when `collectPerformanceMetrics` is `false`. Can
-     * also be forced off with `PIWI_CAPTURE_PAGE_STATE=false`.
-     */
-    capturePageState?: boolean;
-    /** Enable live streaming of results (falls back to batch if unsupported). Defaults to `true`. */
-    streaming?: boolean;
-    /** Number of test results to batch before sending during streaming. Defaults to `5`. */
-    streamingBatchSize?: number;
-    /** Max delay (ms) before flushing pending events during streaming. Defaults to `2000`. */
-    streamingBatchDelay?: number;
-    /** Username for dashboard login (use `apiKey` instead when possible) */
-    username?: string | null;
-    /** Password for dashboard login (used with `username`) */
-    password?: string | null;
-    /** API key for authentication (preferred over `username`/`password` for CI) */
-    apiKey?: string | null;
-    /** Additional report types to upload. Each entry can specify `type`, optional `dir`, and optional `label`. */
-    reports?: Array<{
-        type: string;
-        dir?: string;
-        label?: string;
-    }>;
-    /** Stable label that ties shards together (e.g. CI run ID). Auto-detected from CI env; override if needed. */
-    runLabel?: string;
-    /** Deployment environment for this run, e.g. `"production"`, `"staging"`, `"integration"` */
-    environment?: string;
-    /** Optional display label for the test run (e.g. "v2.3.1 release") */
-    label?: string;
-    /** Related issue reference, e.g. `"JIRA-123"` */
-    relatedIssue?: string;
-    /** CI job information */
-    ciInfo?: string;
-    /** Tags to categorize the test run */
-    tags?: string[];
-    /** Additional custom metadata as key-value pairs */
-    customData?: Record<string, unknown>;
-    /** Enable verbose logging for debugging. Defaults to `false`. */
-    verbose?: boolean;
-}

package/dist/public/options.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/public/reporter.d.ts

@@ -1,68 +0,0 @@
-import type { FullConfig, Suite, TestCase, TestResult, FullResult } from '@playwright/test/reporter';
-import { createGlobalSetup } from './global-setup.js';
-import { wrapConfig } from './config-wrapper.js';
-/**
- * Piwi Dashboard Playwright reporter.
- *
- * Collects test results, metadata, performance metrics and trace files, then
- * hands the collected run to a `RunSubmitter` which drives the JSON / multipart
- * / streaming submit ladder. The reporter itself only owns the Playwright hooks
- * and the running counters.
- */
-export declare class PiwiDashboardReporter {
-    private options;
-    private testCases;
-    private startTime;
-    private playwrightVersion;
-    private readonly reporterVersion;
-    private totalTests;
-    private passedTests;
-    private failedTests;
-    private skippedTests;
-    private timedOutTests;
-    private didNotRunTests;
-    /** Full set of tests Playwright planned to run this shard (captured in `onBegin`). */
-    private plannedTests;
-    /** Ids of tests that actually reported via `onTestEnd`, to find the ones that never ran. */
-    private reportedTestIds;
-    private instanceId;
-    private runLabel;
-    private shardInfo;
-    private metadata;
-    private enabled;
-    private isFullRun;
-    private filterDetails;
-    private httpClient;
-    private uploader;
-    private fileHandler;
-    private metadataCollector;
-    private streamManager;
-    private recovery;
-    private submitter;
-    private readonly logger;
-    static wrapConfig: typeof wrapConfig;
-    static createGlobalSetup: typeof createGlobalSetup;
-    constructor(rawOptions?: Record<string, any>);
-    /** 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 */
-    onTestBegin(test: TestCase, result: TestResult): void;
-    /** Track suite-level setup steps (beforeAll/afterAll) not tied to any test */
-    private setupSteps;
-    /** 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 */
-    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;
-    /**
-     * Synthesize `didnotrun` cases for tests Playwright planned but never reported
-     * (no `onTestEnd`) — typically because `maxFailures` cut the run short. These
-     * carry no result, so they're emitted with zero duration and no error. In
-     * streaming mode they're queued as complete events so the pre-finish drain
-     * sends them alongside the rest.
-     */
-    private materializeUnrunTests;
-    /** Playwright reporter hook: called when the full test run finishes */
-    onEnd(result: FullResult): Promise<void>;
-}