Update playwright monorepo to v1.43.0 #1686

renovate · 2024-04-06T09:17:01Z

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
@playwright/test (source)	`1.35.1` -> `1.43.0`
playwright-chromium (source)	`1.42.1` -> `1.43.0`
playwright-core (source)	`1.42.1` -> `1.43.0`

Release Notes

microsoft/playwright (@playwright/test)

`v1.43.0`

Compare Source

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 '@&#8203;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

`v1.42.1`

Compare Source

Highlights

https://github.com/microsoft/playwright/issues/29732 - [Regression]: HEAD requests to webServer.url since v1.42.0https://github.com/microsoft/playwright/issues/297466 - [Regression]: Playwright CT CLI scripts fail due to broken initializePlugin imporhttps://github.com/microsoft/playwright/issues/2973939 - [Bug]: Component tests fails when imported a module with a dot in a nahttps://github.com/microsoft/playwright/issues/29731731 - [Regression]: 1.42.0 breaks some import statemehttps://github.com/microsoft/playwright/issues/297609760 - [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

`v1.42.0`

Compare Source

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: ['@&#8203;fast', '@&#8203;login'] }, async ({ page }) => {
  // ...
});
```
Use --grep command line option to run only tests with certain tags.
```
npx playwright test --grep @&#8203;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

`v1.41.2`

Compare Source

Highlights

https://github.com/microsoft/playwright/issues/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

`v1.41.1`

Compare Source

Highlights

https://github.com/microsoft/playwright/issues/29067 - [REGRESSION] Codegen/Recorder: not all clicks are being actioned nor recordedhttps://github.com/microsoft/playwright/issues/290288 - [REGRESSION] React component tests throw type error when passing null/undefined to componenhttps://github.com/microsoft/playwright/issues/2902727 - [REGRESSION] React component tests not passing Date prop valuhttps://github.com/microsoft/playwright/issues/29023023 - [REGRESSION] React component tests not rendering children phttps://github.com/microsoft/playwright/issues/290199019 - [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

`v1.41.0`

Compare Source

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

`v1.40.1`

Compare Source

Highlights

https://github.com/microsoft/playwright/issues/28319 - [REGRESSION]: Version 1.40.0 Produces corrupted traceshttps://github.com/microsoft/playwright/issues/283711 - [BUG] The color of the 'ok' text did not change to green in the vs code test results sectiohttps://github.com/microsoft/playwright/issues/2832121 - [BUG] Ambiguous test outcome and status for serial mohttps://github.com/microsoft/playwright/issues/28362362 - [BUG] Merging blobs ends up in Error: Cannot create a string longer than 0x1fffffe8 characthttps://github.com/microsoft/playwright/pull/282398239 - 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

`v1.40.0`

Compare Source

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 '@&#8203;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

`v1.39.0`

Compare Source

Add custom matchers to your expect

You can extend Playwright assertions by providing custom matchers. These matchers will be available on the expect object.

import { expect as baseExpect } from '@&#8203;playwright/test';
export const expect = baseExpect.extend({
  async toHaveAmount(locator: Locator, expected: number, options?: { timeout?: number }) {
    // ... see documentation for how to write matchers.
  },
});

test('pass', async ({ page }) => {
  await expect(page.getByTestId('cart')).toHaveAmount(5);
});

See the documentation for a full example.

Merge test fixtures

You can now merge test fixtures from multiple files or modules:

import { mergeTests } from '@&#8203;playwright/test';
import { test as dbTest } from 'database-test-utils';
import { test as a11yTest } from 'a11y-test-utils';

export const test = mergeTests(dbTest, a11yTest);

import { test } from './fixtures';

test('passes', async ({ database, page, a11y }) => {
  // use database and a11y fixtures.
});

Merge custom expect matchers

You can now merge custom expect matchers from multiple files or modules:

import { mergeTests, mergeExpects } from '@&#8203;playwright/test';
import { test as dbTest, expect as dbExpect } from 'database-test-utils';
import { test as a11yTest, expect as a11yExpect } from 'a11y-test-utils';

export const test = mergeTests(dbTest, a11yTest);
export const expect = mergeExpects(dbExpect, a11yExpect);

import { test, expect } from './fixtures';

test('passes', async ({ page, database }) => {
  await expect(database).toHaveDatabaseUser('admin');
  await expect(page).toPassA11yAudit();
});

Hide implementation details: box test steps

You can mark a test.step() as "boxed" so that errors inside it point to the step call site.

async function login(page) {
  await test.step('login', async () => {
    // ...
  }, { box: true });  // Note the "box" option here.
}

Error: Timed out 5000ms waiting for expect(locator).toBeVisible()
  ... error details omitted ...

  14 |   await page.goto('https://github.com/login');
> 15 |   await login(page);
     |         ^
  16 | });

