--- id: release-notes title: "Release notes" toc_max_heading_level: 2 --- import LiteYouTube from '@site/src/components/LiteYouTube'; ## Version 1.56 ### 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: ```bash # 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](./test-agents.md) ### New APIs - New methods [`method: Page.consoleMessages`] and [`method: Page.pageErrors`] for retrieving the most recent console messages from the page - New method [`method: Page.requests`] for retrieving the most recent network requests from the page - Added [`--test-list` and `--test-list-invert`](./test-cli.md#test-list) to allow manual specification of specific tests from a file ### UI Mode and HTML Reporter - Added option to `'html'` reporter to disable the "Copy prompt" button - Added option to `'html'` reporter and UI Mode to merge files, collapsing test and describe blocks into a single unified list - Added option to UI Mode mirroring the `--update-snapshots` options - Added option to UI Mode to run only a single worker at a time ### Breaking Changes - Event [`event: BrowserContext.backgroundPage`] has been deprecated and will not be emitted. Method [`method: BrowserContext.backgroundPages`] will return an empty list ### Miscellaneous - Aria snapshots render and compare `input` `placeholder` - Added environment variable `PLAYWRIGHT_TEST` to Playwright worker processes to allow discriminating on testing status ### Browser Versions - Chromium 141.0.7390.37 - Mozilla Firefox 142.0.1 - WebKit 26.0 ## Version 1.55 ### New APIs - New Property [`property: TestStepInfo.titlePath`] Returns the full title path starting from the test file, including test and step titles. ### Codegen - Automatic `toBeVisible()` assertions: Codegen can now generate automatic `toBeVisible()` assertions for common UI interactions. This feature can be enabled in the Codegen settings UI. ### Breaking Changes - ⚠️ Dropped support for Chromium extension manifest v2. ### Miscellaneous - Added support for Debian 13 "Trixie". ### Browser Versions - Chromium 140.0.7339.16 - Mozilla Firefox 141.0 - WebKit 26.0 This version was also tested against the following stable channels: - Google Chrome 139 - Microsoft Edge 139 ## Version 1.54 ### Highlights - 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](https://developer.mozilla.org/en-US/docs/Web/Privacy/Guides/Privacy_sandbox/Partitioned_cookies) 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. ```js 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. ### Command Line - New option `--user-data-dir` in multiple commands. You can specify the same user data dir to reuse browsing state, like authentication, between sessions. ```bash 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. ### Miscellaneous - Support for Node.js 16 has been removed. - Support for Node.js 18 has been deprecated, and will be removed in the future. ### Browser Versions - Chromium 139.0.7258.5 - Mozilla Firefox 140.0.2 - WebKit 26.0 This version was also tested against the following stable channels: - Google Chrome 140 - Microsoft Edge 140 ## Version 1.53 ### Trace Viewer and HTML Reporter Updates - New Steps in Trace Viewer and HTML reporter: ![New Trace Viewer Steps](https://github.com/user-attachments/assets/1963ff7d-4070-41be-a79b-4333176921a2) - New option in `'html'` reporter to set the title of a specific test run: ```js import { defineConfig } from '@playwright/test'; export default defineConfig({ reporter: [['html', { title: 'Custom test run #1028' }]] }); ``` ### Miscellaneous - New option [`option: TestInfo.snapshotPath.kind`] in [`method: TestInfo.snapshotPath`] controls which snapshot path template is used. - New method [`method: Locator.describe`] to describe a locator. Used for trace viewer and reports. ```js 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. ### Browser Versions - Chromium 138.0.7204.4 - Mozilla Firefox 139.0 - WebKit 18.5 This version was also tested against the following stable channels: - Google Chrome 137 - Microsoft Edge 137 ## Version 1.52 ### Highlights - New method [`method: LocatorAssertions.toContainClass`] to ergonomically assert individual class names on the element. ```ts await expect(page.getByRole('listitem', { name: 'Ship v1.52' })).toContainClass('done'); ``` - [Aria Snapshots](./aria-snapshots.md) got two new properties: [`/children`](./aria-snapshots.md#strict-matching) for strict matching and `/url` for links. ```ts await expect(locator).toMatchAriaSnapshot(` - list - /children: equal - listitem: Feature A - listitem: - link "Feature B": - /url: "https://playwright.dev" `); ``` ### Test Runner - New property [`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. - New [`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. - New property [`property: TestResult.annotations`] contains annotations for each test retry. ### Miscellaneous - New option [`option: APIRequest.newContext.maxRedirects`] in [`method: APIRequest.newContext`] to control the maximum number of redirects. - HTML reporter now supports *NOT filtering* via `!@my-tag` or `!my-file.spec.ts` or `!p:my-project`. ### Breaking Changes - Glob URL patterns in methods like [`method: Page.route`] do not support `?` and `[]` anymore. We recommend using regular expressions instead. - Method [`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`]. - macOS 13 is now deprecated and will no longer receive WebKit updates. Please upgrade to a more recent macOS version to continue benefiting from the latest WebKit improvements. ### Browser Versions - Chromium 136.0.7103.25 - Mozilla Firefox 137.0 - WebKit 18.4 This version was also tested against the following stable channels: - Google Chrome 135 - Microsoft Edge 135 ## Version 1.51 ### StorageState for indexedDB * New option [`option: BrowserContext.storageState.indexedDB`] for [`method: BrowserContext.storageState`] allows to save and restore IndexedDB contents. Useful when your application uses [IndexedDB API](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API) to store authentication tokens, like Firebase Authentication. Here is an example following the [authentication guide](./auth.md#basic-shared-account-in-all-tests): ```js title="tests/auth.setup.ts" 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 }); }); ``` ### Copy as prompt 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. ![Copy prompt](https://github.com/user-attachments/assets/f3654407-dd6d-4240-9845-0d96df2bf30a) ### Filter visible elements New option [`option: Locator.filter.visible`] for [`method: Locator.filter`] allows matching only visible elements. ```js title="example.spec.ts" 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); }); ``` ### Git information in HTML report Set option [`property: TestConfig.captureGitInfo`] to capture git information into [`property: TestConfig.metadata`]. ```js title="playwright.config.ts" import { defineConfig } from '@playwright/test'; export default defineConfig({ captureGitInfo: { commit: true, diff: true } }); ``` HTML report will show this information when available: ![Git information in the report](https://github.com/user-attachments/assets/f5b3f6f4-aa08-4a24-816c-7edf33ef0c37) ### Test Step improvements A new [TestStepInfo] object is now available in test steps. You can add step attachments or skip the step under some conditions. ```js 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' }); // ... }); }); ``` ### Miscellaneous * New option `contrast` for methods [`method: Page.emulateMedia`] and [`method: Browser.newContext`] allows to emulate the `prefers-contrast` media feature. * New option [`option: APIRequest.newContext.failOnStatusCode`] makes all fetch requests made through the [APIRequestContext] throw on response codes other than 2xx and 3xx. * Assertion [`method: PageAssertions.toHaveURL`] now supports a predicate. ### Browser Versions * Chromium 134.0.6998.35 * Mozilla Firefox 135.0 * WebKit 18.4 This version was also tested against the following stable channels: * Google Chrome 133 * Microsoft Edge 133 ## Version 1.50 ### Test runner * 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. ```js 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. ```js 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](https://w3c.github.io/aria/#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. ```bash 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. ### UI updates * Updated default HTML reporter to improve display of attachments. * New button in Codegen for picking elements to produce aria snapshots. * Additional details (such as keys pressed) are now displayed alongside action API calls in traces. * Display of `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. ### Breaking * [`method: LocatorAssertions.toBeEditable`] and [`method: Locator.isEditable`] now throw if the target element is not ``, `` elements. ```js 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. ```js // 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. ### Browser Versions * Chromium 127.0.6533.5 * Mozilla Firefox 127.0 * WebKit 17.4 This version was also tested against the following stable channels: * Google Chrome 126 * Microsoft Edge 126 ## Version 1.44 ### New APIs **Accessibility assertions** - [`method: LocatorAssertions.toHaveAccessibleName`] checks if the element has the specified accessible name: ```js const locator = page.getByRole('button'); await expect(locator).toHaveAccessibleName('Submit'); ``` - [`method: LocatorAssertions.toHaveAccessibleDescription`] checks if the element has the specified accessible description: ```js const locator = page.getByRole('button'); await expect(locator).toHaveAccessibleDescription('Upload a photo'); ``` - [`method: LocatorAssertions.toHaveRole`] checks if the element has the specified ARIA role: ```js const locator = page.getByTestId('save-button'); await expect(locator).toHaveRole('button'); ``` **Locator handler** - After executing the handler added with [`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. - You can use new `times` option in [`method: Page.addLocatorHandler`] to specify maximum number of times the handler should be run. - The handler in [`method: Page.addLocatorHandler`] now accepts the locator as argument. - New [`method: Page.removeLocatorHandler`] method for removing previously added locator handlers. ```js 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`](./api/class-apirequestcontext#api-request-context-fetch-option-multipart) option in `apiRequestContext.fetch()` now accepts [`FormData`](https://developer.mozilla.org/en-US/docs/Web/API/FormData) and supports repeating fields with the same name. ```js 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](./api/class-pageassertions#page-assertions-to-have-url-option-ignore-case). - [`property: TestProject.ignoreSnapshots`](./api/class-testproject#test-project-ignore-snapshots) allows to configure per project whether to skip screenshot expectations. **Reporter API** - New method [`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. - [Blob](./test-reporters#blob-reporter) reporter now allows overriding report file path with a single option `outputFile`. The same option can also be specified as `PLAYWRIGHT_BLOB_OUTPUT_FILE` environment variable that might be more convenient on CI/CD. - [JUnit](./test-reporters#junit-reporter) reporter now supports `includeProjectInTestName` option. **Command line** - `--last-failed` CLI option to for running only tests that failed in the previous run. First run all tests: ```sh $ 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: ```sh $ npx playwright test --last-failed Running 2 tests using 2 workers 2 passed (1.2s) ``` ### Browser Versions * Chromium 125.0.6422.14 * Mozilla Firefox 125.0.1 * WebKit 17.4 This version was also tested against the following stable channels: * Google Chrome 124 * Microsoft Edge 124 ## Version 1.43 ### New APIs - Method [`method: BrowserContext.clearCookies`] now supports filters to remove only some cookies. ```js // 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. ```js title=playwright.config.ts 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. ```js 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. ```js 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. ```js const frameLocator = page.frameLocator('iframe[name="embedded"]'); // ... const locator = frameLocator.owner(); await expect(locator).toBeVisible(); ``` ### UI Mode Updates ![Playwright UI Mode](https://github.com/microsoft/playwright/assets/9881434/61ca7cfc-eb7a-4305-8b62-b6c9f098f300) * See tags in the test list. * Filter by tags by typing `@fast` or clicking on the tag itself. * New shortcuts: - "F5" to run tests. - "Shift F5" to stop running tests. - "Ctrl `" to toggle test output. ### Browser Versions * Chromium 124.0.6367.8 * Mozilla Firefox 124.0 * WebKit 17.4 This version was also tested against the following stable channels: * Google Chrome 123 * Microsoft Edge 123 ## Version 1.42 ### New APIs - New method [`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: ```js // 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](./api/class-testconfig#test-config-expect) or in [project config](./api/class-testproject#test-project-expect) - [`event: ElectronApplication.console`] event is emitted when Electron main process calls console API methods. ```js 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' })); ``` - [New syntax](./test-annotations#tag-tests) for adding tags to the tests (@-tokens in the test title are still supported): ```js test('test customer login', { tag: ['@fast', '@login'], }, async ({ page }) => { // ... }); ``` Use `--grep` command line option to run only tests with certain tags. ```sh npx playwright test --grep @fast ``` - `--project` command line [flag](./test-cli#all-options) now supports '*' wildcard: ```sh npx playwright test --project='*mobile*' ``` - [New syntax](./test-annotations#annotate-tests) for test annotations: ```js 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 }) => { // ... }); ``` - [`method: Page.pdf`] accepts two new options [`tagged`](./api/class-page#page-pdf-option-tagged) and [`outline`](./api/class-page#page-pdf-option-outline). ### Announcements * ⚠️ Ubuntu 18 is not supported anymore. ### Browser Versions * Chromium 123.0.6312.4 * Mozilla Firefox 123.0 * WebKit 17.4 This version was also tested against the following stable channels: * Google Chrome 122 * Microsoft Edge 123 ## Version 1.41 ### New APIs - New method [`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. - New method [`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. - New options [`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. - New option `stylePath` for methods [`method: PageAssertions.toHaveScreenshot#1`] and [`method: LocatorAssertions.toHaveScreenshot#1`] to apply a custom stylesheet while making the screenshot. - New `fileName` option for [Blob reporter](./test-reporters#blob-reporter), to specify the name of the report to be created. ### Browser Versions * Chromium 121.0.6167.57 * Mozilla Firefox 121.0 * WebKit 17.4 This version was also tested against the following stable channels: * Google Chrome 120 * Microsoft Edge 120 ## Version 1.40 ### Test Generator Update ![Playwright Test Generator](https://github.com/microsoft/playwright/assets/9881434/e8d67e2e-f36d-4301-8631-023948d3e190) New tools to generate assertions: - "Assert visibility" tool generates [`method: LocatorAssertions.toBeVisible`]. - "Assert value" tool generates [`method: LocatorAssertions.toHaveValue`]. - "Assert text" tool generates [`method: LocatorAssertions.toContainText`]. Here is an example of a generated test with assertions: ```js 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'); }); ``` ### New APIs - Options [`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 [`option: BrowserType.launchPersistentContext.firefoxUserPrefs`] in [`method: BrowserType.launchPersistentContext`]. ### Other Changes - Methods [`method: Download.path`] and [`method: Download.createReadStream`] throw an error for failed and cancelled downloads. - Playwright [docker image](./docker.md) now comes with Node.js v20. ### Browser Versions * Chromium 120.0.6099.28 * Mozilla Firefox 119.0 * WebKit 17.4 This version was also tested against the following stable channels: * Google Chrome 119 * Microsoft Edge 119 ## Version 1.39 ### Add custom matchers to your expect You can extend Playwright assertions by providing custom matchers. These matchers will be available on the expect object. ```js title="test.spec.ts" 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](./test-assertions#add-custom-matchers-using-expectextend). ### Merge test fixtures You can now merge test fixtures from multiple files or modules: ```js title="fixtures.ts" 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); ``` ```js title="test.spec.ts" import { test } from './fixtures'; test('passes', async ({ database, page, a11y }) => { // use database and a11y fixtures. }); ``` ### Merge custom expect matchers You can now merge custom expect matchers from multiple files or modules: ```js title="fixtures.ts" 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); ``` ```js title="test.spec.ts" import { test, expect } from './fixtures'; test('passes', async ({ page, database }) => { await expect(database).toHaveDatabaseUser('admin'); await expect(page).toPassA11yAudit(); }); ``` ### Hide implementation details: box test steps You can mark a [`method: Test.step`] as "boxed" so that errors inside it point to the step call site. ```js async function login(page) { await test.step('login', async () => { // ... }, { box: true }); // Note the "box" option here. } ``` ```txt 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. ### New APIs - [`method: LocatorAssertions.toHaveAttribute#2`] ### Browser Versions * Chromium 119.0.6045.9 * Mozilla Firefox 118.0.1 * WebKit 17.4 This version was also tested against the following stable channels: * Google Chrome 118 * Microsoft Edge 118 ## Version 1.38 ### UI Mode Updates ![Playwright UI Mode](https://github.com/microsoft/playwright/assets/746130/8ba27be0-58fd-4f62-8561-950480610369) 1. Zoom into time range. 1. Network panel redesign. ### New APIs - [`event: BrowserContext.webError`] - [`method: Locator.pressSequentially`] - The [`method: Reporter.onEnd`] now reports `startTime` and total run `duration`. ### Deprecations * The following methods were deprecated: [`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. ### Breaking Changes: Playwright no longer downloads browsers automatically > **Note**: If you are using `@playwright/test` package, 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: ```yml - 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: ```json // 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" } } ``` ### Browser Versions * Chromium 117.0.5938.62 * Mozilla Firefox 117.0 * WebKit 17.0 This version was also tested against the following stable channels: * Google Chrome 116 * Microsoft Edge 116 ## Version 1.37 ### New `npx playwright merge-reports` tool If 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: 1. Adding a new "blob" reporter to the config when running on CI: ```js title="playwright.config.ts" 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. 2. Copying all "blob" reports in a single shared location and running `npx playwright merge-reports`: ```bash npx playwright merge-reports --reporter html ./all-blob-reports ``` Read more in [our documentation](./test-sharding.md). ### 📚 Debian 12 Bookworm Support 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 | ✅ | ✅ | ✅ | ✅ | ### UI Mode Updates - UI Mode now respects project dependencies. You can control which dependencies to respect by checking/unchecking them in a projects list. - Console logs from the test are now displayed in the Console tab. ### Browser Versions * Chromium 116.0.5845.82 * Mozilla Firefox 115.0 * WebKit 17.0 This version was also tested against the following stable channels: * Google Chrome 115 * Microsoft Edge 115 ## Version 1.36 🏝️ Summer maintenance release. ### Browser Versions * Chromium 115.0.5790.75 * Mozilla Firefox 115.0 * WebKit 17.0 This version was also tested against the following stable channels: * Google Chrome 114 * Microsoft Edge 114 ## Version 1.35 ### Highlights * UI mode is now available in VSCode Playwright extension via a new "Show trace viewer" button: ![Playwright UI Mode](https://github.com/microsoft/playwright/assets/746130/13094128-259b-477a-8bbb-c1181178e8a2) * 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](./api-testing): ![Trace Viewer](https://github.com/microsoft/playwright/assets/746130/0df2d4b6-faa3-465c-aff3-c435b430bfe1) * 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: ```js 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: ```bash $ 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: ```bash $ 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 ``` ### ⚠️ Breaking changes * `playwright-core` binary got renamed from `playwright` to `playwright-core`. So if you use `playwright-core` CLI, make sure to update the name: ```bash $ 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. ### Browser Versions * Chromium 115.0.5790.13 * Mozilla Firefox 113.0 * WebKit 16.4 This version was also tested against the following stable channels: * Google Chrome 114 * Microsoft Edge 114 ## Version 1.34 ### Highlights * UI Mode now shows steps, fixtures and attachments: ![UI Mode attachments](https://github.com/microsoft/playwright/assets/746130/1d280419-d79a-4a56-b2dc-54d631281d56) * 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`: ```js title="playwright.config.ts" 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`](./test-assertions.md#expectconfigure) to create pre-configured expect instance with its own defaults such as `timeout` and `soft`. ```js 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: ```js title="playwright.config.ts" 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. ```js 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. ### ⚠️ Breaking changes * `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: ```js title="automation.ts" import { chromium, firefox, webkit } from '@playwright/test'; /* ... */ ``` * Node.js 14 is no longer supported since it [reached its end-of-life](https://nodejs.dev/en/about/releases/) on April 30, 2023. ### Browser Versions * Chromium 114.0.5735.26 * Mozilla Firefox 113.0 * WebKit 16.4 This version was also tested against the following stable channels: * Google Chrome 113 * Microsoft Edge 113 ## Version 1.33 ### Locators Update * 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: ```js 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. ```js 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. ### New APIs - [`method: Locator.or`] - New option [`option: Locator.filter.hasNot`] in [`method: Locator.filter`] - New option [`option: Locator.filter.hasNotText`] in [`method: Locator.filter`] - [`method: LocatorAssertions.toBeAttached`] - New option [`option: Route.fetch.timeout`] in [`method: Route.fetch`] - [`method: Reporter.onExit`] ### ⚠️ Breaking change * The `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. ### Browser Versions * Chromium 113.0.5672.53 * Mozilla Firefox 112.0 * WebKit 16.4 This version was also tested against the following stable channels: * Google Chrome 112 * Microsoft Edge 112 ## Version 1.32 ### Introducing UI Mode (preview) New [UI Mode](./test-ui-mode.md) lets you explore, run and debug tests. Comes with a built-in watch mode. ![Playwright UI Mode](https://user-images.githubusercontent.com/746130/227004851-3901a691-4f8e-43d6-8d6b-cbfeafaeb999.png) Engage with a new flag `--ui`: ```sh npx playwright test --ui ``` ### New APIs - New options [`option: Page.routeFromHAR.updateMode`] and [`option: Page.routeFromHAR.updateContent`] in [`method: Page.routeFromHAR`] and [`method: BrowserContext.routeFromHAR`]. - Chaining existing locator objects, see [locator docs](./locators.md#matching-inside-a-locator) for details. - New property [`property: TestInfo.testId`]. - New option [`option: Tracing.startChunk.name`] in method [`method: Tracing.startChunk`]. ### ⚠️ Breaking change in component tests Note: **component tests only**, does not affect end-to-end tests. * `@playwright/experimental-ct-react` now supports **React 18 only**. * If you're running component tests with React 16 or 17, please replace `@playwright/experimental-ct-react` with `@playwright/experimental-ct-react17`. ### Browser Versions * Chromium 112.0.5615.29 * Mozilla Firefox 111.0 * WebKit 16.4 This version was also tested against the following stable channels: * Google Chrome 111 * Microsoft Edge 111 ## Version 1.31 ### New APIs - 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. ```js title="playwright.config.ts" 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](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API). ```js 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 }); ``` ### Miscellaneous - DOM snapshots in trace viewer can be now opened in a separate window. - New method `defineConfig` to be used in `playwright.config`. - New option [`option: Route.fetch.maxRedirects`] for method [`method: Route.fetch`]. - Playwright now supports Debian 11 arm64. - Official [docker images](./docker.md) now include Node 18 instead of Node 16. ### ⚠️ Breaking change in component tests Note: **component tests only**, does not affect end-to-end tests. `playwright-ct.config` configuration file for [component testing](./test-components.md) now requires calling `defineConfig`. ```js // 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: ```js // After import { defineConfig, devices } from '@playwright/experimental-ct-react'; export default defineConfig({ // ... config goes here ... }); ``` ### Browser Versions * Chromium 111.0.5563.19 * Mozilla Firefox 109.0 * WebKit 16.4 This version was also tested against the following stable channels: * Google Chrome 110 * Microsoft Edge 110 ## Version 1.30 ### Browser Versions * Chromium 110.0.5481.38 * Mozilla Firefox 108.0.2 * WebKit 16.4 This version was also tested against the following stable channels: * Google Chrome 109 * Microsoft Edge 109 ## Version 1.29 ### New APIs - New method [`method: Route.fetch`] and new option `json` for [`method: Route.fulfill`]: ```js 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: ```js // 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: ```html ``` ```js await element.selectOption('Red'); ``` - Retry blocks of code until all assertions pass: ```js await expect(async () => { const response = await page.request.get('https://api.example.com'); await expect(response).toBeOK(); }).toPass(); ``` Read more in [our documentation](./test-assertions.md#expecttopass). - Automatically capture **full page screenshot** on test failure: ```js title="playwright.config.ts" import { defineConfig } from '@playwright/test'; export default defineConfig({ use: { screenshot: { mode: 'only-on-failure', fullPage: true, } } }); ``` ### Miscellaneous - Playwright Test now respects [`jsconfig.json`](https://code.visualstudio.com/docs/languages/jsconfig). - New options `args` and `proxy` for [`method: AndroidDevice.launchBrowser`]. - Option `postData` in method [`method: Route.continue`] now supports [Serializable] values. ### Browser Versions * Chromium 109.0.5414.46 * Mozilla Firefox 107.0 * WebKit 16.4 This version was also tested against the following stable channels: * Google Chrome 108 * Microsoft Edge 108 ## Version 1.28 ### Playwright Tools * **Record at Cursor in VSCode.** You can run the test, position the cursor at the end of the test and continue generating the test. ![New VSCode Extension](https://user-images.githubusercontent.com/746130/202005839-aba2eeba-217b-424d-8496-8b4f5fa72f41.png) * **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. ![Locator Explorer](https://user-images.githubusercontent.com/746130/201796876-01567a0b-ca61-4a9d-b12b-04786c471671.png) * **Codegen and Trace Viewer Dark Theme.** Automatically picked up from operating system settings. ![Dark Theme](https://user-images.githubusercontent.com/746130/201797969-603f74df-d7cf-4c56-befd-798dbd269796.png) ### Test Runner * Configure retries and test timeout for a file or a test with [`method: Test.describe.configure`]. ```js // 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`]. ```js title="playwright.config.ts" import { defineConfig } from '@playwright/test'; export default defineConfig({ testDir: './tests', snapshotPathTemplate: '{testDir}/__screenshots__/{testFilePath}/{arg}{ext}', }); ``` ### New APIs - [`method: Locator.blur`] - [`method: Locator.clear`] - [`method: Android.launchServer`] and [`method: Android.connect`] - [`event: AndroidDevice.close`] ### Browser Versions * Chromium 108.0.5359.29 * Mozilla Firefox 106.0 * WebKit 16.4 This version was also tested against the following stable channels: * Google Chrome 107 * Microsoft Edge 107 ## Version 1.27 ### Locators 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](https://www.w3.org/TR/wai-aria-1.2/#roles), [ARIA attributes](https://www.w3.org/TR/wai-aria-1.2/#aria-attributes) and [accessible name](https://w3c.github.io/accname/#dfn-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. ```js 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. ### Other highlights - `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: ```bash npx playwright test --workers=20% ``` - New options `host` and `port` for the html reporter. ```js 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. ### Behavior Changes - [`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. ```js 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. ### Browser Versions * Chromium 107.0.5304.18 * Mozilla Firefox 105.0.1 * WebKit 16.0 This version was also tested against the following stable channels: * Google Chrome 106 * Microsoft Edge 106 ## Version 1.26 ### Assertions - New option `enabled` for [`method: LocatorAssertions.toBeEnabled`]. - [`method: LocatorAssertions.toHaveText`] now pierces open shadow roots. - New option `editable` for [`method: LocatorAssertions.toBeEditable`]. - New option `visible` for [`method: LocatorAssertions.toBeVisible`]. ### Other highlights - New option `maxRedirects` for [`method: APIRequestContext.get`] and others to limit redirect count. - New command-line flag `--pass-with-no-tests` that allows the test suite to pass when no files are found. - New command-line flag `--ignore-snapshots` to skip snapshot expectations, such as `expect(value).toMatchSnapshot()` and `expect(page).toHaveScreenshot()`. ### Behavior Change A bunch of Playwright APIs already support the `waitUntil: 'domcontentloaded'` option. For example: ```js 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. ### Browser Versions * Chromium 106.0.5249.30 * Mozilla Firefox 104.0 * WebKit 16.0 This version was also tested against the following stable channels: * Google Chrome 105 * Microsoft Edge 105 ## Version 1.25 ### VSCode Extension * Watch your tests running live & keep devtools open. * Pick selector. * Record new test from current page state. ![vscode extension screenshot](https://user-images.githubusercontent.com/746130/183781999-1b9fdbc5-cfae-47d6-b4f7-5d4ae89716a8.jpg) ### Test Runner * [`method: Test.step`] now returns the value of the step function: ```js 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`. ### Announcements * 🎁 We now ship Ubuntu 22.04 Jammy Jellyfish docker image: `mcr.microsoft.com/playwright:v1.34.0-jammy`. * 🪦 This is the last release with macOS 10.15 support (deprecated as of 1.21). * 🪦 This is the last release with Node.js 12 support, we recommend upgrading to Node.js LTS (16). * ⚠️ Ubuntu 18 is now deprecated and will not be supported as of Dec 2022. ### Browser Versions * Chromium 105.0.5195.19 * Mozilla Firefox 103.0 * WebKit 16.0 This version was also tested against the following stable channels: * Google Chrome 104 * Microsoft Edge 104 ## Version 1.24 ### 🌍 Multiple Web Servers in `playwright.config.ts` Launch multiple web servers, databases, or other processes by passing an array of configurations: ```js title="playwright.config.ts" 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/', }, }); ``` ### 🐂 Debian 11 Bullseye Support 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 | ✅ | ✅ | ✅ | ### 🕵️ Anonymous Describe 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`]. ```js test.describe(() => { test.use({ colorScheme: 'dark' }); test('one', async ({ page }) => { // ... }); test('two', async ({ page }) => { // ... }); }); ``` ### 🧩 Component Tests Update 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: ```js title="src/component.spec.ts" 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 */ } }); }); ``` ```js title="playwright/index.ts" 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: ```js title="src/component.spec.jsx" import { test } from '@playwright/experimental-ct-react'; import { Component } from './mycomponent'; test('should work', async ({ mount }) => { const component = await mount(, { // Pass mock value from test into `beforeMount`. hooksConfig: { router: { query: { page: 1, per_page: 10 }, asPath: '/posts' } } }); }); ``` ```js title="playwright/index.js" 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; }); ``` ## Version 1.23 ### Network Replay Now you can record network traffic into a HAR file and re-use this traffic in your tests. To record network into HAR file: ```bash npx playwright open --save-har=github.har.zip https://github.com/microsoft ``` Alternatively, you can record HAR programmatically: ```js 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](http://www.softwareishard.com/blog/har-12-spec/) file: ```js await context.routeFromHAR('github.har.zip'); ``` Read more in [our documentation](./mock.md#mocking-with-har-files). ### Advanced Routing You can now use [`method: Route.fallback`] to defer routing to other handlers. Consider the following example: ```js // 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. ### Web-First Assertions Update * New method [`method: LocatorAssertions.toHaveValues`] that asserts all selected values of `