chore: roll 1.51.0 driver, implement new features (#1757)

Author: yury-s

.github/workflows/test_cli.yml

@@ -15,7 +15,7 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - name: Cache Maven packages
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: ~/.m2
           key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}

README.md

@@ -10,9 +10,9 @@ Playwright is a Java library to automate [Chromium](https://www.chromium.org/Hom
 
 |          | Linux | macOS | Windows |
 |   :---   | :---: | :---: | :---:   |
-| Chromium <!-- GEN:chromium-version -->133.0.6943.16<!-- GEN:stop --> | :white_check_mark: | :white_check_mark: | :white_check_mark: |
-| WebKit <!-- GEN:webkit-version -->18.2<!-- GEN:stop --> | ✅ | ✅ | ✅ |
-| Firefox <!-- GEN:firefox-version -->134.0<!-- GEN:stop --> | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+| Chromium <!-- GEN:chromium-version -->134.0.6998.35<!-- GEN:stop --> | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+| WebKit <!-- GEN:webkit-version -->18.4<!-- GEN:stop --> | ✅ | ✅ | ✅ |
+| Firefox <!-- GEN:firefox-version -->135.0<!-- GEN:stop --> | :white_check_mark: | :white_check_mark: | :white_check_mark: |
 
 Headless execution is supported for all the browsers on all platforms. Check out [system requirements](https://playwright.dev/java/docs/intro#system-requirements) for details.
 

examples/pom.xml

@@ -10,7 +10,7 @@
   <name>Playwright Client Examples</name>
   <properties>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-    <playwright.version>1.49.0</playwright.version>
+    <playwright.version>1.51.0</playwright.version>
   </properties>
   <dependencies>
     <dependency>

playwright/src/main/java/com/microsoft/playwright/APIRequest.java

@@ -59,6 +59,10 @@ class NewContextOptions {
      * An object containing additional HTTP headers to be sent with every request. Defaults to none.
      */
     public Map<String, String> extraHTTPHeaders;
+    /**
+     * Whether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status codes.
+     */
+    public Boolean failOnStatusCode;
     /**
      * Credentials for <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication">HTTP authentication</a>. If
      * no origin is specified, the username and password are sent to any servers upon unauthorized responses.
@@ -138,6 +142,13 @@ public NewContextOptions setExtraHTTPHeaders(Map<String, String> extraHTTPHeader
       this.extraHTTPHeaders = extraHTTPHeaders;
       return this;
     }
+    /**
+     * Whether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status codes.
+     */
+    public NewContextOptions setFailOnStatusCode(boolean failOnStatusCode) {
+      this.failOnStatusCode = failOnStatusCode;
+      return this;
+    }
     /**
      * Credentials for <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication">HTTP authentication</a>. If
      * no origin is specified, the username and password are sent to any servers upon unauthorized responses.

playwright/src/main/java/com/microsoft/playwright/APIRequestContext.java

@@ -58,12 +58,23 @@ public DisposeOptions setReason(String reason) {
     }
   }
   class StorageStateOptions {
+    /**
+     * Set to {@code true} to include IndexedDB in the storage state snapshot.
+     */
+    public Boolean indexedDB;
     /**
      * The file path to save the storage state to. If {@code path} is a relative path, then it is resolved relative to current
      * working directory. If no path is provided, storage state is still returned, but won't be saved to the disk.
      */
     public Path path;
 
+    /**
+     * Set to {@code true} to include IndexedDB in the storage state snapshot.
+     */
+    public StorageStateOptions setIndexedDB(boolean indexedDB) {
+      this.indexedDB = indexedDB;
+      return this;
+    }
     /**
      * The file path to save the storage state to. If {@code path} is a relative path, then it is resolved relative to current
      * working directory. If no path is provided, storage state is still returned, but won't be saved to the disk.

playwright/src/main/java/com/microsoft/playwright/Browser.java

@@ -118,6 +118,12 @@ class NewContextOptions {
      * "light"}.
      */
     public Optional<ColorScheme> colorScheme;
+    /**
+     * Emulates {@code "prefers-contrast"} media feature, supported values are {@code "no-preference"}, {@code "more"}. See
+     * {@link com.microsoft.playwright.Page#emulateMedia Page.emulateMedia()} for more details. Passing {@code null} resets
+     * emulation to system defaults. Defaults to {@code "no-preference"}.
+     */
+    public Optional<Contrast> contrast;
     /**
      * Specify device scale factor (can be thought of as dpr). Defaults to {@code 1}. Learn more about <a
      * href="https://playwright.dev/java/docs/emulation#devices">emulating devices with device scale factor</a>.
@@ -335,6 +341,15 @@ public NewContextOptions setColorScheme(ColorScheme colorScheme) {
       this.colorScheme = Optional.ofNullable(colorScheme);
       return this;
     }
+    /**
+     * Emulates {@code "prefers-contrast"} media feature, supported values are {@code "no-preference"}, {@code "more"}. See
+     * {@link com.microsoft.playwright.Page#emulateMedia Page.emulateMedia()} for more details. Passing {@code null} resets
+     * emulation to system defaults. Defaults to {@code "no-preference"}.
+     */
+    public NewContextOptions setContrast(Contrast contrast) {
+      this.contrast = Optional.ofNullable(contrast);
+      return this;
+    }
     /**
      * Specify device scale factor (can be thought of as dpr). Defaults to {@code 1}. Learn more about <a
      * href="https://playwright.dev/java/docs/emulation#devices">emulating devices with device scale factor</a>.
@@ -671,6 +686,12 @@ class NewPageOptions {
      * "light"}.
      */
     public Optional<ColorScheme> colorScheme;
+    /**
+     * Emulates {@code "prefers-contrast"} media feature, supported values are {@code "no-preference"}, {@code "more"}. See
+     * {@link com.microsoft.playwright.Page#emulateMedia Page.emulateMedia()} for more details. Passing {@code null} resets
+     * emulation to system defaults. Defaults to {@code "no-preference"}.
+     */
+    public Optional<Contrast> contrast;
     /**
      * Specify device scale factor (can be thought of as dpr). Defaults to {@code 1}. Learn more about <a
      * href="https://playwright.dev/java/docs/emulation#devices">emulating devices with device scale factor</a>.
@@ -888,6 +909,15 @@ public NewPageOptions setColorScheme(ColorScheme colorScheme) {
       this.colorScheme = Optional.ofNullable(colorScheme);
       return this;
     }
+    /**
+     * Emulates {@code "prefers-contrast"} media feature, supported values are {@code "no-preference"}, {@code "more"}. See
+     * {@link com.microsoft.playwright.Page#emulateMedia Page.emulateMedia()} for more details. Passing {@code null} resets
+     * emulation to system defaults. Defaults to {@code "no-preference"}.
+     */
+    public NewPageOptions setContrast(Contrast contrast) {
+      this.contrast = Optional.ofNullable(contrast);
+      return this;
+    }
     /**
      * Specify device scale factor (can be thought of as dpr). Defaults to {@code 1}. Learn more about <a
      * href="https://playwright.dev/java/docs/emulation#devices">emulating devices with device scale factor</a>.

playwright/src/main/java/com/microsoft/playwright/BrowserContext.java

@@ -407,12 +407,31 @@ public RouteFromHAROptions setUrl(Pattern url) {
     }
   }
   class StorageStateOptions {
+    /**
+     * Set to {@code true} to include <a href="https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API">IndexedDB</a> in
+     * the storage state snapshot. If your application uses IndexedDB to store authentication tokens, like Firebase
+     * Authentication, enable this.
+     *
+     * <p> <strong>NOTE:</strong> IndexedDBs with typed arrays are currently not supported.
+     */
+    public Boolean indexedDB;
     /**
      * The file path to save the storage state to. If {@code path} is a relative path, then it is resolved relative to current
      * working directory. If no path is provided, storage state is still returned, but won't be saved to the disk.
      */
     public Path path;
 
+    /**
+     * Set to {@code true} to include <a href="https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API">IndexedDB</a> in
+     * the storage state snapshot. If your application uses IndexedDB to store authentication tokens, like Firebase
+     * Authentication, enable this.
+     *
+     * <p> <strong>NOTE:</strong> IndexedDBs with typed arrays are currently not supported.
+     */
+    public StorageStateOptions setIndexedDB(boolean indexedDB) {
+      this.indexedDB = indexedDB;
+      return this;
+    }
     /**
      * The file path to save the storage state to. If {@code path} is a relative path, then it is resolved relative to current
      * working directory. If no path is provided, storage state is still returned, but won't be saved to the disk.
@@ -1435,15 +1454,15 @@ default void routeFromHAR(Path har) {
    */
   void setOffline(boolean offline);
   /**
-   * Returns storage state for this browser context, contains current cookies and local storage snapshot.
+   * Returns storage state for this browser context, contains current cookies, local storage snapshot and IndexedDB snapshot.
    *
    * @since v1.8
    */
   default String storageState() {
     return storageState(null);
   }
   /**
-   * Returns storage state for this browser context, contains current cookies and local storage snapshot.
+   * Returns storage state for this browser context, contains current cookies, local storage snapshot and IndexedDB snapshot.
    *
    * @since v1.8
    */

playwright/src/main/java/com/microsoft/playwright/BrowserType.java

@@ -497,6 +497,12 @@ class LaunchPersistentContextOptions {
      * "light"}.
      */
     public Optional<ColorScheme> colorScheme;
+    /**
+     * Emulates {@code "prefers-contrast"} media feature, supported values are {@code "no-preference"}, {@code "more"}. See
+     * {@link com.microsoft.playwright.Page#emulateMedia Page.emulateMedia()} for more details. Passing {@code null} resets
+     * emulation to system defaults. Defaults to {@code "no-preference"}.
+     */
+    public Optional<Contrast> contrast;
     /**
      * Specify device scale factor (can be thought of as dpr). Defaults to {@code 1}. Learn more about <a
      * href="https://playwright.dev/java/docs/emulation#devices">emulating devices with device scale factor</a>.
@@ -816,6 +822,15 @@ public LaunchPersistentContextOptions setColorScheme(ColorScheme colorScheme) {
       this.colorScheme = Optional.ofNullable(colorScheme);
       return this;
     }
+    /**
+     * Emulates {@code "prefers-contrast"} media feature, supported values are {@code "no-preference"}, {@code "more"}. See
+     * {@link com.microsoft.playwright.Page#emulateMedia Page.emulateMedia()} for more details. Passing {@code null} resets
+     * emulation to system defaults. Defaults to {@code "no-preference"}.
+     */
+    public LaunchPersistentContextOptions setContrast(Contrast contrast) {
+      this.contrast = Optional.ofNullable(contrast);
+      return this;
+    }
     /**
      * Specify device scale factor (can be thought of as dpr). Defaults to {@code 1}. Learn more about <a
      * href="https://playwright.dev/java/docs/emulation#devices">emulating devices with device scale factor</a>.
@@ -1197,22 +1212,24 @@ public LaunchPersistentContextOptions setViewportSize(ViewportSize viewportSize)
     }
   }
   /**
-   * This method attaches Playwright to an existing browser instance. When connecting to another browser launched via {@code
-   * BrowserType.launchServer} in Node.js, the major and minor version needs to match the client version (1.2.3 → is
-   * compatible with 1.2.x).
+   * This method attaches Playwright to an existing browser instance created via {@code BrowserType.launchServer} in Node.js.
+   *
+   * <p> <strong>NOTE:</strong> The major and minor version of the Playwright instance that connects needs to match the version of Playwright that
+   * launches the browser (1.2.3 → is compatible with 1.2.x).
    *
-   * @param wsEndpoint A browser websocket endpoint to connect to.
+   * @param wsEndpoint A Playwright browser websocket endpoint to connect to. You obtain this endpoint via {@code BrowserServer.wsEndpoint}.
    * @since v1.8
    */
   default Browser connect(String wsEndpoint) {
     return connect(wsEndpoint, null);
   }
   /**
-   * This method attaches Playwright to an existing browser instance. When connecting to another browser launched via {@code
-   * BrowserType.launchServer} in Node.js, the major and minor version needs to match the client version (1.2.3 → is
-   * compatible with 1.2.x).
+   * This method attaches Playwright to an existing browser instance created via {@code BrowserType.launchServer} in Node.js.
    *
-   * @param wsEndpoint A browser websocket endpoint to connect to.
+   * <p> <strong>NOTE:</strong> The major and minor version of the Playwright instance that connects needs to match the version of Playwright that
+   * launches the browser (1.2.3 → is compatible with 1.2.x).
+   *
+   * @param wsEndpoint A Playwright browser websocket endpoint to connect to. You obtain this endpoint via {@code BrowserServer.wsEndpoint}.
    * @since v1.8
    */
   Browser connect(String wsEndpoint, ConnectOptions options);
@@ -1223,6 +1240,11 @@ default Browser connect(String wsEndpoint) {
    *
    * <p> <strong>NOTE:</strong> Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers.
    *
+   * <p> <strong>NOTE:</strong> This connection is significantly lower fidelity than the Playwright protocol connection via {@link
+   * com.microsoft.playwright.BrowserType#connect BrowserType.connect()}. If you are experiencing issues or attempting to use
+   * advanced functionality, you probably want to use {@link com.microsoft.playwright.BrowserType#connect
+   * BrowserType.connect()}.
+   *
    * <p> <strong>Usage</strong>
    * <pre>{@code
    * Browser browser = playwright.chromium().connectOverCDP("http://localhost:9222");
@@ -1244,6 +1266,11 @@ default Browser connectOverCDP(String endpointURL) {
    *
    * <p> <strong>NOTE:</strong> Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers.
    *
+   * <p> <strong>NOTE:</strong> This connection is significantly lower fidelity than the Playwright protocol connection via {@link
+   * com.microsoft.playwright.BrowserType#connect BrowserType.connect()}. If you are experiencing issues or attempting to use
+   * advanced functionality, you probably want to use {@link com.microsoft.playwright.BrowserType#connect
+   * BrowserType.connect()}.
+   *
    * <p> <strong>Usage</strong>
    * <pre>{@code
    * Browser browser = playwright.chromium().connectOverCDP("http://localhost:9222");

playwright/src/main/java/com/microsoft/playwright/ElementHandle.java

@@ -599,7 +599,9 @@ class ScreenshotOptions {
     public ScreenshotCaret caret;
     /**
      * Specify locators that should be masked when the screenshot is taken. Masked elements will be overlaid with a pink box
-     * {@code #FF00FF} (customized by {@code maskColor}) that completely covers its bounding box.
+     * {@code #FF00FF} (customized by {@code maskColor}) that completely covers its bounding box. The mask is also applied to
+     * invisible elements, see <a href="https://playwright.dev/java/docs/locators#matching-only-visible-elements">Matching only
+     * visible elements</a> to disable that.
      */
     public List<Locator> mask;
     /**
@@ -673,7 +675,9 @@ public ScreenshotOptions setCaret(ScreenshotCaret caret) {
     }
     /**
      * Specify locators that should be masked when the screenshot is taken. Masked elements will be overlaid with a pink box
-     * {@code #FF00FF} (customized by {@code maskColor}) that completely covers its bounding box.
+     * {@code #FF00FF} (customized by {@code maskColor}) that completely covers its bounding box. The mask is also applied to
+     * invisible elements, see <a href="https://playwright.dev/java/docs/locators#matching-only-visible-elements">Matching only
+     * visible elements</a> to disable that.
      */
     public ScreenshotOptions setMask(List<Locator> mask) {
       this.mask = mask;