@piwitests/reporter 0.11.0 → 0.13.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@piwitests/reporter",
-  "version": "0.11.0",
+  "version": "0.13.0",
   "description": "Playwright reporter for sending test results to Piwi Dashboard",
   "url": "https://github.com/PiwiTests/platform",
   "homepage": "https://piwitests.github.io",
@@ -35,8 +35,9 @@
     "provenance": true
   },
   "scripts": {
-    "reporter:build": "tsc",
-    "reporter:dev": "tsc --watch",
+    "reporter:build": "tsup",
+    "reporter:dev": "tsup --watch",
+    "reporter:typecheck": "tsc --noEmit",
     "reporter:format": "oxfmt --config oxfmt.config.mts --write \"src/\"",
     "reporter:format:check": "oxfmt --config oxfmt.config.mts --check \"src/\"",
     "reporter:lint": "oxlint --config oxlint.config.mts .",
@@ -52,9 +53,13 @@
     "dist/"
   ],
   "peerDependencies": {
-    "@playwright/test": "^1.40.0"
+    "@playwright/test": "^1.61.1"
   },
   "dependencies": {
     "form-data": "^4.0.0"
+  },
+  "devDependencies": {
+    "@piwitests/core": "*",
+    "tsup": "^8.5.0"
   }
 }

package/dist/internal/collect/error-text.d.ts

@@ -1,18 +0,0 @@
-import type { TestResult } from '@playwright/test/reporter';
-/**
- * Build the stored error text for a test result.
- *
- * Playwright's `result.error` carries the primary failure but for a **timeout**
- * it is only the bare `Test timeout of 30000ms exceeded.` — the interrupted
- * action's actual error (with its call log — the single most diagnostic fact)
- * lives in `result.errors[1..]`. Concatenating all errors (deduped by message)
- * ensures the server sees the call log so it can extract the locator, fingerprint
- * correctly, and feed the model the right facts.
- *
- * A synthetic `at file:line:col` frame from `error.location` is appended when
- * no stack frame is present, enabling locator-healing to find the pre-captured
- * snapshot for that call site. The frame sits after the message, where
- * `extractMessageHead` trims it before fingerprinting — so clustering is
- * unaffected.
- */
-export declare function buildErrorText(result: TestResult): string | null;

package/dist/internal/collect/error-text.js

@@ -1,79 +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.buildErrorText = buildErrorText;
-const path = __importStar(require("node:path"));
-/**
- * Build the stored error text for a test result.
- *
- * Playwright's `result.error` carries the primary failure but for a **timeout**
- * it is only the bare `Test timeout of 30000ms exceeded.` — the interrupted
- * action's actual error (with its call log — the single most diagnostic fact)
- * lives in `result.errors[1..]`. Concatenating all errors (deduped by message)
- * ensures the server sees the call log so it can extract the locator, fingerprint
- * correctly, and feed the model the right facts.
- *
- * A synthetic `at file:line:col` frame from `error.location` is appended when
- * no stack frame is present, enabling locator-healing to find the pre-captured
- * snapshot for that call site. The frame sits after the message, where
- * `extractMessageHead` trims it before fingerprinting — so clustering is
- * unaffected.
- */
-function buildErrorText(result) {
-    if (!result.errors || result.errors.length === 0)
-        return null;
-    const seen = new Set();
-    const parts = [];
-    for (const err of result.errors) {
-        const msg = err.message ?? '';
-        if (!msg)
-            continue;
-        const dedupeKey = msg.trim().slice(0, 200);
-        if (seen.has(dedupeKey))
-            continue;
-        seen.add(dedupeKey);
-        parts.push(msg);
-    }
-    let text = parts.join('\n---\n');
-    if (!text)
-        return null;
-    const primary = result.error;
-    const loc = primary?.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;
-}

package/dist/internal/collect/metadata-collector.d.ts

