@piwitests/reporter 0.12.0 → 0.14.0

package/dist/internal/files/file-handler.js

@@ -1,207 +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.FileHandler = void 0;
-const fs = __importStar(require("node:fs"));
-const errors_js_1 = require("../support/errors.js");
-const path = __importStar(require("node:path"));
-const crypto = __importStar(require("node:crypto"));
-const compression_js_1 = require("./compression.js");
-const logger_js_1 = require("../support/logger.js");
-const attachments_js_1 = require("../capture/attachments.js");
-/**
- * File-system helpers for discovering report directories, trace files, and
- * test attachments, as well as compressing report directories and computing
- * trace-file hashes for deduplication.
- */
-class FileHandler {
-    constructor(logger = new logger_js_1.Logger()) {
-        this.logger = logger;
-    }
-    /** Locate a Playwright HTML report directory containing `index.html`. Optionally override the search path. */
-    findHTMLReportDirectory(customDir) {
-        const possibleDirs = customDir
-            ? [customDir, path.join(process.cwd(), customDir)]
-            : ['playwright-report', './playwright-report', path.join(process.cwd(), 'playwright-report')];
-        for (const reportDir of possibleDirs) {
-            if (fs.existsSync(reportDir) && fs.statSync(reportDir).isDirectory()) {
-                if (fs.existsSync(path.join(reportDir, 'index.html')))
-                    return reportDir;
-            }
-        }
-        return null;
-    }
-    /** Check if `dir` exists and is a directory; also checks `path.join(process.cwd(), dir)` */
-    findReportDirectory(dir) {
-        const candidates = [dir, path.join(process.cwd(), dir)];
-        for (const candidate of candidates) {
-            if (fs.existsSync(candidate) && fs.statSync(candidate).isDirectory())
-                return candidate;
-        }
-        return null;
-    }
-    /** Gzip-compress an entire report directory into a single buffer. Returns `null` on failure. */
-    async compressReportDirectory(reportDir) {
-        try {
-            return (await (0, compression_js_1.compressDirectory)(reportDir)) || null;
-        }
-        catch (error) {
-            this.logger.warn(`Failed to compress report directory ${reportDir}: ${(0, errors_js_1.errorMessage)(error)}`);
-            return null;
-        }
-    }
-    /** Return resolved paths for all trace attachments on a test case */
-    findTraceFiles(testCase) {
-        const set = new Set();
-        if (testCase.attachments) {
-            for (const a of testCase.attachments) {
-                if (a.name === 'trace' && a.path)
-                    set.add(path.resolve(a.path));
-            }
-        }
-        return Array.from(set);
-    }
-    /** Return all non-trace, non-internal attachments from a test case. Skips `trace` and `piwi-*` attachments. */
-    findAllAttachments(testCase) {
-        const result = [];
-        if (testCase.attachments) {
-            for (const a of testCase.attachments) {
-                if (a.name === 'trace')
-                    continue;
-                if (a.name && attachments_js_1.INTERNAL_ATTACHMENT_NAMES.has(a.name))
-                    continue;
-                if (a.path && fs.existsSync(a.path)) {
-                    result.push({
-                        name: a.name || 'attachment',
-                        path: path.resolve(a.path),
-                        contentType: a.contentType || 'application/octet-stream',
-                        originalName: path.basename(a.path),
-                    });
-                }
-            }
-        }
-        return result;
-    }
-    /** Mapping of well-known report type names to their default output directories */
-    getDefaultReportDirs() {
-        return {
-            html: 'playwright-report',
-            monocart: 'monocart-report',
-            allure: 'allure-report',
-            blob: 'blob-report',
-        };
-    }
-    /** Parse Piwi-internal attachment bodies (`piwi-network`, `piwi-web-vitals`, `piwi-console`, `piwi-aria-snapshot`) into structured fields on the test case */
-    parsePerformanceAttachments(testCase, attachments) {
-        const find = (name) => attachments.find((a) => a.name === name);
-        const net = find(attachments_js_1.ATTACHMENT_NAMES.network);
-        if (net?.body) {
-            try {
-                testCase.networkRequests = JSON.parse(net.body.toString());
-            }
-            catch {
-                /* ignore */
-            }
-        }
-        const vitals = find(attachments_js_1.ATTACHMENT_NAMES.webVitals);
-        if (vitals?.body) {
-            try {
-                testCase.webVitals = JSON.parse(vitals.body.toString());
-            }
-            catch {
-                /* ignore */
-            }
-        }
-        const consoleLog = find(attachments_js_1.ATTACHMENT_NAMES.console);
-        if (consoleLog?.body) {
-            try {
-                testCase.consoleLogs = JSON.parse(consoleLog.body.toString());
-            }
-            catch {
-                /* ignore */
-            }
-        }
-        const aria = find(attachments_js_1.ATTACHMENT_NAMES.ariaSnapshot);
-        if (aria?.body)
-            testCase.ariaSnapshot = aria.body.toString();
-        const pageState = find(attachments_js_1.ATTACHMENT_NAMES.pageState);
-        if (pageState?.body) {
-            try {
-                testCase.pageState = JSON.parse(pageState.body.toString());
-            }
-            catch {
-                /* ignore */
-            }
-        }
-    }
-    /** Compute SHA-256 hash and size for a single test case's trace file. Returns `null` when the case has no trace on disk. */
-    async computeSingleTraceHash(testCase) {
-        const tracePaths = this.findTraceFiles(testCase);
-        let lastPath = null;
-        for (const tp of tracePaths) {
-            if (fs.existsSync(tp))
-                lastPath = tp;
-        }
-        if (!lastPath)
-            return null;
-        const hash = crypto.createHash('sha256');
-        await new Promise((resolve, reject) => {
-            fs.createReadStream(lastPath)
-                .on('data', (chunk) => hash.update(chunk))
-                .on('end', resolve)
-                .on('error', reject);
-        });
-        return {
-            tracePath: lastPath,
-            hash: hash.digest('hex'),
-            size: fs.statSync(lastPath).size,
-        };
-    }
-    /** Ask the server which trace hashes it already has, returning the set of hashes that are missing */
-    async checkMissingTraces(httpClient, projectName, traceHashMap, auth) {
-        if (traceHashMap.size === 0)
-            return new Set();
-        const hashes = [...traceHashMap.values()].map((h) => h.hash);
-        try {
-            const response = await httpClient.postJSON('/api/traces/check', { projectName, hashes }, auth);
-            const missing = Array.isArray(response.missing) ? response.missing : hashes;
-            return new Set(missing);
-        }
-        catch {
-            return new Set(hashes);
-        }
-    }
-}
-exports.FileHandler = FileHandler;

