[Snyk] Upgrade @playwright/test from 1.19.0-alpha-1643749494000 to 1.49.0 #1467
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Snyk has created this PR to upgrade @playwright/test from 1.19.0-alpha-1643749494000 to 1.49.0.
ℹ️ 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 1831 versions ahead of your current version.
The recommended version was released on 25 days 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
Aria snapshots
New assertion expect(locator).toMatchAriaSnapshot() verifies page structure by comparing to an expected accessibility tree, represented as YAML.
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.
Test runner
tsconfig
to be used for all tests.'on-first-failure'
for testOptions.screenshot.Error.cause
.Breaking: channels
chrome
,msedge
and similar switch to new headlessThis change affects you if you're using one of the following channels in your
playwright.config.ts
:chrome
,chrome-dev
,chrome-beta
, orchrome-canary
msedge
,msedge-dev
,msedge-beta
, ormsedge-canary
What do I need to do?
After 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.
Other breaking changes
@ playwright/experimental-ct-vue2
will no longer be updated.@ playwright/experimental-ct-solid
will no longer be updated.Try new Chromium headless
You can opt into the new headless mode by using
'chromium'
channel. As official Chrome documentation puts it: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.
export default defineConfig({
projects: [
{
name: 'chromium',
use: { ...devices['Desktop Chrome'], channel: 'chromium' },
},
],
});
Miscellaneous
<canvas>
elements inside a snapshot now draw a preview.Browser Versions
This version was also tested against the following stable channels:
Highlights
#33141 - [Bug]: UI Mode crashed
#33219 - [BUG] Trace Viewer PWA crashes with "Aw, Snap!"
#33086 - [Bug]: UI Mode Memory problem
#33000 - [Regression]: Inspector and Browser doesn't close on CTRL+C
#33204 - [Bug]: Chrome tab and inspector not closing after terminating session in terminal
Browser Versions
This version was also tested against the following stable channels:
Highlights
#33023 - [Bug]: command line flag --headed has no effect in ui mode
#33107 - [REGRESSION]: page.waitForRequest does not get resolved since 1.48.0
#33085 - [Bug]: WebSocket route does not handle full URLs in Playwright
#33052 - [Regression]: Inspector not showing recorded steps
#33132 - [Bug]: Wrong Ubuntu release name in Dockerfile.noble
#32996 - [BUG] Trace attachments have small unusable height
Browser Versions
This version was also tested against the following stable channels:
WebSocket routing
New methods page.routeWebSocket() and 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"
.See WebSocketRoute for more details.
UI updates
Miscellaneous
form
and similar ones now accept FormData.location
to pass custom step location.Browser Versions
This version was also tested against the following stable channels:
Highlights
#32699 [REGRESSION]: fix(codegen): use content_frame property in python/.NET
#32706 [REGRESSION]: page.pause() does not pause test timeout after 1.47
#32661 - fix(trace-viewer): time delta between local and remote actions
Browser Versions
This version was also tested against the following stable channels:
Highlights
#32480 - [REGRESSION]: tsconfig.json's compilerOptions.paths no longer working in 1.47
#32552 - [REGRESSION]: broken UI in Trace Viewer while showing network response body
Browser Versions
This version was also tested against the following stable channels:
Network Tab improvements
The Network tab in the UI mode and trace viewer has several nice improvements:
Credit to @ kubajanik for these wonderful 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:
APIRequestContext now accepts
URLSearchParams
andstring
as query parametersYou can now pass
URLSearchParams
andstring
as query parameters to APIRequestContext:Miscellaneous
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.:latest
/:focal
/:jammy
tag for Playwright Docker images is no longer being published. Pin to a specific version for better stability and reproducibility.behavior
in page.removeAllListeners(), browser.removeAllListeners() and browserContext.removeAllListeners() to wait for ongoing listeners to complete.cert
andkey
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.noWaitAfter
in locator.selectOption() was deprecated.macos-13
. We recommend upgrading GitHub Actions tomacos-14
.Browser Versions
This version was also tested against the following stable channels:
Highlights
#32004 - [REGRESSION]: Client Certificates don't work with Microsoft IIS
#32004 - [REGRESSION]: Websites stall on TLS handshake errors when using Client Certificates
#32146 - [BUG]: Credential scanners warn about internal socks-proxy TLS certificates
#32056 - [REGRESSION]: 1.46.0 (TypeScript) - custom fixtures extend no longer chainable
#32070 - [Bug]: --only-changed flag and project dependencies
#32188 - [Bug]: --only-changed with shallow clone throws "unknown revision" error
Browser Versions
This version was also tested against the following stable channels:
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
: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 browser.newContext() and apiRequest.newContext().
--only-changed
cli optionNew 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".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
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 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.
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.
UI Mode / Trace Viewer Updates
baseURL
.Miscellaneous
maxRetries
option in apiRequestContext.fetch() which retries on theECONNRESET
network 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:// Define an option fixture that has an "array of objects" value
type User = { name: string, password: string };
const test = base.extend<{ users: User[] }>({
users: [ [], { option: true } ],
});
// Specify option value in the test.use block.
test.use({
// WRONG: this syntax may not work for you
users: [
{ 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
This version was also tested against the following stable channels: