@checkly/playwright-reporter 1.2.0 → 1.4.0

package/CHANGELOG.md

@@ -4,6 +4,44 @@ All notable changes to `@checkly/playwright-reporter` will be documented in this
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
+## 1.4.0 (2026-02-03)
+
+### Added
+
+- **Secret scrubbing** - Automatically scrub sensitive values from reports and trace files. Configure via the new `scrubbing` option:
+  - `envVars`: Array of environment variable names whose values should be scrubbed
+  - `autoDetect`: Auto-detect secrets from env vars matching common patterns (SECRET, KEY, TOKEN, PASSWORD, CREDENTIAL, AUTH, PRIVATE, API)
+  - `replacement`: Custom replacement string (default: `*********`)
+  - Set `scrubbing: false` to disable scrubbing entirely
+
+```typescript
+createChecklyReporter({
+  scrubbing: {
+    envVars: ['API_KEY', 'DB_PASSWORD'],
+    autoDetect: true,
+    replacement: '[REDACTED]'
+  }
+})
+```
+
+- **Improved network and console data** - Network requests now include detailed fields (domain, resource type, headers, timing, transfer/resource bytes). Console logs include location information. Resource types are automatically derived from Content-Type headers when not available.
+
+### Changed
+
+- **Playwright 1.58 support** - Now tested against Playwright 1.58.0.
+
+## 1.3.0 (2026-01-29)
+
+### Added
+
+- **Real-time test progress** - See test results as they run with status icons, error details, and a summary, similar to Playwright's built-in `line` reporter. Disable with `showProgress: false` if using another reporter.
+
+- **Summary table** - View a per-project breakdown of test results with pass/fail/flaky/skip counts and pass rates. Enable with `showSummaryTable: true`. Projects are color-coded for easy identification.
+
+- **Automatic git detection** - Git information (branch, commit, author) is now automatically detected in CI environments and locally.
+
+- **Test step code snippets** - Test steps now include source code context in the report. When viewing step details, you'll see the exact line of code that executed along with surrounding context and a pointer to the precise column location. This makes debugging failed steps easier by showing exactly what code ran.
+
 ## 1.2.0 (2026-01-21)
 
 ### Breaking Changes

package/dist/index.d.ts

@@ -1,21 +1,52 @@
-import { JSONReportTestResult as JSONReportTestResult$1, Reporter } from '@playwright/test/reporter';
-export { JSONReport, JSONReportError, JSONReportSTDIOEntry, JSONReportSpec, JSONReportSuite, JSONReportTest, JSONReportTestStep } from '@playwright/test/reporter';
+import { JSONReportTestResult as JSONReportTestResult$1, JSONReportTestStep as JSONReportTestStep$1, Reporter } from '@playwright/test/reporter';
+export { JSONReport, JSONReportError, JSONReportSTDIOEntry, JSONReportSpec, JSONReportSuite, JSONReportTest, TestError } from '@playwright/test/reporter';
 
-interface ChecklyConsoleLog {
+interface ChecklyStepData {
+    location?: {
+        file: string;
+        line: number;
+        column: number;
+    };
+    snippet?: string;
+}
+interface JSONReportTestStep extends JSONReportTestStep$1 {
+    _checkly?: ChecklyStepData;
+    steps?: JSONReportTestStep[];
+}
+interface ConsoleEntryLocation {
+    url: string;
+    columnNumber: number;
+    lineNumber: number;
+}
+interface ConsoleLog {
+    id: string;
     type: 'log' | 'warn' | 'error' | 'info' | 'debug';
-    message: string;
+    text: string;
     timestamp: string;
+    location: ConsoleEntryLocation;
 }
-interface ChecklyNetworkRequest {
+interface NetworkRequest {
+    id: string;
     url: string;
+    domain: string;
     method: string;
-    status?: number;
-    duration?: number;
-    timestamp: string;
+    resourceType: string;
+    statusCode: number | null;
+    statusText: string;
+    start: number;
+    startedAt: number;
+    finishedAt: number | null;
+    time: number | null;
+    hasFinished: boolean;
+    hasSucceeded: boolean;
+    requestHeaders: Record<string, string>;
+    responseHeaders: Record<string, string>;
+    transferBytes: number | null;
+    resourceBytes: number | null;
 }
 interface ChecklyData {
-    consoleLogs?: ChecklyConsoleLog[];
-    networkRequests?: ChecklyNetworkRequest[];
+    console?: ConsoleLog[];
+    network?: NetworkRequest[];
 }
 interface JSONReportTestResult extends JSONReportTestResult$1 {
     _checkly?: ChecklyData;
@@ -25,6 +56,26 @@ declare class MissingCredentialsError extends Error {
     constructor(missing: string[]);
 }
 
+/**
+ * Configuration for secret scrubbing in reports and traces.
+ */
+interface ScrubbingOptions {
+    /**
+     * Environment variable names whose values should be scrubbed.
+     * The reporter looks up values at runtime from process.env.
+     */
+    envVars?: string[];
+    /**
+     * Auto-detect common secret patterns in environment variable names.
+     * Matches env vars containing: SECRET, KEY, TOKEN, PASSWORD, CREDENTIAL, AUTH, PRIVATE, API.
+     */
+    autoDetect?: boolean;
+    /**
+     * Custom replacement string for scrubbed values.
+     */
+    replacement?: string;
+}
+
 /**
  * Configuration options for the Checkly Playwright Reporter.
  */
@@ -45,6 +96,28 @@ interface ChecklyReporterOptions {
     }) => string);
     /** Dry run mode - generate report but don't upload. */
     dryRun?: boolean;
+    /**
+     * Show real-time test progress in the terminal (like Playwright's "line" reporter).
+     * Set to false if you're using another reporter that prints progress.
+     * Defaults to true.
+     */
+    showProgress?: boolean;
+    /**
+     * When showProgress is enabled, also print individual test steps.
+     * Defaults to false.
+     */
+    printSteps?: boolean;
+    /**
+     * Show a summary table at the end of the test run with per-project breakdown.
+     * Defaults to true.
+     */
+    showSummaryTable?: boolean;
+    /**
+     * Configure secret scrubbing from reports and traces.
+     * Set to false to disable scrubbing entirely.
+     * @example { envVars: ['API_KEY'], autoDetect: true }
+     */
+    scrubbing?: false | ScrubbingOptions;
 }
 type ChecklyReporterClass = new (options?: ChecklyReporterOptions) => Reporter;
 declare const _default: ChecklyReporterClass;
@@ -65,4 +138,4 @@ declare const _default: ChecklyReporterClass;
  */
 declare function createChecklyReporter(options?: ChecklyReporterOptions): ['@checkly/playwright-reporter', ChecklyReporterOptions];
 
-export { type ChecklyConsoleLog, type ChecklyData, type ChecklyNetworkRequest, type ChecklyReporterOptions, type JSONReportTestResult, MissingCredentialsError, createChecklyReporter, _default as default };
+export { type ChecklyData, type ChecklyReporterOptions, type ConsoleLog, type JSONReportTestResult, type JSONReportTestStep, MissingCredentialsError, type NetworkRequest, type ScrubbingOptions, createChecklyReporter, _default as default };