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.

You can provide client certificates as a parameter of browser.newContext() and apiRequest.newContext(). The following snippet sets up a client certificate for https://example.com:

BrowserContext context = browser.newContext(new Browser.NewContextOptions()
    .setClientCertificates(asList(new ClientCertificate("https://example.com")
          .setCertPath(Paths.get("client-certificates/cert.pem"))
          .setKeyPath(Paths.get("client-certificates/key.pem")))));

Trace Viewer Updates

• Content of text attachments is now rendered inline in the attachments pane.
• New setting to show/hide routing actions like route.resume().
• 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.

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

Highlights

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

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 with some time before the test time and let the page load
// naturally. `Date.now` will progress as the timers fire.
page.clock().install(new Clock.InstallOptions().setTime("2024-02-02T08:00:00"));
page.navigate("http://localhost:3333");
Locator locator = page.getByTestId("current-time");

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

// Assert the page state.
assertThat(locator).hasText("2/2/2024, 10:00:00 AM");

// Close the laptop lid again and open it at 10:30am.
page.clock().fastForward("30:00");
assertThat(locator).hasText("2/2/2024, 10:30:00 AM");

See the clock guide for more details.

Miscellaneous

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

  page.getByLabel("Upload directory").setInputFiles(Paths.get("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.
  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.

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

New APIs

Accessibility assertions

• assertThat(locator).toHaveAccessibleName() checks if the element has the specified accessible name:

  Locator locator = page.getByRole(AriaRole.BUTTON);
  assertThat(locator).hasAccessibleName("Submit");

• assertThat(locator).toHaveAccessibleDescription() checks if the element has the specified accessible description:

  Locator locator = page.getByRole(AriaRole.BUTTON);
  assertThat(locator).hasAccessibleDescription("Upload a photo");

• assertThat(locator).toHaveRole() checks if the element has the specified ARIA role:

  Locator locator = page.getByTestId("save-button");
  assertThat(locator).hasRole(AriaRole.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 setNoWaitAfter option.
• You can use new setTimes 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.

Locator locator = page.getByText("This interstitial covers the button");
page.addLocatorHandler(locator, overlay -> {
  overlay.locator("#close").click();
}, new Page.AddLocatorHandlerOptions().setTimes(3).setNoWaitAfter(true));
// Run your tests that can be interrupted by the overlay.
// ...
page.removeLocatorHandler(locator);

Miscellaneous options

• New method formData.append() allows to specify repeating fields with the same name in setMultipart option in RequestOptions:

  FormData formData = FormData.create();
  formData.append("file", new FilePayload("f1.js", "text/javascript",
  "var x = 2024;".getBytes(StandardCharsets.UTF_8)));
  formData.append("file", new FilePayload("f2.txt", "text/plain",
    "hello".getBytes(StandardCharsets.UTF_8)));
  APIResponse response = context.request().post("https://example.com/uploadFile", RequestOptions.create().setMultipart(formData));

• expect(page).toHaveURL(url) now supports setIgnoreCase option.

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

New APIs

• Method browserContext.clearCookies([options]) now supports filters to remove only some cookies.

  // Clear all cookies.
  context.clearCookies();
  // New: clear cookies with a particular name.
  context.clearCookies(new BrowserContext.ClearCookiesOptions().setName("session-id"));
  // New: clear cookies for a particular domain.
  context.clearCookies(new BrowserContext.ClearCookiesOptions().setDomain("my-origin.com"));

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

  Locator locator = page.locator("iframe[name='embedded']");
  // ...
  FrameLocator frameLocator = locator.contentFrame();
  frameLocator.getByRole(AriaRole.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.

  FrameLocator frameLocator = page.frameLocator("iframe[name='embedded']");
  // ...
  Locator locator = frameLocator.owner();
  assertThat(locator).isVisible();

Browser Versions

• Chromium 124.0.6367.8
• 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.0

JUnit integration

Warning

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

Add new @UsePlaywright annotation to your test classes to start using Playwright
fixtures for Page, BrowserContext, Browser, APIRequestContext and Playwright in the
test methods.

package org.example;

import com.microsoft.playwright.Page;
import com.microsoft.playwright.junit.UsePlaywright;
import org.junit.jupiter.api.Test;

import static com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertEquals;

@UsePlaywright
public class TestExample {
  void shouldNavigateToInstallationGuide(Page page) {
    page.navigate("https://playwright.dev/java/");
    page.getByRole(AriaRole.LINK, new Page.GetByRoleOptions().setName("Docs")).click();
    assertThat(page.getByRole(AriaRole.HEADING, new Page.GetByRoleOptions().setName("Installation"))).isVisible();
  }

  @Test
  void shouldCheckTheBox(Page page) {
    page.setContent("<input id='checkbox' type='checkbox'></input>");
    page.locator("input").check();
    assertEquals(true, page.evaluate("window['checkbox'].checked"));
  }

  @Test
  void shouldSearchWiki(Page page) {
    page.navigate("https://www.wikipedia.org/");
    page.locator("input[name=\"search\"]").click();
    page.locator("input[name=\"search\"]").fill("playwright");
    page.locator("input[name=\"search\"]").press("Enter");
    assertThat(page).hasURL("https://en.wikipedia.org/wiki/Playwright");
  }
}

In the example above, all three test methods use the same Browser. Each test
uses its own BrowserContext and Page.

Custom options

Implement your own OptionsFactory to initialize the fixtures with custom configuration.

import com.microsoft.playwright.junit.Options;
import com.microsoft.playwright.junit.OptionsFactory;
import com.microsoft.playwright.junit.UsePlaywright;

@UsePlaywright(MyTest.CustomOptions.class)
public class MyTest {

  public static class CustomOptions implements OptionsFactory {
    @Override
    public Options getOptions() {
      return new Options()
          .setHeadless(false)
          .setContextOption(new Browser.NewContextOptions()
              .setBaseURL("https://github.com"))
          .setApiRequestOptions(new APIRequest.NewContextOptions()
              .setBaseURL("https://playwright.dev"));
    }
  }

  @Test
  public void testWithCustomOptions(Page page, APIRequestContext request) {
    page.navigate("/");
    assertThat(page).hasURL(Pattern.compile("github"));

    APIResponse response = request.get("/");
    assertTrue(response.text().contains("Playwright"));
  }
}

Learn more about the fixtures in our JUnit guide.

New Locator Handler

New method page.addLocatorHandler(locator, handler, handler, handler) 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.
page.addLocatorHandler(
    page.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("Hej! You are in control of your cookies.")),
    () - > {
        page.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("Accept all")).click();
    });
// Write the test as usual.
page.navigate("https://www.ikea.com/");
page.getByRole(AriaRole.LINK, new Page.GetByRoleOptions().setName("Collection of blue and white")).click();
assertThat(page.getByRole(AriaRole.HEADING, new Page.GetByRoleOptions().setName("Light and easy"))).isVisible();

New APIs

• page.pdf() accepts two new options tagged and outline.

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

microsoft/playwright#29123 - [REGRESSION] route.continue: Protocol error (Fetch.continueRequest): Invalid InterceptionId.
#1468 - [BUG] File Upload leads to "Exactly one of payloads, localPaths and streams must be provided"

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

microsoft/playwright#29067 - [REGRESSION] Codegen/Recorder: not all clicks are being actioned nor recorded
microsoft/playwright#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() removes all routes registered by Page.route() and Page.routeFromHAR().
• New method BrowserContext.unrouteAll() removes all routes registered by BrowserContext.route() and BrowserContext.routeFromHAR().
• New option setStyle in Page.screenshot() and Locator.screenshot() to add custom CSS to the page before taking a screenshot.

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

Test Generator Update

New tools to generate assertions:

• "Assert visibility" tool generates assertThat(locator).isVisible([options]).
• "Assert value" tool generates assertThat(locator).hasValue(value[, options]).
• "Assert text" tool generates assertThat(locator).containsText(expected[, options]).

Here is an example of a generated test with assertions:

page.navigate("https://playwright.dev/");
page.getByRole(AriaRole.LINK, new Page.GetByRoleOptions().setName("Get started")).click();
assertThat(page.getByLabel("Breadcrumbs").getByRole(AriaRole.LIST)).containsText("Installation");
assertThat(page.getByLabel("Search")).isVisible();
page.getByLabel("Search").click();
page.getByPlaceholder("Search docs").fill("locator");
assertThat(page.getByPlaceholder("Search docs")).hasValue("locator");

New APIs

• Option reason in page.close([options]), browserContext.close([options]) and browser.close([options]). Close reason is reported for all operations interrupted by the closure.
• Option firefoxUserPrefs in browserType.launchPersistentContext(userDataDir[, options]).

Other Changes

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

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