package/dist/internal/streaming/crash-recovery.d.ts

@@ -1,23 +0,0 @@
-import type { HttpClient } from '../transport/http-client.js';
-import { Logger } from '../support/logger.js';
-/**
- * Persists a test-run payload to disk when all upload strategies fail, so the
- * data can be retried on the next run.
- */
-export declare class CrashRecovery {
-    private readonly logger;
-    private readonly filePath;
-    /**
-     * @param projectName Used to derive the temp-file name so recovery data is project-scoped.
-     * @param logger      Prefixed logger.
-     */
-    constructor(projectName: string, logger?: Logger);
-    /** Serialise the payload to a temp file for later retry */
-    save(data: Record<string, unknown>): void;
-    /** Read the saved payload from disk, or return `null` if none exists */
-    load(): Record<string, unknown> | null;
-    /** Delete the recovery file from disk */
-    clear(): void;
-    /** Attempt to submit a previously saved payload. Clears the recovery file on success. */
-    tryUpload(httpClient: HttpClient, auth?: string | null): Promise<void>;
-}

package/dist/internal/streaming/crash-recovery.js

@@ -1,106 +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.CrashRecovery = void 0;
-const path = __importStar(require("node:path"));
-const errors_js_1 = require("../support/errors.js");
-const os = __importStar(require("node:os"));
-const fs = __importStar(require("node:fs"));
-const instance_id_js_1 = require("../support/instance-id.js");
-const logger_js_1 = require("../support/logger.js");
-/**
- * Persists a test-run payload to disk when all upload strategies fail, so the
- * data can be retried on the next run.
- */
-class CrashRecovery {
-    /**
-     * @param projectName Used to derive the temp-file name so recovery data is project-scoped.
-     * @param logger      Prefixed logger.
-     */
-    constructor(projectName, logger = new logger_js_1.Logger()) {
-        this.logger = logger;
-        this.filePath = path.join(os.tmpdir(), `piwi-dashboard-recovery-${(0, instance_id_js_1.hashForProject)(projectName)}.json`);
-    }
-    /** Serialise the payload to a temp file for later retry */
-    save(data) {
-        try {
-            fs.writeFileSync(this.filePath, JSON.stringify(data), 'utf8');
-            this.logger.info('Saved recovery data for later upload');
-        }
-        catch (error) {
-            this.logger.error(`Failed to save recovery data: ${(0, errors_js_1.errorMessage)(error)}`);
-        }
-    }
-    /** Read the saved payload from disk, or return `null` if none exists */
-    load() {
-        try {
-            if (fs.existsSync(this.filePath))
-                return JSON.parse(fs.readFileSync(this.filePath, 'utf8'));
-        }
-        catch {
-            // Non-fatal
-        }
-        return null;
-    }
-    /** Delete the recovery file from disk */
-    clear() {
-        try {
-            if (fs.existsSync(this.filePath))
-                fs.unlinkSync(this.filePath);
-        }
-        catch {
-            // Non-fatal
-        }
-    }
-    /** Attempt to submit a previously saved payload. Clears the recovery file on success. */
-    async tryUpload(httpClient, auth) {
-        const data = this.load();
-        if (!data)
-            return;
-        this.logger.info('Found saved test data from a previous run, uploading...');
-        // Strip instanceId so /submit doesn't cancel the current run (which shares
-        // the same instanceId for the same project + hostname combination).
-        delete data.instanceId;
-        try {
-            await httpClient.postJSON('/api/test-runs/submit', data, auth);
-            this.logger.info('Successfully uploaded saved test data');
-            this.clear();
-        }
-        catch (error) {
-            this.logger.warn(`Could not upload saved test data: ${(0, errors_js_1.errorMessage)(error)}`);
-        }
-    }
-}
-exports.CrashRecovery = CrashRecovery;