See test.step() documentation for a full example.

New APIs

expect(locator).toHaveAttribute(name)

Browser Versions

Chromium 119.0.6045.9
Mozilla Firefox 118.0.1
WebKit 17.4

This version was also tested against the following stable channels:

Google Chrome 118
Microsoft Edge 118

`v1.38.1`

Compare Source

Highlights

Browser Versions

Chromium 117.0.5938.62
Mozilla Firefox 117.0
WebKit 17.0

This version was also tested against the following stable channels:

Google Chrome 116
Microsoft Edge 116

`v1.38.0`

Compare Source

UI Mode Updates

Zoom into time range.
Network panel redesign.

New APIs

[browserContext.on('weberror')][browserContext.on('weberror')]
[locator.pressSequentially()][locator.pressSequentially()]
The [reporter.onEnd()][reporter.onEnd()] now reports startTime and total run duration.

Deprecations

The following methods were deprecated: [page.type()][page.type()], [frame.type()][frame.type()], [locator.type()][locator.type()] and [elementHandle.type()][elementHandle.type()].
Please use [locator.fill()][locator.fill()] instead which is much faster. Use [locator.pressSequentially()][locator.pressSequentially()] only if there is a
special keyboard handling on the page, and you need to press keys one-by-one.

Breaking Changes: Playwright no longer downloads browsers automatically

[!NOTE]
If you are using @playwright/test package, this change does not affect you.

Playwright recommends to use @playwright/test package and download browsers via npx playwright install command. If you are following this recommendation, nothing has changed for you.

However, up to v1.38, installing the playwright package instead of @playwright/test did automatically download browsers. This is no longer the case, and we recommend to explicitly download browsers via npx playwright install command.

v1.37 and earlier

playwright package was downloading browsers during npm install, while @playwright/test was not.

v1.38 and later

playwright and @playwright/test packages do not download browsers during npm install.

Recommended migration

Run npx playwright install to download browsers after npm install. For example, in your CI configuration:

- run: npm ci
- run: npx playwright install --with-deps

Alternative migration option - not recommended

Add @playwright/browser-chromium, @playwright/browser-firefox and @playwright/browser-webkit as a dependency. These packages download respective browsers during npm install. Make sure you keep the version of all playwright packages in sync:

// package.json
{
  "devDependencies": {
    "playwright": "1.38.0",
    "@&#8203;playwright/browser-chromium": "1.38.0",
    "@&#8203;playwright/browser-firefox": "1.38.0",
    "@&#8203;playwright/browser-webkit": "1.38.0"
  }
}

Browser Versions

Chromium 117.0.5938.62
Mozilla Firefox 117.0
WebKit 17.0

This version was also tested against the following stable channels:

Google Chrome 116
Microsoft Edge 116

`v1.37.1`

Compare Source

Highlights

https://github.com/microsoft/playwright/issues/26496 - [REGRESSION] webServer stdout is always getting printedhttps://github.com/microsoft/playwright/issues/264922 - [REGRESSION] test.only with project dependency is not working

Browser Versions

Chromium 116.0.5845.82
Mozilla Firefox 115.0
WebKit 17.0

This version was also tested against the following stable channels:

Google Chrome 115
Microsoft Edge 115

`v1.37.0`

Compare Source

Watch the overview: Playwright 1.36 & 1.37

✨ New tool to merge reports

If you run tests on multiple shards, you can now merge all reports in a single HTML report (or any other report)
using the new merge-reports CLI tool.

Using merge-reports tool requires the following steps:

Adding a new "blob" reporter to the config when running on CI:
```
export default defineConfig({
  testDir: './tests',
  reporter: process.env.CI ? 'blob' : 'html',
});
```
The "blob" reporter will produce ".zip" files that contain all the information
about the test run.
Copying all "blob" reports in a single shared location and running npx playwright merge-reports:
```
npx playwright merge-reports --reporter html ./all-blob-reports
```

📚 Debian 12 Bookworm Support

Playwright now supports Debian 12 Bookworm on both x86_64 and arm64 for Chromium, Firefox and WebKit.
Let us know if you encounter any issues!

Linux support looks like this:

	Ubuntu 20.04	Ubuntu 22.04	Debian 11	Debian 12
Chromium	✅	✅	✅	✅
WebKit	✅	✅	✅	✅
Firefox	✅	✅	✅	✅

🌈 UI Mode Updates

UI Mode now respects project dependencies. You can control which dependencies to respect by checking/unchecking them in a projects list.
Console logs from the test are now displayed in the Console tab.

Browser Versions

Chromium 116.0.5845.82
Mozilla Firefox 115.0
WebKit 17.0

This version was also tested against the following stable channels:

Google Chrome 115
Microsoft Edge 115

`v1.36.2`: 1.36.2

Compare Source

