[Snyk] Upgrade playwright from 1.39.0 to 1.52.0#229
Closed
Conversation
Snyk has created this PR to upgrade playwright from 1.39.0 to 1.52.0. See this package in npm: playwright See this project in Snyk: https://app.snyk.io/org/cognigy-gmbh/project/056b6112-fb88-4e0a-ac0e-394c72d16862?utm_source=github&utm_medium=referral&page=upgrade-pr
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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 from 1.39.0 to 1.52.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 857 versions ahead of your current version.
The recommended version was released 2 months ago.
Release notes
Package name: playwright
Highlights
New method expect(locator).toContainClass() to ergonomically assert individual class names on the element.
Aria Snapshots got two new properties:
/childrenfor strict matching and/urlfor links.Test Runner
--fail-on-flaky-tests. This is useful for CI/CD environments where you want to ensure that all tests are stable before deploying.Miscellaneous
maxRedirectsin apiRequest.newContext() to control the maximum number of redirects.refin locator.ariaSnapshot() to generate reference for each element in the snapshot which can later be used to locate the element.!@ my-tagor!my-file.spec.tsor!p:my-project.Breaking Changes
?wildcard is not supported any more, it will always match question mark?character.[]are not supported anymore. We recommend using regular expressions instead.Cookieheader anymore. If aCookieheader is provided, it will be ignored, and the cookie will be loaded from the browser's cookie store. To set custom cookies, use browserContext.addCookies().Browser Versions
This version was also tested against the following stable channels:
Highlights
#35093 - [Regression]: TimeoutOverflowWarning: 2149630296.634 does not fit into a 32-bit signed integer
#35138 - [Regression]: TypeError: Cannot read properties of undefined (reading 'expectInfo')
Browser Versions
This version was also tested against the following stable channels:
StorageState for indexedDB
New option
indexedDBfor browserContext.storageState() allows to save and restore IndexedDB contents. Useful when your application uses IndexedDB API to store authentication tokens, like Firebase Authentication.Here is an example following the authentication guide:
import { test as setup, expect } from '@ playwright/test';
import path from 'path';
const authFile = path.join(__dirname, '../playwright/.auth/user.json');
setup('authenticate', async ({ page }) => {
await page.goto('/');
// ... perform authentication steps ...
// make sure to save indexedDB
await page.context().storageState({ path: authFile, indexedDB: true });
});
Copy 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.
Filter visible elements
New option
visiblefor locator.filter() allows matching only visible elements.Git information in HTML report
Set option testConfig.captureGitInfo to capture git information into testConfig.metadata.
import { defineConfig } from '@ playwright/test';
export default defineConfig({
captureGitInfo: { commit: true, diff: true }
});
HTML report will show this information when available:
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.
// Note the new "step" argument:
await test.step('here is my step', async step => {
step.skip(isMobile, 'not relevant on mobile layouts');
});
});
Miscellaneous
contrastfor methods page.emulateMedia() and browser.newContext() allows to emulate theprefers-contrastmedia feature.failOnStatusCodemakes all fetch requests made through the APIRequestContext throw on response codes other than 2xx and 3xx.Browser Versions
This version was also tested against the following stable channels:
Highlights
#34483 - [Feature]: single aria snapshot for different engines/browsers
#34497 - [Bug]: Firefox not handling keepalive: true fetch requests
#34504 - [Bug]: update snapshots not creating good diffs
#34507 - [Bug]: snapshotPathTemplate doesnt work when multiple projects
#34462 - [Bug]: updateSnapshots "changed" throws an error
Browser Versions
This version was also tested against the following stable channels:
Test runner
New option
timeoutallows specifying a maximum run time for an individual test step. A timed-out step will fail the execution of the test.New method test.step.skip() to disable execution of a test step.
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 expect(locator).toMatchAriaSnapshot() to allow storing of aria snapshots in separate YAML files.
Added method expect(locator).toHaveAccessibleErrorMessage() to assert the Locator points to an element with a given aria errormessage.
Option testConfig.updateSnapshots added the configuration enum
changed.changedupdates only the snapshots that have changed, whereasallnow updates all snapshots, regardless of whether there are any differences.New option testConfig.updateSourceMethod defines the way source code is updated when testConfig.updateSnapshots is configured. Added
overwriteand3-waymodes that write the changes into source code, on top of existingpatchmode that creates a patch file.npx playwright test --update-snapshots=changed --update-source-method=3wayOption testConfig.webServer added a
gracefulShutdownfield for specifying a process kill signal other than the defaultSIGKILL.Exposed testStep.attachments from the reporter API to allow retrieval of all attachments created by that step.
New option
pathTemplatefortoHaveScreenshotandtoMatchAriaSnapshotassertions in the testConfig.expect configuration.UI updates
canvascontent in traces is error-prone. Display is now disabled by default, and can be enabled via theDisplay canvas contentUI setting.CallandNetworkpanels now display additional time information.Breaking
<input>,<select>, or a number of other editable elements.all, rather than only the failed/changed snapshots. Use the new enumchangedto keep the old functionality of only updating the changed snapshots.Browser Versions
This version was also tested against the following stable channels:
Highlights
#33802 - [Bug]: Codegen's Clear button doesn't work if not recording
#33806 - [Bug]: playwright hangs while waiting for pending navigations
#33787 - [Bug]: VSC extension isn't capturing all entered text
#33788 - [Regression]: Double clicking the steps in trace viewer doesn't filter actions
#33772 - [Bug]: aria_snapshot generates invalid yaml when combined with an aria-label attribut
#33791 - [Bug]: text input with number value raises "container is not iterable" with to_match_aria_snapshot
#33644 - [Bug]: getByRole can't find element with the accessible name from label element when aria-labelledby is not valid
#33660 - [Regression]: Unable to open Playwright UI in Dark Mode
Browser Versions
This version was also tested against the following stable channels:
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-snapshotscommand line flag.Learn more in the aria snapshots guide.
Test runner
tsconfigto be used for all tests.'on-first-failure'for testOptions.screenshot.Error.cause.Breaking: channels
chrome,msedgeand 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-canarymsedge,msedge-dev,msedge-beta, ormsedge-canaryWhat 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-vue2will no longer be updated.@ playwright/experimental-ct-solidwill 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: