@testrelic/playwright-analytics 2.6.0-next.38 → 2.6.0-next.42

package/dist/reporter-entry.d.cts

@@ -0,0 +1,140 @@
+import { ReporterConfig } from '@testrelic/core';
+
+/**
+ * TestRelicReporter — Playwright custom reporter
+ *
+ * Captures test execution data and produces a structured JSON timeline.
+ * All hooks are wrapped in try/catch (FR-026): never crashes the test run.
+ */
+
+interface PwFullConfig {
+    rootDir: string;
+    [key: string]: unknown;
+}
+interface PwSuite {
+    allTests(): PwTestCase[];
+}
+interface PwProjectUse {
+    browserName?: string;
+    channel?: string;
+    isMobile?: boolean;
+    [key: string]: unknown;
+}
+interface PwFullProject {
+    use: PwProjectUse;
+    [key: string]: unknown;
+}
+interface PwSuiteNode {
+    project?(): PwFullProject | undefined;
+    parent?: PwSuiteNode;
+}
+interface PwTestCase {
+    title: string;
+    titlePath(): string[];
+    annotations: Array<{
+        type: string;
+        description?: string;
+    }>;
+    tags?: string[];
+    location: {
+        file: string;
+        line: number;
+        column: number;
+    };
+    results: PwTestResult[];
+    outcome(): 'expected' | 'unexpected' | 'skipped' | 'flaky';
+    expectedStatus: 'passed' | 'failed' | 'timedOut' | 'skipped' | 'interrupted';
+    id: string;
+    parent?: PwSuiteNode;
+}
+interface PwTestResult {
+    status: 'passed' | 'failed' | 'timedOut' | 'skipped' | 'interrupted';
+    duration: number;
+    startTime: Date;
+    retry: number;
+    errors: PwTestError[];
+    attachments: Array<{
+        name: string;
+        contentType: string;
+        path?: string;
+        body?: Buffer;
+    }>;
+    steps?: readonly PwTestStep[];
+}
+interface PwTestStep {
+    title: string;
+    category: string;
+    startTime: Date;
+    duration: number;
+    error?: {
+        message?: string;
+    };
+    steps: readonly PwTestStep[];
+}
+interface PwTestError {
+    message?: string;
+    stack?: string;
+    location?: {
+        file: string;
+        line: number;
+        column: number;
+    };
+    snippet?: string;
+}
+interface PwFullResult {
+    status: 'passed' | 'failed' | 'timedout' | 'interrupted';
+    startTime: Date;
+    duration: number;
+}
+declare class TestRelicReporter {
+    private config;
+    private apiConfig;
+    private rootDir;
+    private startedAt;
+    private testRunId;
+    private collectedTests;
+    private fixtureDataReceived;
+    private testCount;
+    private cloudClient;
+    private cloudRunId;
+    private runTimestamp;
+    private pendingArtifactEntries;
+    private detectedOs;
+    private detectedSource;
+    private cloudTestsBuffer;
+    private activeReportMode;
+    private streamingWriter;
+    private testIndex;
+    private summaryCounters;
+    constructor(options?: Partial<ReporterConfig>);
+    onBegin(config: PwFullConfig, _suite: PwSuite): Promise<void>;
+    onTestBegin(test: PwTestCase, _result: PwTestResult): void;
+    onTestEnd(test: PwTestCase, result: PwTestResult): void;
+    onEnd(_result: PwFullResult): Promise<void>;
+    /**
+     * Collect artifact entries from all collected tests for cloud upload.
+     * In streaming mode, uses the separately accumulated pendingArtifactEntries
+     * since collectedTests artifacts are nulled after writing to disk.
+     */
+    private collectArtifactEntries;
+    private finalizeStreamingReport;
+    /** Build a lightweight TestRunReport from streaming data (for HTML generation and cloud). */
+    private buildStreamingReport;
+    printsToStdio(): boolean;
+    /** Check heap usage and warn or auto-switch to streaming mode. */
+    private checkMemoryPressure;
+    /** Switch from embedded to streaming mode mid-run. */
+    private switchToStreamingMode;
+    private buildTimeline;
+    private readJsonlFile;
+    private toTestResult;
+    /**
+     * Build a full payload for cloud upload that includes console logs,
+     * network requests, navigations, and actions read from JSONL files.
+     * Called before streaming writer moves files and before fields are nulled.
+     */
+    private buildCloudTestPayload;
+    private writeReport;
+}
+
+export { TestRelicReporter as default };