Highlights

https://github.com/microsoft/playwright/issues/24316 - [REGRESSION] Character classes are not working in globs in 1.36

Browser Versions

Chromium 115.0.5790.75
Mozilla Firefox 115.0
WebKit 17.0

This version was also tested against the following stable channels:

Google Chrome 114
Microsoft Edge 114

`v1.36.1`

Compare Source

Highlights

https://github.com/microsoft/playwright/issues/24184 - [REGRESSION]: Snapshot name contains some random string after test name when tests are run in container

Browser Versions

Chromium 115.0.5790.75
Mozilla Firefox 115.0
WebKit 17.0

This version was also tested against the following stable channels:

Google Chrome 114
Microsoft Edge 114

`v1.36.0`

Compare Source

Watch the overview: Playwright 1.36 & 1.37

Highlights

🏝️ Summer maintenance release.

Browser Versions

Chromium 115.0.5790.75
Mozilla Firefox 115.0
WebKit 17.0

This version was also tested against the following stable channels:

Google Chrome 114
Microsoft Edge 114

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about these updates again.

If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

renovate · 2024-04-06T09:17:02Z

⚠ Artifact update problem

Renovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is.

♻ Renovate will retry this branch, including artifacts, only when one of the following happens:

any of the package files in this branch needs updating, or
the branch becomes conflicted, or
you click the rebase/retry checkbox if found above, or
you rename this PR's title to start with "rebase!" to trigger it manually

The artifact failure details are included below:

File name: pnpm-lock.yaml

Scope: all 21 workspace projects
Progress: resolved 0, reused 1, downloaded 0, added 0
.                                        |  WARN  deprecated @types/sharp@0.32.0
.                                        |  WARN  deprecated @babel/plugin-proposal-object-rest-spread@7.20.7
Progress: resolved 98, reused 71, downloaded 0, added 0
Progress: resolved 147, reused 103, downloaded 0, added 0
Progress: resolved 190, reused 134, downloaded 0, added 0
packages/next                            |  WARN  deprecated @babel/plugin-proposal-class-properties@7.18.6
packages/next                            |  WARN  deprecated @babel/plugin-proposal-export-namespace-from@7.18.9
packages/next                            |  WARN  deprecated @babel/plugin-proposal-numeric-separator@7.18.6
Progress: resolved 264, reused 207, downloaded 0, added 0
packages/next                            |  WARN  deprecated @types/lru-cache@7.10.10
packages/next                            |  WARN  deprecated @types/path-to-regexp@1.7.0
Progress: resolved 374, reused 321, downloaded 0, added 0
/tmp/renovate/repos/github/X-oss-byte/Nextjs/packages/third-parties:
 ERR_PNPM_FETCH_404  GET https://registry.npmjs.org/next/-/next-13.5.0.tgz: Not Found - 404

This error happened while installing a direct dependency of /tmp/renovate/repos/github/X-oss-byte/Nextjs/packages/third-parties

No authorization header was set for the request.

stackblitz · 2024-04-06T09:17:06Z

Run & review this pull request in StackBlitz Codeflow.

changeset-bot · 2024-04-06T09:17:07Z

⚠️ No Changeset found

Latest commit: bd79fd4

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Update playwright monorepo to v1.43.0

bd79fd4

kodiakhq bot merged commit f3ee752 into canary Apr 6, 2024
1 of 3 checks passed

kodiakhq bot deleted the renovate/playwright-monorepo branch April 6, 2024 09:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update playwright monorepo to v1.43.0 #1686

Update playwright monorepo to v1.43.0 #1686

renovate bot commented Apr 6, 2024

renovate bot commented Apr 6, 2024

stackblitz bot commented Apr 6, 2024

changeset-bot bot commented Apr 6, 2024

Update playwright monorepo to v1.43.0 #1686

Update playwright monorepo to v1.43.0 #1686

Conversation

renovate bot commented Apr 6, 2024

Release Notes

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

Add custom matchers to your expect

Merge test fixtures

Merge custom expect matchers

Hide implementation details: box test steps

New APIs

Browser Versions

Highlights

Browser Versions

UI Mode Updates

New APIs

Deprecations

Breaking Changes: Playwright no longer downloads browsers automatically

Browser Versions

Highlights

Browser Versions

✨ New tool to merge reports

📚 Debian 12 Bookworm Support

🌈 UI Mode Updates

Browser Versions

v1.36.2: 1.36.2

Highlights

Browser Versions

Highlights

Browser Versions

Highlights

Browser Versions

Configuration

renovate bot commented Apr 6, 2024

⚠ Artifact update problem

File name: pnpm-lock.yaml

stackblitz bot commented Apr 6, 2024

changeset-bot bot commented Apr 6, 2024

⚠️ No Changeset found

`v1.36.2`: 1.36.2