@testdino/playwright 1.0.7 → 1.0.8

package/dist/index.d.mts

@@ -1,4 +1,7 @@
 import { Reporter, FullConfig, Suite, TestCase, TestResult, TestStep, FullResult, TestError } from '@playwright/test/reporter';
+import * as playwright_test from 'playwright/test';
+import { Page, TestInfo } from '@playwright/test';
+export { expect } from '@playwright/test';
 
 /**
  * Metadata collection types and interfaces
@@ -253,6 +256,200 @@ interface MetadataCollectionSummary {
     failureCount: number;
 }
 
+/**
+ * Coverage type definitions for TestDino Playwright integration.
+ * Istanbul-only (V8 coverage planned for future release).
+ */
+/**
+ * Istanbul coverage map format (window.__coverage__).
+ * Contains structural metadata + execution counts per file.
+ * Does NOT contain source code.
+ */
+type IstanbulCoverageMap = Record<string, IstanbulFileCoverage>;
+interface IstanbulFileCoverage {
+    path: string;
+    statementMap: Record<string, {
+        start: {
+            line: number;
+            column: number;
+        };
+        end: {
+            line: number;
+            column: number;
+        };
+    }>;
+    fnMap: Record<string, {
+        name: string;
+        decl: {
+            start: {
+                line: number;
+                column: number;
+            };
+            end: {
+                line: number;
+                column: number;
+            };
+        };
+        loc: {
+            start: {
+                line: number;
+                column: number;
+            };
+            end: {
+                line: number;
+                column: number;
+            };
+        };
+    }>;
+    branchMap: Record<string, {
+        type: string;
+        loc: {
+            start: {
+                line: number;
+                column: number;
+            };
+            end: {
+                line: number;
+                column: number;
+            };
+        };
+        locations: Array<{
+            start: {
+                line: number;
+                column: number;
+            };
+            end: {
+                line: number;
+                column: number;
+            };
+        }>;
+    }>;
+    /** Statement execution counts */
+    s: Record<string, number>;
+    /** Function call counts */
+    f: Record<string, number>;
+    /** Branch path counts */
+    b: Record<string, number[]>;
+}
+/**
+ * Coverage fragment collected per-test by the fixture.
+ * Attached to testInfo as 'testdino-coverage' attachment.
+ */
+interface CoverageFragment {
+    istanbul: IstanbulCoverageMap | null;
+}
+/**
+ * Metric with total, covered count, and optional percentage.
+ * The pct field is calculated on the server/client and not sent over the wire.
+ */
+interface CoverageMetric {
+    total: number;
+    covered: number;
+    /** Coverage percentage (0-100), calculated from total and covered */
+    pct: number;
+}
+/**
+ * Summary metrics for a coverage report.
+ */
+interface CoverageSummary {
+    lines: CoverageMetric;
+    branches: CoverageMetric;
+    functions: CoverageMetric;
+    statements: CoverageMetric;
+}
+/**
+ * Per-file coverage metrics (no source code, no raw maps).
+ */
+interface FileCoverage {
+    path: string;
+    lines: CoverageMetric;
+    branches: CoverageMetric;
+    functions: CoverageMetric;
+    statements: CoverageMetric;
+}
+/**
+ * Compact per-file hit counts for cross-shard merging.
+ * Contains only execution counts and totals — no structural maps,
+ * no source code, no line/column data.
+ */
+interface CompactFileCounts {
+    /** Statement execution counts */
+    s: Record<string, number>;
+    /** Function call counts */
+    f: Record<string, number>;
+    /** Branch path counts */
+    b: Record<string, number[]>;
+    /** Denominators computed from structural maps */
+    totals: {
+        s: number;
+        f: number;
+        b: number;
+    };
+    /** Hash of structural map shape for build mismatch detection */
+    shapeHash: string;
+}
+/**
+ * Compact coverage data for sharded uploads.
+ * Sent as part of coverage:data event for server-side merging.
+ */
+interface CompactCoverageData {
+    files: Record<string, CompactFileCounts>;
+    fileCount: number;
+}
+/**
+ * Coverage threshold percentages.
+ * If set, the run fails when coverage drops below these values.
+ */
+interface CoverageThresholds {
+    statements?: number;
+    branches?: number;
+    functions?: number;
+    lines?: number;
+}
+/**
+ * Coverage configuration options (part of TestdinoConfig).
+ */
+interface CoverageConfig {
+    /** Enable coverage collection. Default: false */
+    enabled: boolean;
+    /** Filter which Playwright projects report coverage */
+    projects?: string[];
+    /** Generate local HTML report using istanbul-reports. Default: false */
+    localReport?: boolean;
+    /** Output directory for local HTML report. Default: './testdino-coverage' */
+    localReportDir?: string;
+    /** Substring patterns — only files whose path contains a pattern are included */
+    include?: string[];
+    /** Substring patterns — files whose path contains a pattern are excluded */
+    exclude?: string[];
+    /** Fail the run if coverage percentages are below these thresholds */
+    thresholds?: CoverageThresholds;
+}
+
+type CoverageFixtures = {
+    _testdinoCoverage: void;
+};
+declare const coverageFixtures: {
+    _testdinoCoverage: ((({ page }: {
+        page: Page;
+    }, use: () => Promise<void>, testInfo: TestInfo) => Promise<void>) | {
+        auto: boolean;
+    })[];
+};
+/**
+ * Pre-extended test with coverage fixtures for direct import.
+ *
+ * Usage:
+ * ```typescript
+ * import { test, expect } from '@testdino/playwright';
+ *
+ * test('my test', async ({ page }) => {
+ *   // coverage collected automatically
+ * });
+ * ```
+ */
+declare const test: playwright_test.TestType<playwright_test.PlaywrightTestArgs & playwright_test.PlaywrightTestOptions & CoverageFixtures, playwright_test.PlaywrightWorkerArgs & playwright_test.PlaywrightWorkerOptions>;
+
 /**
  * Server error classes for quota and infrastructure errors
  * These are received from the TestDino server and handled gracefully in the reporter
@@ -390,6 +587,12 @@ interface TestdinoConfig {
      * Set to false or use --no-artifacts CLI flag to disable
      */
     artifacts?: boolean;
