How does Playwright CRX compare to standard Playwright for extension testing?

Playwright CRX is specialized for Chrome Extensions by leveraging chrome.debugger for direct control, whereas standard Playwright focuses on general web automation and might not handle extension contexts seamlessly. It adds tools like the recorder extension but is limited to Chrome.

How to set up the recorder extension in Playwright CRX?

Install it from the Chrome Web Store, then use the action button or context menu to attach tabs. Configure settings like default language and side panel behavior in the options page, and use shortcuts like Alt+Shift+R to start recording scripts directly in the browser.

Can Playwright CRX test Firefox or Edge extensions?

No, Playwright CRX is specifically designed for Chrome Extensions and relies on Chrome's debugger API. For Firefox or Edge extensions, you would need alternative tools or adapt standard Playwright, as this library doesn't support other browsers' extension ecosystems.

What permissions does Playwright CRX require to work?

It requires the debugger permission to use chrome.debugger for automation, which may need user consent and specific manifest entries in your extension. This can be a hurdle in restricted environments or for extensions with strict security policies.

How to debug tests with Playwright Trace Viewer in Playwright CRX?

Use the tracing API in your scripts to start and stop traces, then upload the generated trace.zip to trace.playwright.dev. The example shows capturing data in memfs and uploading it, but note that file paths from memfs aren't directly supported.

Is Playwright CRX suitable for production testing of extensions?

Yes, but with caveats: it's powerful for automation and debugging, but it's specialized and may require careful integration. Since it's not for general end-to-end tests, ensure your use case aligns with extension-specific automation, not broader web app testing.

Playwright CRX — Chrome Extension Automation

What is Playwright CRX?

Playwright CRX is a Chrome Extensions flavor of the Playwright library that enables automation and testing of browser extensions. It leverages Chrome's debugger API to provide Playwright's powerful automation capabilities specifically for extension contexts, allowing developers to script interactions, record tests, and run assertions within extensions.

Target Audience

Developers building or testing Chrome Extensions who want to automate interactions, create end-to-end tests, or integrate with Playwright's ecosystem for reliable extension testing.

Value Proposition

It offers a seamless bridge between Playwright's robust testing framework and Chrome Extensions, providing a dedicated API, recorder tools, and tracing support that are not available in standard Playwright, making extension testing more accessible and integrated.

Overview

Playwright for chrome extensions

Use Cases

Best For

Automating interactions within Chrome Extensions for testing purposes
Recording Playwright scripts directly from browser extensions without external tools
Writing end-to-end tests for Chrome Extensions using Playwright's API
Debugging extension behavior with Playwright Trace Viewer compatibility
Creating custom Chrome Extensions that programmatically control web pages
Integrating extension testing into existing Playwright-based test suites

Not Ideal For

Projects testing web applications without any Chrome Extensions involvement
Teams requiring cross-browser testing for extensions on Firefox or Safari
Developers seeking a simple, general-purpose web automation tool without extension-specific complexities
Environments where Chrome's debugger API is disabled or restricted, such as secure corporate browsers

Pros & Cons

Pros

Chrome Extension Automation

Uses chrome.debugger to implement Playwright's ConnectionTransport, enabling direct control over extensions, as demonstrated in the API example for background service workers automating page interactions.

Integrated Recorder Tool

Provides a Chrome extension for recording Playwright scripts in multiple languages without external dependencies, featuring a side panel, shortcuts like Alt+Shift+R, and configurable options via an options page.

Tracing Compatibility

Supports Playwright Trace Viewer for debugging, allowing traces to be captured and uploaded, as shown in the tracing example with screenshots and snapshots.

Programmatic API

Offers a TypeScript/JavaScript API to create and control extensions programmatically from service workers, useful for automating complex workflows, with examples like todomvc-crx.

Cons

Chrome-Only Limitation

Tied exclusively to Chrome Extensions and the chrome.debugger API, making it unsuitable for testing extensions on other browsers or in non-Chrome environments, which limits cross-browser compatibility.

Not for General E2E

As noted in the README, it's not intended for writing end-to-end tests; users should use @playwright/test instead, indicating it's specialized and not a drop-in replacement for broader testing needs.

Complex Setup and Permissions

Requires understanding of both Playwright and Chrome Extensions development, with dependencies on debugger permissions that might need additional configurations or user consent, adding setup overhead.

Playwright CRX

What is Playwright CRX?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

Playwright CRX

What is Playwright CRX?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?