@@ -1,32 +0,0 @@
-import type { FullConfig, Suite, TestCase } from '@playwright/test/reporter';
-import { Logger } from '../support/logger.js';
-import type { SuiteConfigEntry } from '../../types.js';
-/**
- * Collects CI/CD environment metadata, SCM (git) information, and Playwright
- * config metadata to attach to each test run submission.
- *
- * Also owns all reach-through access to Playwright-internal suite fields
- * (`_parallelMode`, `_annotations`, `project()`) so the surface area that
- * breaks when Playwright renames those internals is guarded behind one class.
- */
-export declare class MetadataCollector {
-    private readonly logger;
-    constructor(logger?: Logger);
-    /** Collect all available metadata from the environment, config, and suite */
-    collect(config: FullConfig, suite: Suite, options: any): Record<string, unknown>;
-    /** Walk the test's parent hierarchy to extract the resolved browser/project configuration */
-    getBrowserConfig(test: TestCase): Record<string, any> | null;
-    /**
-     * Walk the test's parent `describe` suites to extract the suite path (titles)
-     * and per-level config (parallel mode + annotations). Reaches into Playwright
-     * suite internals (`_parallelMode`, `_annotations`) — kept here next to
-     * `getBrowserConfig` so all such access is guarded behind one class.
-     */
-    getSuiteInfo(test: TestCase): {
-        suitePath: string[];
-        suiteConfig: SuiteConfigEntry[];
-    };
-    private collectScmInfo;
-    private collectCiInfo;
-    private extractPlaywrightConfigMetadata;
-}

package/dist/internal/collect/metadata-collector.js

@@ -1,246 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MetadataCollector = void 0;
-const node_child_process_1 = require("node:child_process");
-const errors_js_1 = require("../support/errors.js");
-const logger_js_1 = require("../support/logger.js");
-/**
- * Collects CI/CD environment metadata, SCM (git) information, and Playwright
- * config metadata to attach to each test run submission.
- *
- * Also owns all reach-through access to Playwright-internal suite fields
- * (`_parallelMode`, `_annotations`, `project()`) so the surface area that
- * breaks when Playwright renames those internals is guarded behind one class.
- */
-class MetadataCollector {
-    constructor(logger = new logger_js_1.Logger()) {
-        this.logger = logger;
-    }
-    /** Collect all available metadata from the environment, config, and suite */
-    collect(config, suite, options) {
-        const metadata = {};
-        if (options.projectDescription)
-            metadata.projectDescription = options.projectDescription;
-        if (options.relatedIssue)
-            metadata.relatedIssue = options.relatedIssue;
-        if (options.ciInfo)
-            metadata.ciInfo = options.ciInfo;
-        if (options.tags && Array.isArray(options.tags))
-            metadata.tags = options.tags;
-        if (options.customData)
-            metadata.customData = options.customData;
-        if (options.collectScmInfo) {
-            const scm = this.collectScmInfo(options);
-            if (scm)
-                metadata.scm = scm;
-        }
-        if (options.collectCiInfo) {
-            const ci = this.collectCiInfo();
-            if (ci)
-                metadata.ci = ci;
-        }
-        const htmlMeta = this.extractPlaywrightConfigMetadata(config);
-        if (htmlMeta && Object.keys(htmlMeta).length > 0)
-            metadata.htmlReport = htmlMeta;
-        if (config.metadata)
-            metadata.playwrightConfig = config.metadata;
-        if (suite?.allTests) {
-            const all = suite.allTests();
-            if (all.length > 0) {
-                const first = all[0];
-                if (first?.parent) {
-                    const proj = first.parent.project();
-                    if (proj?.metadata)
-                        metadata.playwrightProject = proj.metadata;
-                }
-            }
-        }
-        return metadata;
-    }
-    /** Walk the test's parent hierarchy to extract the resolved browser/project configuration */
-    getBrowserConfig(test) {
-        try {
-            let suite = test.parent;
-            let depth = 0;
-            while (suite && depth < 20) {
-                depth++;
-                const project = suite.project?.();
-                if (project) {
-                    const use = project.use ?? {};
-                    const config = { projectName: project.name };
-                    if (use.browserName)
-                        config.browserName = use.browserName;
-                    if (use.channel)
-                        config.channel = use.channel;
-                    if (use.viewport)
-                        config.viewport = { width: use.viewport.width, height: use.viewport.height };
-                    if (use.deviceScaleFactor != null)
-                        config.deviceScaleFactor = use.deviceScaleFactor;
-                    if (use.isMobile != null)
-                        config.isMobile = use.isMobile;
-                    if (use.hasTouch != null)
-                        config.hasTouch = use.hasTouch;
-                    if (use.locale)
-                        config.locale = use.locale;
-                    if (use.timezoneId)
-                        config.timezoneId = use.timezoneId;
-                    if (use.geolocation) {
-                        config.geolocation = {
-                            longitude: use.geolocation.longitude,
-                            latitude: use.geolocation.latitude,
-                            ...(use.geolocation.accuracy != null && { accuracy: use.geolocation.accuracy }),
-                        };
-                    }
-                    if (use.colorScheme)
-                        config.colorScheme = use.colorScheme;
-                    if (use.reducedMotion)
-                        config.reducedMotion = use.reducedMotion;
-                    if (use.forcedColors)
-                        config.forcedColors = use.forcedColors;
-                    if (use.offline)
-                        config.offline = use.offline;
-                    if (use.bypassCSP)
-                        config.bypassCSP = use.bypassCSP;
-                    if (use.javaScriptEnabled === false)
-                        config.javaScriptEnabled = false;
-                    if (use.serviceWorkers)
-                        config.serviceWorkers = use.serviceWorkers;
-                    if (use.userAgent)
-                        config.userAgent = use.userAgent;
-                    return config;
-                }
-                suite = suite.parent;
-            }
-            return null;
-        }
-        catch {
-            return null;
-        }
-    }
-    /**
-     * Walk the test's parent `describe` suites to extract the suite path (titles)
-     * and per-level config (parallel mode + annotations). Reaches into Playwright
-     * suite internals (`_parallelMode`, `_annotations`) — kept here next to
-     * `getBrowserConfig` so all such access is guarded behind one class.
-     */
-    getSuiteInfo(test) {
-        const suitePath = [];
-        const suiteConfig = [];
-        const suites = [];
-        let suite = test.parent;
-        while (suite && suite.type === 'describe') {
-            suites.unshift(suite);
-            suite = suite.parent;
-        }
-        for (const s of suites) {
-            if (!s.title)
-                continue;
-            suitePath.push(s.title);
-            const rawMode = s._parallelMode;
-            const mode = rawMode === 'parallel' ? 'parallel' : rawMode === 'serial' ? 'serial' : 'default';
-            const annotations = s._annotations ?? [];
-            suiteConfig.push({ mode, annotations });
-        }
-        return { suitePath, suiteConfig };
-    }
-    collectScmInfo(_options) {
-        const scm = {};
-        try {
-            const execOpts = { encoding: 'utf8', timeout: 5000, maxBuffer: 1024 * 1024 };
-            scm.commit = (0, node_child_process_1.execSync)('git rev-parse HEAD', execOpts).trim();
-            scm.branch = (0, node_child_process_1.execSync)('git rev-parse --abbrev-ref HEAD', execOpts).trim();
-            scm.author = (0, node_child_process_1.execSync)('git log -1 --pretty=format:"%an"', execOpts).trim();
-            scm.commitMessage = (0, node_child_process_1.execSync)('git log -1 --pretty=format:"%s"', execOpts).trim();
-            try {
-                scm.remoteUrl = (0, node_child_process_1.execSync)('git config --get remote.origin.url', execOpts).trim();
-            }
-            catch {
-                /* optional */
-            }
-        }
-        catch (error) {
-            this.logger.debug(`Git info not available: ${(0, errors_js_1.errorMessage)(error)}`);
-        }
-        return Object.keys(scm).length > 0 ? scm : undefined;
-    }
-    collectCiInfo() {
-        // Env vars are `string | undefined`; undefined values are dropped on JSON
-        // serialization, so collecting them directly preserves the prior behavior.
-        const ci = {};
-        const env = process.env;
-        if (env.JENKINS_URL) {
-            ci.provider = 'Jenkins';
-            ci.buildNumber = env.BUILD_NUMBER;
-            ci.buildUrl = env.BUILD_URL;
-            ci.jobName = env.JOB_NAME;
-        }
-        else if (env.GITHUB_ACTIONS) {
-            ci.provider = 'GitHub Actions';
-            ci.runId = env.GITHUB_RUN_ID;
-            ci.runNumber = env.GITHUB_RUN_NUMBER;
-            ci.workflow = env.GITHUB_WORKFLOW;
-            ci.actor = env.GITHUB_ACTOR;
-            ci.repository = env.GITHUB_REPOSITORY;
-            ci.ref = env.GITHUB_REF;
-            ci.sha = env.GITHUB_SHA;
-            ci.serverUrl = env.GITHUB_SERVER_URL;
-            if (ci.serverUrl && ci.repository && ci.runId) {
-                ci.buildUrl = `${ci.serverUrl}/${ci.repository}/actions/runs/${ci.runId}`;
-            }
-        }
-        else if (env.GITLAB_CI) {
-            ci.provider = 'GitLab CI';
-            ci.pipelineId = env.CI_PIPELINE_ID;
-            ci.pipelineUrl = env.CI_PIPELINE_URL;
-            ci.jobId = env.CI_JOB_ID;
-            ci.jobUrl = env.CI_JOB_URL;
-            ci.jobName = env.CI_JOB_NAME;
-        }
-        else if (env.CIRCLECI) {
-            ci.provider = 'CircleCI';
-            ci.buildNumber = env.CIRCLE_BUILD_NUM;
-            ci.buildUrl = env.CIRCLE_BUILD_URL;
-            ci.jobName = env.CIRCLE_JOB;
-            ci.workflow = env.CIRCLE_WORKFLOW_ID;
-        }
-        else if (env.TRAVIS) {
-            ci.provider = 'Travis CI';
-            ci.buildNumber = env.TRAVIS_BUILD_NUMBER;
-            ci.buildUrl = env.TRAVIS_BUILD_WEB_URL;
-            ci.jobNumber = env.TRAVIS_JOB_NUMBER;
-        }
-        else if (env.TF_BUILD) {
-            ci.provider = 'Azure Pipelines';
-            ci.buildNumber = env.BUILD_BUILDNUMBER;
-            ci.buildId = env.BUILD_BUILDID;
-            if (env.SYSTEM_TEAMFOUNDATIONSERVERURI && env.SYSTEM_TEAMPROJECT && env.BUILD_BUILDID) {
-                ci.buildUrl = `${env.SYSTEM_TEAMFOUNDATIONSERVERURI}${env.SYSTEM_TEAMPROJECT}/_build/results?buildId=${env.BUILD_BUILDID}`;
-            }
-            ci.jobName = env.AGENT_JOBNAME;
-        }
-        else if (env.CI) {
-            ci.provider = 'Unknown CI';
-            ci.detected = true;
-        }
-        return Object.keys(ci).length > 0 ? ci : undefined;
-    }
-    extractPlaywrightConfigMetadata(config) {
-        const meta = {};
-        if (config.projects?.length > 0) {
-            meta.projects = config.projects.map((p) => ({
-                name: p.name,
-                testDir: p.testDir,
-                use: {
-                    browserName: p.use?.browserName || p.name,
-                    viewport: p.use?.viewport,
-                    deviceScaleFactor: p.use?.deviceScaleFactor,
-                },
-            }));
-        }
-        meta.workers = config.workers;
-        meta.timeout = config.globalTimeout;
-        meta.fullyParallel = config.fullyParallel;
-        return meta;
-    }
-}
-exports.MetadataCollector = MetadataCollector;