package/dist/reporter-entry.d.ts

@@ -0,0 +1,140 @@
+import { ReporterConfig } from '@testrelic/core';
+
+/**
+ * TestRelicReporter — Playwright custom reporter
+ *
+ * Captures test execution data and produces a structured JSON timeline.
+ * All hooks are wrapped in try/catch (FR-026): never crashes the test run.
+ */
+
+interface PwFullConfig {
+    rootDir: string;
+    [key: string]: unknown;
+}
+interface PwSuite {
+    allTests(): PwTestCase[];
+}
+interface PwProjectUse {
+    browserName?: string;
+    channel?: string;
+    isMobile?: boolean;
+    [key: string]: unknown;
+}
+interface PwFullProject {
+    use: PwProjectUse;
+    [key: string]: unknown;
+}
+interface PwSuiteNode {
+    project?(): PwFullProject | undefined;
+    parent?: PwSuiteNode;
+}
+interface PwTestCase {
+    title: string;
+    titlePath(): string[];
+    annotations: Array<{
+        type: string;
+        description?: string;
+    }>;
+    tags?: string[];
+    location: {
+        file: string;
+        line: number;
+        column: number;
+    };
+    results: PwTestResult[];
+    outcome(): 'expected' | 'unexpected' | 'skipped' | 'flaky';
+    expectedStatus: 'passed' | 'failed' | 'timedOut' | 'skipped' | 'interrupted';
+    id: string;
+    parent?: PwSuiteNode;
+}
+interface PwTestResult {
+    status: 'passed' | 'failed' | 'timedOut' | 'skipped' | 'interrupted';
+    duration: number;
+    startTime: Date;
+    retry: number;
+    errors: PwTestError[];
+    attachments: Array<{
+        name: string;
+        contentType: string;
+        path?: string;
+        body?: Buffer;
+    }>;
+    steps?: readonly PwTestStep[];
+}
+interface PwTestStep {
+    title: string;
+    category: string;
+    startTime: Date;
+    duration: number;
+    error?: {
+        message?: string;
+    };
+    steps: readonly PwTestStep[];
+}
+interface PwTestError {
+    message?: string;
+    stack?: string;
+    location?: {
+        file: string;
+        line: number;
+        column: number;
+    };
+    snippet?: string;
+}
+interface PwFullResult {
+    status: 'passed' | 'failed' | 'timedout' | 'interrupted';
+    startTime: Date;
+    duration: number;
+}
+declare class TestRelicReporter {
+    private config;
+    private apiConfig;
+    private rootDir;
+    private startedAt;
+    private testRunId;
+    private collectedTests;
+    private fixtureDataReceived;
+    private testCount;
+    private cloudClient;
+    private cloudRunId;
+    private runTimestamp;
+    private pendingArtifactEntries;
+    private detectedOs;
+    private detectedSource;
+    private cloudTestsBuffer;
+    private activeReportMode;
+    private streamingWriter;
+    private testIndex;
+    private summaryCounters;
+    constructor(options?: Partial<ReporterConfig>);
+    onBegin(config: PwFullConfig, _suite: PwSuite): Promise<void>;
+    onTestBegin(test: PwTestCase, _result: PwTestResult): void;
+    onTestEnd(test: PwTestCase, result: PwTestResult): void;
+    onEnd(_result: PwFullResult): Promise<void>;
+    /**
+     * Collect artifact entries from all collected tests for cloud upload.
+     * In streaming mode, uses the separately accumulated pendingArtifactEntries
+     * since collectedTests artifacts are nulled after writing to disk.
+     */
+    private collectArtifactEntries;
+    private finalizeStreamingReport;
+    /** Build a lightweight TestRunReport from streaming data (for HTML generation and cloud). */
+    private buildStreamingReport;
+    printsToStdio(): boolean;
+    /** Check heap usage and warn or auto-switch to streaming mode. */
+    private checkMemoryPressure;
+    /** Switch from embedded to streaming mode mid-run. */
+    private switchToStreamingMode;
+    private buildTimeline;
+    private readJsonlFile;
+    private toTestResult;
+    /**
+     * Build a full payload for cloud upload that includes console logs,
+     * network requests, navigations, and actions read from JSONL files.
+     * Called before streaming writer moves files and before fields are nulled.
+     */
+    private buildCloudTestPayload;
+    private writeReport;
+}
+
+export { TestRelicReporter as default };