package/dist/internal/streaming/stream-buffer.d.ts

@@ -1,17 +0,0 @@
-import type { StreamEvent } from '../../types.js';
-/**
- * Persistent JSONL buffer on disk.  Events are appended to a temp file so they
- * survive a crash and can be replayed when the reporter restarts.
- */
-export declare class StreamBuffer {
-    private readonly filePath;
-    constructor(projectName: string);
-    /** Append one or more events to the on-disk buffer */
-    append(events: StreamEvent[]): void;
-    /** Load all buffered events from disk, clearing the file */
-    load(): StreamEvent[];
-    /** Delete the buffer file from disk */
-    clear(): void;
-    /** Remove the buffer file if it is older than `maxAgeMs` (default 2 hours). Used on startup to discard orphaned data. */
-    clearStale(maxAgeMs?: number): void;
-}

package/dist/internal/streaming/stream-buffer.js

@@ -1,102 +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.StreamBuffer = void 0;
-const path = __importStar(require("node:path"));
-const os = __importStar(require("node:os"));
-const fs = __importStar(require("node:fs"));
-const instance_id_js_1 = require("../support/instance-id.js");
-/**
- * Persistent JSONL buffer on disk.  Events are appended to a temp file so they
- * survive a crash and can be replayed when the reporter restarts.
- */
-class StreamBuffer {
-    constructor(projectName) {
-        this.filePath = path.join(os.tmpdir(), `piwi-dashboard-stream-${(0, instance_id_js_1.hashForProject)(projectName)}.jsonl`);
-    }
-    /** Append one or more events to the on-disk buffer */
-    append(events) {
-        if (events.length === 0)
-            return;
-        try {
-            const lines = events.map((e) => JSON.stringify(e) + '\n').join('');
-            fs.appendFileSync(this.filePath, lines, 'utf8');
-        }
-        catch {
-            // Non-fatal
-        }
-    }
-    /** Load all buffered events from disk, clearing the file */
-    load() {
-        try {
-            if (fs.existsSync(this.filePath)) {
-                const content = fs.readFileSync(this.filePath, 'utf8');
-                return content
-                    .split('\n')
-                    .filter(Boolean)
-                    .map((line) => JSON.parse(line));
-            }
-        }
-        catch {
-            // Non-fatal
-        }
-        return [];
-    }
-    /** Delete the buffer file from disk */
-    clear() {
-        try {
-            if (fs.existsSync(this.filePath))
-                fs.unlinkSync(this.filePath);
-        }
-        catch {
-            // Non-fatal
-        }
-    }
-    /** Remove the buffer file if it is older than `maxAgeMs` (default 2 hours). Used on startup to discard orphaned data. */
-    clearStale(maxAgeMs = 7200000) {
-        try {
-            if (fs.existsSync(this.filePath)) {
-                const stats = fs.statSync(this.filePath);
-                if (Date.now() - stats.mtimeMs > maxAgeMs) {
-                    fs.unlinkSync(this.filePath);
-                }
-            }
-        }
-        catch {
-            // Non-fatal
-        }
-    }
-}
-exports.StreamBuffer = StreamBuffer;

package/dist/internal/streaming/stream-manager.d.ts

