Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
TypeScript automationchromechromiume2e-testingelectronend-to-end-testingfirefoxjavascriptplaywrighttesttest-automationtestingtesting-toolswebwebkit
docs: release notes v1.59 (#39941)
Pavel Feldmanc3a74dcab064
diff --git a/docs/src/images/release-notes-1.59-screencast-demo.gif b/docs/src/images/release-notes-1.59-screencast-demo.gifnew file mode 100644index 0000000000..90b2e029f5Binary files /dev/null and b/docs/src/images/release-notes-1.59-screencast-demo.gif differdiff --git a/docs/src/release-notes-js.md b/docs/src/release-notes-js.mdindex c909043c10..435911d424 100644--- a/docs/src/release-notes-js.md+++ b/docs/src/release-notes-js.md@@ -6,6 +6,207 @@ toc_max_heading_level: 2import LiteYouTube from '@site/src/components/LiteYouTube';+## Version 1.59++### π¬ Screencast++New [`property: Page.screencast`] API provides a unified interface for capturing page content β both as video recordings and as real-time frame streams.++<img src="https://raw.githubusercontent.com/microsoft/playwright/main/docs/src/images/release-notes-1.59-screencast-demo.gif" alt="Demo" width="500" height="313" />++**Video recording** β record video with precise start/stop control, as an alternative to the [`option: Browser.newContext.recordVideo`] option:++```js+await page.screencast.start({ path: 'video.webm' });+// ... perform actions ...+await page.screencast.stop();+```++**Real-time frame capture** β stream JPEG-encoded frames for custom processing like thumbnails, live previews, AI vision, and more:++```js+await page.screencast.start({+ onFrame: ({ data }) => sendToVisionModel(data),+ size: { width: 800, height: 600 },+});+```++**Action annotations** β enable built-in visual annotations that highlight interacted elements and display action titles during recording:++```js+await page.screencast.start({+ path: 'video.webm',+ annotate: { position: 'top-right' },+});+```++The `annotate` option accepts `position` (`'top-left'`, `'top'`, `'top-right'`, `'bottom-left'`, `'bottom'`, `'bottom-right'`), `duration` (ms per annotation), and `fontSize` (px).++**Visual overlays** β add chapter titles and custom HTML overlays on top of the page for richer narration:++```js+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>');+```++**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:++```js+await page.screencast.start({+ path: 'receipt.webm',+ annotate: { 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.++### π€ Agentic Tools++#### CLI debugger++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:++```bash+$ 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+```++#### CLI trace analysis++Coding agents can run `npx playwright trace` to explore [Playwright Trace](./trace-viewer.md) and understand failing or flaky tests from the command line:++```bash+$ 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 using`++Many APIs now return [async disposables](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/asyncDispose), enabling the `await using` syntax for automatic cleanup:++```js+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+```++### π Snapshots and Locators++- Method [`method: Page.ariaSnapshot`] to capture the aria snapshot of the page β equivalent to `page.locator('body').ariaSnapshot()`.+- Options `depth` and `mode` in [`method: Locator.ariaSnapshot`].+- Method [`method: Locator.normalize`] converts a locator to follow best practices like test ids and aria roles.+- Method [`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.++### New APIs++#### Screencast++- [`property: Page.screencast`] provides video recording, real-time frame streaming, and overlay management.+- Methods [`method: Screencast.start`] and [`method: Screencast.stop`] for recording and frame capture.+- Methods [`method: Screencast.showChapter`] and [`method: Screencast.showOverlay`] for visual annotations.+- Methods [`method: Screencast.showOverlays`] and [`method: Screencast.hideOverlays`] for overlay visibility control.++#### Storage, Console and Errors++- Method [`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.+- Methods [`method: Page.clearConsoleMessages`] and [`method: Page.clearPageErrors`] to clear stored messages and errors.+- Option `filter` in [`method: Page.consoleMessages`] and [`method: Page.pageErrors`] controls which messages are returned.+- Method [`method: ConsoleMessage.timestamp`].++#### Miscellaneous++- [`property: BrowserContext.debugger`] provides programmatic control over the Playwright debugger.+- Method [`method: BrowserContext.isClosed`].+- Method [`method: Request.existingResponse`] returns the response without waiting.+- Method [`method: Response.httpVersion`] returns the HTTP version used by the response.+- Events [`event: CDPSession.event`] and [`event: CDPSession.close`] for CDP sessions.+- Option `live` in [`method: Tracing.start`] for real-time trace updates.+- Option `artifactsDir` in [`method: BrowserType.launch`] to configure the artifacts directory.++### π οΈ Other improvements++- UI Mode has an option to only show tests affected by source changes.+- UI Mode and Trace Viewer have improved action filtering.+- HTML Reporter shows the list of runs from the same worker.+- HTML Reporter allows filtering test steps for quick search.+- New trace mode `'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.++### Breaking Changes β οΈ++- Removed macOS 14 support for WebKit. We recommend upgrading your macOS version, or keeping an older Playwright version.+- Removed `@playwright/experimental-ct-svelte` package.++### Browser Versions++- Chromium 146.0.7680.31+- Mozilla Firefox 148.0.2+- WebKit 26.0++This version was also tested against the following stable channels:++- Google Chrome 145+- Microsoft Edge 145++## Version 1.58### Timeline