Update dependency @playwright/test to v1.44.0 #18589

renovate · 2023-10-12T01:31:06Z

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
@playwright/test (source)	`1.38.1` -> `1.44.0`

Release Notes

microsoft/playwright (@playwright/test)

`v1.44.0`

Compare Source

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

`v1.43.1`

Compare Source

Highlights

https://github.com/microsoft/playwright/issues/30300 - [REGRESSION]: UI mode restarts if keep storage statehttps://github.com/microsoft/playwright/issues/303399 - [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

`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

Configuration

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

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

♻ Rebasing: Never, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update 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.

codecov · 2023-10-12T01:46:06Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 72.68%. Comparing base (15573b5) to head (1d52e39).
Report is 8 commits behind head on main.

❗ Current head 1d52e39 differs from pull request most recent head 72c3a72. Consider uploading reports for the commit 72c3a72 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #18589      +/-   ##
==========================================
- Coverage   73.28%   72.68%   -0.60%     
==========================================
  Files        1264     1259       -5     
  Lines       74317    73277    -1040     
  Branches     9886     9710     -176     
==========================================
- Hits        54462    53261    -1201     
- Misses      19056    19231     +175     
+ Partials      799      785      -14

Flag	Coverage Δ
admin-tests	`40.97% <ø> (-1.18%)`	⬇️
e2e-tests	`81.39% <ø> (-0.43%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

daniellockyer added the browser-tests label Oct 23, 2023

renovate bot force-pushed the renovate/playwright-monorepo branch from 5ba1841 to ecb2f61 Compare October 23, 2023 09:22

renovate bot changed the title ~~Update dependency @playwright/test to v1.39.0~~ Update dependency @playwright/test to v1.40.0 Nov 20, 2023

renovate bot force-pushed the renovate/playwright-monorepo branch from ecb2f61 to 6308636 Compare November 20, 2023 09:56

renovate bot changed the title ~~Update dependency @playwright/test to v1.40.0~~ Update dependency @playwright/test to v1.40.1 Dec 4, 2023

renovate bot force-pushed the renovate/playwright-monorepo branch from 6308636 to 2490f2e Compare December 4, 2023 20:58

github-actions bot added the affects:admin Anything relating to Ghost Admin label Dec 4, 2023

renovate bot force-pushed the renovate/playwright-monorepo branch from 2490f2e to cd47cb2 Compare December 13, 2023 08:22

renovate bot force-pushed the renovate/playwright-monorepo branch from cd47cb2 to dbd7e2c Compare January 2, 2024 12:05

renovate bot force-pushed the renovate/playwright-monorepo branch from dbd7e2c to 1d52e39 Compare January 15, 2024 19:54

Update dependency @playwright/test to v1.44.0

72c3a72

renovate bot force-pushed the renovate/playwright-monorepo branch from 1d52e39 to 72c3a72 Compare May 9, 2024 10:50

renovate bot changed the title ~~Update dependency @playwright/test to v1.40.1~~ Update dependency @playwright/test to v1.44.0 May 9, 2024

daniellockyer enabled auto-merge (rebase) May 9, 2024 10:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update dependency @playwright/test to v1.44.0 #18589

Update dependency @playwright/test to v1.44.0 #18589

renovate bot commented Oct 12, 2023 •

edited

codecov bot commented Oct 12, 2023 •

edited

Update dependency @playwright/test to v1.44.0 #18589

Are you sure you want to change the base?

Update dependency @playwright/test to v1.44.0 #18589

Conversation

renovate bot commented Oct 12, 2023 • edited

Release Notes

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

Add custom matchers to your expect

Merge test fixtures

Merge custom expect matchers

Hide implementation details: box test steps

New APIs

Browser Versions

Configuration

codecov bot commented Oct 12, 2023 • edited

Codecov Report

renovate bot commented Oct 12, 2023 •

edited

codecov bot commented Oct 12, 2023 •

edited