@@ -1,88 +0,0 @@
-import type { PiwiDashboardOptions, ShardInfo } from '../../public/options.js';
-import type { HttpClient } from '../transport/http-client.js';
-import type { StreamBuffer } from './stream-buffer.js';
-import type { CrashRecovery } from './crash-recovery.js';
-import type { Uploader } from '../submit/uploader.js';
-import type { FileHandler } from '../files/file-handler.js';
-import { Logger } from '../support/logger.js';
-import type { CollectedTestCase, StreamEvent, FilterDetails } from '../../types.js';
-/**
- * Manages the streaming protocol: queues events (begin / complete), flushes
- * them in batches, schedules retries on failure, and handles per-test-case
- * live file uploads.
- */
-export declare class StreamManager {
-    private readonly httpClient;
-    private readonly streamBuffer;
-    private readonly recovery;
-    private readonly uploader;
-    private readonly fileHandler;
-    private readonly options;
-    private readonly logger;
-    private pendingEvents;
-    private pendingBeginEvents;
-    private flushTimer;
-    private flushPromises;
-    private liveUploadPromises;
-    private readonly limitLiveUpload;
-    private retryCount;
-    private retryTimer;
-    private readonly maxRetryDelay;
-    /**
-     * Idle heartbeat: while the run is open but no events are flowing (e.g. a single
-     * long test, or `beforeAll` setup), a periodic ping keeps the server's activity
-     * timestamp fresh so the stale-run reaper can tell a live run from a crashed one.
-     * The interval must stay well below the server's stale timeout.
-     */
-    private heartbeatTimer;
-    private heartbeatStopped;
-    private lastActivityAt;
-    private readonly heartbeatInterval;
-    /** Tracks cases whose files have already been uploaded live, so `uploadRemaining` can skip them. */
-    private readonly uploadedCaseFiles;
-    private _enabled;
-    private _runId;
-    private _token;
-    private _auth;
-    private _startPromise;
-    /** Whether the streaming session is active */
-    get enabled(): boolean;
-    /** Server-assigned run ID (`null` until the stream opens) */
-    get runId(): number | null;
-    /** Stream authentication token (`null` until the stream opens) */
-    get token(): string | null;
-    /** Resolved auth string (API key or session cookie) used in stream requests */
-    get auth(): string | null;
-    /** Promise that resolves when the stream has been fully initialised */
-    get startPromise(): Promise<void> | null;
-    /**
-     * @param httpClient  HTTP client for server communication.
-     * @param streamBuffer On-disk buffer for crash-safe event persistence.
-     * @param recovery    Crash-recovery handler for uploading stale payloads on startup.
-     * @param uploader    Uploader for per-test-case file uploads.
-     * @param fileHandler File-discovery helper for finding traces and attachments.
-     * @param options     Piwi Dashboard reporter options.
-     * @param logger      Prefixed logger.
-     */
-    constructor(httpClient: HttpClient, streamBuffer: StreamBuffer, recovery: CrashRecovery, uploader: Uploader, fileHandler: FileHandler, options: PiwiDashboardOptions, logger?: Logger);
-    /** Begin the streaming session after `onBegin` fires. Non-blocking — the actual handshake runs asynchronously. */
-    start(startTime: string, metadata: Record<string, any>, instanceId: string, playwrightVersion?: string | null, reporterVersion?: string | null, shardInfo?: ShardInfo | null, isFullRun?: boolean, filterDetails?: FilterDetails | null): void;
-    private _doStart;
-    /** Queue a test-case `begin` event. Held in a pre-start buffer if the stream is not yet open, then prepended so it arrives before the matching `complete` event. */
-    queueBeginEvent(event: StreamEvent): void;
-    /** Queue a test-case event. Triggers an immediate flush when the batch size is reached, otherwise schedules a timer-based flush. */
-    queueEvent(event: StreamEvent): void;
-    /** Flush all pending events to the server. Returns a promise that resolves to `true` on success or `false` on failure (events are re-queued for retry). */
-    flush(): Promise<boolean> | null;
-    private scheduleRetry;
-    private scheduleHeartbeat;
-    private sendHeartbeat;
-    /** Stop the idle heartbeat permanently (called when the run is wrapping up). */
-    private stopHeartbeat;
-    /** Drain all pending and buffered events before the run finishes. Retries up to 10 times with exponential back-off. */
-    drain(): Promise<void>;
-    /** Schedule a live upload of trace and attachment files for a test case. Skips cases with no files. Concurrency is limited to 2 simultaneous uploads. */
-    scheduleLiveUpload(tc: CollectedTestCase): void;
-    /** Wait for all live uploads to settle, then upload files for any test cases that weren't uploaded live */
-    uploadRemaining(testCases: CollectedTestCase[]): Promise<void>;
-}