@checkly/playwright-reporter 1.5.0 → 1.6.0

package/CHANGELOG.md

@@ -4,6 +4,19 @@ 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.6.0
+
+### Added
+
+- **Test source code** - The source code of each executed test and its dependency files (helpers, page objects, utilities) are now included in the report. View the exact test body alongside results in the Checkly UI.
+- **System metrics** - CPU and memory usage are sampled throughout the test run, helping diagnose resource-constrained failures.
+- **Active duration** - Reports now distinguish actual test execution time from total wall-clock time, so idle gaps from worker scheduling don't inflate your numbers.
+- **Prefix-based secret scrubbing** - Environment variables starting with `CHECKLY_SECRET_` are now automatically scrubbed from reports, traces, and logs. Customize the prefix or disable it via the `scrubbing.prefix` option.
+
+### Changed
+
+- **Scrubbing now covers logs** - Secret scrubbing now extends to reporter log entries, not just the JSON report and trace files.
+
 ## 1.5.0 (2026-02-18)
 
 ### Added

package/README.md

@@ -1,7 +1,5 @@
 # @checkly/playwright-reporter
 
-> **Technical Preview** - This reporter is currently in technical preview. Features and APIs may change.
-
 Official Playwright reporter for Checkly. Automatically upload test results, screenshots, videos, and traces to gain visibility into your end-to-end tests.
 
 **Fully compatible with Playwright's native JSON reporter** - use it as a drop-in replacement that adds Checkly integration.
@@ -81,27 +79,29 @@ createChecklyReporter({
   sessionName: 'My Test Suite',
   dryRun: false,
   verbose: false,
+  showProgress: true,
+  showSummaryTable: true,
 })
 ```
 
 | Option | Type | Default | Description |
 |--------|------|---------|-------------|
+| `apiKey` | `string` | `CHECKLY_API_KEY` env var | Checkly API key |
+| `accountId` | `string` | `CHECKLY_ACCOUNT_ID` env var | Checkly account ID |
 | `outputDir` | `string` | Playwright's `outputDir` | Directory for assets, JSON, and ZIP |
 | `sessionName` | `string \| function` | Auto-generated | Custom session name |
 | `dryRun` | `boolean` | `false` | Create ZIP without uploading |
 | `verbose` | `boolean` | `false` | Enable debug logging |
+| `showProgress` | `boolean` | `true` | Show real-time test progress in the terminal |
+| `printSteps` | `boolean` | `false` | Print individual test steps (requires `showProgress`) |
+| `showSummaryTable` | `boolean` | `true` | Show per-project breakdown table after the run |
+| `scrubbing` | `object \| false` | See [Secret Scrubbing](#secret-scrubbing) | Configure secret scrubbing for reports and traces |
+| `testCommand` | `string` | Auto-detected | Override the test command shown in the Checkly UI |
 
 **Output files** (written to `outputDir`):
 - `checkly-report.json` - JSON test report
 - `checkly-report.zip` - ZIP archive with report and assets
 
-**Deprecated options** (will be removed in next major version):
-| Option | Migration |
-|--------|-----------|
-| `outputFile` | JSON now at `{outputDir}/checkly-report.json` |
-| `testResultsDir` | Use `outputDir` |
-| `outputPath` | ZIP now at `{outputDir}/checkly-report.zip` |
-
 ## Environment Variables
 
 | Variable | Description |
@@ -109,6 +109,12 @@ createChecklyReporter({
 | `CHECKLY_API_KEY` | Your Checkly API key |
 | `CHECKLY_ACCOUNT_ID` | Your Checkly account ID |
 | `CHECKLY_REPORTER_VERBOSE` | Set to `true` for detailed debug output |
+| `CHECKLY_REPORTER_DRY_RUN` | Set to `true` to skip uploading |
+| `CHECKLY_REPORTER_OUTPUT_DIR` | Override the output directory |
+| `CHECKLY_REPORTER_SHOW_SUMMARY_TABLE` | Set to `false` to hide the summary table |
+| `CHECKLY_TEST_COMMAND` | Override the test command shown in the Checkly UI |
+
+Environment variables take precedence over options passed in the config.
 
 ## What Gets Uploaded
 
@@ -119,6 +125,32 @@ createChecklyReporter({
 - Playwright traces
 - Console logs and network requests (extracted from traces)
 
+## Secret Scrubbing
+
+The reporter automatically scrubs sensitive values from JSON reports, trace files, and logs before upload.
+
+By default, any environment variable whose name starts with `CHECKLY_SECRET_` is scrubbed. You can configure additional scrubbing strategies:
+
+```typescript
+createChecklyReporter({
+  scrubbing: {
+    envVars: ['DB_PASSWORD', 'STRIPE_KEY'],
+    autoDetect: true,
+    prefix: 'CHECKLY_SECRET_',
+    replacement: '[REDACTED]',
+  },
+})
+```
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `envVars` | `string[]` | `[]` | Environment variable names whose runtime values should be scrubbed |
+| `autoDetect` | `boolean` | `false` | Scrub env vars matching common secret patterns (SECRET, KEY, TOKEN, PASSWORD, CREDENTIAL, AUTH, PRIVATE, API) |
+| `prefix` | `string \| false \| null` | `'CHECKLY_SECRET_'` | Scrub all env vars starting with this prefix. Set to `false` or `''` to disable |
+| `replacement` | `string` | `'*********'` | Custom replacement string for scrubbed values |
+
+Set `scrubbing: false` to disable scrubbing entirely.
+
 ## Flaky Test Detection
 
 The reporter automatically detects flaky tests:
@@ -257,6 +289,8 @@ createChecklyReporter({
 createChecklyReporter()  // Reads from environment
 ```
 
