feat: roll driver, deprecated channel enum (#468)

Author: yury-s

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

@@ -142,6 +142,11 @@ class NewContextOptions {
      * be scaled down if necessary to fit the specified size.
      */
     public RecordVideoSize recordVideoSize;
+    /**
+     * Emulates {@code "prefers-reduced-motion"} media feature, supported values are {@code "reduce"}, {@code "no-preference"}. See {@link
+     * Page#emulateMedia Page.emulateMedia()} for more details. Defaults to {@code "no-preference"}.
+     */
+    public ReducedMotion reducedMotion;
     /**
      * Emulates consistent window screen size available inside web page via {@code window.screen}. Is only used when the {@code viewport}
      * is set.
@@ -261,6 +266,10 @@ public NewContextOptions setRecordVideoSize(RecordVideoSize recordVideoSize) {
       this.recordVideoSize = recordVideoSize;
       return this;
     }
+    public NewContextOptions setReducedMotion(ReducedMotion reducedMotion) {
+      this.reducedMotion = reducedMotion;
+      return this;
+    }
     public NewContextOptions setScreenSize(int width, int height) {
       return setScreenSize(new ScreenSize(width, height));
     }
@@ -379,6 +388,11 @@ class NewPageOptions {
      * be scaled down if necessary to fit the specified size.
      */
     public RecordVideoSize recordVideoSize;
+    /**
+     * Emulates {@code "prefers-reduced-motion"} media feature, supported values are {@code "reduce"}, {@code "no-preference"}. See {@link
+     * Page#emulateMedia Page.emulateMedia()} for more details. Defaults to {@code "no-preference"}.
+     */
+    public ReducedMotion reducedMotion;
     /**
      * Emulates consistent window screen size available inside web page via {@code window.screen}. Is only used when the {@code viewport}
      * is set.
@@ -498,6 +512,10 @@ public NewPageOptions setRecordVideoSize(RecordVideoSize recordVideoSize) {
       this.recordVideoSize = recordVideoSize;
       return this;
     }
+    public NewPageOptions setReducedMotion(ReducedMotion reducedMotion) {
+      this.reducedMotion = reducedMotion;
+      return this;
+    }
     public NewPageOptions setScreenSize(int width, int height) {
       return setScreenSize(new ScreenSize(width, height));
     }

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

@@ -412,7 +412,7 @@ default void exposeBinding(String name, BindingCallback callback) {
    *
    * <p> See {@link Page#exposeFunction Page.exposeFunction()} for page-only version.
    *
-   * <p> An example of adding an {@code md5} function to all pages in the context:
+   * <p> An example of adding a {@code sha256} function to all pages in the context:
    * <pre>{@code
    * import com.microsoft.playwright.*;
    *
@@ -426,11 +426,11 @@ default void exposeBinding(String name, BindingCallback callback) {
    *     try (Playwright playwright = Playwright.create()) {
    *       BrowserType webkit = playwright.webkit()
    *       Browser browser = webkit.launch(new BrowserType.LaunchOptions().setHeadless(false));
-   *       context.exposeFunction("sha1", args -> {
+   *       context.exposeFunction("sha256", args -> {
    *         String text = (String) args[0];
    *         MessageDigest crypto;
    *         try {
-   *           crypto = MessageDigest.getInstance("SHA-1");
+   *           crypto = MessageDigest.getInstance("SHA-256");
    *         } catch (NoSuchAlgorithmException e) {
    *           return null;
    *         }
@@ -440,7 +440,7 @@ default void exposeBinding(String name, BindingCallback callback) {
    *       Page page = context.newPage();
    *       page.setContent("<script>\n" +
    *         "  async function onClick() {\n" +
-   *         "    document.querySelector('div').textContent = await window.sha1('PLAYWRIGHT');\n" +
+   *         "    document.querySelector('div').textContent = await window.sha256('PLAYWRIGHT');\n" +
    *         "  }\n" +
    *         "</script>\n" +
    *         "<button onclick=\"onClick()\">Click me</button>\n" +

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

@@ -106,10 +106,11 @@ class LaunchOptions {
      */
     public List<String> args;
     /**
-     * Browser distribution channel. Read more about using <a
+     * Browser distribution channel.  Supported values are "chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge",
+     * "msedge-beta", "msedge-dev", "msedge-canary". Read more about using <a
      * href="https://playwright.dev/java/docs/browsers/#google-chrome--microsoft-edge">Google Chrome and Microsoft Edge</a>.
      */
-    public BrowserChannel channel;
+    public Object channel;
     /**
      * Enable Chromium sandboxing. Defaults to {@code false}.
      */
@@ -184,16 +185,21 @@ class LaunchOptions {
     /**
      * If specified, traces are saved into this directory.
      */
-    public Path traceDir;
+    public Path tracesDir;
 
     public LaunchOptions setArgs(List<String> args) {
       this.args = args;
       return this;
     }
+    @Deprecated
     public LaunchOptions setChannel(BrowserChannel channel) {
       this.channel = channel;
       return this;
     }
+    public LaunchOptions setChannel(String channel) {
+      this.channel = channel;
+      return this;
+    }
     public LaunchOptions setChromiumSandbox(boolean chromiumSandbox) {
       this.chromiumSandbox = chromiumSandbox;
       return this;
@@ -257,8 +263,8 @@ public LaunchOptions setTimeout(double timeout) {
       this.timeout = timeout;
       return this;
     }
-    public LaunchOptions setTraceDir(Path traceDir) {
-      this.traceDir = traceDir;
+    public LaunchOptions setTracesDir(Path tracesDir) {
+      this.tracesDir = tracesDir;
       return this;
     }
   }
@@ -277,10 +283,11 @@ class LaunchPersistentContextOptions {
      */
     public Boolean bypassCSP;
     /**
-     * Browser distribution channel. Read more about using <a
+     * Browser distribution channel.  Supported values are "chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge",
+     * "msedge-beta", "msedge-dev", "msedge-canary". Read more about using <a
      * href="https://playwright.dev/java/docs/browsers/#google-chrome--microsoft-edge">Google Chrome and Microsoft Edge</a>.
      */
-    public BrowserChannel channel;
+    public Object channel;
     /**
      * Enable Chromium sandboxing. Defaults to {@code false}.
      */
@@ -408,6 +415,11 @@ class LaunchPersistentContextOptions {
      * be scaled down if necessary to fit the specified size.
      */
     public RecordVideoSize recordVideoSize;
+    /**
+     * Emulates {@code "prefers-reduced-motion"} media feature, supported values are {@code "reduce"}, {@code "no-preference"}. See {@link
+     * Page#emulateMedia Page.emulateMedia()} for more details. Defaults to {@code "no-preference"}.
+     */
+    public ReducedMotion reducedMotion;
     /**
      * Emulates consistent window screen size available inside web page via {@code window.screen}. Is only used when the {@code viewport}
      * is set.
@@ -431,7 +443,7 @@ class LaunchPersistentContextOptions {
     /**
      * If specified, traces are saved into this directory.
      */
-    public Path traceDir;
+    public Path tracesDir;
     /**
      * Specific user agent to use in this context.
      */
@@ -453,10 +465,15 @@ public LaunchPersistentContextOptions setBypassCSP(boolean bypassCSP) {
       this.bypassCSP = bypassCSP;
       return this;
     }
+    @Deprecated
     public LaunchPersistentContextOptions setChannel(BrowserChannel channel) {
       this.channel = channel;
       return this;
     }
+    public LaunchPersistentContextOptions setChannel(String channel) {
+      this.channel = channel;
+      return this;
+    }
     public LaunchPersistentContextOptions setChromiumSandbox(boolean chromiumSandbox) {
       this.chromiumSandbox = chromiumSandbox;
       return this;
@@ -581,6 +598,10 @@ public LaunchPersistentContextOptions setRecordVideoSize(RecordVideoSize recordV
       this.recordVideoSize = recordVideoSize;
       return this;
     }
+    public LaunchPersistentContextOptions setReducedMotion(ReducedMotion reducedMotion) {
+      this.reducedMotion = reducedMotion;
+      return this;
+    }
     public LaunchPersistentContextOptions setScreenSize(int width, int height) {
       return setScreenSize(new ScreenSize(width, height));
     }
@@ -600,8 +621,8 @@ public LaunchPersistentContextOptions setTimezoneId(String timezoneId) {
       this.timezoneId = timezoneId;
       return this;
     }
-    public LaunchPersistentContextOptions setTraceDir(Path traceDir) {
-      this.traceDir = traceDir;
+    public LaunchPersistentContextOptions setTracesDir(Path tracesDir) {
+      this.tracesDir = tracesDir;
       return this;
     }
     public LaunchPersistentContextOptions setUserAgent(String userAgent) {

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

@@ -258,7 +258,8 @@ public interface Page extends AutoCloseable {
    *
    * <p> <strong>NOTE:</strong> HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will complete
    * with {@link Page#onRequestFinished Page.onRequestFinished()} event and not with {@link Page#onRequestFailed
-   * Page.onRequestFailed()}.
+   * Page.onRequestFailed()}. A request will only be considered failed when the client cannot get an HTTP response from the
+   * server, e.g. due to network error net::ERR_FAILED.
    */
   void onRequestFailed(Consumer<Request> handler);
   /**
@@ -626,6 +627,11 @@ class EmulateMediaOptions {
      * disables CSS media emulation.
      */
     public Optional<Media> media;
+    /**
+     * Emulates {@code "prefers-reduced-motion"} media feature, supported values are {@code "reduce"}, {@code "no-preference"}. Passing {@code null}
+     * disables reduced motion emulation.
+     */
+    public Optional<ReducedMotion> reducedMotion;
 
     public EmulateMediaOptions setColorScheme(ColorScheme colorScheme) {
       this.colorScheme = Optional.ofNullable(colorScheme);
@@ -635,6 +641,10 @@ public EmulateMediaOptions setMedia(Media media) {
       this.media = Optional.ofNullable(media);
       return this;
     }
+    public EmulateMediaOptions setReducedMotion(ReducedMotion reducedMotion) {
+      this.reducedMotion = Optional.ofNullable(reducedMotion);
+      return this;
+    }
   }
   class ExposeBindingOptions {
     /**
@@ -1603,6 +1613,26 @@ public WaitForRequestOptions setTimeout(double timeout) {
       return this;
     }
   }
+  class WaitForRequestFinishedOptions {
+    /**
+     * Receives the {@code Request} object and resolves to truthy value when the waiting should resolve.
+     */
+    public Predicate<Request> predicate;
+    /**
+     * Maximum time to wait for in milliseconds. Defaults to {@code 30000} (30 seconds). Pass {@code 0} to disable timeout. The default
+     * value can be changed by using the {@link BrowserContext#setDefaultTimeout BrowserContext.setDefaultTimeout()}.
+     */
+    public Double timeout;
+
+    public WaitForRequestFinishedOptions setPredicate(Predicate<Request> predicate) {
+      this.predicate = predicate;
+      return this;
+    }
+    public WaitForRequestFinishedOptions setTimeout(double timeout) {
+      this.timeout = timeout;
+      return this;
+    }
+  }
   class WaitForResponseOptions {
     /**
      * Maximum wait time in milliseconds, defaults to 30 seconds, pass {@code 0} to disable the timeout. The default value can be
@@ -2508,7 +2538,7 @@ default void exposeBinding(String name, BindingCallback callback) {
    *
    * <p> <strong>NOTE:</strong> Functions installed via {@link Page#exposeFunction Page.exposeFunction()} survive navigations.
    *
-   * <p> An example of adding an {@code sha1} function to the page:
+   * <p> An example of adding a {@code sha256} function to the page:
    * <pre>{@code
    * import com.microsoft.playwright.*;
    *
@@ -2523,11 +2553,11 @@ default void exposeBinding(String name, BindingCallback callback) {
    *       BrowserType webkit = playwright.webkit();
    *       Browser browser = webkit.launch({ headless: false });
    *       Page page = browser.newPage();
-   *       page.exposeFunction("sha1", args -> {
+   *       page.exposeFunction("sha256", args -> {
    *         String text = (String) args[0];
    *         MessageDigest crypto;
    *         try {
-   *           crypto = MessageDigest.getInstance("SHA-1");
+   *           crypto = MessageDigest.getInstance("SHA-256");
    *         } catch (NoSuchAlgorithmException e) {
    *           return null;
    *         }
@@ -2536,7 +2566,7 @@ default void exposeBinding(String name, BindingCallback callback) {
    *       });
    *       page.setContent("<script>\n" +
    *         "  async function onClick() {\n" +
-   *         "    document.querySelector('div').textContent = await window.sha1('PLAYWRIGHT');\n" +
+   *         "    document.querySelector('div').textContent = await window.sha256('PLAYWRIGHT');\n" +
    *         "  }\n" +
    *         "</script>\n" +
    *         "<button onclick=\"onClick()\">Click me</button>\n" +
@@ -4095,7 +4125,7 @@ default Page waitForClose(Runnable callback) {
   /**
    * Performs action and waits for a {@code ConsoleMessage} to be logged by in the page. If predicate is provided, it passes
    * {@code ConsoleMessage} value into the {@code predicate} function and waits for {@code predicate(message)} to return a truthy value. Will
-   * throw an error if the page is closed before the console event is fired.
+   * throw an error if the page is closed before the {@link Page#onConsole Page.onConsole()} event is fired.
    *
    * @param callback Callback that performs the action triggering the event.
    */
@@ -4105,7 +4135,7 @@ default ConsoleMessage waitForConsoleMessage(Runnable callback) {
   /**
    * Performs action and waits for a {@code ConsoleMessage} to be logged by in the page. If predicate is provided, it passes
    * {@code ConsoleMessage} value into the {@code predicate} function and waits for {@code predicate(message)} to return a truthy value. Will
-   * throw an error if the page is closed before the console event is fired.
+   * throw an error if the page is closed before the {@link Page#onConsole Page.onConsole()} event is fired.
    *
    * @param callback Callback that performs the action triggering the event.
    */
@@ -4401,7 +4431,7 @@ default Page waitForPopup(Runnable callback) {
    * Waits for the matching request and returns it.  See <a
    * href="https://playwright.dev/java/docs/events/#waiting-for-event">waiting for event</a> for more details about events.
    * <pre>{@code
-   * // Waits for the next response with the specified url
+   * // Waits for the next request with the specified url
    * Request request = page.waitForRequest("https://example.com/resource", () -> {
    *   // Triggers the request
    *   page.click("button.triggers-request");
@@ -4424,7 +4454,7 @@ default Request waitForRequest(String urlOrPredicate, Runnable callback) {
    * Waits for the matching request and returns it.  See <a
    * href="https://playwright.dev/java/docs/events/#waiting-for-event">waiting for event</a> for more details about events.
    * <pre>{@code
-   * // Waits for the next response with the specified url
+   * // Waits for the next request with the specified url
    * Request request = page.waitForRequest("https://example.com/resource", () -> {
    *   // Triggers the request
    *   page.click("button.triggers-request");
@@ -4445,7 +4475,7 @@ default Request waitForRequest(String urlOrPredicate, Runnable callback) {
    * Waits for the matching request and returns it.  See <a
    * href="https://playwright.dev/java/docs/events/#waiting-for-event">waiting for event</a> for more details about events.
    * <pre>{@code
-   * // Waits for the next response with the specified url
+   * // Waits for the next request with the specified url
    * Request request = page.waitForRequest("https://example.com/resource", () -> {
    *   // Triggers the request
    *   page.click("button.triggers-request");
@@ -4468,7 +4498,7 @@ default Request waitForRequest(Pattern urlOrPredicate, Runnable callback) {
    * Waits for the matching request and returns it.  See <a
    * href="https://playwright.dev/java/docs/events/#waiting-for-event">waiting for event</a> for more details about events.
    * <pre>{@code
-   * // Waits for the next response with the specified url
+   * // Waits for the next request with the specified url
    * Request request = page.waitForRequest("https://example.com/resource", () -> {
    *   // Triggers the request
    *   page.click("button.triggers-request");
@@ -4489,7 +4519,7 @@ default Request waitForRequest(Pattern urlOrPredicate, Runnable callback) {
    * Waits for the matching request and returns it.  See <a
    * href="https://playwright.dev/java/docs/events/#waiting-for-event">waiting for event</a> for more details about events.
    * <pre>{@code
-   * // Waits for the next response with the specified url
+   * // Waits for the next request with the specified url
    * Request request = page.waitForRequest("https://example.com/resource", () -> {
    *   // Triggers the request
    *   page.click("button.triggers-request");
@@ -4512,7 +4542,7 @@ default Request waitForRequest(Predicate<Request> urlOrPredicate, Runnable callb
    * Waits for the matching request and returns it.  See <a
    * href="https://playwright.dev/java/docs/events/#waiting-for-event">waiting for event</a> for more details about events.
    * <pre>{@code
-   * // Waits for the next response with the specified url
+   * // Waits for the next request with the specified url
    * Request request = page.waitForRequest("https://example.com/resource", () -> {
    *   // Triggers the request
    *   page.click("button.triggers-request");
@@ -4529,6 +4559,24 @@ default Request waitForRequest(Predicate<Request> urlOrPredicate, Runnable callb
    * @param callback Callback that performs the action triggering the event.
    */
   Request waitForRequest(Predicate<Request> urlOrPredicate, WaitForRequestOptions options, Runnable callback);
+  /**
+   * Performs action and waits for a {@code Request} to finish loading. If predicate is provided, it passes {@code Request} value into
+   * the {@code predicate} function and waits for {@code predicate(request)} to return a truthy value. Will throw an error if the page is
+   * closed before the {@link Page#onRequestFinished Page.onRequestFinished()} event is fired.
+   *
+   * @param callback Callback that performs the action triggering the event.
+   */
+  default Request waitForRequestFinished(Runnable callback) {
+    return waitForRequestFinished(null, callback);
+  }
+  /**
+   * Performs action and waits for a {@code Request} to finish loading. If predicate is provided, it passes {@code Request} value into
+   * the {@code predicate} function and waits for {@code predicate(request)} to return a truthy value. Will throw an error if the page is
+   * closed before the {@link Page#onRequestFinished Page.onRequestFinished()} event is fired.
+   *
+   * @param callback Callback that performs the action triggering the event.
+   */
+  Request waitForRequestFinished(WaitForRequestFinishedOptions options, Runnable callback);
   /**
    * Returns the matched response. See <a href="https://playwright.dev/java/docs/events/#waiting-for-event">waiting for
    * event</a> for more details about events.