@piwitests/reporter 0.4.4 → 0.6.0

package/dist/internal/support/cli-filters.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.detectCliFileFilters = detectCliFileFilters;
+/**
+ * Extract positional file/path filters from a Playwright CLI invocation
+ * (e.g. `playwright test tests/login.spec.ts auth/`). These narrow a run to
+ * specific files and are NOT reflected in `config.grep`, so they're the only
+ * signal that a file-filtered run is partial. Returns an empty array when the
+ * full suite was requested.
+ *
+ * Best-effort: skips the values of known value-taking options so they aren't
+ * mistaken for file filters. `--flag=value` forms consume no extra token.
+ */
+const PW_VALUE_FLAGS = new Set([
+    '-c',
+    '--config',
+    '-j',
+    '--workers',
+    '-g',
+    '--grep',
+    '--grep-invert',
+    '--global-timeout',
+    '--max-failures',
+    '--output',
+    '-p',
+    '--project',
+    '--repeat-each',
+    '--reporter',
+    '--retries',
+    '--shard',
+    '--timeout',
+    '--trace',
+]);
+function detectCliFileFilters(argv = process.argv) {
+    // Drop the node executable + script path, then start after the `test` subcommand.
+    const args = argv.slice(2);
+    const testIdx = args.indexOf('test');
+    const rest = testIdx >= 0 ? args.slice(testIdx + 1) : args;
+    const files = [];
+    for (let i = 0; i < rest.length; i++) {
+        const tok = rest[i];
+        if (tok.startsWith('-')) {
+            // A bare value-taking flag (no `=`) consumes the next token as its value.
+            if (!tok.includes('=') && PW_VALUE_FLAGS.has(tok))
+                i++;
+            continue;
+        }
+        files.push(tok);
+    }
+    return files;
+}

package/dist/internal/support/errors.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Extract a human-readable message from an unknown thrown value.
+ *
+ * `catch` bindings are typed `unknown` (TypeScript strict mode), so reach for
+ * this instead of `(error as any).message` — it returns `error.message` for any
+ * `Error` (including `HttpError`) and a stringified form otherwise.
+ */
+export declare function errorMessage(error: unknown): string;

package/dist/internal/support/errors.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.errorMessage = errorMessage;
+/**
+ * Extract a human-readable message from an unknown thrown value.
+ *
+ * `catch` bindings are typed `unknown` (TypeScript strict mode), so reach for
+ * this instead of `(error as any).message` — it returns `error.message` for any
+ * `Error` (including `HttpError`) and a stringified form otherwise.
+ */
+function errorMessage(error) {
+    if (error instanceof Error)
+        return error.message;
+    return String(error);
+}

package/dist/internal/support/instance-id.d.ts

@@ -0,0 +1,4 @@
+/** Produce a deterministic short SHA-1 hex hash for a project name (used in temp file names) */
+export declare function hashForProject(projectName: string): string;
+/** Derive a unique instance identifier by hashing hostname + projectName (or runLabel + projectName when sharding) */
+export declare function computeInstanceId(projectName: string, runLabel?: string | null): string;

package/dist/internal/support/instance-id.js

@@ -0,0 +1,48 @@
+"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.hashForProject = hashForProject;
+exports.computeInstanceId = computeInstanceId;
+const crypto = __importStar(require("node:crypto"));
+const os = __importStar(require("node:os"));
+/** Produce a deterministic short SHA-1 hex hash for a project name (used in temp file names) */
+function hashForProject(projectName) {
+    return crypto.createHash('sha1').update(projectName).digest('hex').slice(0, 16);
+}
+/** Derive a unique instance identifier by hashing hostname + projectName (or runLabel + projectName when sharding) */
+function computeInstanceId(projectName, runLabel) {
+    const seed = runLabel ? `${projectName}|${runLabel}` : `${os.hostname()}|${projectName}`;
+    return crypto.createHash('sha256').update(seed).digest('hex').slice(0, 16);
+}

package/dist/internal/support/limiter.d.ts