+Use the [Secret Scrubbing](#secret-scrubbing) feature to ensure sensitive values don't leak into uploaded reports and traces.
+
 ## Documentation
 
 For detailed documentation, visit [checklyhq.com/docs/detect/testing/playwright-reporter](https://www.checklyhq.com/docs/detect/testing/playwright-reporter/).

package/dist/index.d.ts

@@ -1,16 +1,66 @@
-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';
+import { JSONReport as JSONReport$1, JSONReportSpec as JSONReportSpec$1, JSONReportTestResult as JSONReportTestResult$1, JSONReportTestStep as JSONReportTestStep$1, Reporter } from '@playwright/test/reporter';
+export { JSONReportError, JSONReportSTDIOEntry, JSONReportSuite, JSONReportTest, TestError } from '@playwright/test/reporter';
 
-interface ChecklyStepData {
-    location?: {
-        file: string;
-        line: number;
-        column: number;
+interface JSONReportSpec extends JSONReportSpec$1 {
+    _checkly?: {
+        sourceCode?: string;
+    };
+}
+
+interface ProjectUse {
+    trace?: unknown;
+    video?: unknown;
+    screenshot?: unknown;
+    viewport?: unknown;
+    baseURL?: unknown;
+    browserName?: unknown;
+}
+interface SystemTick {
+    /** Milliseconds since the start of the test run. */
+    time: number;
+    /** CPU usage as a fraction (0 to 1) averaged across all cores. */
+    cpuUsage: number;
+    /** Free system memory in bytes. */
+    memFree: number;
+}
+interface SystemInfo {
+    cpuModel: string;
+    cpuCores: number;
+    memTotal: number;
+    arch: string;
+    platform: string;
+    osRelease: string;
+    nodeVersion: string;
+}
+interface SystemMetrics {
+    info: SystemInfo;
+    ticks: SystemTick[];
+}
+interface JSONReport extends Omit<JSONReport$1, 'config' | 'stats'> {
+    config: Omit<JSONReport$1['config'], 'projects'> & {
+        projects: Array<JSONReport$1['config']['projects'][number] & {
+            use?: ProjectUse;
+        }>;
+    };
+    stats: JSONReport$1['stats'] & {
+        /** Total time during which tests were actively executing, excluding idle gaps. */
+        activeDuration: number;
+        /** System CPU and memory metrics sampled during the test run. */
+        systemMetrics: SystemMetrics;
+    };
+    _checkly?: {
+        sourceFiles?: Record<string, string>;
     };
-    snippet?: string;
 }
 interface JSONReportTestStep extends JSONReportTestStep$1 {
-    _checkly?: ChecklyStepData;
+    _checkly?: {
+        location?: {
+            file: string;
+            line: number;
+            column: number;
+        };
+        snippet?: string;
+    };
     steps?: JSONReportTestStep[];
 }
 interface ConsoleEntryLocation {
@@ -44,12 +94,11 @@ interface NetworkRequest {
     transferBytes: number | null;
     resourceBytes: number | null;
 }
-interface ChecklyData {
-    console?: ConsoleLog[];
-    network?: NetworkRequest[];
-}
 interface JSONReportTestResult extends JSONReportTestResult$1 {
-    _checkly?: ChecklyData;
+    _checkly?: {
+        console?: ConsoleLog[];
+        network?: NetworkRequest[];
+    };
 }
 
 declare class MissingCredentialsError extends Error {
@@ -70,6 +119,11 @@ interface ScrubbingOptions {
      * Matches env vars containing: SECRET, KEY, TOKEN, PASSWORD, CREDENTIAL, AUTH, PRIVATE, API.
      */
     autoDetect?: boolean;
+    /**
+     * Scrub all env vars whose name starts with this prefix.
+     * Defaults to `'CHECKLY_SECRET_'`. Set to `false`, `null`, or `''` to disable.
+     */
+    prefix?: string | false | null;
     /**
      * Custom replacement string for scrubbed values.
      */
@@ -140,4 +194,4 @@ declare const _default: ChecklyReporterClass;
  */
 declare function createChecklyReporter(options?: ChecklyReporterOptions): ['@checkly/playwright-reporter', ChecklyReporterOptions];
 
-export { type ChecklyData, type ChecklyReporterOptions, type ConsoleLog, type JSONReportTestResult, type JSONReportTestStep, MissingCredentialsError, type NetworkRequest, type ScrubbingOptions, createChecklyReporter, _default as default };
+export { type ChecklyReporterOptions, type ConsoleLog, type JSONReport, type JSONReportSpec, type JSONReportTestResult, type JSONReportTestStep, MissingCredentialsError, type NetworkRequest, type ScrubbingOptions, createChecklyReporter, _default as default };