+    /**
+     * Coverage collection configuration.
+     * When enabled, Istanbul coverage is collected per-test via fixtures,
+     * merged in the reporter, and uploaded as metrics to the server.
+     */
+    coverage?: CoverageConfig;
 }
 interface EventBuffer {
     events: TestEvent[];
@@ -403,7 +606,7 @@ interface ConnectionConfig {
     maxRetries?: number;
     retryDelay?: number;
 }
-type TestEvent = TestRunBeginEvent | TestBeginEvent | TestStepBeginEvent | TestStepEndEvent | TestEndEvent | TestRunEndEvent | TestRunErrorEvent | TestConsoleOutEvent | TestConsoleErrEvent;
+type TestEvent = TestRunBeginEvent | TestBeginEvent | TestStepBeginEvent | TestStepEndEvent | TestEndEvent | TestRunEndEvent | TestRunErrorEvent | TestConsoleOutEvent | TestConsoleErrEvent | CoverageDataEvent;
 interface Annotation {
     type: string;
     description?: string;
@@ -556,6 +759,27 @@ interface TestRunEndEvent extends BaseEvent {
         total: number;
     };
 }
+/**
+ * Coverage data event — sent after all tests complete, before run:end.
+ *
+ * Non-sharded runs: contains computed summary + per-file metrics.
+ * Sharded runs: contains compact hit counts for server-side cross-shard merging.
+ */
+interface CoverageDataEvent extends BaseEvent {
+    type: 'coverage:data';
+    summary: CoverageSummary;
+    files: FileCoverage[];
+    compactCounts?: CompactCoverageData;
+    metadata: {
+        instrumentationType: 'istanbul';
+        fileCount: number;
+        sharded: boolean;
+    };
+    shard?: {
+        current: number;
+        total: number;
+    };
+}
 interface TestRunErrorEvent extends BaseEvent {
     type: 'run:error';
     error: {
@@ -622,6 +846,16 @@ declare class TestdinoReporter implements Reporter {
     private initFailed;
     private pendingTestEndPromises;
     private log;
+    private coverageEnabled;
+    private coverageMerger;
+    private warnedCoverageDisconnect;
+    private coverageThresholdFailed;
+    private testCounts;
+    private totalTests;
+    private lastCoverageEvent;
+    private projectNames;
+    private runMetadata;
+    private workerCount;
     constructor(config?: TestdinoConfig);
     /**
      * Load configuration from CLI temp file if available
@@ -668,7 +902,9 @@ declare class TestdinoReporter implements Reporter {
     /**
      * Called after all tests complete
      */
-    onEnd(result: FullResult): Promise<void>;
+    onEnd(result: FullResult): Promise<{
+        status?: FullResult['status'];
+    } | void>;
     /**
      * Called on global errors
      */
@@ -818,6 +1054,29 @@ declare class TestdinoReporter implements Reporter {
      * Get base server URL without /api/reporter suffix
      */
     private getBaseServerUrl;
+    /**
+     * Walk up the suite hierarchy to find the project name for a test.
+     */
+    private getProjectName;
+    /**
+     * Extract coverage fragment from test result attachments and merge incrementally.
+     * The fixture attaches coverage as an in-memory JSON attachment named 'testdino-coverage'.
+     *
+     * Respects coverage.projects filter to avoid duplicate coverage from multiple browser projects.
+     */
+    private extractCoverageFromResult;
+    /**
+     * Build a coverage:data event from the merged coverage data.
+     *
+     * Non-sharded runs: summary + per-file metrics only (small payload).
+     * Sharded runs: also includes compact hit counts for server-side cross-shard merging.
+     */
+    private buildCoverageEvent;
+    /**
+     * Check coverage against configured thresholds.
+     * Returns an array of failure messages (empty if all thresholds pass).
+     */
+    private checkCoverageThresholds;
 }
 
-export { type Annotation, type BaseEvent, type CIMetadata, CircuitBreakerError, type ConnectionConfig, type EventBuffer, type GitMetadata, type MetadataCollectionResult, type MetadataCollectionSummary, type MetadataCollector, type NackMessage, type PRMetadata, type PlaywrightMetadata, QueueFullError, QuotaExceededError, QuotaExhaustedError, type CompleteMetadata as RunMetadata, type ServerError, type SessionCreationQuotaResponse, type ShardMetadata, type SystemMetadata, type TestBeginEvent, type TestConsoleErrEvent, type TestConsoleOutEvent, type TestEndEvent, type TestEvent, type TestRunBeginEvent, type TestRunEndEvent, type TestRunErrorEvent, type TestStepBeginEvent, type TestStepEndEvent, type TestdinoConfig, TestdinoReporter as default };
+export { type Annotation, type BaseEvent, type CIMetadata, CircuitBreakerError, type CompactCoverageData, type CompactFileCounts, type ConnectionConfig, type CoverageConfig, type CoverageDataEvent, type CoverageFragment, type CoverageMetric, type CoverageSummary, type CoverageThresholds, type EventBuffer, type FileCoverage, type GitMetadata, type IstanbulCoverageMap, type MetadataCollectionResult, type MetadataCollectionSummary, type MetadataCollector, type NackMessage, type PRMetadata, type PlaywrightMetadata, QueueFullError, QuotaExceededError, QuotaExhaustedError, type CompleteMetadata as RunMetadata, type ServerError, type SessionCreationQuotaResponse, type ShardMetadata, type SystemMetadata, type TestBeginEvent, type TestConsoleErrEvent, type TestConsoleOutEvent, type TestEndEvent, type TestEvent, type TestRunBeginEvent, type TestRunEndEvent, type TestRunErrorEvent, type TestStepBeginEvent, type TestStepEndEvent, type TestdinoConfig, coverageFixtures, TestdinoReporter as default, test };

package/dist/index.d.ts

@@ -1,4 +1,7 @@
 import { Reporter, FullConfig, Suite, TestCase, TestResult, TestStep, FullResult, TestError } from '@playwright/test/reporter';
+import * as playwright_test from 'playwright/test';
+import { Page, TestInfo } from '@playwright/test';
+export { expect } from '@playwright/test';
 
 /**
  * Metadata collection types and interfaces
@@ -253,6 +256,200 @@ interface MetadataCollectionSummary {
     failureCount: number;
 }
 
+/**
+ * Coverage type definitions for TestDino Playwright integration.
+ * Istanbul-only (V8 coverage planned for future release).
+ */
+/**
+ * Istanbul coverage map format (window.__coverage__).
+ * Contains structural metadata + execution counts per file.
+ * Does NOT contain source code.
+ */
+type IstanbulCoverageMap = Record<string, IstanbulFileCoverage>;
+interface IstanbulFileCoverage {
+    path: string;
+    statementMap: Record<string, {
+        start: {
+            line: number;
+            column: number;
+        };
+        end: {
+            line: number;
+            column: number;
+        };
+    }>;
+    fnMap: Record<string, {
+        name: string;
+        decl: {
+            start: {
+                line: number;
+                column: number;
+            };
+            end: {
+                line: number;
+                column: number;
+            };
+        };
+        loc: {
+            start: {
+                line: number;
+                column: number;
+            };
+            end: {
+                line: number;
+                column: number;
+            };
+        };
+    }>;
+    branchMap: Record<string, {
+        type: string;
+        loc: {
+            start: {
+                line: number;
+                column: number;
+            };
+            end: {
+                line: number;
+                column: number;
+            };
+        };
+        locations: Array<{
+            start: {
+                line: number;
+                column: number;
+            };
+            end: {
+                line: number;
+                column: number;
+            };
+        }>;
+    }>;
+    /** Statement execution counts */
+    s: Record<string, number>;
+    /** Function call counts */
+    f: Record<string, number>;
+    /** Branch path counts */
+    b: Record<string, number[]>;
+}
+/**
+ * Coverage fragment collected per-test by the fixture.
+ * Attached to testInfo as 'testdino-coverage' attachment.
+ */
+interface CoverageFragment {
+    istanbul: IstanbulCoverageMap | null;
+}
+/**
+ * Metric with total, covered count, and optional percentage.
+ * The pct field is calculated on the server/client and not sent over the wire.
+ */
+interface CoverageMetric {
+    total: number;
+    covered: number;
+    /** Coverage percentage (0-100), calculated from total and covered */
+    pct: number;
+}
+/**
+ * Summary metrics for a coverage report.
+ */
+interface CoverageSummary {
+    lines: CoverageMetric;
+    branches: CoverageMetric;
+    functions: CoverageMetric;
+    statements: CoverageMetric;
+}
+/**
+ * Per-file coverage metrics (no source code, no raw maps).
+ */
+interface FileCoverage {
+    path: string;
+    lines: CoverageMetric;
+    branches: CoverageMetric;
+    functions: CoverageMetric;
+    statements: CoverageMetric;
+}
+/**
+ * Compact per-file hit counts for cross-shard merging.
+ * Contains only execution counts and totals — no structural maps,
+ * no source code, no line/column data.
+ */
+interface CompactFileCounts {
+    /** Statement execution counts */
+    s: Record<string, number>;
+    /** Function call counts */
+    f: Record<string, number>;
+    /** Branch path counts */
+    b: Record<string, number[]>;
+    /** Denominators computed from structural maps */
+    totals: {
+        s: number;
+        f: number;
+        b: number;
+    };
+    /** Hash of structural map shape for build mismatch detection */
+    shapeHash: string;
+}
+/**
+ * Compact coverage data for sharded uploads.
+ * Sent as part of coverage:data event for server-side merging.
+ */
+interface CompactCoverageData {
+    files: Record<string, CompactFileCounts>;
+    fileCount: number;
+}
+/**
+ * Coverage threshold percentages.
+ * If set, the run fails when coverage drops below these values.
+ */
+interface CoverageThresholds {
+    statements?: number;
+    branches?: number;
+    functions?: number;
+    lines?: number;
+}
+/**
+ * Coverage configuration options (part of TestdinoConfig).
+ */
+interface CoverageConfig {
+    /** Enable coverage collection. Default: false */
+    enabled: boolean;
+    /** Filter which Playwright projects report coverage */
+    projects?: string[];
+    /** Generate local HTML report using istanbul-reports. Default: false */
+    localReport?: boolean;
+    /** Output directory for local HTML report. Default: './testdino-coverage' */
+    localReportDir?: string;
+    /** Substring patterns — only files whose path contains a pattern are included */
+    include?: string[];
+    /** Substring patterns — files whose path contains a pattern are excluded */
+    exclude?: string[];
+    /** Fail the run if coverage percentages are below these thresholds */
+    thresholds?: CoverageThresholds;
+}
+
+type CoverageFixtures = {
+    _testdinoCoverage: void;
+};
+declare const coverageFixtures: {
+    _testdinoCoverage: ((({ page }: {
+        page: Page;
+    }, use: () => Promise<void>, testInfo: TestInfo) => Promise<void>) | {
+        auto: boolean;
+    })[];
+};
+/**
+ * Pre-extended test with coverage fixtures for direct import.
+ *
+ * Usage:
+ * ```typescript
+ * import { test, expect } from '@testdino/playwright';
+ *
+ * test('my test', async ({ page }) => {
+ *   // coverage collected automatically
+ * });
+ * ```
+ */
+declare const test: playwright_test.TestType<playwright_test.PlaywrightTestArgs & playwright_test.PlaywrightTestOptions & CoverageFixtures, playwright_test.PlaywrightWorkerArgs & playwright_test.PlaywrightWorkerOptions>;
+
 /**
  * Server error classes for quota and infrastructure errors
  * These are received from the TestDino server and handled gracefully in the reporter
@@ -390,6 +587,12 @@ interface TestdinoConfig {
      * Set to false or use --no-artifacts CLI flag to disable
      */
     artifacts?: boolean;
+    /**
+     * Coverage collection configuration.
+     * When enabled, Istanbul coverage is collected per-test via fixtures,
+     * merged in the reporter, and uploaded as metrics to the server.
+     */
+    coverage?: CoverageConfig;
 }
 interface EventBuffer {
     events: TestEvent[];
@@ -403,7 +606,7 @@ interface ConnectionConfig {
     maxRetries?: number;
     retryDelay?: number;
 }
-type TestEvent = TestRunBeginEvent | TestBeginEvent | TestStepBeginEvent | TestStepEndEvent | TestEndEvent | TestRunEndEvent | TestRunErrorEvent | TestConsoleOutEvent | TestConsoleErrEvent;
+type TestEvent = TestRunBeginEvent | TestBeginEvent | TestStepBeginEvent | TestStepEndEvent | TestEndEvent | TestRunEndEvent | TestRunErrorEvent | TestConsoleOutEvent | TestConsoleErrEvent | CoverageDataEvent;
 interface Annotation {
     type: string;
     description?: string;
@@ -556,6 +759,27 @@ interface TestRunEndEvent extends BaseEvent {
         total: number;
     };
 }
+/**
+ * Coverage data event — sent after all tests complete, before run:end.
+ *
+ * Non-sharded runs: contains computed summary + per-file metrics.
+ * Sharded runs: contains compact hit counts for server-side cross-shard merging.
+ */
+interface CoverageDataEvent extends BaseEvent {
+    type: 'coverage:data';
+    summary: CoverageSummary;
+    files: FileCoverage[];
+    compactCounts?: CompactCoverageData;
+    metadata: {
+        instrumentationType: 'istanbul';
+        fileCount: number;
+        sharded: boolean;
+    };
+    shard?: {
+        current: number;
+        total: number;
+    };
+}
 interface TestRunErrorEvent extends BaseEvent {
     type: 'run:error';
     error: {
@@ -622,6 +846,16 @@ declare class TestdinoReporter implements Reporter {
     private initFailed;
     private pendingTestEndPromises;
     private log;
+    private coverageEnabled;
+    private coverageMerger;
+    private warnedCoverageDisconnect;
+    private coverageThresholdFailed;
+    private testCounts;
+    private totalTests;
+    private lastCoverageEvent;
+    private projectNames;
+    private runMetadata;
+    private workerCount;
     constructor(config?: TestdinoConfig);
     /**
      * Load configuration from CLI temp file if available
@@ -668,7 +902,9 @@ declare class TestdinoReporter implements Reporter {
     /**
      * Called after all tests complete
      */
-    onEnd(result: FullResult): Promise<void>;
+    onEnd(result: FullResult): Promise<{
+        status?: FullResult['status'];
+    } | void>;
     /**
      * Called on global errors
      */
@@ -818,6 +1054,29 @@ declare class TestdinoReporter implements Reporter {
      * Get base server URL without /api/reporter suffix
      */
     private getBaseServerUrl;
+    /**
+     * Walk up the suite hierarchy to find the project name for a test.
+     */
+    private getProjectName;
+    /**
+     * Extract coverage fragment from test result attachments and merge incrementally.
+     * The fixture attaches coverage as an in-memory JSON attachment named 'testdino-coverage'.
+     *
+     * Respects coverage.projects filter to avoid duplicate coverage from multiple browser projects.
+     */
+    private extractCoverageFromResult;
+    /**
+     * Build a coverage:data event from the merged coverage data.
+     *
+     * Non-sharded runs: summary + per-file metrics only (small payload).
+     * Sharded runs: also includes compact hit counts for server-side cross-shard merging.
+     */
+    private buildCoverageEvent;
+    /**
+     * Check coverage against configured thresholds.
+     * Returns an array of failure messages (empty if all thresholds pass).
+     */
+    private checkCoverageThresholds;
 }
 
-export { type Annotation, type BaseEvent, type CIMetadata, CircuitBreakerError, type ConnectionConfig, type EventBuffer, type GitMetadata, type MetadataCollectionResult, type MetadataCollectionSummary, type MetadataCollector, type NackMessage, type PRMetadata, type PlaywrightMetadata, QueueFullError, QuotaExceededError, QuotaExhaustedError, type CompleteMetadata as RunMetadata, type ServerError, type SessionCreationQuotaResponse, type ShardMetadata, type SystemMetadata, type TestBeginEvent, type TestConsoleErrEvent, type TestConsoleOutEvent, type TestEndEvent, type TestEvent, type TestRunBeginEvent, type TestRunEndEvent, type TestRunErrorEvent, type TestStepBeginEvent, type TestStepEndEvent, type TestdinoConfig, TestdinoReporter as default };
+export { type Annotation, type BaseEvent, type CIMetadata, CircuitBreakerError, type CompactCoverageData, type CompactFileCounts, type ConnectionConfig, type CoverageConfig, type CoverageDataEvent, type CoverageFragment, type CoverageMetric, type CoverageSummary, type CoverageThresholds, type EventBuffer, type FileCoverage, type GitMetadata, type IstanbulCoverageMap, type MetadataCollectionResult, type MetadataCollectionSummary, type MetadataCollector, type NackMessage, type PRMetadata, type PlaywrightMetadata, QueueFullError, QuotaExceededError, QuotaExhaustedError, type CompleteMetadata as RunMetadata, type ServerError, type SessionCreationQuotaResponse, type ShardMetadata, type SystemMetadata, type TestBeginEvent, type TestConsoleErrEvent, type TestConsoleOutEvent, type TestEndEvent, type TestEvent, type TestRunBeginEvent, type TestRunEndEvent, type TestRunErrorEvent, type TestStepBeginEvent, type TestStepEndEvent, type TestdinoConfig, coverageFixtures, TestdinoReporter as default, test };