Update @playwright/test 1.39.0 → 1.44.0 (minor) #536

depfu · 2024-05-08T10:41:53Z

Here is everything you need to know about this update. Please take a good look at what changed and the test results before merging this pull request.

What changed?

✳️ @playwright/test (1.39.0 → 1.44.0) · Repo

Release Notes

1.44.0

New APIs

Accessibility assertions
expect(locator).toHaveAccessibleName() checks if the element has the specified accessible name:
const locator = page.getByRole('button');
await expect(locator).toHaveAccessibleName('Submit');
expect(locator).toHaveAccessibleDescription() checks if the element has the specified accessible description:
const locator = page.getByRole('button');
await expect(locator).toHaveAccessibleDescription('Upload a photo');
expect(locator).toHaveRole() checks if the element has the specified ARIA role:
const locator = page.getByTestId('save-button');
await expect(locator).toHaveRole('button');
Locator handler

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.

The handler in page.addLocatorHandler() now accepts the locator as argument.

New page.removeLocatorHandler() method for removing previously added locator handlers.
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 option in apiRequestContext.fetch() now accepts FormData and supports repeating fields with the same name.
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.inervals option globally in testConfig.expect or per project in testProject.expect.

expect(page).toHaveURL(url) now supports ignoreCase option.

testProject.ignoreSnapshots allows to configure per project whether to skip screenshot expectations.
Reporter API

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:

Google Chrome 124

Microsoft Edge 124

1.43.1

Highlights

#30300 - [REGRESSION]: UI mode restarts if keep storage state
#30339 - [REGRESSION]: Brand new install of playwright, unable to run chromium with show browser using vscode

Browser Versions

Chromium 124.0.6367.29

Mozilla Firefox 124.0

WebKit 17.4

This version was also tested against the following stable channels:

Google Chrome 123

Microsoft Edge 123

1.43.0

New APIs
Method browserContext.clearCookies() now supports filters to remove only some cookies.
// 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 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.
import { defineConfig } from '@playwright/test';
export default defineConfig({

use: {

trace: 'retain-on-first-failure',

},

});
New property testInfo.tags exposes test tags during test execution.
test('example', async ({ page }) => {
  console.log(test.info().tags);
});
New 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.
const locator = page.locator('iframe[name="embedded"]');
// ...
const frameLocator = locator.contentFrame();
await frameLocator.getByRole('button').click();
New 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.
const frameLocator = page.frameLocator('iframe[name="embedded"]');
// ...
const locator = frameLocator.owner();
await expect(locator).toBeVisible();
UI Mode Updates

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.29

Mozilla Firefox 124.0

WebKit 17.4

This version was also tested against the following stable channels:

Google Chrome 123

Microsoft Edge 123

1.42.1

Highlights

#29732 - [Regression]: HEAD requests to webServer.url since v1.42.0
#29746 - [Regression]: Playwright CT CLI scripts fail due to broken initializePlugin import
#29739 - [Bug]: Component tests fails when imported a module with a dot in a name
#29731 - [Regression]: 1.42.0 breaks some import statements
#29760 - [Bug]: Possible regression with chained locators in v1.42

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

1.42.0

New APIs
Test tags

New tag syntax for adding tags to the tests (@-tokens in the test title are still supported).
test('test customer login', { tag: ['@fast', '@login'] }, async ({ page }) => {
  // ...
});
Use --grep command line option to run only tests with certain tags.
npx playwright test --grep @fast
Annotating skipped tests

New annotation syntax for test annotations allows annotating the tests that do not run.
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 }) => {
  // ...
});
page.addLocatorHandler()

New 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.
// 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();
Project wildcard filter
Playwright command line flag now supports '*' wildcard when filtering by project.
npx playwright test --project='*mobile*'
Other APIs
expect(callback).toPass({ timeout })
The timeout can now be configured by expect.toPass.timeout option globally or in project config
electronApplication.on('console')
electronApplication.on('console') event is emitted when Electron main process calls console API methods.
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' }));
page.pdf() accepts two new options tagged and outline.
Breaking changes

Mixing the test instances in the same suite is no longer supported. Allowing it was an oversight as it makes reasoning about the semantics unnecessarily hard.
const test = baseTest.extend({ item: async ({}, use) => {} });
baseTest.describe('Admin user', () => {
  test('1', async ({ page, item }) => {});
  test('2', async ({ page, item }) => {});
});
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

1.41.2

Highlights

#29123 - [REGRESSION] route.continue: Protocol error (Fetch.continueRequest): Invalid InterceptionId.

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

1.41.1

Highlights

#29067 - [REGRESSION] Codegen/Recorder: not all clicks are being actioned nor recorded
#29028 - [REGRESSION] React component tests throw type error when passing null/undefined to component
#29027 - [REGRESSION] React component tests not passing Date prop values
#29023 - [REGRESSION] React component tests not rendering children prop
#29019 - [REGRESSION] trace.playwright.dev does not currently support the loading from URL

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

1.41.0

New APIs

New method page.unrouteAll([options]) removes all routes registered by page.route(url, handler, handler[, options]) and page.routeFromHAR(har[, options]). Optionally allows to wait for ongoing routes to finish, or ignore any errors from them.

New method browserContext.unrouteAll([options]) removes all routes registered by browserContext.route(url, handler, handler[, options]) and browserContext.routeFromHAR(har[, options]). Optionally allows to wait for ongoing routes to finish, or ignore any errors from them.

New option style in page.screenshot([options]) and locator.screenshot([options]) to add custom CSS to the page before taking a screenshot.

New option stylePath for methods expect(page).toHaveScreenshot(name[, options]) and expect(locator).toHaveScreenshot(name[, options]) to apply a custom stylesheet while making the screenshot.

New fileName option for 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

1.40.1

Highlights

#28319 - [REGRESSION]: Version 1.40.0 Produces corrupted traces
#28371 - [BUG] The color of the 'ok' text did not change to green in the vs code test results section
#28321 - [BUG] Ambiguous test outcome and status for serial mode
#28362 - [BUG] Merging blobs ends up in Error: Cannot create a string longer than 0x1fffffe8 characters
#28239 - fix: collect all errors in removeFolders

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

1.40.0

Test Generator Update

New tools to generate assertions:

"Assert visibility" tool generates expect(locator).toBeVisible().

"Assert value" tool generates expect(locator).toHaveValue(value).

"Assert text" tool generates expect(locator).toContainText(text).

Here is an example of a generated test with assertions:
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

Option reason in page.close(), browserContext.close() and browser.close(). Close reason is reported for all operations interrupted by the closure.

Option firefoxUserPrefs in browserType.launchPersistentContext(userDataDir).

Other Changes

Methods download.path() and download.createReadStream() throw an error for failed and cancelled downloads.

Playwright docker image 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

Does any of this look wrong? Please let us know.

Commits

See the full diff on Github. The new version differs by more commits than we can show here.

Depfu will automatically keep this PR conflict-free, as long as you don't add any commits to this branch yourself. You can also trigger a rebase manually by commenting with @depfu rebase.

All Depfu comment commands

@depfu rebase
Rebases against your default branch and redoes this update

@depfu recreate
Recreates this PR, overwriting any edits that you've made to it

@depfu merge
Merges this PR once your tests are passing and conflicts are resolved

@depfu cancel merge
Cancels automatic merging of this PR

@depfu close
Closes this PR and deletes the branch

@depfu reopen
Restores the branch and reopens this PR (if it's closed)

@depfu pause
Ignores all future updates for this dependency and closes this PR

@depfu pause [minor|major]
Ignores all future minor/major updates for this dependency and closes this PR

@depfu resume
Future versions of this dependency will create PRs again (leaves this PR as is)

depfu · 2024-05-25T13:13:12Z

Closed in favor of #537.

Update @playwright/test to version 1.44.0

45bdd35

depfu bot added the depfu label May 8, 2024

depfu bot mentioned this pull request May 8, 2024

Update @playwright/test 1.39.0 → 1.43.1 (minor) #535

Closed

depfu bot closed this May 25, 2024

depfu bot deleted the depfu/update/pnpm/@playwright/test-1.44.0 branch May 25, 2024 13:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update @playwright/test 1.39.0 → 1.44.0 (minor) #536

Update @playwright/test 1.39.0 → 1.44.0 (minor) #536

depfu bot commented May 8, 2024

depfu bot commented May 25, 2024

Update @playwright/test 1.39.0 → 1.44.0 (minor) #536

Update @playwright/test 1.39.0 → 1.44.0 (minor) #536

Conversation

depfu bot commented May 8, 2024

What changed?

✳️ @​playwright/test (1.39.0 → 1.44.0) · Repo

New APIs

Browser Versions

Highlights

Browser Versions

New APIs

UI Mode Updates

Browser Versions

Highlights

Browser Versions

New APIs

Breaking changes

Announcements

Browser Versions

Highlights

Browser Versions

Highlights

Browser Versions

New APIs

Browser Versions

Highlights

Browser Versions

Test Generator Update

New APIs

Other Changes

Browser Versions

depfu bot commented May 25, 2024

✳️ @playwright/test (1.39.0 → 1.44.0) · Repo