Playwright Reporter Changelog

• Fixed npm install failing with 404 error due to missing dependency.

• 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

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.

• Playwright 1.58 support - Now tested against Playwright 1.58.0.

reporter: [['@checkly/playwright-reporter', { dryRun: true }]]

• Shows both config option and environment variable (e.g., “apiKey / CHECKLY_API_KEY”)
• Includes direct link to API keys settings page
• Invalid API keys display “Authentication failed”
• Wrong account IDs display “Access denied” with guidance

Note: This minor version contains breaking changes. Options API configurations in 1.0.x could lead to broken states, so we published this as a minor version and unpublished previous 1.0.x releases.

• outputFile - Use outputDir instead
• testResultsDir - Use outputDir instead
• outputPath - Use outputDir instead

• outputDir - Directory for all output (JSON report and ZIP assets)
• verbose - Enable debug logging
• apiKey - Checkly API key (or use CHECKLY_API_KEY env var)
• accountId - Checkly account ID (or use CHECKLY_ACCOUNT_ID env var)
• sessionName - Custom session name (string or function)
• dryRun - Generate report without uploading

// playwright.config.ts
export default defineConfig({
  reporter: [
-   ['@checkly/playwright-reporter', {
-     outputFile: 'results/report.json',
-     testResultsDir: 'test-results',
-   }],
+   ['@checkly/playwright-reporter', {
+     outputDir: 'results'
+   }],
  ],
})

• Fixed module loading issues in certain Playwright configurations
• Reduced package size

• Fixed compatibility with Playwright’s TypeScript configuration loading mechanism
• Reporter version now correctly displays in test session summary
• CHECKLY_ACCOUNT_ID environment variable is now properly read for all features

• Test session creation is now properly awaited before uploading results, fixing intermittent upload failures in CI environments
• Sharded test execution now works correctly when using playwright merge-reports command
• Default projects now preserve their empty name correctly
• Output types now re-export from @playwright/test/reporter with Checkly augmentations for _checkly property

• Extension-based architecture - Modular design allows for composable functionality
• Broad Playwright support - Compatible with Playwright versions 1.40 through 1.57+
• Drop-in JSON replacement - Fully compatible with Playwright’s native JSON reporter output format
• Trace extraction - Automatically extracts console messages and network requests from Playwright trace files
• Checkly integration - Automatic upload to Checkly Test Sessions when credentials are configured
• New createChecklyReporter() function - Better IntelliSense support in playwright.config.ts
• Unified outputDir option - Single option for all output files (JSON report, ZIP assets)
• Verbose logging - Debug mode for troubleshooting report generation

// playwright.config.ts
+import { createChecklyReporter } from '@checkly/playwright-reporter'

export default defineConfig({
  reporter: [
-   ['@checkly/playwright-reporter', { outputFile: 'results/report.json' }],
+   createChecklyReporter({ outputDir: 'results' }),
  ],
})