Snyk has created this PR to upgrade @playwright/test from 1.19.0-alpha-1643749494000 to 1.46.0.
:information_source: Keep your dependencies up-to-date. This makes it easier to fix existing vulnerabilities and to more quickly identify and fix newly disclosed vulnerabilities when they affect your project.
The recommended version is 1633 versions ahead of your current version.
The recommended version was released on a month ago.
Playwright now allows to supply client-side certificates, so that server can verify them, as specified by TLS Client Authentication.
When client certificates are specified, all browser traffic is routed through a proxy that establishes the secure TLS connection, provides client certificates to the server and validates server certificates.
The following snippet sets up a client certificate for https://example.com:
New CLI option --only-changed allows to only run test files that have been changed since the last git commit or from a specific git "ref".
# 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
Component Testing: New router fixture
This release introduces an experimental router fixture to intercept and handle network requests in component testing.
There are two ways to use the router fixture:
Call router.route(url, handler) that behaves similarly to page.route().
Call 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 testawaitrouter.use(...handlers);});test('example test',async({ mount })=>{// test as usual, your handlers are active// ...});
New option to box a fixture to minimize the fixture exposure in test reports and error messages.
New option to provide a custom fixture title to be used in test reports and error messages.
Possibly breaking change
Fixture values that are array of objects, when specified in the test.use() block, may require being wrapped into a fixture tuple. This is best seen on the example:
import{testasbase}from'@ playwright/test';// Define an option fixture that has an "array of objects" valuetypeUser={name: string,password: string};consttest=base.extend<{users: User[]}>({users: [[],{option: true}],});// Specify option value in the test.use block.test.use({// WRONG: this syntax may not work for youusers: [{name: 'John Doe',password: 'secret'},{name: 'John Smith',password: 's3cr3t'},],// CORRECT: this syntax will work. Note extra [] around the value, and the "scope" property.users: [[{name: 'John Doe',password: 'secret'},{name: 'John Smith',password: 's3cr3t'},],{scope: 'test'}],});test('example test',async()=>{// ...});
Browser Versions
Chromium 128.0.6613.18
Mozilla Firefox 128.0
WebKit 18.0
This version was also tested against the following stable channels:
#31613 - [REGRESSION]: Trace is not showing any screenshots nor test name #31601 - [REGRESSION]: missing trace for 2nd browser #31541 - [REGRESSION]: Failing tests have a trace with no images and with steps missing
Browser Versions
Chromium 127.0.6533.5
Mozilla Firefox 127.0
WebKit 17.4
This version was also tested against the following stable channels:
#31473 - [REGRESSION]: Playwright raises an error ENOENT: no such file or directory, open 'test-results/.playwright-artifacts-0/hash.zip' with Electron #31442 - [REGRESSION]: Locators of elements changing from/to hidden have operations hanging when using --disable-web-security #31431 - [REGRESSION]: NewTab doesn't work properly with Chrome with --disable-web-security #31425 - [REGRESSION]: beforeEach hooks are not skipped when describe condition depends on fixtures #31491 - [REGRESSION]: @ playwright/experimental-ct-react doesn't work with VSCode extension and PNPM
Browser Versions
Chromium 127.0.6533.5
Mozilla Firefox 127.0
WebKit 17.4
This version was also tested against the following stable channels:
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:
testing with predefined time;
keeping consistent time and timers;
monitoring inactivity;
ticking through time manually.
// Initialize clock and let the page load naturally.awaitpage.clock.install({time: newDate('2024-02-02T08:00:00')});awaitpage.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.awaitpage.clock.pauseAt(newDate('2024-02-02T10:00:00'));// Assert the page state.awaitexpect(page.getByTestId('current-time')).toHaveText('2/2/2024, 10:00:00 AM');// Close the laptop lid again and open it at 10:30am.awaitpage.clock.fastForward('30:00');awaitexpect(page.getByTestId('current-time')).toHaveText('2/2/2024, 10:30:00 AM');
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 enviroment 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 property timeout is now available for custom expect matchers. This property takes into account playwright.config.ts and expect.configure().
import{expectasbaseExpect}from'@ playwright/test';exportconstexpect=baseExpect.extend({asynctoHaveAmount(locator: Locator,expected: number,options?: {timeout?: number}){// When no timeout option is specified, use the config timeout.consttimeout=options?.timeout??this.timeout;// ... implement the assertion ...},});
Miscellaneous
Method locator.setInputFiles() now supports uploading a directory for <input type=file webkitdirectory> elements.
Multiple methods like locator.click() or 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.awaitpage.keyboard.press('ControlOrMeta+S');
New property httpCredentials.send in apiRequest.newContext() that allows to either always send the Authorization header or only send it in response to 401 Unauthorized.
New option reason in apiRequestContext.dispose() that will be included in the error message of ongoing operations interrupted by the context disposal.
New option host in 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:
#30779 - [REGRESSION]: When using video: 'on' with VSCode extension the browser got closed #30755 - [REGRESSION]: Electron launch with spaces inside executablePath didn't work #30770 - [REGRESSION]: Mask elements outside of viewport when creating fullscreen screenshots didn't work #30858 - [REGRESSION]: ipv6 got shown instead of localhost in show-trace/show-report
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:
After executing the handler added with 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 page.addLocatorHandler() to specify maximum number of times the handler should be run.
constlocator=page.getByText('This interstitial covers the button');awaitpage.addLocatorHandler(locator,asyncoverlay=>{awaitoverlay.locator('#close').click();},{times: 3,noWaitAfter: true});// Run your tests that can be interrupted by the overlay.// ...awaitpage.removeLocatorHandler(locator);
Miscellaneous options
multipart option in apiRequestContext.fetch() now accepts FormData and supports repeating fields with the same name.
constformData=newFormData();formData.append('file',newFile(['let x = 2024;'],'f1.js',{type: 'text/javascript'}));formData.append('file',newFile(['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.inervals option globally in testConfig.expect or per project in testProject.expect.
expect(page).toHaveURL(url) now supports ignoreCaseoption.
New method suite.entries() returns child test suites and test cases in their declaration order. suite.type and testCase.type can be used to tell apart test cases and suites in the list.
Blob 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 reporter now supports includeProjectInTestName option.
Command line
--last-failed CLI option 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)
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:
Snyk has created this PR to upgrade @playwright/test from 1.19.0-alpha-1643749494000 to 1.46.0.
:information_source: Keep your dependencies up-to-date. This makes it easier to fix existing vulnerabilities and to more quickly identify and fix newly disclosed vulnerabilities when they affect your project.
The recommended version is 1633 versions ahead of your current version.
The recommended version was released on a month ago.
Issues fixed by the recommended upgrade:
SNYK-JS-SEMVER-3247795
SNYK-JS-WS-7266574
SNYK-JS-BRACES-6838727
SNYK-JS-IP-6240864
SNYK-JS-JPEGJS-2859218
SNYK-JS-MICROMATCH-6838728
SNYK-JS-JSON5-3182856
SNYK-JS-MINIMIST-2429795
SNYK-JS-BABELTRAVERSE-5962462
SNYK-JS-INFLIGHT-6095116
SNYK-JS-IP-7148531
SNYK-JS-JSON5-3182856
SNYK-JS-MINIMATCH-3050818
Release notes
Package name: @playwright/test
TLS Client Certificates
Playwright now allows to supply client-side certificates, so that server can verify them, as specified by TLS Client Authentication.
When client certificates are specified, all browser traffic is routed through a proxy that establishes the secure TLS connection, provides client certificates to the server and validates server certificates.
The following snippet sets up a client certificate for
https://example.com:You can also provide client certificates to a particular test project or as a parameter of browser.newContext() and apiRequest.newContext().
--only-changedcli optionNew CLI option
--only-changedallows to only run test files that have been changed since the last git commit or from a specific git "ref".Component Testing: New
routerfixtureThis release introduces an experimental
routerfixture 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 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.
This fixture is only available in component tests.
UI Mode / Trace Viewer Updates
baseURL.Miscellaneous
maxRetriesoption in apiRequestContext.fetch() which retries on theECONNRESETnetwork error.Possibly breaking change
Fixture values that are array of objects, when specified in the
test.use()block, may require being wrapped into a fixture tuple. This is best seen on the example:Browser Versions
This version was also tested against the following stable channels:
Highlights
#31764 - [Bug]: some actions do not appear in the trace file
microsoft/playwright-java#1617 - [Bug]: Traceviewer not reporting all actions
Browser Versions
This version was also tested against the following stable channels:
Highlights
#31613 - [REGRESSION]: Trace is not showing any screenshots nor test name
#31601 - [REGRESSION]: missing trace for 2nd browser
#31541 - [REGRESSION]: Failing tests have a trace with no images and with steps missing
Browser Versions
This version was also tested against the following stable channels:
Highlights
#31473 - [REGRESSION]: Playwright raises an error ENOENT: no such file or directory, open 'test-results/.playwright-artifacts-0/hash.zip' with Electron
#31442 - [REGRESSION]: Locators of elements changing from/to hidden have operations hanging when using
--disable-web-security#31431 - [REGRESSION]: NewTab doesn't work properly with Chrome with
--disable-web-security#31425 - [REGRESSION]: beforeEach hooks are not skipped when describe condition depends on fixtures
#31491 - [REGRESSION]:
@ playwright/experimental-ct-reactdoesn't work with VSCode extension and PNPMBrowser Versions
This version was also tested against the following stable channels:
Clock
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:
See the clock guide for more details.
Test runner
New CLI option
--fail-on-flaky-teststhat sets exit code to1upon any flaky tests. Note that by default, the test runner exits with code0when all failed tests recovered upon a retry. With this option, the test run will fail in such case.New enviroment variable
PLAYWRIGHT_FORCE_TTYcontrols whether built-inlist,lineanddotreporters 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.New options testConfig.respectGitIgnore and testProject.respectGitIgnore control whether files matching
.gitignorepatterns are excluded when searching for tests.New property
timeoutis now available for custom expect matchers. This property takes into accountplaywright.config.tsandexpect.configure().Miscellaneous
Method locator.setInputFiles() now supports uploading a directory for
<input type=file webkitdirectory>elements.Multiple methods like locator.click() or locator.press() now support a
ControlOrMetamodifier key. This key maps toMetaon macOS and maps toControlon Windows and Linux.New property
httpCredentials.sendin apiRequest.newContext() that allows to either always send theAuthorizationheader or only send it in response to401 Unauthorized.New option
reasonin apiRequestContext.dispose() that will be included in the error message of ongoing operations interrupted by the context disposal.New option
hostin browserType.launchServer() allows to accept websocket connections on a specific address instead of unspecified0.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
This version was also tested against the following stable channels:
Highlights
#30779 - [REGRESSION]: When using
video: 'on'with VSCode extension the browser got closed#30755 - [REGRESSION]: Electron launch with spaces inside executablePath didn't work
#30770 - [REGRESSION]: Mask elements outside of viewport when creating fullscreen screenshots didn't work
#30858 - [REGRESSION]: ipv6 got shown instead of localhost in show-trace/show-report
Browser Versions
This version was also tested against the following stable channels:
New APIs
Accessibility assertions
expect(locator).toHaveAccessibleName() checks if the element has the specified accessible name:
expect(locator).toHaveAccessibleDescription() checks if the element has the specified accessible description:
expect(locator).toHaveRole() checks if the element has the specified ARIA role:
Locator handler
noWaitAfteroption.timesoption in page.addLocatorHandler() to specify maximum number of times the handler should be run.Miscellaneous options
multipartoption inapiRequestContext.fetch()now acceptsFormDataand supports repeating fields with the same name.expect(callback).toPass({ intervals })can now be configured byexpect.toPass.inervalsoption globally in testConfig.expect or per project in testProject.expect.expect(page).toHaveURL(url)now supportsignoreCaseoption.testProject.ignoreSnapshots allows to configure per project whether to skip screenshot expectations.
Reporter API
outputFile. The same option can also be specified asPLAYWRIGHT_BLOB_OUTPUT_FILEenvironment variable that might be more convenient on CI/CD.includeProjectInTestNameoption.Command line
--last-failedCLI option 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-failedoption:$ npx playwright test --last-failed Running 2 tests using 2 workers 2 passed (1.2s)Browser Versions
This version was also tested against the following stable channels: