docs/src/release-notes-js.md
import LiteYouTube from '@site/src/components/LiteYouTube';
New [property: Page.screencast] API provides a unified interface for capturing page content with:
Screencast recording β record video with precise start/stop control, as an alternative to the [option: Browser.newContext.recordVideo] option:
await page.screencast.start({ path: 'video.webm' });
// ... perform actions ...
await page.screencast.stop();
Action annotations β enable built-in visual annotations that highlight interacted elements and display action titles during recording:
await page.screencast.showActions({ position: 'top-right' });
[method: Screencast.showActions] accepts position ('top-left', 'top', 'top-right', 'bottom-left', 'bottom', 'bottom-right'), duration (ms per annotation), and fontSize (px). Returns a disposable to stop showing actions.
Action annotations can also be enabled in test fixtures via the video option:
// playwright.config.ts
export default defineConfig({
use: {
video: {
mode: 'on',
show: {
actions: { position: 'top-left' },
test: { position: 'top-right' },
},
},
},
});
Visual overlays β add chapter titles and custom HTML overlays on top of the page for richer narration:
await page.screencast.showChapter('Adding TODOs', {
description: 'Type and press enter for each TODO',
duration: 1000,
});
await page.screencast.showOverlay('<div style="color: red">Recording</div>');
Real-time frame capture β stream JPEG-encoded frames for custom processing like thumbnails, live previews, AI vision, and more:
await page.screencast.start({
onFrame: ({ data }) => sendToVisionModel(data),
size: { width: 800, height: 600 },
});
Agentic video receipts β coding agents can produce video evidence of their work. After completing a task, an agent can record a walkthrough video with rich annotations for human review:
await page.screencast.start({ path: 'receipt.webm' });
await page.screencast.showActions({ position: 'top-right' });
await page.screencast.showChapter('Verifying checkout flow', {
description: 'Added coupon code support per ticket #1234',
});
// Agent performs the verification steps...
await page.locator('#coupon').fill('SAVE20');
await page.locator('#apply-coupon').click();
await expect(page.locator('.discount')).toContainText('20%');
await page.screencast.showChapter('Done', {
description: 'Coupon applied, discount reflected in total',
});
await page.screencast.stop();
The resulting video serves as a receipt: chapter titles provide context, action annotations highlight each interaction, and the visual walkthrough is faster to review than text logs.
New [method: Browser.bind] API makes a launched browser available for playwright-cli, @playwright/mcp, and other clients to connect to.
Bind a browser β start a browser and bind it so others can connect:
const { endpoint } = await browser.bind('my-session', {
workspaceDir: '/my/project',
});
Connect from playwright-cli β connect to the running browser from your favorite coding agent.
playwright-cli attach my-session
playwright-cli -s my-session snapshot
Connect from @playwright/mcp β or point your MCP server to the running browser.
@playwright/mcp --endpoint=my-session
Connect from a Playwright client β use API to connect to the browser. Multiple clients at a time are supported!
const browser = await chromium.connect(endpoint);
Pass host and port options to bind over WebSocket instead of a named pipe:
const { endpoint } = await browser.bind('my-session', {
host: 'localhost',
port: 0,
});
// endpoint is a ws:// URL
Call [method: Browser.unbind] to stop accepting new connections.
Run playwright-cli show to open the Dashboard that lists all the bound browsers, their statuses, and allows interacting with them:
playwright-cli binds all of its browsers automatically, so you can see what your agents are doing.PLAYWRIGHT_DASHBOARD=1 env variable to see all @playwright/test browsers in the dashboard.Coding agents can now run npx playwright test --debug=cli to attach and debug tests over playwright-cli β perfect for automatically fixing tests in agentic workflows:
$ npx playwright test --debug=cli
### Debugging Instructions
- Run "playwright-cli attach tw-87b59e" to attach to this test
$ playwright-cli attach tw-87b59e
### Session `tw-87b59e` created, attached to `tw-87b59e`.
Run commands with: playwright-cli --session=tw-87b59e <command>
### Paused
- Navigate to "/" at output/tests/example.spec.ts:4
$ playwright-cli --session tw-87b59e step-over
### Page
- Page URL: https://playwright.dev/
- Page Title: Fast and reliable end-to-end testing for modern web apps | Playwright
### Paused
- Expect "toHaveTitle" at output/tests/example.spec.ts:7
Coding agents can run npx playwright trace to explore Playwright Trace and understand failing or flaky tests from the command line:
$ npx playwright trace open test-results/example-has-title-chromium/trace.zip
Title: example.spec.ts:3 βΊ has title
$ npx playwright trace actions --grep="expect"
# Time Action Duration
ββββ βββββββββ βββββββββββββββββββββββββββββββββββββββββββββββββββββββ ββββββββ
9. 0:00.859 Expect "toHaveTitle" 5.1s β
$ npx playwright trace action 9
Expect "toHaveTitle"
Error: expect(page).toHaveTitle(expected) failed
Expected pattern: /Wrong Title/
Received string: "Fast and reliable end-to-end testing for modern web apps | Playwright"
Timeout: 5000ms
Snapshots
available: before, after
usage: npx playwright trace snapshot 9 --name <before|after>
$ npx playwright trace snapshot 9 --name after
### Page
- Page Title: Fast and reliable end-to-end testing for modern web apps | Playwright
$ npx playwright trace close
await usingMany APIs now return async disposables, enabling the await using syntax for automatic cleanup:
await using page = await context.newPage();
{
await using route = await page.route('**/*', route => route.continue());
await using script = await page.addInitScript('console.log("init script here")');
await page.goto('https://playwright.dev');
// do something
}
// route and init script have been removed at this point
method: Page.ariaSnapshot] to capture the aria snapshot of the page β equivalent to page.locator('body').ariaSnapshot().depth and mode in [method: Locator.ariaSnapshot].method: Locator.normalize] converts a locator to follow best practices like test ids and aria roles.method: Page.pickLocator] enters an interactive mode where hovering over elements highlights them and shows the corresponding locator. Click an element to get its [Locator] back. Use [method: Page.cancelPickLocator] to cancel.property: Page.screencast] provides video recording, real-time frame streaming, and overlay management.method: Screencast.start] and [method: Screencast.stop] for recording and frame capture.method: Screencast.showActions] and [method: Screencast.hideActions] for action annotations.method: Screencast.showChapter] and [method: Screencast.showOverlay] for visual overlays.method: Screencast.showOverlays] and [method: Screencast.hideOverlays] for overlay visibility control.method: BrowserContext.setStorageState] clears existing cookies, local storage, and IndexedDB for all origins and sets a new storage state β no need to create a new context.method: Page.clearConsoleMessages] and [method: Page.clearPageErrors] to clear stored messages and errors.filter in [method: Page.consoleMessages] and [method: Page.pageErrors] controls which messages are returned.method: ConsoleMessage.timestamp].property: BrowserContext.debugger] provides programmatic control over the Playwright debugger.method: BrowserContext.isClosed].method: Request.existingResponse] returns the response without waiting.method: Response.httpVersion] returns the HTTP version used by the response.event: CDPSession.event] and [event: CDPSession.close] for CDP sessions.live in [method: Tracing.start] for real-time trace updates.artifactsDir in [method: BrowserType.launch] to configure the artifacts directory.'retain-on-failure-and-retries' records a trace for each test run and retains all traces when an attempt fails β great for comparing a passing trace with a failing one from a flaky test.@playwright/experimental-ct-svelte package.This version was also tested against the following stable channels:
If you're using merged reports, the HTML report Speedboard tab now shows the Timeline:
Thanks to @cpAdm for contributing these improvements!
[method: BrowserType.connectOverCDP] now accepts an isLocal option. When set to true, it tells Playwright that it runs on the same host as the CDP server, enabling file system optimizations.
Removed _react and _vue selectors. See locators guide for alternatives.
Removed :light selector engine suffix. Use standard CSS selectors instead.
Option devtools from [method: BrowserType.launch] has been removed. Use args: ['--auto-open-devtools-for-tabs'] instead.
Removed macOS 13 support for WebKit. We recommend to upgrade your macOS version, or keep using an older Playwright version.
This version was also tested against the following stable channels:
In HTML reporter, there's a new tab we call "Speedboard":
It shows you all your executed tests sorted by slowness, and can help you understand where your test suite is taking longer than expected. Take a look at yours - maybe you'll find some tests that are spending a longer time waiting than they should!
Playwright now runs on Chrome for Testing builds rather than Chromium. Headed mode uses chrome; headless mode uses chrome-headless-shell. Existing tests should continue to pass after upgrading to v1.57.
We're expecting no functional changes to come from this switch. The biggest change is the new icon and title in your toolbar.
If you still see an unexpected behaviour change, please file an issue.
On Arm64 Linux, Playwright continues to use Chromium.
[property: TestConfig.webServer] added a wait field. Pass a regular expression, and Playwright will wait until the webserver logs match it.
import { defineConfig } from '@playwright/test';
export default defineConfig({
webServer: {
command: 'npm run start',
wait: {
stdout: /Listening on port (?<my_server_port>\d+)/
},
},
});
If you include a named capture group into the expression, then Playwright will provide the capture group contents via environment variables:
import { test, expect } from '@playwright/test';
test.use({ baseURL: `http://localhost:${process.env.MY_SERVER_PORT ?? 3000}` });
test('homepage', async ({ page }) => {
await page.goto('/');
});
This is not just useful for capturing varying ports of dev servers. You can also use it to wait for readiness of a service that doesn't expose an HTTP readiness check, but instead prints a readiness message to stdout or stderr.
After 3 years of being deprecated, we removed page.accessibility from our API. Please use other libraries such as Axe if you need to test page accessibility. See our Node.js guide for integration with Axe.
property: TestConfig.tag] adds a tag to all tests in this run. This is useful when using merge-reports.event: Worker.console] event is emitted when JavaScript within the worker calls one of console API methods, e.g. console.log or console.dir. [method: Worker.waitForEvent] can be used to wait for it.method: Locator.description] returns locator description previously set with [method: Locator.describe], and [method: Locator.toString] now uses the description when available.option: Locator.click.steps] in [method: Locator.click] and [method: Locator.dragTo] that configures the number of mousemove events emitted while moving the mouse pointer to the target element.PLAYWRIGHT_DISABLE_SERVICE_WORKER_NETWORK environment variable.event: Worker.console]. You can opt out of this using the PLAYWRIGHT_DISABLE_SERVICE_WORKER_CONSOLE environment variable.<LiteYouTube id="_AifxZGxwuk" title="Playwright 1.56 - Introducing Playwright Test Agents" />
Introducing Playwright Test Agents, three custom agent definitions designed to guide LLMs through the core process of building a Playwright test:
π planner explores the app and produces a Markdown test plan
π generator transforms the Markdown plan into the Playwright Test files
π healer executes the test suite and automatically repairs failing tests
Run npx playwright init-agents with your client of choice to generate the latest agent definitions:
# Generate agent files for each agentic loop
# Visual Studio Code
npx playwright init-agents --loop=vscode
# Claude Code
npx playwright init-agents --loop=claude
# opencode
npx playwright init-agents --loop=opencode
Learn more about Playwright Test Agents
method: Page.consoleMessages] and [method: Page.pageErrors] for retrieving the most recent console messages from the pagemethod: Page.requests] for retrieving the most recent network requests from the page--test-list and --test-list-invert to allow manual specification of specific tests from a file'html' reporter to disable the "Copy prompt" button'html' reporter and UI Mode to merge files, collapsing test and describe blocks into a single unified list--update-snapshots optionsevent: BrowserContext.backgroundPage] has been deprecated and will not be emitted. Method [method: BrowserContext.backgroundPages] will return an empty listinput placeholderPLAYWRIGHT_TEST to Playwright worker processes to allow discriminating on testing statusproperty: TestStepInfo.titlePath] Returns the full title path starting from the test file, including test and step titles.toBeVisible() assertions: Codegen can now generate automatic toBeVisible() assertions for common UI interactions. This feature can be enabled in the Codegen settings UI.This version was also tested against the following stable channels:
New cookie property partitionKey in [method: BrowserContext.cookies] and [method: BrowserContext.addCookies]. This property allows to save and restore partitioned cookies. See CHIPS MDN article for more information. Note that browsers have different support and defaults for cookie partitioning.
New option noSnippets to disable code snippets in the html report.
import { defineConfig } from '@playwright/test';
export default defineConfig({
reporter: [['html', { noSnippets: true }]]
});
New property location in test annotations, for example in [property: TestResult.annotations] and [property: TestInfo.annotations]. It shows where the annotation like test.skip or test.fixme was added.
New option --user-data-dir in multiple commands. You can specify the same user data dir to reuse browsing state, like authentication, between sessions.
npx playwright codegen --user-data-dir=./user-data
Option -gv has been removed from the npx playwright test command. Use --grep-invert instead.
npx playwright open does not open the test recorder anymore. Use npx playwright codegen instead.
Support for Node.js 16 has been removed.
Support for Node.js 18 has been deprecated, and will be removed in the future.
This version was also tested against the following stable channels:
New Steps in Trace Viewer and HTML reporter:
New option in 'html' reporter to set the title of a specific test run:
import { defineConfig } from '@playwright/test';
export default defineConfig({
reporter: [['html', { title: 'Custom test run #1028' }]]
});
option: TestInfo.snapshotPath.kind] in [method: TestInfo.snapshotPath] controls which snapshot path template is used.method: Locator.describe] to describe a locator. Used for trace viewer and reports.
const button = page.getByTestId('btn-sub').describe('Subscribe button');
await button.click();
npx playwright install --list will now list all installed browsers, versions and locations.This version was also tested against the following stable channels:
New method [method: LocatorAssertions.toContainClass] to ergonomically assert individual class names on the element.
await expect(page.getByRole('listitem', { name: 'Ship v1.52' })).toContainClass('done');
Aria Snapshots got two new properties: /children for strict matching and /url for links.
await expect(locator).toMatchAriaSnapshot(`
- list
- /children: equal
- listitem: Feature A
- listitem:
- link "Feature B":
- /url: "https://playwright.dev"
`);
property: TestProject.workers] allows to specify the number of concurrent worker processes to use for a test project. The global limit of property [property: TestConfig.workers] still applies.property: TestConfig.failOnFlakyTests] option to fail the test run if any flaky tests are detected, similarly to --fail-on-flaky-tests. This is useful for CI/CD environments where you want to ensure that all tests are stable before deploying.property: TestResult.annotations] contains annotations for each test retry.option: APIRequest.newContext.maxRedirects] in [method: APIRequest.newContext] to control the maximum number of redirects.!@my-tag or !my-file.spec.ts or !p:my-project.method: Page.route] do not support ? and [] anymore. We recommend using regular expressions instead.method: Route.continue] does not allow to override the Cookie header anymore. If a Cookie header is provided, it will be ignored, and the cookie will be loaded from the browser's cookie store. To set custom cookies, use [method: BrowserContext.addCookies].This version was also tested against the following stable channels:
New option [option: BrowserContext.storageState.indexedDB] for [method: BrowserContext.storageState] allows to save and restore IndexedDB contents. Useful when your application uses IndexedDB API to store authentication tokens, like Firebase Authentication.
Here is an example following the authentication guide:
import { test as setup, expect } from '@playwright/test';
import path from 'path';
const authFile = path.join(__dirname, '../playwright/.auth/user.json');
setup('authenticate', async ({ page }) => {
await page.goto('/');
// ... perform authentication steps ...
// make sure to save indexedDB
await page.context().storageState({ path: authFile, indexedDB: true });
});
New "Copy prompt" button on errors in the HTML report, trace viewer and UI mode. Click to copy a pre-filled LLM prompt that contains the error message and useful context for fixing the error.
New option [option: Locator.filter.visible] for [method: Locator.filter] allows matching only visible elements.
test('some test', async ({ page }) => {
// Ignore invisible todo items.
const todoItems = page.getByTestId('todo-item').filter({ visible: true });
// Check there are exactly 3 visible ones.
await expect(todoItems).toHaveCount(3);
});
Set option [property: TestConfig.captureGitInfo] to capture git information into [property: TestConfig.metadata].
import { defineConfig } from '@playwright/test';
export default defineConfig({
captureGitInfo: { commit: true, diff: true }
});
HTML report will show this information when available:
A new [TestStepInfo] object is now available in test steps. You can add step attachments or skip the step under some conditions.
test('some test', async ({ page, isMobile }) => {
// Note the new "step" argument:
await test.step('here is my step', async step => {
step.skip(isMobile, 'not relevant on mobile layouts');
// ...
await step.attach('my attachment', { body: 'some text' });
// ...
});
});
contrast for methods [method: Page.emulateMedia] and [method: Browser.newContext] allows to emulate the prefers-contrast media feature.option: APIRequest.newContext.failOnStatusCode] makes all fetch requests made through the [APIRequestContext] throw on response codes other than 2xx and 3xx.method: PageAssertions.toHaveURL] now supports a predicate.This version was also tested against the following stable channels:
New option [option: Test.step.timeout] allows specifying a maximum run time for an individual test step. A timed-out step will fail the execution of the test.
test('some test', async ({ page }) => {
await test.step('a step', async () => {
// This step can time out separately from the test
}, { timeout: 1000 });
});
New method [method: Test.step.skip] to disable execution of a test step.
test('some test', async ({ page }) => {
await test.step('before running step', async () => {
// Normal step
});
await test.step.skip('not yet ready', async () => {
// This step is skipped
});
await test.step('after running step', async () => {
// This step still runs even though the previous one was skipped
});
});
Expanded [method: LocatorAssertions.toMatchAriaSnapshot#2] to allow storing of aria snapshots in separate YAML files.
Added method [method: LocatorAssertions.toHaveAccessibleErrorMessage] to assert the Locator points to an element with a given aria errormessage.
Option [property: TestConfig.updateSnapshots] added the configuration enum changed. changed updates only the snapshots that have changed, whereas all now updates all snapshots, regardless of whether there are any differences.
New option [property: TestConfig.updateSourceMethod] defines the way source code is updated when [property: TestConfig.updateSnapshots] is configured. Added overwrite and 3-way modes that write the changes into source code, on top of existing patch mode that creates a patch file.
npx playwright test --update-snapshots=changed --update-source-method=3way
Option [property: TestConfig.webServer] added a gracefulShutdown field for specifying a process kill signal other than the default SIGKILL.
Exposed [property: TestStep.attachments] from the reporter API to allow retrieval of all attachments created by that step.
New option pathTemplate for toHaveScreenshot and toMatchAriaSnapshot assertions in the [property: TestConfig.expect] configuration.
canvas content in traces is error-prone. Display is now disabled by default, and can be enabled via the Display canvas content UI setting.Call and Network panels now display additional time information.method: LocatorAssertions.toBeEditable] and [method: Locator.isEditable] now throw if the target element is not <input>, <select>, or a number of other editable elements.property: TestConfig.updateSnapshots] now updates all snapshots when set to all, rather than only the failed/changed snapshots. Use the new enum changed to keep the old functionality of only updating the changed snapshots.This version was also tested against the following stable channels:
<LiteYouTube id="S5wCft-ImKk" title="Playwright 1.49" />
New assertion [method: LocatorAssertions.toMatchAriaSnapshot] verifies page structure by comparing to an expected accessibility tree, represented as YAML.
await page.goto('https://playwright.dev');
await expect(page.locator('body')).toMatchAriaSnapshot(`
- banner:
- heading /Playwright enables reliable/ [level=1]
- link "Get started"
- link "Star microsoft/playwright on GitHub"
- main:
- img "Browsers (Chromium, Firefox, WebKit)"
- heading "Any browser β’ Any platform β’ One API"
`);
You can generate this assertion with Test Generator and update the expected snapshot with --update-snapshots command line flag.
Learn more in the aria snapshots guide.
property: TestConfig.tsconfig] allows to specify a single tsconfig to be used for all tests.method: Test.fail.only] to focus on a failing test.property: TestConfig.globalSetup] and [property: TestConfig.globalTeardown] now support multiple setups/teardowns.'on-first-failure' for [property: TestOptions.screenshot].property: TestInfoError.cause] and [property: TestError.cause] mirroring Error.cause.chrome and msedge channels switch to new headless modeThis change affects you if you're using one of the following channels in your playwright.config.ts:
chrome, chrome-dev, chrome-beta, or chrome-canarymsedge, msedge-dev, msedge-beta, or msedge-canaryAfter updating to Playwright v1.49, run your test suite. If it still passes, you're good to go. If not, you will probably need to update your snapshots, and adapt some of your test code around PDF viewers and extensions. See issue #33566 for more details.
@playwright/experimental-ct-vue2 will no longer be updated.@playwright/experimental-ct-solid will no longer be updated.You can opt into the new headless mode by using 'chromium' channel. As official Chrome documentation puts it:
New Headless on the other hand is the real Chrome browser, and is thus more authentic, reliable, and offers more features. This makes it more suitable for high-accuracy end-to-end web app testing or browser extension testing.
See issue #33566 for the list of possible breakages you could encounter and more details on Chromium headless. Please file an issue if you see any problems after opting in.
import { defineConfig, devices } from '@playwright/test';
export default defineConfig({
projects: [
{
name: 'chromium',
use: { ...devices['Desktop Chrome'], channel: 'chromium' },
},
],
});
<canvas> elements inside a snapshot now draw a preview.method: Tracing.group] to visually group actions in the trace.This version was also tested against the following stable channels:
<LiteYouTube id="VGlkSBkMVCQ" title="Playwright 1.48" />
New methods [method: Page.routeWebSocket] and [method: BrowserContext.routeWebSocket] allow to intercept, modify and mock WebSocket connections initiated in the page. Below is a simple example that mocks WebSocket communication by responding to a "request" with a "response".
await page.routeWebSocket('/ws', ws => {
ws.onMessage(message => {
if (message === 'request')
ws.send('response');
});
});
See [WebSocketRoute] for more details.
method: Route.fulfill] are not shown in the report and trace viewer anymore. You can see which network requests were routed in the network tab instead.option: APIRequestContext.fetch.form] and similar ones now accept FormData.method: Page.requestGC] may help detect memory leaks.option: Test.step.location] to pass custom step location.This version was also tested against the following stable channels:
The Network tab in the UI mode and trace viewer has several nice improvements:
--tsconfig CLI optionBy default, Playwright will look up the closest tsconfig for each imported file using a heuristic. You can now specify a single tsconfig file in the command line, and Playwright will use it for all imported files, not only test files:
# Pass a specific tsconfig
npx playwright test --tsconfig tsconfig.test.json
URLSearchParams and string as query parametersYou can now pass URLSearchParams and string as query parameters to [APIRequestContext]:
test('query params', async ({ request }) => {
const searchParams = new URLSearchParams();
searchParams.set('userId', 1);
const response = await request.get(
'https://jsonplaceholder.typicode.com/posts',
{
params: searchParams // or as a string: 'userId=1'
}
);
// ...
});
mcr.microsoft.com/playwright:v1.47.0 now serves a Playwright image based on Ubuntu 24.04 Noble.
To use the 22.04 jammy-based image, please use mcr.microsoft.com/playwright:v1.47.0-jammy instead.option: Page.removeAllListeners.behavior], [option: Browser.removeAllListeners.behavior] and [option: BrowserContext.removeAllListeners.behavior] to wait for ongoing listeners to complete.option: Browser.newContext.clientCertificates.cert] and [option: Browser.newContext.clientCertificates.key] as buffers instead of file paths.text/html content type can now be opened in a new tab in the HTML report. This is useful for including third-party reports or other HTML content in the Playwright test report and distributing it to your team.option: Locator.selectOption.noWaitAfter] option in [method: Locator.selectOption] was deprecated.macos-13. We recommend upgrading GitHub Actions to macos-14.This version was also tested against the following stable channels:
<LiteYouTube id="tQo7w-QQBsI" title="Playwright 1.46" />
Playwright now allows you to supply client-side certificates, so that server can verify them, as specified by TLS Client Authentication.
The following snippet sets up a client certificate for https://example.com:
import { defineConfig } from '@playwright/test';
export default defineConfig({
// ...
use: {
clientCertificates: [{
origin: 'https://example.com',
certPath: './cert.pem',
keyPath: './key.pem',
passphrase: 'mysecretpassword',
}],
},
// ...
});
You can also provide client certificates to a particular test project or as a parameter of [method: Browser.newContext] and [method: APIRequest.newContext].
--only-changed cli optionNew CLI option --only-changed will only run test files that have been changed since the last git commit or from a specific git "ref". This will also run all test files that import any changed files.
# Only run test files with uncommitted changes
npx playwright test --only-changed
# Only run test files changed relative to the "main" branch
npx playwright test --only-changed=main
router fixtureThis release introduces an experimental router fixture to intercept and handle network requests in component testing.
There are two ways to use the router fixture:
router.route(url, handler) that behaves similarly to [method: Page.route].router.use(handlers) and pass MSW library request handlers to it.Here is an example of reusing your existing MSW handlers in the test.
import { handlers } from '@src/mocks/handlers';
test.beforeEach(async ({ router }) => {
// install common handlers before each test
await router.use(...handlers);
});
test('example test', async ({ mount }) => {
// test as usual, your handlers are active
// ...
});
This fixture is only available in component tests.
method: Route.continue].baseURL.maxRetries option in [method: APIRequestContext.fetch] which retries on the ECONNRESET network error.This version was also tested against the following stable channels:
<LiteYouTube id="54_aC-rVKHg" title="Playwright 1.45" />
Utilizing the new [Clock] API allows to manipulate and control time within tests to verify time-related behavior. This API covers many common scenarios, including:
// Initialize clock and let the page load naturally.
await page.clock.install({ time: new Date('2024-02-02T08:00:00') });
await page.goto('http://localhost:3333');
// Pretend that the user closed the laptop lid and opened it again at 10am,
// Pause the time once reached that point.
await page.clock.pauseAt(new Date('2024-02-02T10:00:00'));
// Assert the page state.
await expect(page.getByTestId('current-time')).toHaveText('2/2/2024, 10:00:00 AM');
// Close the laptop lid again and open it at 10:30am.
await page.clock.fastForward('30:00');
await expect(page.getByTestId('current-time')).toHaveText('2/2/2024, 10:30:00 AM');
See the clock guide for more details.
New CLI option --fail-on-flaky-tests that sets exit code to 1 upon any flaky tests. Note that by default, the test runner exits with code 0 when all failed tests recovered upon a retry. With this option, the test run will fail in such case.
New environment variable PLAYWRIGHT_FORCE_TTY controls whether built-in list, line and dot reporters assume a live terminal. For example, this could be useful to disable tty behavior when your CI environment does not handle ANSI control sequences well. Alternatively, you can enable tty behavior even when to live terminal is present, if you plan to post-process the output and handle control sequences.
# Avoid TTY features that output ANSI control sequences
PLAYWRIGHT_FORCE_TTY=0 npx playwright test
# Enable TTY features, assuming a terminal width 80
PLAYWRIGHT_FORCE_TTY=80 npx playwright test
New options [property: TestConfig.respectGitIgnore] and [property: TestProject.respectGitIgnore] control whether files matching .gitignore patterns are excluded when searching for tests.
New property timeout is now available for custom expect matchers. This property takes into account playwright.config.ts and expect.configure().
import { expect as baseExpect } from '@playwright/test';
export const expect = baseExpect.extend({
async toHaveAmount(locator: Locator, expected: number, options?: { timeout?: number }) {
// When no timeout option is specified, use the config timeout.
const timeout = options?.timeout ?? this.timeout;
// ... implement the assertion ...
},
});
Method [method: Locator.setInputFiles] now supports uploading a directory for <input type=file webkitdirectory> elements.
await page.getByLabel('Upload directory').setInputFiles(path.join(__dirname, 'mydir'));
Multiple methods like [method: Locator.click] or [method: Locator.press] now support a ControlOrMeta modifier key. This key maps to Meta on macOS and maps to Control on Windows and Linux.
// Press the common keyboard shortcut Control+S or Meta+S to trigger a "Save" operation.
await page.keyboard.press('ControlOrMeta+S');
New property httpCredentials.send in [method: APIRequest.newContext] that allows to either always send the Authorization header or only send it in response to 401 Unauthorized.
New option reason in [method: APIRequestContext.dispose] that will be included in the error message of ongoing operations interrupted by the context disposal.
New option host in [method: BrowserType.launchServer] allows to accept websocket connections on a specific address instead of unspecified 0.0.0.0.
Playwright now supports Chromium, Firefox and WebKit on Ubuntu 24.04.
v1.45 is the last release to receive WebKit update for macOS 12 Monterey. Please update macOS to keep using the latest WebKit.
This version was also tested against the following stable channels:
<LiteYouTube id="avjSahFWdCI" title="Playwright 1.44" />
Accessibility assertions
[method: LocatorAssertions.toHaveAccessibleName] checks if the element has the specified accessible name:
const locator = page.getByRole('button');
await expect(locator).toHaveAccessibleName('Submit');
[method: LocatorAssertions.toHaveAccessibleDescription] checks if the element has the specified accessible description:
const locator = page.getByRole('button');
await expect(locator).toHaveAccessibleDescription('Upload a photo');
[method: LocatorAssertions.toHaveRole] checks if the element has the specified ARIA role:
const locator = page.getByTestId('save-button');
await expect(locator).toHaveRole('button');
Locator handler
method: Page.addLocatorHandler], Playwright will now wait until the overlay that triggered the handler is not visible anymore. You can opt-out of this behavior with the new noWaitAfter option.times option in [method: Page.addLocatorHandler] to specify maximum number of times the handler should be run.method: Page.addLocatorHandler] now accepts the locator as argument.method: Page.removeLocatorHandler] method for removing previously added locator handlers.const locator = page.getByText('This interstitial covers the button');
await page.addLocatorHandler(locator, async overlay => {
await overlay.locator('#close').click();
}, { times: 3, noWaitAfter: true });
// Run your tests that can be interrupted by the overlay.
// ...
await page.removeLocatorHandler(locator);
Miscellaneous options
multipart option in apiRequestContext.fetch() now accepts FormData and supports repeating fields with the same name.
const formData = new FormData();
formData.append('file', new File(['let x = 2024;'], 'f1.js', { type: 'text/javascript' }));
formData.append('file', new File(['hello'], 'f2.txt', { type: 'text/plain' }));
context.request.post('https://example.com/uploadFiles', {
multipart: formData
});
expect(callback).toPass({ intervals }) can now be configured by expect.toPass.intervals option globally in [property: TestConfig.expect] or per project in [property: TestProject.expect].
expect(page).toHaveURL(url) now supports ignoreCase option.
property: TestProject.ignoreSnapshots allows to configure per project whether to skip screenshot expectations.
Reporter API
method: Suite.entries] returns child test suites and test cases in their declaration order. [property: Suite.type] and [property: TestCase.type] can be used to tell apart test cases and suites in the list.outputFile. The same option can also be specified as PLAYWRIGHT_BLOB_OUTPUT_FILE environment variable that might be more convenient on CI/CD.includeProjectInTestName option.Command line
--last-failed CLI option to for running only tests that failed in the previous run.
First run all tests:
$ npx playwright test
Running 103 tests using 5 workers
...
2 failed
[chromium] βΊ my-test.spec.ts:8:5 βΊ two βββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
[chromium] βΊ my-test.spec.ts:13:5 βΊ three ββββββββββββββββββββββββββββββββββββββββββββββββββββββ
101 passed (30.0s)
Now fix the failing tests and run Playwright again with --last-failed option:
$ npx playwright test --last-failed
Running 2 tests using 2 workers
2 passed (1.2s)
This version was also tested against the following stable channels:
Method [method: BrowserContext.clearCookies] now supports filters to remove only some cookies.
// Clear all cookies.
await context.clearCookies();
// New: clear cookies with a particular name.
await context.clearCookies({ name: 'session-id' });
// New: clear cookies for a particular domain.
await context.clearCookies({ domain: 'my-origin.com' });
New mode retain-on-first-failure for [property: TestOptions.trace]. In this mode, trace is recorded for the first run of each test, but not for retires. When test run fails, the trace file is retained, otherwise it is removed.
import { defineConfig } from '@playwright/test';
export default defineConfig({
use: {
trace: 'retain-on-first-failure',
},
});
New property [property: TestInfo.tags] exposes test tags during test execution.
test('example', async ({ page }) => {
console.log(test.info().tags);
});
New method [method: Locator.contentFrame] converts a [Locator] object to a [FrameLocator]. This can be useful when you have a [Locator] object obtained somewhere, and later on would like to interact with the content inside the frame.
const locator = page.locator('iframe[name="embedded"]');
// ...
const frameLocator = locator.contentFrame();
await frameLocator.getByRole('button').click();
New method [method: FrameLocator.owner] converts a [FrameLocator] object to a [Locator]. This can be useful when you have a [FrameLocator] object obtained somewhere, and later on would like to interact with the iframe element.
const frameLocator = page.frameLocator('iframe[name="embedded"]');
// ...
const locator = frameLocator.owner();
await expect(locator).toBeVisible();
@fast or clicking on the tag itself.This version was also tested against the following stable channels:
<LiteYouTube id="KjSaIQLlgns" title="Playwright 1.41 & 1.42" />
method: Page.addLocatorHandler] registers a callback that will be invoked when specified element becomes visible and may block Playwright actions. The callback can get rid of the overlay. Here is an example that closes a cookie dialog when it appears:// Setup the handler.
await page.addLocatorHandler(
page.getByRole('heading', { name: 'Hej! You are in control of your cookies.' }),
async () => {
await page.getByRole('button', { name: 'Accept all' }).click();
});
// Write the test as usual.
await page.goto('https://www.ikea.com/');
await page.getByRole('link', { name: 'Collection of blue and white' }).click();
await expect(page.getByRole('heading', { name: 'Light and easy' })).toBeVisible();
expect(callback).toPass() timeout can now be configured by expect.toPass.timeout option globally or in project config
[event: ElectronApplication.console] event is emitted when Electron main process calls console API methods.
electronApp.on('console', async msg => {
const values = [];
for (const arg of msg.args())
values.push(await arg.jsonValue());
console.log(...values);
});
await electronApp.evaluate(() => console.log('hello', 5, { foo: 'bar' }));
test('test customer login', {
tag: ['@fast', '@login'],
}, async ({ page }) => {
// ...
});
Use --grep command line option to run only tests with certain tags.
npx playwright test --grep @fast
--project command line flag now supports '*' wildcard:npx playwright test --project='*mobile*'
test('test full report', {
annotation: [
{ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/23180' },
{ type: 'docs', description: 'https://playwright.dev/docs/test-annotations#tag-tests' },
],
}, async ({ page }) => {
// ...
});
This version was also tested against the following stable channels:
method: Page.unrouteAll] removes all routes registered by [method: Page.route] and [method: Page.routeFromHAR]. Optionally allows to wait for ongoing routes to finish, or ignore any errors from them.method: BrowserContext.unrouteAll] removes all routes registered by [method: BrowserContext.route] and [method: BrowserContext.routeFromHAR]. Optionally allows to wait for ongoing routes to finish, or ignore any errors from them.option: Page.screenshot.style] in [method: Page.screenshot] and [option: Locator.screenshot.style] in [method: Locator.screenshot] to add custom CSS to the page before taking a screenshot.stylePath for methods [method: PageAssertions.toHaveScreenshot#1] and [method: LocatorAssertions.toHaveScreenshot#1] to apply a custom stylesheet while making the screenshot.fileName option for Blob reporter, to specify the name of the report to be created.This version was also tested against the following stable channels:
<LiteYouTube id="mn892dV81_8" title="Playwright 1.40" />
New tools to generate assertions:
method: LocatorAssertions.toBeVisible].method: LocatorAssertions.toHaveValue].method: LocatorAssertions.toContainText].Here is an example of a generated test with assertions:
import { test, expect } from '@playwright/test';
test('test', async ({ page }) => {
await page.goto('https://playwright.dev/');
await page.getByRole('link', { name: 'Get started' }).click();
await expect(page.getByLabel('Breadcrumbs').getByRole('list')).toContainText('Installation');
await expect(page.getByLabel('Search')).toBeVisible();
await page.getByLabel('Search').click();
await page.getByPlaceholder('Search docs').fill('locator');
await expect(page.getByPlaceholder('Search docs')).toHaveValue('locator');
});
option: Page.close.reason] in [method: Page.close], [option: BrowserContext.close.reason] in [method: BrowserContext.close] and [option: Browser.close.reason] in [method: Browser.close]. Close reason is reported for all operations interrupted by the closure.option: BrowserType.launchPersistentContext.firefoxUserPrefs] in [method: BrowserType.launchPersistentContext].method: Download.path] and [method: Download.createReadStream] throw an error for failed and cancelled downloads.This version was also tested against the following stable channels:
<LiteYouTube id="KqVuRAlOkm0" title="Playwright 1.39" />
You can extend Playwright assertions by providing custom matchers. These matchers will be available on the expect object.
import { expect as baseExpect } from '@playwright/test';
export const expect = baseExpect.extend({
async toHaveAmount(locator: Locator, expected: number, options?: { timeout?: number }) {
// ... see documentation for how to write matchers.
},
});
test('pass', async ({ page }) => {
await expect(page.getByTestId('cart')).toHaveAmount(5);
});
See the documentation for a full example.
You can now merge test fixtures from multiple files or modules:
import { mergeTests } from '@playwright/test';
import { test as dbTest } from 'database-test-utils';
import { test as a11yTest } from 'a11y-test-utils';
export const test = mergeTests(dbTest, a11yTest);
import { test } from './fixtures';
test('passes', async ({ database, page, a11y }) => {
// use database and a11y fixtures.
});
You can now merge custom expect matchers from multiple files or modules:
import { mergeTests, mergeExpects } from '@playwright/test';
import { test as dbTest, expect as dbExpect } from 'database-test-utils';
import { test as a11yTest, expect as a11yExpect } from 'a11y-test-utils';
export const test = mergeTests(dbTest, a11yTest);
export const expect = mergeExpects(dbExpect, a11yExpect);
import { test, expect } from './fixtures';
test('passes', async ({ page, database }) => {
await expect(database).toHaveDatabaseUser('admin');
await expect(page).toPassA11yAudit();
});
You can mark a [method: Test.step] as "boxed" so that errors inside it point to the step call site.
async function login(page) {
await test.step('login', async () => {
// ...
}, { box: true }); // Note the "box" option here.
}
Error: Timed out 5000ms waiting for expect(locator).toBeVisible()
... error details omitted ...
14 | await page.goto('https://github.com/login');
> 15 | await login(page);
| ^
16 | });
See [method: Test.step] documentation for a full example.
method: LocatorAssertions.toHaveAttribute#2]This version was also tested against the following stable channels:
<LiteYouTube id="YGJTeXaZDTM" title="Playwright 1.38" />
event: BrowserContext.webError]method: Locator.pressSequentially]method: Reporter.onEnd] now reports startTime and total run duration.method: Page.type], [method: Frame.type],
[method: Locator.type] and [method: ElementHandle.type].
Please use [method: Locator.fill] instead which is much faster. Use
[method: Locator.pressSequentially] only if there is a special keyboard
handling on the page, and you need to press keys one-by-one.Note: If you are using
@playwright/testpackage, this change does not affect you.
Playwright recommends to use @playwright/test package and download browsers via npx playwright install command. If you are following this recommendation, nothing has changed for you.
However, up to v1.38, installing the playwright package instead of @playwright/test did automatically download browsers. This is no longer the case, and we recommend to explicitly download browsers via npx playwright install command.
v1.37 and earlier
playwright package was downloading browsers during npm install, while @playwright/test was not.
v1.38 and later
playwright and @playwright/test packages do not download browsers during npm install.
Recommended migration
Run npx playwright install to download browsers after npm install. For example, in your CI configuration:
- run: npm ci
- run: npx playwright install --with-deps
Alternative migration option - not recommended
Add @playwright/browser-chromium, @playwright/browser-firefox and @playwright/browser-webkit as a dependency. These packages download respective browsers during npm install. Make sure you keep the version of all playwright packages in sync:
// package.json
{
"devDependencies": {
"playwright": "1.38.0",
"@playwright/browser-chromium": "1.38.0",
"@playwright/browser-firefox": "1.38.0",
"@playwright/browser-webkit": "1.38.0"
}
}
This version was also tested against the following stable channels:
<LiteYouTube id="cEd4SH_Xf5U" title="Playwright 1.36 & 1.37" />
npx playwright merge-reports toolIf you run tests on multiple shards, you can now merge all reports in a single HTML report (or any other report)
using the new merge-reports CLI tool.
Using merge-reports tool requires the following steps:
export default defineConfig({
testDir: './tests',
reporter: process.env.CI ? 'blob' : 'html',
});
The "blob" reporter will produce ".zip" files that contain all the information about the test run.
npx playwright merge-reports:npx playwright merge-reports --reporter html ./all-blob-reports
Read more in our documentation.
Playwright now supports Debian 12 Bookworm on both x86_64 and arm64 for Chromium, Firefox and WebKit. Let us know if you encounter any issues!
Linux support looks like this:
| Ubuntu 20.04 | Ubuntu 22.04 | Debian 11 | Debian 12 | |
|---|---|---|---|---|
| Chromium | β | β | β | β |
| WebKit | β | β | β | β |
| Firefox | β | β | β | β |
This version was also tested against the following stable channels:
ποΈ Summer maintenance release.
This version was also tested against the following stable channels:
<LiteYouTube id="pJiirfyJwcA" title="Playwright 1.35" />
UI mode is now available in VSCode Playwright extension via a new "Show trace viewer" button:
UI mode and trace viewer mark network requests handled with [method: Page.route] and [method: BrowserContext.route] handlers, as well as those issued via the API testing:
New option maskColor for methods [method: Page.screenshot], [method: Locator.screenshot], [method: PageAssertions.toHaveScreenshot#1] and [method: LocatorAssertions.toHaveScreenshot#1] to change default masking color:
await page.goto('https://playwright.dev');
await expect(page).toHaveScreenshot({
mask: [page.locator('img')],
maskColor: '#00FF00', // green
});
New uninstall CLI command to uninstall browser binaries:
$ npx playwright uninstall # remove browsers installed by this installation
$ npx playwright uninstall --all # remove all ever-install Playwright browsers
Both UI mode and trace viewer now could be opened in a browser tab:
$ npx playwright test --ui-port 0 # open UI mode in a tab on a random port
$ npx playwright show-trace --port 0 # open trace viewer in tab on a random port
playwright-core binary got renamed from playwright to playwright-core. So if you use playwright-core CLI, make sure to update the name:
$ npx playwright-core install # the new way to install browsers when using playwright-core
This change does not affect @playwright/test and playwright package users.
This version was also tested against the following stable channels:
<LiteYouTube id="JeFD6rqDbBo" title="Playwright 1.34" />
UI Mode now shows steps, fixtures and attachments:
New property [property: TestProject.teardown] to specify a project that needs to run after this
and all dependent projects have finished. Teardown is useful to cleanup any resources acquired by this project.
A common pattern would be a setup dependency with a corresponding teardown:
import { defineConfig } from '@playwright/test';
export default defineConfig({
projects: [
{
name: 'setup',
testMatch: /global.setup\.ts/,
teardown: 'teardown',
},
{
name: 'teardown',
testMatch: /global.teardown\.ts/,
},
{
name: 'chromium',
use: devices['Desktop Chrome'],
dependencies: ['setup'],
},
{
name: 'firefox',
use: devices['Desktop Firefox'],
dependencies: ['setup'],
},
{
name: 'webkit',
use: devices['Desktop Safari'],
dependencies: ['setup'],
},
],
});
New method expect.configure to
create pre-configured expect instance with its own defaults such as timeout
and soft.
const slowExpect = expect.configure({ timeout: 10000 });
await slowExpect(locator).toHaveText('Submit');
// Always do soft assertions.
const softExpect = expect.configure({ soft: true });
New options stderr and stdout in [property: TestConfig.webServer] to configure output handling:
import { defineConfig } from '@playwright/test';
export default defineConfig({
// Run your local dev server before starting the tests
webServer: {
command: 'npm run start',
url: 'http://127.0.0.1:3000',
reuseExistingServer: !process.env.CI,
stdout: 'pipe',
stderr: 'pipe',
},
});
New [method: Locator.and] to create a locator that matches both locators.
const button = page.getByRole('button').and(page.getByTitle('Subscribe'));
New events [event: BrowserContext.console] and [event: BrowserContext.dialog] to subscribe to any dialogs
and console messages from any page from the given browser context. Use the new methods [method: ConsoleMessage.page]
and [method: Dialog.page] to pin-point event source.
npx playwright test no longer works if you install both playwright and @playwright/test. There's no need
to install both, since you can always import browser automation APIs from @playwright/test directly:
import { chromium, firefox, webkit } from '@playwright/test';
/* ... */
Node.js 14 is no longer supported since it reached its end-of-life on April 30, 2023.
This version was also tested against the following stable channels:
<LiteYouTube id="JeFD6rqDbBo" title="Playwright 1.33" />
Use [method: Locator.or] to create a locator that matches either of the two locators.
Consider a scenario where you'd like to click on a "New email" button, but sometimes a security settings dialog shows up instead.
In this case, you can wait for either a "New email" button, or a dialog and act accordingly:
const newEmail = page.getByRole('button', { name: 'New email' });
const dialog = page.getByText('Confirm security settings');
await expect(newEmail.or(dialog)).toBeVisible();
if (await dialog.isVisible())
await page.getByRole('button', { name: 'Dismiss' }).click();
await newEmail.click();
Use new options [option: Locator.filter.hasNot] and [option: Locator.filter.hasNotText] in [method: Locator.filter]
to find elements that do not match certain conditions.
const rowLocator = page.locator('tr');
await rowLocator
.filter({ hasNotText: 'text in column 1' })
.filter({ hasNot: page.getByRole('button', { name: 'column 2 button' }) })
.screenshot();
Use new web-first assertion [method: LocatorAssertions.toBeAttached] to ensure that the element
is present in the page's DOM. Do not confuse with the [method: LocatorAssertions.toBeVisible] that ensures that
element is both attached & visible.
method: Locator.or]option: Locator.filter.hasNot] in [method: Locator.filter]option: Locator.filter.hasNotText] in [method: Locator.filter]method: LocatorAssertions.toBeAttached]option: Route.fetch.timeout] in [method: Route.fetch]method: Reporter.onExit]mcr.microsoft.com/playwright:v1.33.0 now serves a Playwright image based on Ubuntu Jammy.
To use the focal-based image, please use mcr.microsoft.com/playwright:v1.33.0-focal instead.This version was also tested against the following stable channels:
<LiteYouTube id="jF0yA-JLQW0" title="Playwright 1.32" />
New UI Mode lets you explore, run and debug tests. Comes with a built-in watch mode.
Engage with a new flag --ui:
npx playwright test --ui
option: Page.routeFromHAR.updateMode] and [option: Page.routeFromHAR.updateContent] in [method: Page.routeFromHAR] and [method: BrowserContext.routeFromHAR].property: TestInfo.testId].option: Tracing.startChunk.name] in method [method: Tracing.startChunk].Note: component tests only, does not affect end-to-end tests.
@playwright/experimental-ct-react now supports React 18 only.@playwright/experimental-ct-react with @playwright/experimental-ct-react17.This version was also tested against the following stable channels:
<LiteYouTube id="PI50YAPTAs4" title="Playwright 1.31" />
New property [property: TestProject.dependencies] to configure dependencies between projects.
Using dependencies allows global setup to produce traces and other artifacts, see the setup steps in the test report and more.
import { defineConfig } from '@playwright/test';
export default defineConfig({
projects: [
{
name: 'setup',
testMatch: /global.setup\.ts/,
},
{
name: 'chromium',
use: devices['Desktop Chrome'],
dependencies: ['setup'],
},
{
name: 'firefox',
use: devices['Desktop Firefox'],
dependencies: ['setup'],
},
{
name: 'webkit',
use: devices['Desktop Safari'],
dependencies: ['setup'],
},
],
});
New assertion [method: LocatorAssertions.toBeInViewport] ensures that locator points to an element that intersects viewport, according to the intersection observer API.
const button = page.getByRole('button');
// Make sure at least some part of element intersects viewport.
await expect(button).toBeInViewport();
// Make sure element is fully outside of viewport.
await expect(button).not.toBeInViewport();
// Make sure that at least half of the element intersects viewport.
await expect(button).toBeInViewport({ ratio: 0.5 });
defineConfig to be used in playwright.config.option: Route.fetch.maxRedirects] for method [method: Route.fetch].Note: component tests only, does not affect end-to-end tests.
playwright-ct.config configuration file for component testing now requires calling defineConfig.
// Before
import { type PlaywrightTestConfig, devices } from '@playwright/experimental-ct-react';
const config: PlaywrightTestConfig = {
// ... config goes here ...
};
export default config;
Replace config variable definition with defineConfig call:
// After
import { defineConfig, devices } from '@playwright/experimental-ct-react';
export default defineConfig({
// ... config goes here ...
});
This version was also tested against the following stable channels:
This version was also tested against the following stable channels:
<LiteYouTube id="VbVlz61VtNo" title="Playwright 1.29" />
New method [method: Route.fetch] and new option json for [method: Route.fulfill]:
await page.route('**/api/settings', async route => {
// Fetch original settings.
const response = await route.fetch();
// Force settings theme to a predefined value.
const json = await response.json();
json.theme = 'Solorized';
// Fulfill with modified data.
await route.fulfill({ json });
});
New method [method: Locator.all] to iterate over all matching elements:
// Check all checkboxes!
const checkboxes = page.getByRole('checkbox');
for (const checkbox of await checkboxes.all())
await checkbox.check();
[method: Locator.selectOption] matches now by value or label:
<select multiple>
<option value="red">Red</option>
<option value="green">Green</option>
<option value="blue">Blue</option>
</select>
await element.selectOption('Red');
Retry blocks of code until all assertions pass:
await expect(async () => {
const response = await page.request.get('https://api.example.com');
await expect(response).toBeOK();
}).toPass();
Read more in our documentation.
Automatically capture full page screenshot on test failure:
import { defineConfig } from '@playwright/test';
export default defineConfig({
use: {
screenshot: {
mode: 'only-on-failure',
fullPage: true,
}
}
});
jsconfig.json.args and proxy for [method: AndroidDevice.launchBrowser].postData in method [method: Route.continue] now supports [Serializable] values.This version was also tested against the following stable channels:
<LiteYouTube id="tVSq-0n-TY4" title="Playwright 1.28" />
Record at Cursor in VSCode. You can run the test, position the cursor at the end of the test and continue generating the test.
Live Locators in VSCode. You can hover and edit locators in VSCode to get them highlighted in the opened browser.
Live Locators in CodeGen. Generate a locator for any element on the page using "Explore" tool.
Codegen and Trace Viewer Dark Theme. Automatically picked up from operating system settings.
Configure retries and test timeout for a file or a test with [method: Test.describe.configure].
// Each test in the file will be retried twice and have a timeout of 20 seconds.
test.describe.configure({ retries: 2, timeout: 20_000 });
test('runs first', async ({ page }) => {});
test('runs second', async ({ page }) => {});
Use [property: TestProject.snapshotPathTemplate] and [property: TestConfig.snapshotPathTemplate] to configure a template controlling location of snapshots generated by [method: PageAssertions.toHaveScreenshot#1] and [method: SnapshotAssertions.toMatchSnapshot#1].
import { defineConfig } from '@playwright/test';
export default defineConfig({
testDir: './tests',
snapshotPathTemplate: '{testDir}/__screenshots__/{testFilePath}/{arg}{ext}',
});
method: Locator.blur]method: Locator.clear]method: Android.launchServer] and [method: Android.connect]event: AndroidDevice.close]This version was also tested against the following stable channels:
<LiteYouTube id="b84eqab3kwc" title="Playwright 1.27" />
With these new APIs writing locators is a joy:
method: Page.getByText] to locate by text content.method: Page.getByRole] to locate by ARIA role, ARIA attributes and accessible name.method: Page.getByLabel] to locate a form control by associated label's text.method: Page.getByTestId] to locate an element based on its data-testid attribute (other attribute can be configured).method: Page.getByPlaceholder] to locate an input by placeholder.method: Page.getByAltText] to locate an element, usually image, by its text alternative.method: Page.getByTitle] to locate an element by its title.await page.getByLabel('User Name').fill('John');
await page.getByLabel('Password').fill('secret-password');
await page.getByRole('button', { name: 'Sign in' }).click();
await expect(page.getByText('Welcome, John!')).toBeVisible();
All the same methods are also available on [Locator], [FrameLocator] and [Frame] classes.
workers option in the playwright.config.ts now accepts a percentage string to use some of the available CPUs. You can also pass it in the command line:
npx playwright test --workers=20%
New options host and port for the html reporter.
import { defineConfig } from '@playwright/test';
export default defineConfig({
reporter: [['html', { host: 'localhost', port: '9223' }]],
});
New field FullConfig.configFile is available to test reporters, specifying the path to the config file if any.
As announced in v1.25, Ubuntu 18 will not be supported as of Dec 2022. In addition to that, there will be no WebKit updates on Ubuntu 18 starting from the next Playwright release.
[method: LocatorAssertions.toHaveAttribute] with an empty value does not match missing attribute anymore. For example, the following snippet will succeed when button does not have a disabled attribute.
await expect(page.getByRole('button')).toHaveAttribute('disabled', '');
Command line options --grep and --grep-invert previously incorrectly ignored grep and grepInvert options specified in the config. Now all of them are applied together.
This version was also tested against the following stable channels:
<LiteYouTube id="b84eqab3kwc" title="Playwright 1.26" />
enabled for [method: LocatorAssertions.toBeEnabled].method: LocatorAssertions.toHaveText] now pierces open shadow roots.editable for [method: LocatorAssertions.toBeEditable].visible for [method: LocatorAssertions.toBeVisible].maxRedirects for [method: APIRequestContext.get] and others to limit redirect count.--pass-with-no-tests that allows the test suite to pass when no files are found.--ignore-snapshots to skip snapshot expectations, such as expect(value).toMatchSnapshot() and expect(page).toHaveScreenshot().A bunch of Playwright APIs already support the waitUntil: 'domcontentloaded' option.
For example:
await page.goto('https://playwright.dev', {
waitUntil: 'domcontentloaded',
});
Prior to 1.26, this would wait for all iframes to fire the DOMContentLoaded
event.
To align with web specification, the 'domcontentloaded' value only waits for
the target frame to fire the 'DOMContentLoaded' event. Use waitUntil: 'load' to wait for all iframes.
This version was also tested against the following stable channels:
<LiteYouTube id="NFLHA57a-so" title="Playwright 1.25" />
[method: Test.step] now returns the value of the step function:
test('should work', async ({ page }) => {
const pageTitle = await test.step('get title', async () => {
await page.goto('https://playwright.dev');
return await page.title();
});
console.log(pageTitle);
});
Added [method: Test.describe.fixme].
New 'interrupted' test status.
Enable tracing via CLI flag: npx playwright test --trace=on.
mcr.microsoft.com/playwright:v1.34.0-jammy.This version was also tested against the following stable channels:
<LiteYouTube id="9F05o1shxcY" title="Playwright 1.24" />
playwright.config.tsLaunch multiple web servers, databases, or other processes by passing an array of configurations:
import { defineConfig } from '@playwright/test';
export default defineConfig({
webServer: [
{
command: 'npm run start',
url: 'http://127.0.0.1:3000',
timeout: 120 * 1000,
reuseExistingServer: !process.env.CI,
},
{
command: 'npm run backend',
url: 'http://127.0.0.1:3333',
timeout: 120 * 1000,
reuseExistingServer: !process.env.CI,
}
],
use: {
baseURL: 'http://localhost:3000/',
},
});
Playwright now supports Debian 11 Bullseye on x86_64 for Chromium, Firefox and WebKit. Let us know if you encounter any issues!
Linux support looks like this:
| | Ubuntu 20.04 | Ubuntu 22.04 | Debian 11 | :--- | :---: | :---: | :---: | :---: | | Chromium | β | β | β | | WebKit | β | β | β | | Firefox | β | β | β |
It is now possible to call [method: Test.describe] to create suites without a title. This is useful for giving a group of tests a common option with [method: Test.use].
test.describe(() => {
test.use({ colorScheme: 'dark' });
test('one', async ({ page }) => {
// ...
});
test('two', async ({ page }) => {
// ...
});
});
Playwright 1.24 Component Tests introduce beforeMount and afterMount hooks.
Use these to configure your app for tests.
For example, this could be used to setup App router in Vue.js:
import { test } from '@playwright/experimental-ct-vue';
import { Component } from './mycomponent';
test('should work', async ({ mount }) => {
const component = await mount(Component, {
hooksConfig: {
/* anything to configure your app */
}
});
});
import { router } from '../router';
import { beforeMount } from '@playwright/experimental-ct-vue/hooks';
beforeMount(async ({ app, hooksConfig }) => {
app.use(router);
});
A similar configuration in Next.js would look like this:
import { test } from '@playwright/experimental-ct-react';
import { Component } from './mycomponent';
test('should work', async ({ mount }) => {
const component = await mount(<Component></Component>, {
// Pass mock value from test into `beforeMount`.
hooksConfig: {
router: {
query: { page: 1, per_page: 10 },
asPath: '/posts'
}
}
});
});
import router from 'next/router';
import { beforeMount } from '@playwright/experimental-ct-react/hooks';
beforeMount(async ({ hooksConfig }) => {
// Before mount, redefine useRouter to return mock value from test.
router.useRouter = () => hooksConfig.router;
});
<LiteYouTube id="NRGOV46P3kU" title="Playwright 1.23" />
Now you can record network traffic into a HAR file and re-use this traffic in your tests.
To record network into HAR file:
npx playwright open --save-har=github.har.zip https://github.com/microsoft
Alternatively, you can record HAR programmatically:
const context = await browser.newContext({
recordHar: { path: 'github.har.zip' }
});
// ... do stuff ...
await context.close();
Use the new methods [method: Page.routeFromHAR] or [method: BrowserContext.routeFromHAR] to serve matching responses from the HAR file:
await context.routeFromHAR('github.har.zip');
Read more in our documentation.
You can now use [method: Route.fallback] to defer routing to other handlers.
Consider the following example:
// Remove a header from all requests.
test.beforeEach(async ({ page }) => {
await page.route('**/*', async route => {
const headers = await route.request().allHeaders();
delete headers['if-none-match'];
await route.fallback({ headers });
});
});
test('should work', async ({ page }) => {
await page.route('**/*', async route => {
if (route.request().resourceType() === 'image')
await route.abort();
else
await route.fallback();
});
});
Note that the new methods [method: Page.routeFromHAR] and [method: BrowserContext.routeFromHAR] also participate in routing and could be deferred to.
method: LocatorAssertions.toHaveValues] that asserts all selected values of <select multiple> element.method: LocatorAssertions.toContainText] and [method: LocatorAssertions.toHaveText] now accept ignoreCase option.@playwright/experimental-ct-vue2 package..js files.Read more about component testing with Playwright.
serviceWorkers:
export default {
use: {
serviceWorkers: 'block',
}
};
.zip path for recordHar context option automatically zips the resulting HAR:
const context = await browser.newContext({
recordHar: {
path: 'github.har.zip',
}
});
"minimal" HAR recording mode
that only records information that is essential for replaying:
const context = await browser.newContext({
recordHar: {
path: 'github.har',
mode: 'minimal',
}
});
mcr.microsoft.com/playwright:v1.34.0-jammy.WebServer is now considered "ready" if request to the specified url has any of the following HTTP status codes:
200-299300-399 (new)400, 401, 402, 403 (new)<LiteYouTube id="keV2CIgtBlg" title="Playwright 1.22" />
Components Testing (preview)
Playwright Test can now test your React or Vue.js components. You can use all the features of Playwright Test (such as parallelization, emulation & debugging) while running components in real browsers.
Here is what a typical component test looks like:
import { test, expect } from '@playwright/experimental-ct-react';
import App from './App';
// Let's test component in a dark scheme!
test.use({ colorScheme: 'dark' });
test('should render', async ({ mount }) => {
const component = await mount(<App></App>);
// As with any Playwright test, assert locator text.
await expect(component).toContainText('React');
// Or do a screenshot π
await expect(component).toHaveScreenshot();
// Or use any Playwright method
await component.click();
});
Read more in our documentation.
Role selectors that allow selecting elements by their ARIA role, ARIA attributes and accessible name.
// Click a button with accessible name "log in"
await page.locator('role=button[name="log in"]').click();
Read more in our documentation.
New [method: Locator.filter] API to filter an existing locator
const buttons = page.locator('role=button');
// ...
const submitButton = buttons.filter({ hasText: 'Submit' });
await submitButton.click();
New web-first assertions [method: PageAssertions.toHaveScreenshot#1] and [method: LocatorAssertions.toHaveScreenshot#1] that
wait for screenshot stabilization and enhances test reliability.
The new assertions has screenshot-specific defaults, such as:
await page.goto('https://playwright.dev');
await expect(page).toHaveScreenshot();
The new [method: PageAssertions.toHaveScreenshot#1] saves screenshots at the same
location as [method: SnapshotAssertions.toMatchSnapshot#1].
<LiteYouTube id="45HZdbmgEw8" title="Playwright 1.21" />
New role selectors that allow selecting elements by their ARIA role, ARIA attributes and accessible name.
// Click a button with accessible name "log in"
await page.locator('role=button[name="log in"]').click();
Read more in our documentation.
New scale option in [method: Page.screenshot] for smaller sized screenshots.
New caret option in [method: Page.screenshot] to control text caret. Defaults to "hide".
New method expect.poll to wait for an arbitrary condition:
// Poll the method until it returns an expected result.
await expect.poll(async () => {
const response = await page.request.get('https://api.example.com');
return response.status();
}).toBe(200);
expect.poll supports most synchronous matchers, like .toBe(), .toContain(), etc.
Read more in our documentation.
PLAYWRIGHT_EXPERIMENTAL_TS_ESM env variable is
no longer required.mcr.microsoft.com/playwright docker image no longer contains Python. Please use mcr.microsoft.com/playwright/python
as a Playwright-ready docker image with pre-installed Python.method: Locator.setInputFiles] API.This version was also tested against the following stable channels:
<LiteYouTube id="6vV-XXKsrbA" title="Playwright 1.20" />
New options for methods [method: Page.screenshot], [method: Locator.screenshot] and [method: ElementHandle.screenshot]:
animations: "disabled" rewinds all CSS animations and transitions to a consistent statemask: Locator[] masks given elements, overlaying them with pink #FF00FF boxes.expect().toMatchSnapshot() now supports anonymous snapshots: when snapshot name is missing, Playwright Test will generate one
automatically:
expect('Web is Awesome <3').toMatchSnapshot();
New maxDiffPixels and maxDiffPixelRatio options for fine-grained screenshot comparison using expect().toMatchSnapshot():
expect(await page.screenshot()).toMatchSnapshot({
maxDiffPixels: 27, // allow no more than 27 different pixels.
});
It is most convenient to specify maxDiffPixels or maxDiffPixelRatio once in [property: TestConfig.expect].
Playwright Test now adds [property: TestConfig.fullyParallel] mode. By default, Playwright Test parallelizes between files. In fully parallel mode, tests inside a single file are also run in parallel. You can also use --fully-parallel command line flag.
export default {
fullyParallel: true,
};
[property: TestProject.grep] and [property: TestProject.grepInvert] are now configurable per project. For example, you can now
configure smoke tests project using grep:
export default {
projects: [
{
name: 'smoke tests',
grep: /@smoke/,
},
],
};
Trace Viewer now shows API testing requests.
[method: Locator.highlight] visually reveals element(s) for easier debugging.
mcr.microsoft.com/playwright/python. Please switch over to it if you use
Python. This is the last release that includes Python inside our javascript mcr.microsoft.com/playwright docker image.This version was also tested against the following stable channels:
<LiteYouTube id="z0EOFvlf14U" title="Playwright 1.19" />
Playwright Test v1.19 now supports soft assertions. Failed soft assertions do not terminate test execution, but mark the test as failed.
// Make a few checks that will not stop the test when failed...
await expect.soft(page.locator('#status')).toHaveText('Success');
await expect.soft(page.locator('#eta')).toHaveText('1 day');
// ... and continue the test to check more things.
await page.locator('#next-page').click();
await expect.soft(page.locator('#title')).toHaveText('Make another order');
Read more in our documentation
You can now specify a custom expect message as a second argument to the expect and expect.soft functions, for example:
await expect(page.locator('text=Name'), 'should be logged in').toBeVisible();
The error would look like this:
Error: should be logged in
Call log:
- expect.toBeVisible with timeout 5000ms
- waiting for "getByText('Name')"
2 |
3 | test('example test', async({ page }) => {
> 4 | await expect(page.locator('text=Name'), 'should be logged in').toBeVisible();
| ^
5 | });
6 |
Read more in our documentation
By default, tests in a single file are run in order. If you have many independent tests in a single file, you can now
run them in parallel with [method: Test.describe.configure].
Locator now supports a has option that makes sure it contains another locator inside:
await page.locator('article', {
has: page.locator('.highlight'),
}).click();
Read more in locator documentation
New [method: Locator.page]
[method: Page.screenshot] and [method: Locator.screenshot] now automatically hide blinking caret
Playwright Codegen now generates locators and frame locators
New option url in [property: TestConfig.webServer] to ensure your web server is ready before running the tests
New [property: TestInfo.errors] and [property: TestResult.errors] that contain all failed assertions and soft assertions.
It is unlikely that this change will affect you, no action is required if your tests keep running as they did.
We've noticed that in rare cases, the set of tests to be executed was configured in the global setup by means of the environment variables. We also noticed some applications that were post processing the reporters' output in the global teardown. If you are doing one of the two, learn more
This version was also tested against the following stable channels:
<LiteYouTube id="ABLYpw2BN_g" title="Playwright 1.18" />
method: Locator.dragTo]expect(locator).toBeChecked({ checked })await page.locator('li', { hasText: 'my item' }).locator('button').click();
tsconfig.json's baseUrl and paths, so you can use aliasesPW_EXPERIMENTAL_TS_ESM that allows importing ESM modules in your TS code, without the need for the compile step. Don't forget the .js suffix when you are importing your esm modules. Run your tests as follows:npm i --save-dev @playwright/[email protected]
PW_EXPERIMENTAL_TS_ESM=1 npx playwright test
The npm init playwright command is now generally available for your use:
# Run from your project's root directory
npm init playwright@latest
# Or create a new project
npm init playwright@latest new-project
This will create a Playwright Test configuration file, optionally add examples, a GitHub Action workflow and a first test example.spec.ts.
testCase.repeatEachIndex APIacceptDownloads option now defaults to trueCustom config options are a convenient way to parametrize projects with different values. Learn more in this guide.
Previously, any fixture introduced through [method: Test.extend] could be overridden in the [property: TestProject.use] config section. For example,
// WRONG: THIS SNIPPET DOES NOT WORK SINCE v1.18.
// fixtures.js
const test = base.extend({
myParameter: 'default',
});
// playwright.config.js
module.exports = {
use: {
myParameter: 'value',
},
};
The proper way to make a fixture parametrized in the config file is to specify option: true when defining the fixture. For example,
// CORRECT: THIS SNIPPET WORKS SINCE v1.18.
// fixtures.js
const test = base.extend({
// Fixtures marked as "option: true" will get a value specified in the config,
// or fallback to the default value.
myParameter: ['default', { option: true }],
});
// playwright.config.js
module.exports = {
use: {
myParameter: 'value',
},
};
This version was also tested against the following stable channels:
<LiteYouTube id="7iyIdeoAP04" title="Playwright 1.17" />
Playwright 1.17 introduces frame locators - a locator to the iframe on the page. Frame locators capture the logic sufficient to retrieve the iframe and then locate elements in that iframe. Frame locators are strict by default, will wait for iframe to appear and can be used in Web-First assertions.
Frame locators can be created with either [method: Page.frameLocator] or [method: Locator.frameLocator] method.
const locator = page.frameLocator('#my-iframe').locator('text=Submit');
await locator.click();
Read more at our documentation.
Playwright Trace Viewer is now available online at https://trace.playwright.dev! Just drag-and-drop your trace.zip file to inspect its contents.
NOTE: trace files are not uploaded anywhere; trace.playwright.dev is a progressive web application that processes traces locally.
npx playwright install msedge
'title' option'commit' waiting optiontestConfig.snapshotDir optiontestInfo.parallelIndextestInfo.titlePathtestOptions.trace has new optionsexpect.toMatchSnapshot supports subdirectoriesreporter.printsToStdio()<LiteYouTube id="OQKwFDmY64g" title="Playwright 1.16" />
Playwright 1.16 introduces new API Testing that lets you send requests to the server directly from Node.js! Now you can:
To do a request on behalf of Playwright's Page, use new [property: Page.request] API:
import { test, expect } from '@playwright/test';
test('context fetch', async ({ page }) => {
// Do a GET request on behalf of page
const response = await page.request.get('http://example.com/foo.json');
// ...
});
To do a stand-alone request from node.js to an API endpoint, use new request fixture:
import { test, expect } from '@playwright/test';
test('context fetch', async ({ request }) => {
// Do a GET request on behalf of page
const response = await request.get('http://example.com/foo.json');
// ...
});
Read more about it in our API testing guide.
It is now possible to do response interception by combining API Testing with request interception.
For example, we can blur all the images on the page:
import { test, expect } from '@playwright/test';
import jimp from 'jimp'; // image processing library
test('response interception', async ({ page }) => {
await page.route('**/*.jpeg', async route => {
const response = await page._request.fetch(route.request());
const image = await jimp.read(await response.body());
await image.blur(5);
await route.fulfill({
response,
body: await image.getBufferAsync('image/jpeg'),
});
});
const response = await page.goto('https://playwright.dev');
expect(response.status()).toBe(200);
});
Read more about response interception.
Try it out new HTML reporter with either --reporter=html or a reporter entry
in playwright.config.ts file:
$ npx playwright test --reporter=html
The HTML reporter has all the information about tests and their failures, including surfacing trace and image artifacts.
Read more about our reporters.
Wait for a locator to resolve to a single element with a given state.
Defaults to the state: 'visible'.
Comes especially handy when working with lists:
import { test, expect } from '@playwright/test';
test('context fetch', async ({ page }) => {
const completeness = page.locator('text=Success');
await completeness.waitFor();
expect(await page.screenshot()).toMatchSnapshot('screen.png');
});
Read more about [method: Locator.waitFor].
Playwright Docker image is now published for Arm64 so it can be used on Apple Silicon.
Read more about Docker integration.
npx playwright show-trace and drop trace files to the trace viewer PWARead more about Trace Viewer.
This version of Playwright was also tested against the following stable channels:
<LiteYouTube id="6RwzsDeEj7Y" title="Playwright 1.15" />
By using [method: Mouse.wheel] you are now able to scroll vertically or horizontally.
Previously it was not possible to get multiple header values of a response. This is now possible and additional helper functions are available:
method: Request.allHeaders]method: Request.headersArray]method: Request.headerValue]method: Response.allHeaders]method: Response.headersArray]method: Response.headerValue]method: Response.headerValues]Its now possible to emulate the forced-colors CSS media feature by passing it in the [method: Browser.newContext] or calling [method: Page.emulateMedia].
method: Page.route] accepts new times option to specify how many times this route should be matched.method: Page.setChecked] and [method: Locator.setChecked] were introduced to set the checked state of a checkbox.method: Request.sizes] Returns resource size information for given http request.method: Tracing.startChunk] - Start a new trace chunk.method: Tracing.stopChunk] - Stops a new trace chunk.test.parallel() run tests in the same file in paralleltest.describe.parallel('group', () => {
test('runs in parallel 1', async ({ page }) => {
});
test('runs in parallel 2', async ({ page }) => {
});
});
By default, tests in a single file are run in order. If you have many independent tests in a single file, you can now run them in parallel with test.describe.parallel(title, callback).
--debug CLI flagBy using npx playwright test --debug it will enable the Playwright Inspector for you to debug your tests.
<LiteYouTube id="LczBDR0gOhk" title="Playwright 1.14" />
Selector ambiguity is a common problem in automation testing. "strict" mode ensures that your selector points to a single element and throws otherwise.
Pass strict: true into your action calls to opt in.
// This will throw if you have more than one button!
await page.click('button', { strict: true });
Locator represents a view to the element(s) on the page. It captures the logic sufficient to retrieve the element at any given moment.
The difference between the Locator and ElementHandle is that the latter points to a particular element, while Locator captures the logic of how to retrieve that element.
Also, locators are "strict" by default!
const locator = page.locator('button');
await locator.click();
Learn more in the documentation.
React and Vue selectors allow selecting elements by its component name and/or property values. The syntax is very similar to attribute selectors and supports all attribute selector operators.
await page.locator('_react=SubmitButton[enabled=true]').click();
await page.locator('_vue=submit-button[enabled=true]').click();
Learn more in the react selectors documentation and the vue selectors documentation.
nth and visible selector enginesnth selector engine is equivalent to the :nth-match pseudo class, but could be combined with other selector engines.visible selector engine is equivalent to the :visible pseudo class, but could be combined with other selector engines.// select the first button among all buttons
await button.click('button >> nth=0');
// or if you are using locators, you can use first(), nth() and last()
await page.locator('button').first().click();
// click a visible button
await button.click('button >> visible=true');
expect now supports lots of new web-first assertions.
Consider the following example:
await expect(page.locator('.status')).toHaveText('Submitted');
Playwright Test will be re-testing the node with the selector .status until fetched Node has the "Submitted" text. It will be re-fetching the node and checking it over and over, until the condition is met or until the timeout is reached. You can either pass this timeout or configure it once via the testProject.expect value in test config.
By default, the timeout for assertions is not set, so it'll wait forever, until the whole test times out.
List of all new assertions:
expect(locator).toBeChecked()expect(locator).toBeDisabled()expect(locator).toBeEditable()expect(locator).toBeEmpty()expect(locator).toBeEnabled()expect(locator).toBeFocused()expect(locator).toBeHidden()expect(locator).toBeVisible()expect(locator).toContainText(text, options?)expect(locator).toHaveAttribute(name, value)expect(locator).toHaveClass(expected)expect(locator).toHaveCount(count)expect(locator).toHaveCSS(name, value)expect(locator).toHaveId(id)expect(locator).toHaveJSProperty(name, value)expect(locator).toHaveText(expected, options)expect(page).toHaveTitle(title)expect(page).toHaveURL(url)expect(locator).toHaveValue(value)describe.serialDeclares a group of tests that should always be run serially. If one of the tests fails, all subsequent tests are skipped. All tests in a group are retried together.
test.describe.serial('group', () => {
test('runs first', async ({ page }) => { /* ... */ });
test('runs second', async ({ page }) => { /* ... */ });
});
Learn more in the documentation.
test.stepSplit long tests into multiple steps using test.step() API:
import { test, expect } from '@playwright/test';
test('test', async ({ page }) => {
await test.step('Log in', async () => {
// ...
});
await test.step('news feed', async () => {
// ...
});
});
Step information is exposed in reporters API.
To launch a server during the tests, use the webServer option in the configuration file. The server will wait for a given url to be available before running the tests, and the url will be passed over to Playwright as a baseURL when creating a context.
import { defineConfig } from '@playwright/test';
export default defineConfig({
webServer: {
command: 'npm run start', // command to launch
url: 'http://127.0.0.1:3000', // url to await for
timeout: 120 * 1000,
reuseExistingServer: !process.env.CI,
},
});
Learn more in the documentation.
baseURL fixture to support relative paths in tests.method: Page.dragAndDrop] API.recordHar option in [method: Browser.newContext].console.log() calls.baseURL option in [method: Browser.newContext] and [method: Browser.newPage]method: Response.securityDetails] and [method: Response.serverAddr]method: Page.dragAndDrop] and [method: Frame.dragAndDrop]method: Download.cancel]method: Page.inputValue], [method: Frame.inputValue] and [method: ElementHandle.inputValue]force option in [method: Page.fill], [method: Frame.fill], and [method: ElementHandle.fill]force option in [method: Page.selectOption], [method: Frame.selectOption], and [method: ElementHandle.selectOption]Playwright Test is a new test runner built from scratch by Playwright team specifically to accommodate end-to-end testing needs:
Installation:
npm i -D @playwright/test
Simple test tests/foo.spec.ts:
import { test, expect } from '@playwright/test';
test('basic test', async ({ page }) => {
await page.goto('https://playwright.dev/');
const name = await page.innerText('.navbar__title');
expect(name).toBe('Playwright');
});
Running:
npx playwright test
π Read more in Playwright Test documentation.
Playwright Trace Viewer is a new GUI tool that helps exploring recorded Playwright traces after the script ran. Playwright traces let you examine:
Traces are recorded using the new [property: BrowserContext.tracing] API:
const browser = await chromium.launch();
const context = await browser.newContext();
// Start tracing before creating / navigating a page.
await context.tracing.start({ screenshots: true, snapshots: true });
const page = await context.newPage();
await page.goto('https://playwright.dev');
// Stop tracing and export it into a zip archive.
await context.tracing.stop({ path: 'trace.zip' });
Traces are examined later with the Playwright CLI:
npx playwright show-trace trace.zip
That will open the following GUI:
π Read more in trace viewer documentation.
This version of Playwright was also tested against the following stable channels:
reducedMotion option in [method: Page.emulateMedia], [method: BrowserType.launchPersistentContext], [method: Browser.newContext] and [method: Browser.newPage]event: BrowserContext.request]event: BrowserContext.requestFailed]event: BrowserContext.requestFinished]event: BrowserContext.response]tracesDir option in [method: BrowserType.launch] and [method: BrowserType.launchPersistentContext]property: BrowserContext.tracing] API namespacemethod: Download.page] methodπ₯ New video: Playwright: A New Test Automation Framework for the Modern Web (slides)
method: Page.waitForRequest] and othersmethod: Page.waitForURL] to await navigations to URLmethod: Video.delete] and [method: Video.saveAs] to manage screen recordingscreen option in the [method: Browser.newContext] method to emulate window.screen dimensionsposition option in [method: Page.check] and [method: Page.uncheck] methodstrial option to dry-run actions in [method: Page.check], [method: Page.uncheck], [method: Page.click], [method: Page.dblclick], [method: Page.hover] and [method: Page.tap]This version of Playwright was also tested against the following stable channels:
method: BrowserType.launch] now accepts the new 'channel' option. Read more in our documentation.Playwright Inspector is a new GUI tool to author and debug your tests.
PWDEBUG=1 environment variable to launch the InspectorPause script execution with [method: Page.pause] in headed mode. Pausing the page launches Playwright Inspector for debugging.
New has-text pseudo-class for CSS selectors. :has-text("example") matches any element containing "example" somewhere inside, possibly in a child or a descendant element. See more examples.
Page dialogs are now auto-dismissed during execution, unless a listener for dialog event is configured. Learn more about this.
Playwright for Python is now stable with an idiomatic snake case API and pre-built Docker image to run tests in CI/CD.
method: Page.pause].:left-of(), :right-of(), :above() and :below().npx playwright --help
method: Page.selectOption] now waits for the options to be present.method: Page.isEditable].method: ElementHandle.isChecked].method: ElementHandle.isDisabled].method: ElementHandle.isEditable].method: ElementHandle.isEnabled].method: ElementHandle.isHidden].method: ElementHandle.isVisible].method: Page.isChecked].method: Page.isDisabled].method: Page.isEditable].method: Page.isEnabled].method: Page.isHidden].method: Page.isVisible].'editable' in [method: ElementHandle.waitForElementState].method: BrowserContext.storageState] to get current state for later reuse.storageState option in [method: Browser.newContext] and [method: Browser.newPage] to setup browser context state.