@piwitests/reporter 0.5.0 → 0.6.0

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>;

package/dist/public/global-setup.js

@@ -0,0 +1,146 @@
+"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/{config.d.ts → public/options.d.ts}

@@ -1,6 +1,12 @@
 import type { PlaywrightTestConfig } from '@playwright/test';
 export type { PlaywrightTestConfig } from '@playwright/test';
-/** Playwright shard info — mirrors `config.shard` shape */
+/**
+ * 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;
@@ -70,47 +76,3 @@ export interface PiwiDashboardOptions extends PlaywrightTestConfig {
     /** Enable verbose logging for debugging. Defaults to `false`. */
     verbose?: boolean;
 }
-/**
- * Single source of truth for the `PIWI_*` env-var → option mapping. Both
- * `resolveOptions` (env → option) and `applyOptionsToEnv` (option → env, used
- * by `wrapConfig` to bridge into the global-setup process) read these names so
- * the mapping lives in exactly one place.
- */
-export declare const PIWI_ENV_KEYS: {
-    readonly serverUrl: "PIWI_DASHBOARD_URL";
-    readonly projectName: "PIWI_PROJECT_NAME";
-    readonly verbose: "PIWI_VERBOSE";
-    readonly apiKey: "PIWI_API_KEY";
-    readonly username: "PIWI_USERNAME";
-    readonly password: "PIWI_PASSWORD";
-    readonly environment: "PIWI_ENVIRONMENT";
-    readonly label: "PIWI_LABEL";
-    readonly runLabel: "PIWI_RUN_LABEL";
-    readonly streaming: "PIWI_STREAMING";
-    readonly streamingBatchSize: "PIWI_STREAMING_BATCH_SIZE";
-    readonly streamingBatchDelay: "PIWI_STREAMING_BATCH_DELAY";
-    readonly liveFileUploads: "PIWI_LIVE_FILE_UPLOADS";
-    readonly uploadTraces: "PIWI_UPLOAD_TRACES";
-    readonly uploadReport: "PIWI_UPLOAD_REPORT";
-    readonly captureLocators: "PIWI_CAPTURE_LOCATORS";
-};
-/**
- * Merge raw user options with defaults, reading from `PIWI_*` env vars when
- * options are not provided.
- *
- * Env semantics: env vars fill in values the caller didn't provide (fallback).
- * They're applied to `raw` *before* the `DEFAULTS` merge so a built-in default
- * never masks an env var (the pre-Phase-4 `PIWI_PROJECT_NAME` was masked by the
- * `default-project` default — that quirk is now fixed).
- *
- * One preserved quirk: `PIWI_VERBOSE` wins over both the default *and* an
- * explicit user option, matching the pre-Phase-4 behavior.
- */
-export declare function resolveOptions(raw: Record<string, any>): PiwiDashboardOptions;
-/**
- * Write the options that the isolated `global-setup-module` process needs into
- * `PIWI_*` env vars. `wrapConfig` calls this so the global setup (which runs
- * `resolveOptions({})` in a separate module) picks up the same server/auth
- * config the reporter instance uses. Only writes values that are actually set.
- */
-export declare function applyOptionsToEnv(options: PiwiDashboardOptions): void;

package/dist/public/options.js

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

package/dist/{reporter.d.ts → public/reporter.d.ts}

@@ -1,5 +1,5 @@
 import type { FullConfig, Suite, TestCase, TestResult, FullResult } from '@playwright/test/reporter';
-import { createGlobalSetup } from './helpers.js';
+import { createGlobalSetup } from './global-setup.js';
 import { wrapConfig } from './config-wrapper.js';
 /**
  * Piwi Dashboard Playwright reporter.