package/dist/internal/collect/skip-classify.d.ts

@@ -1,27 +0,0 @@
-import type { TestAnnotation } from '../../types.js';
-/** Minimal structural shape for the annotation carriers (avoids importing Playwright types). */
-interface AnnotationCarrier {
-    annotations?: ReadonlyArray<{
-        type: string;
-        description?: string;
-    }>;
-}
-/**
- * Merge a test's declared annotations (`test.annotations`) with its result-level
- * annotations (`result.annotations`), deduped by `type + description`. Runtime
- * `test.skip('reason')` calls can surface on either side depending on the
- * Playwright version, so both are considered.
- */
-export declare function mergeAnnotations(test: AnnotationCarrier, result: AnnotationCarrier): TestAnnotation[];
-/**
- * Distinguish an intentional skip from a test that could not run.
- *
- * Playwright reports both as `result.status === 'skipped'`, but an intentional
- * `test.skip()` / `test.fixme()` (static, conditional, or runtime) always
- * carries a `skip`/`fixme` annotation, while a test skipped as a side effect of
- * an earlier failure in a `describe.serial` group carries none. The latter is
- * reclassified to `didnotrun` so the dashboard can tell "deliberately skipped"
- * from "never actually executed". Non-skipped statuses pass through unchanged.
- */
-export declare function classifyStatus(rawStatus: string, annotations: TestAnnotation[]): string;
-export {};

