v1.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()

Warning

This feature is experimental, we are actively looking for the feedback based on your scenarios.

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

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

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

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

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

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

v1.39.0

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 '@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 '@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 '@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

Highlights

#27071 - expect(value).toMatchSnapshot() deprecation announcement on V1.38
#27072 - [BUG] PWT trace viewer fails to load trace and throws TypeError
#27073 - [BUG] RangeError: Invalid time value
#27087 - [REGRESSION]: npx playwright test --list prints all tests twice
#27113 - [REGRESSION]: No longer able to extend PlaywrightTest.Matchers type for locators and pages
#27144 - [BUG]can not display trace
#27163 - [REGRESSION] Single Quote Wrongly Escaped by Locator When Using Unicode Flag
#27181 - [BUG] evaluate serializing fails at 1.38

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

UI Mode Updates

1. Zoom into time range.
2. Network panel redesign.

New APIs

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

Deprecations

• The following methods were deprecated: page.type(), frame.type(), locator.type() and elementHandle.type().
  Please use locator.fill() instead which is much faster. Use 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",
    "@playwright/browser-chromium": "1.38.0",
    "@playwright/browser-firefox": "1.38.0",
    "@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

Highlights

#26496 - [REGRESSION] webServer stdout is always getting printed
#26492 - [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