@@ -0,0 +1,2 @@
+/** Create a concurrency limiter that ensures at most `maxConcurrent` async operations run simultaneously */
+export declare function createLimiter(maxConcurrent: number): <T>(fn: () => Promise<T>) => Promise<T>;

package/dist/internal/support/limiter.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createLimiter = createLimiter;
+/** Create a concurrency limiter that ensures at most `maxConcurrent` async operations run simultaneously */
+function createLimiter(maxConcurrent) {
+    const limitValue = Math.max(1, Math.floor(maxConcurrent));
+    let active = 0;
+    const queue = [];
+    const next = () => {
+        active--;
+        const run = queue.shift();
+        if (run)
+            run();
+    };
+    return function limit(fn) {
+        return new Promise((resolve, reject) => {
+            const run = () => {
+                active++;
+                Promise.resolve().then(fn).then(resolve, reject).finally(next);
+            };
+            if (active < limitValue)
+                run();
+            else
+                queue.push(run);
+        });
+    };
+}

package/dist/internal/support/setup-file.d.ts

@@ -0,0 +1,13 @@
+/** Return the temp-file path used to exchange setup info between globalSetup and the reporter instance */
+export declare function getSetupFilePath(projectName: string): string;
+/** Information saved by the global setup for the reporter instance to consume */
+export interface SetupInfo {
+    /** Server-assigned run ID */
+    runId: number;
+    /** One-time token used to authenticate the /begin call */
+    setupToken: string;
+    /** Project name this run belongs to */
+    projectName: string;
+}
+/** Read and delete the setup info file for the given project. Returns `null` when no file exists. */
+export declare function readSetupInfo(projectName: string): SetupInfo | null;

package/dist/internal/support/setup-file.js

@@ -0,0 +1,61 @@
+"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.getSetupFilePath = getSetupFilePath;
+exports.readSetupInfo = readSetupInfo;
+const path = __importStar(require("node:path"));
+const os = __importStar(require("node:os"));
+const fs = __importStar(require("node:fs"));
+const instance_id_js_1 = require("./instance-id.js");
+/** Return the temp-file path used to exchange setup info between globalSetup and the reporter instance */
+function getSetupFilePath(projectName) {
+    return path.join(os.tmpdir(), `piwi-dashboard-setup-${(0, instance_id_js_1.hashForProject)(projectName)}.json`);
+}
+/** Read and delete the setup info file for the given project. Returns `null` when no file exists. */
+function readSetupInfo(projectName) {
+    const setupFile = getSetupFilePath(projectName);
+    try {
+        if (fs.existsSync(setupFile)) {
+            const info = JSON.parse(fs.readFileSync(setupFile, 'utf8'));
+            fs.unlinkSync(setupFile);
+            if (info.projectName === projectName)
+                return info;
+        }
+    }
+    catch {
+        /* ignore */
+    }
+    return null;
+}

package/dist/internal/support/source-snippet.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Read a snippet of source code surrounding the declaration line, optionally
+ * highlighting a separate failing line. Returns a formatted string with line
+ * numbers and markers (`>` for the failing line, `*` for the declaration), or
+ * `null` on error.
+ */
+export declare function readSourceSnippet(file: string, declLine: number, context: number, failingLine?: number): string | null;
+/**
+ * Extract the line number of the first stack frame inside `testFile` from an
+ * error's stack trace. Falls back to `declarationLine`.
+ */
+export declare function extractFailingLine(errorText: string | null | undefined, testFile: string, declarationLine: number): number;

package/dist/internal/support/source-snippet.js