package/dist/internal/collect/skip-classify.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.mergeAnnotations = mergeAnnotations;
-exports.classifyStatus = classifyStatus;
-/**
- * Merge a test's declared annotations (`test.annotations`) with its result-level
- * annotations (`result.annotations`), deduped by `type + description`. Runtime
- * `test.skip('reason')` calls can surface on either side depending on the
- * Playwright version, so both are considered.
- */
-function mergeAnnotations(test, result) {
-    const out = [];
-    const seen = new Set();
-    for (const list of [test.annotations, result.annotations]) {
-        for (const a of list ?? []) {
-            const key = `${a.type}\x00${a.description ?? ''}`;
-            if (seen.has(key))
-                continue;
-            seen.add(key);
-            out.push(a.description === undefined ? { type: a.type } : { type: a.type, description: a.description });
-        }
-    }
-    return out;
-}
-/**
- * Distinguish an intentional skip from a test that could not run.
- *
- * Playwright reports both as `result.status === 'skipped'`, but an intentional
- * `test.skip()` / `test.fixme()` (static, conditional, or runtime) always
- * carries a `skip`/`fixme` annotation, while a test skipped as a side effect of
- * an earlier failure in a `describe.serial` group carries none. The latter is
- * reclassified to `didnotrun` so the dashboard can tell "deliberately skipped"
- * from "never actually executed". Non-skipped statuses pass through unchanged.
- */
-function classifyStatus(rawStatus, annotations) {
-    if (rawStatus !== 'skipped')
-        return rawStatus;
-    const intentional = annotations.some((a) => a.type === 'skip' || a.type === 'fixme');
-    return intentional ? 'skipped' : 'didnotrun';
-}

package/dist/internal/collect/step-analyzer.d.ts

