v1.46.1

Highlights

#32004 - [REGRESSION]: Client Certificates don't work with Microsoft IIS
#32004 - [REGRESSION]: Websites stall on TLS handshake errors when using Client Certificates
#32146 - [BUG]: Credential scanners warn about internal socks-proxy TLS certificates
#32056 - [REGRESSION]: 1.46.0 (TypeScript) - custom fixtures extend no longer chainable
#32070 - [Bug]: --only-changed flag and project dependencies
#32188 - [Bug]: --only-changed with shallow clone throws "unknown revision" error

Browser Versions

• Chromium 128.0.6613.18
• Mozilla Firefox 128.0
• WebKit 18.0

This version was also tested against the following stable channels:

• Google Chrome 127
• Microsoft Edge 127

v1.46.0

TLS Client Certificates

Playwright now allows to supply client-side certificates, so that server can verify them, as specified by TLS Client Authentication.

When client certificates are specified, all browser traffic is routed through a proxy that establishes the secure TLS connection, provides client certificates to the server and validates server certificates.

The following snippet sets up a client certificate for https://example.com:

import { defineConfig } from '@playwright/test';

export default defineConfig({
  // ...
  use: {
    clientCertificates: [{
      origin: 'https://example.com',
      certPath: './cert.pem',
      keyPath: './key.pem',
      passphrase: 'mysecretpassword',
    }],
  },
  // ...
});

You can also provide client certificates to a particular test project or as a parameter of browser.newContext() and apiRequest.newContext().

--only-changed cli option

New CLI option --only-changed allows to only run test files that have been changed since the last git commit or from a specific git "ref".

# Only run test files with uncommitted changes
npx playwright test --only-changed

# Only run test files changed relative to the "main" branch
npx playwright test --only-changed=main

Component Testing: New router fixture

This release introduces an experimental router fixture to intercept and handle network requests in component testing.
There are two ways to use the router fixture:

• Call router.route(url, handler) that behaves similarly to page.route().
• Call router.use(handlers) and pass MSW library request handlers to it.

Here is an example of reusing your existing MSW handlers in the test.

import { handlers } from '@src/mocks/handlers';

test.beforeEach(async ({ router }) => {
  // install common handlers before each test
  await router.use(...handlers);
});

test('example test', async ({ mount }) => {
  // test as usual, your handlers are active
  // ...
});

This fixture is only available in component tests.

UI Mode / Trace Viewer Updates

• Test annotations are now shown in UI mode.
• Content of text attachments is now rendered inline in the attachments pane.
• New setting to show/hide routing actions like route.continue().
• Request method and status are shown in the network details tab.
• New button to copy source file location to clipboard.
• Metadata pane now displays the baseURL.

Miscellaneous

• New maxRetries option in apiRequestContext.fetch() which retries on the ECONNRESET network error.
• New option to box a fixture to minimize the fixture exposure in test reports and error messages.
• New option to provide a custom fixture title to be used in test reports and error messages.

Possibly breaking change

Fixture values that are array of objects, when specified in the test.use() block, may require being wrapped into a fixture tuple. This is best seen on the example:

import { test as base } from '@playwright/test';

// Define an option fixture that has an "array of objects" value
type User = { name: string, password: string };
const test = base.extend<{ users: User[] }>({
  users: [ [], { option: true } ],
}); 

// Specify option value in the test.use block.
test.use({
  // WRONG: this syntax may not work for you
  users: [
    { name: 'John Doe', password: 'secret' },
    { name: 'John Smith', password: 's3cr3t' },
  ],
  // CORRECT: this syntax will work. Note extra [] around the value, and the "scope" property.
  users: [[
    { name: 'John Doe', password: 'secret' },
    { name: 'John Smith', password: 's3cr3t' },
  ], { scope: 'test' }],
});

test('example test', async () => {
  // ...
});

Browser Versions

• Chromium 128.0.6613.18
• Mozilla Firefox 128.0
• WebKit 18.0

This version was also tested against the following stable channels:

• Google Chrome 127
• Microsoft Edge 127

v1.45.3

Highlights

#31764 - [Bug]: some actions do not appear in the trace file
microsoft/playwright-java#1617 - [Bug]: Traceviewer not reporting all actions

Browser Versions

• Chromium 127.0.6533.5
• Mozilla Firefox 127.0
• WebKit 17.4

This version was also tested against the following stable channels:

• Google Chrome 126
• Microsoft Edge 126

v1.45.2

Highlights

#31613 - [REGRESSION]: Trace is not showing any screenshots nor test name
#31601 - [REGRESSION]: missing trace for 2nd browser
#31541 - [REGRESSION]: Failing tests have a trace with no images and with steps missing

Browser Versions

• Chromium 127.0.6533.5
• Mozilla Firefox 127.0
• WebKit 17.4

This version was also tested against the following stable channels:

• Google Chrome 126
• Microsoft Edge 126