@@ -0,0 +1,97 @@
+"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.readSourceSnippet = readSourceSnippet;
+exports.extractFailingLine = extractFailingLine;
+const fs = __importStar(require("node:fs"));
+const path = __importStar(require("node:path"));
+/**
+ * Read a snippet of source code surrounding the declaration line, optionally
+ * highlighting a separate failing line. Returns a formatted string with line
+ * numbers and markers (`>` for the failing line, `*` for the declaration), or
+ * `null` on error.
+ */
+function readSourceSnippet(file, declLine, context, failingLine) {
+    try {
+        const content = fs.readFileSync(file, 'utf-8');
+        const lines = content.split('\n');
+        const anchor = failingLine ?? declLine;
+        const start = Math.max(0, anchor - context - 1);
+        const end = Math.min(lines.length, anchor + context);
+        return lines
+            .slice(start, end)
+            .map((l, i) => {
+            const lineNum = start + i + 1;
+            const hasFailingLine = failingLine != null;
+            const isFailing = hasFailingLine && lineNum === failingLine;
+            const isDecl = lineNum === declLine && !isFailing;
+            let marker = '  ';
+            if (isFailing)
+                marker = '> ';
+            else if (isDecl)
+                marker = hasFailingLine ? '* ' : '> ';
+            return `${marker}${String(lineNum).padStart(4)} | ${l}`;
+        })
+            .join('\n');
+    }
+    catch {
+        return null;
+    }
+}
+/**
+ * Extract the line number of the first stack frame inside `testFile` from an
+ * error's stack trace. Falls back to `declarationLine`.
+ */
+function extractFailingLine(errorText, testFile, declarationLine) {
+    if (!errorText)
+        return declarationLine;
+    const expectedFile = path.resolve(testFile);
+    const stackRe = /^\s+at (?:[^(]*\()?(.+?):(\d+):\d+\)?\s*$/gm;
+    let m;
+    while ((m = stackRe.exec(errorText)) !== null) {
+        try {
+            const frameFile = path.resolve(m[1]);
+            if (frameFile === expectedFile) {
+                const line = parseInt(m[2], 10);
+                if (!isNaN(line))
+                    return line;
+            }
+        }
+        catch {
+            /* skip unresolvable paths */
+        }
+    }
+    return declarationLine;
+}

package/dist/internal/support/worker-index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Extract a worker index from a Playwright `TestResult`, falling back to
+ * `parallelIndex` when `workerIndex` is absent. Returns `null` when neither is
+ * set. Localizes the `as any` reach into Playwright's result object so the
+ * cast lives in exactly one place.
+ */
+export declare function workerIndexOf(result: any): number | null;

package/dist/internal/support/worker-index.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.workerIndexOf = workerIndexOf;
+/**
+ * Extract a worker index from a Playwright `TestResult`, falling back to
+ * `parallelIndex` when `workerIndex` is absent. Returns `null` when neither is
+ * set. Localizes the `as any` reach into Playwright's result object so the
+ * cast lives in exactly one place.
+ */
+function workerIndexOf(result) {
+    if (!result)
+        return null;
+    return result.workerIndex ?? result.parallelIndex ?? null;
+}

package/dist/{http-client.d.ts → internal/transport/http-client.d.ts}

@@ -1,6 +1,16 @@
 import FormData from 'form-data';
-import { Logger } from './logger.js';
+import { Logger } from '../support/logger.js';
 export { FormData };
+/**
+ * An HTTP response with a non-2xx status. Carries the numeric `status` so
+ * callers can branch on a specific code (401, 404, 409, 422, …) via
+ * `error instanceof HttpError && error.status === …` instead of sniffing the
+ * message string.
+ */
+export declare class HttpError extends Error {
+    readonly status: number;
+    constructor(status: number, message?: string);
+}
 /**
  * Low-level HTTP client for communicating with the Piwi Dashboard server.
  * Supports JSON requests, multipart form-data uploads, and session-based login.

package/dist/{http-client.js → internal/transport/http-client.js}

@@ -1,15 +1,62 @@
 "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;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HttpClient = exports.FormData = void 0;
-const https_1 = __importDefault(require("https"));
-const http_1 = __importDefault(require("http"));
-const url_1 = require("url");
+exports.HttpClient = exports.HttpError = exports.FormData = void 0;
+const https = __importStar(require("node:https"));
+const http = __importStar(require("node:http"));
+const node_url_1 = require("node:url");
 const form_data_1 = __importDefault(require("form-data"));
 exports.FormData = form_data_1.default;
-const logger_js_1 = require("./logger.js");
+const logger_js_1 = require("../support/logger.js");
+/**
+ * An HTTP response with a non-2xx status. Carries the numeric `status` so
+ * callers can branch on a specific code (401, 404, 409, 422, …) via
+ * `error instanceof HttpError && error.status === …` instead of sniffing the
+ * message string.
+ */
+class HttpError extends Error {
+    constructor(status, message = `Request failed with status ${status}`) {
+        super(message);
+        this.status = status;
+        this.name = 'HttpError';
+    }
+}
+exports.HttpError = HttpError;
 /**
  * Low-level HTTP client for communicating with the Piwi Dashboard server.
  * Supports JSON requests, multipart form-data uploads, and session-based login.
@@ -56,7 +103,7 @@ class HttpClient {
         });
         if (res.status < 200 || res.status >= 300) {
             this.logger.debugError(`Login response: ${res.text}`);
-            throw new Error(`Login failed with status ${res.status}`);
+            throw new HttpError(res.status, `Login failed with status ${res.status}`);
         }
         const setCookie = res.headers['set-cookie'];
         if (!setCookie || setCookie.length === 0) {
@@ -79,7 +126,7 @@ class HttpClient {
         });
         if (res.status < 200 || res.status >= 300) {
             this.logger.debugError(`Response: ${res.text}`);
-            throw new Error(`Request failed with status ${res.status}`);
+            throw new HttpError(res.status);
         }
         try {
             return JSON.parse(res.text);
@@ -93,7 +140,7 @@ class HttpClient {
         const headers = form.getHeaders();
         const res = await this.request('POST', pathname, { headers, form, auth });
         if (res.status < 200 || res.status >= 300) {
-            throw new Error(`Request failed with status ${res.status}: ${res.text}`);
+            throw new HttpError(res.status, `Request failed with status ${res.status}: ${res.text}`);
         }
         try {
             return JSON.parse(res.text);
@@ -105,8 +152,8 @@ class HttpClient {
     /** Unified request core: transport, headers, auth, response accumulation, timeout. */
     request(method, pathname, opts) {
         return new Promise((resolve, reject) => {
-            const url = new url_1.URL(pathname, this.serverUrl);
-            const transport = url.protocol === 'https:' ? https_1.default : http_1.default;
+            const url = new node_url_1.URL(pathname, this.serverUrl);
+            const transport = url.protocol === 'https:' ? https : http;
             const headers = { ...opts.headers };
             this.applyAuth(headers, opts.auth);
             const req = transport.request({

package/dist/{config-wrapper.d.ts → public/config-wrapper.d.ts}

@@ -1,5 +1,5 @@
 import type { PlaywrightTestConfig } from '@playwright/test';
-import { type PiwiDashboardOptions } from './config.js';
+import type { PiwiDashboardOptions } from './options.js';
 /**
  * Wrap a Playwright config to auto-inject the Piwi Dashboard reporter and
  * chain its global setup module. Returns a new config object (shallow merge)

package/dist/{config-wrapper.js → public/config-wrapper.js}

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.wrapConfig = wrapConfig;
-const config_js_1 = require("./config.js");
+const env_js_1 = require("../internal/config/env.js");
 const PIWI_MODULE = '@piwitests/reporter';
 function isPiwiReporterEntry(entry) {
     if (typeof entry === 'string')
@@ -23,10 +23,10 @@ function injectReporter(reporter, piwiOptions) {
 }
 function resolveSetupModule() {
     try {
-        return require.resolve('./global-setup-module.js');
+        return require.resolve('../global-setup-module.js');
     }
     catch {
-        return require.resolve('./global-setup-module.ts');
+        return require.resolve('../global-setup-module.ts');
     }
 }
 /**
@@ -49,7 +49,7 @@ function resolveSetupModule() {
  */
 function wrapConfig(config, piwiOptions) {
     if (piwiOptions)
-        (0, config_js_1.applyOptionsToEnv)(piwiOptions);
+        (0, env_js_1.applyOptionsToEnv)(piwiOptions);
     const globalSetupModules = [];
     if (config.globalSetup) {
         const orig = Array.isArray(config.globalSetup) ? config.globalSetup : [config.globalSetup];

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

@@ -0,0 +1,13 @@
+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>;