@@ -1,103 +0,0 @@
-/**
- * Categorise a Playwright step into `navigation`, `action`, `input`,
- * `assertion`, `wait`, `api`, `hook`, or `other`.
- *
- * Supports two title formats:
- *  - Legacy api-path titles ("page.goto", "locator.click", "page.waitForTimeout")
- *  - Modern human-readable titles introduced in newer Playwright versions
- *    ("Navigate to \"{url}\"", "Click", "Wait for timeout", "Wait for load state").
- * Hook/fixture/expect steps are detected via Playwright's own `category`.
- */
-export declare function categorizeStep(title: string, pwCategory?: string): string;
-/** A single step flattened from the Playwright step tree with its derived category */
-export interface FlatStep {
-    title: string;
-    duration: number;
-    category: string;
-    /** Error message when the step failed (undefined when the step passed). */
-    error?: {
-        message: string;
-    };
-    /** True when the step carried an error — the signal the server needs for inline failure markers. */
-    failed?: boolean;
-}
-/** Step-event category restricted to the values `extractTestStepEvents` emits. */
-export type StepEventCategory = 'hook' | 'fixture' | 'test.step' | 'expect' | 'wait';
-/** Recursively flatten a nested step tree into a flat list. Uses Playwright's built-in category when available. */
-export declare function flattenSteps(steps: any[]): FlatStep[];
-/** Aggregated step performance data for a single test case */
-export interface StepMetrics {
-    /** Flattened step list with categories */
-    steps: FlatStep[];
-    /** Sum of top-level step durations */
-    totalStepDuration: number;
-    /** The single slowest step (by duration) */
-    slowestStep: {
-        title: string;
-        duration: number;
-    } | null;
-    /** How many navigation steps were executed */
-    navigationCount: number;
-    /** Total wall-clock time spent in navigation steps */
-    navigationTotalDuration: number;
-    /** Total wall-clock time spent in wait steps (wasted time) */
-    waitTotalDuration: number;
-    /** Count of wait steps */
-    waitCount: number;
-}
-/** Collect step metrics (flat steps, slowest step, navigation stats) from a Playwright step array */
-export declare function collectStepMetrics(steps: any[]): StepMetrics;
-/** Calculate the p-th percentile from a sorted array of numbers */
-export declare function percentile(sortedArr: number[], p: number): number;
-/** Summary performance statistics for a complete test run */
-export interface PerformanceSummary {
-    /** Average test-case duration in ms */
-    avgTestDuration?: number;
-    /** Median (P50) test-case duration in ms */
-    p50TestDuration?: number;
-    /** P90 test-case duration in ms */
-    p90TestDuration?: number;
-    /** P95 test-case duration in ms */
-    p95TestDuration?: number;
-    /** Up to 5 slowest test cases */
-    slowestTests?: Array<{
-        title: string;
-        duration: number;
-    }>;
-    /** Total time spent in navigation steps across all cases */
-    totalNavigationDuration?: number;
-    /** Average time per navigation step */
-    avgNavigationDuration?: number;
-    /** Total time spent in wait steps across all cases */
-    totalWastedTimeMs?: number;
-}
-/** Compute run-level performance summary (averages, percentiles, slowest tests) from all test cases */
-export declare function computePerformanceSummary(testCases: any[]): PerformanceSummary;
-/**
- * Extract hook and fixture step events with absolute timings from a Playwright
- * step tree. These are used by the WorkersTimeline to render hook segments.
- *
- * Returns only top-level hook/fixture steps (beforeEach, afterEach, fixture
- * setup/teardown) — their sub-steps are included implicitly in their duration.
- */
-export declare function extractTestStepEvents(steps: any[], _testStartTime: Date): Array<{
-    title: string;
-    category: StepEventCategory;
-    startedAt: number;
-    duration: number;
-    status: string;
-    location?: string | null;
-}>;
-/**
- * Recursively extract wait-category steps from the Playwright step tree
- * with absolute timings. These are rendered as semi-transparent amber bars
- * on WorkersTimeline to visualize wasted time.
- */
-export declare function extractWaitEvents(steps: any[], insideWait?: boolean): Array<{
-    title: string;
-    category: StepEventCategory;
-    startedAt: number;
-    duration: number;
-    status: string;
-    location?: string | null;
-}>;