v1.45.1

Highlights

#31473 - [REGRESSION]: Playwright raises an error ENOENT: no such file or directory, open 'test-results/.playwright-artifacts-0/hash.zip' with Electron
#31442 - [REGRESSION]: Locators of elements changing from/to hidden have operations hanging when using --disable-web-security
#31431 - [REGRESSION]: NewTab doesn't work properly with Chrome with --disable-web-security
#31425 - [REGRESSION]: beforeEach hooks are not skipped when describe condition depends on fixtures
#31491 - [REGRESSION]: @playwright/experimental-ct-react doesn't work with VSCode extension and PNPM

Browser Versions

• Chromium 127.0.6533.5
• Mozilla Firefox 127.0
• WebKit 17.4

This version was also tested against the following stable channels:

• Google Chrome 126
• Microsoft Edge 126

v1.45.0

Clock

Utilizing the new Clock API allows to manipulate and control time within tests to verify time-related behavior. This API covers many common scenarios, including:

• testing with predefined time;
• keeping consistent time and timers;
• monitoring inactivity;
• ticking through time manually.

// Initialize clock and let the page load naturally.
await page.clock.install({ time: new Date('2024-02-02T08:00:00') });
await page.goto('http://localhost:3333');

// Pretend that the user closed the laptop lid and opened it again at 10am,
// Pause the time once reached that point.
await page.clock.pauseAt(new Date('2024-02-02T10:00:00'));

// Assert the page state.
await expect(page.getByTestId('current-time')).toHaveText('2/2/2024, 10:00:00 AM');

// Close the laptop lid again and open it at 10:30am.
await page.clock.fastForward('30:00');
await expect(page.getByTestId('current-time')).toHaveText('2/2/2024, 10:30:00 AM');

See the clock guide for more details.

Test runner

• New CLI option --fail-on-flaky-tests that sets exit code to 1 upon any flaky tests. Note that by default, the test runner exits with code 0 when all failed tests recovered upon a retry. With this option, the test run will fail in such case.

• New enviroment variable PLAYWRIGHT_FORCE_TTY controls whether built-in list, line and dot reporters assume a live terminal. For example, this could be useful to disable tty behavior when your CI environment does not handle ANSI control sequences well. Alternatively, you can enable tty behavior even when to live terminal is present, if you plan to post-process the output and handle control sequences.

  # Avoid TTY features that output ANSI control sequences
  PLAYWRIGHT_FORCE_TTY=0 npx playwright test
  
  # Enable TTY features, assuming a terminal width 80
  PLAYWRIGHT_FORCE_TTY=80 npx playwright test

• New options testConfig.respectGitIgnore and testProject.respectGitIgnore control whether files matching .gitignore patterns are excluded when searching for tests.

• New property timeout is now available for custom expect matchers. This property takes into account playwright.config.ts and expect.configure().

  import { expect as baseExpect } from '@playwright/test';
  
  export const expect = baseExpect.extend({
    async toHaveAmount(locator: Locator, expected: number, options?: { timeout?: number }) {
      // When no timeout option is specified, use the config timeout.
      const timeout = options?.timeout ?? this.timeout;
      // ... implement the assertion ...
    },
  });

Miscellaneous

• Method locator.setInputFiles() now supports uploading a directory for <input type=file webkitdirectory> elements.

  await page.getByLabel('Upload directory').setInputFiles(path.join(__dirname, 'mydir'));

• Multiple methods like locator.click() or locator.press() now support a ControlOrMeta modifier key. This key maps to Meta on macOS and maps to Control on Windows and Linux.

  // Press the common keyboard shortcut Control+S or Meta+S to trigger a "Save" operation.
  await page.keyboard.press('ControlOrMeta+S');

• New property httpCredentials.send in apiRequest.newContext() that allows to either always send the Authorization header or only send it in response to 401 Unauthorized.

• New option reason in apiRequestContext.dispose() that will be included in the error message of ongoing operations interrupted by the context disposal.

• New option host in browserType.launchServer() allows to accept websocket connections on a specific address instead of unspecified 0.0.0.0.

• Playwright now supports Chromium, Firefox and WebKit on Ubuntu 24.04.

• v1.45 is the last release to receive WebKit update for macOS 12 Monterey. Please update macOS to keep using the latest WebKit.

Browser Versions

• Chromium 127.0.6533.5
• Mozilla Firefox 127.0
• WebKit 17.4

This version was also tested against the following stable channels:

• Google Chrome 126
• Microsoft Edge 126

v1.44.1

Highlights

#30779 - [REGRESSION]: When using video: 'on' with VSCode extension the browser got closed
#30755 - [REGRESSION]: Electron launch with spaces inside executablePath didn't work
#30770 - [REGRESSION]: Mask elements outside of viewport when creating fullscreen screenshots didn't work
#30858 - [REGRESSION]: ipv6 got shown instead of localhost in show-trace/show-report

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

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

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