feat: roll driver, implement locator.waitFor (#639)

Author: yury-s

README.md

@@ -11,7 +11,7 @@ Playwright is a Java library to automate [Chromium](https://www.chromium.org/Hom
 
 |          | Linux | macOS | Windows |
 |   :---   | :---: | :---: | :---:   |
-| Chromium <!-- GEN:chromium-version -->96.0.4655.0<!-- GEN:stop --> | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+| Chromium <!-- GEN:chromium-version -->96.0.4660.0<!-- GEN:stop --> | :white_check_mark: | :white_check_mark: | :white_check_mark: |
 | WebKit <!-- GEN:webkit-version -->15.0<!-- GEN:stop --> | ✅ | ✅ | ✅ |
 | Firefox <!-- GEN:firefox-version -->92.0<!-- GEN:stop --> | :white_check_mark: | :white_check_mark: | :white_check_mark: |
 

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

@@ -1079,7 +1079,8 @@ default Browser launch() {
    * @param userDataDir Path to a User Data Directory, which stores browser session data like cookies and local storage. More details for <a
    * href="https://chromium.googlesource.com/chromium/src/+/master/docs/user_data_dir.md#introduction">Chromium</a> and <a
    * href="https://developer.mozilla.org/en-US/docs/Mozilla/Command_Line_Options#User_Profile">Firefox</a>. Note that
-   * Chromium's user data directory is the **parent** directory of the "Profile Path" seen at {@code chrome://version}.
+   * Chromium's user data directory is the **parent** directory of the "Profile Path" seen at {@code chrome://version}. Pass an
+   * empty string to use a temporary directory instead.
    */
   default BrowserContext launchPersistentContext(Path userDataDir) {
     return launchPersistentContext(userDataDir, null);
@@ -1093,7 +1094,8 @@ default BrowserContext launchPersistentContext(Path userDataDir) {
    * @param userDataDir Path to a User Data Directory, which stores browser session data like cookies and local storage. More details for <a
    * href="https://chromium.googlesource.com/chromium/src/+/master/docs/user_data_dir.md#introduction">Chromium</a> and <a
    * href="https://developer.mozilla.org/en-US/docs/Mozilla/Command_Line_Options#User_Profile">Firefox</a>. Note that
-   * Chromium's user data directory is the **parent** directory of the "Profile Path" seen at {@code chrome://version}.
+   * Chromium's user data directory is the **parent** directory of the "Profile Path" seen at {@code chrome://version}. Pass an
+   * empty string to use a temporary directory instead.
    */
   BrowserContext launchPersistentContext(Path userDataDir, LaunchPersistentContextOptions options);
   /**

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

@@ -1355,6 +1355,51 @@ public UncheckOptions setTrial(boolean trial) {
       return this;
     }
   }
+  class WaitForOptions {
+    /**
+     * Defaults to {@code "visible"}. Can be either:
+     * <ul>
+     * <li> {@code "attached"} - wait for element to be present in DOM.</li>
+     * <li> {@code "detached"} - wait for element to not be present in DOM.</li>
+     * <li> {@code "visible"} - wait for element to have non-empty bounding box and no {@code visibility:hidden}. Note that element without any
+     * content or with {@code display:none} has an empty bounding box and is not considered visible.</li>
+     * <li> {@code "hidden"} - wait for element to be either detached from DOM, or have an empty bounding box or {@code visibility:hidden}. This
+     * is opposite to the {@code "visible"} option.</li>
+     * </ul>
+     */
+    public WaitForSelectorState state;
+    /**
+     * Maximum time in milliseconds, defaults to 30 seconds, pass {@code 0} to disable timeout. The default value can be changed by
+     * using the {@link BrowserContext#setDefaultTimeout BrowserContext.setDefaultTimeout()} or {@link Page#setDefaultTimeout
+     * Page.setDefaultTimeout()} methods.
+     */
+    public Double timeout;
+
+    /**
+     * Defaults to {@code "visible"}. Can be either:
+     * <ul>
+     * <li> {@code "attached"} - wait for element to be present in DOM.</li>
+     * <li> {@code "detached"} - wait for element to not be present in DOM.</li>
+     * <li> {@code "visible"} - wait for element to have non-empty bounding box and no {@code visibility:hidden}. Note that element without any
+     * content or with {@code display:none} has an empty bounding box and is not considered visible.</li>
+     * <li> {@code "hidden"} - wait for element to be either detached from DOM, or have an empty bounding box or {@code visibility:hidden}. This
+     * is opposite to the {@code "visible"} option.</li>
+     * </ul>
+     */
+    public WaitForOptions setState(WaitForSelectorState state) {
+      this.state = state;
+      return this;
+    }
+    /**
+     * Maximum time in milliseconds, defaults to 30 seconds, pass {@code 0} to disable timeout. The default value can be changed by
+     * using the {@link BrowserContext#setDefaultTimeout BrowserContext.setDefaultTimeout()} or {@link Page#setDefaultTimeout
+     * Page.setDefaultTimeout()} methods.
+     */
+    public WaitForOptions setTimeout(double timeout) {
+      this.timeout = timeout;
+      return this;
+    }
+  }
   /**
    * Returns an array of {@code node.innerText} values for all matching nodes.
    */
@@ -2667,5 +2712,29 @@ default void uncheck() {
    * zero timeout disables this.
    */
   void uncheck(UncheckOptions options);
+  /**
+   * Returns when element specified by locator satisfies the {@code state} option.
+   *
+   * <p> If target element already satisfies the condition, the method returns immediately. Otherwise, waits for up to {@code timeout}
+   * milliseconds until the condition is met.
+   * <pre>{@code
+   * Locator orderSent = page.locator("#order-sent");
+   * orderSent.waitFor();
+   * }</pre>
+   */
+  default void waitFor() {
+    waitFor(null);
+  }
+  /**
+   * Returns when element specified by locator satisfies the {@code state} option.
+   *
+   * <p> If target element already satisfies the condition, the method returns immediately. Otherwise, waits for up to {@code timeout}
+   * milliseconds until the condition is met.
+   * <pre>{@code
+   * Locator orderSent = page.locator("#order-sent");
+   * orderSent.waitFor();
+   * }</pre>
+   */
+  void waitFor(WaitForOptions options);
 }
 

playwright/src/main/java/com/microsoft/playwright/impl/FrameImpl.java

@@ -948,11 +948,16 @@ public ElementHandle waitForSelector(String selector, WaitForSelectorOptions opt
   }
 
   ElementHandle waitForSelectorImpl(String selector, WaitForSelectorOptions options) {
+    return waitForSelectorImpl(selector, options, false);
+  }
+
+  ElementHandle waitForSelectorImpl(String selector, WaitForSelectorOptions options, boolean omitReturnValue) {
     if (options == null) {
       options = new WaitForSelectorOptions();
     }
     JsonObject params = gson().toJsonTree(options).getAsJsonObject();
     params.addProperty("selector", selector);
+    params.addProperty("omitReturnValue", omitReturnValue);
     JsonElement json = sendMessage("waitForSelector", params);
     JsonObject element = json.getAsJsonObject().getAsJsonObject("element");
     if (element == null) {

playwright/src/main/java/com/microsoft/playwright/impl/LocatorImpl.java

@@ -399,6 +399,18 @@ public void uncheck(UncheckOptions options) {
     frame.uncheck(selector, convertViaJson(options, Frame.UncheckOptions.class).setStrict(true));
   }
 
+  @Override
+  public void waitFor(WaitForOptions options) {
+    if (options == null) {
+      options = new WaitForOptions();
+    }
+    waitForImpl(options);
+  }
+
+  private void waitForImpl(WaitForOptions options) {
+    frame.withLogging("Locator.waitFor", () -> frame.waitForSelectorImpl(selector, convertViaJson(options, Frame.WaitForSelectorOptions.class).setStrict(true), true));
+  }
+
   @Override
   public String toString() {
     return "Locator@" + selector;

playwright/src/main/java/com/microsoft/playwright/impl/RequestImpl.java

@@ -167,13 +167,8 @@ private RawHeaders getRawHeaders() {
     if (rawHeaders != null) {
       return rawHeaders;
     }
-    ResponseImpl response = response();
-    // there is no response, so should we return the headers we have now?
-    if (response == null) {
-      return headers;
-    }
-    JsonArray rawHeadersJson = response.withLogging("Request.allHeaders", () -> {
-      JsonObject result = response.sendMessage("rawRequestHeaders").getAsJsonObject();
+    JsonArray rawHeadersJson = withLogging("Request.allHeaders", () -> {
+      JsonObject result = sendMessage("rawRequestHeaders").getAsJsonObject();
       return result.getAsJsonArray("headers");
     });
 

playwright/src/test/java/com/microsoft/playwright/TestLocatorMisc.java

@@ -16,9 +16,11 @@
 
 package com.microsoft.playwright;
 
+import com.microsoft.playwright.options.WaitForSelectorState;
 import org.junit.jupiter.api.Test;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 public class TestLocatorMisc extends TestBase{
   @Test
@@ -30,4 +32,21 @@ void shouldCheckTheBoxUsingSetChecked() {
     input.setChecked(false);
     assertEquals(false, page.evaluate("checkbox.checked"));
   }
+
+  @Test
+  void shouldWaitFor() {
+    page.setContent("<div></div>");
+    Locator locator = page.locator("span");
+    page.evalOnSelector("div", "div => setTimeout(() => div.innerHTML = '<span>target</span>', 500)");
+    locator.waitFor();
+    assertTrue(locator.textContent().contains("target"));
+  }
+
+  @Test
+  void shouldWaitForHidden() {
+    page.setContent("<div><span>target</span></div>");
+    Locator locator = page.locator("span");
+    page.evalOnSelector("div", "div => setTimeout(() => div.innerHTML = '', 500)");
+    locator.waitFor(new Locator.WaitForOptions().setState(WaitForSelectorState.HIDDEN));
+  }
 }

playwright/src/test/java/com/microsoft/playwright/TestNetworkRequest.java

@@ -73,6 +73,18 @@ void shouldWorkForARedirect() {
     assertEquals(server.PREFIX + "/empty.html", requests.get(1).url());
   }
 
+  @Test
+  void shouldWorkAllHeadersInsideRoute() {
+    List<Request> requests = new ArrayList<>();
+    page.route("**", route -> {
+      assertTrue(route.request().allHeaders().get("accept").length() > 5);
+      requests.add(route.request());
+      route.resume();
+    });
+    page.navigate(server.PREFIX + "/empty.html");
+    assertEquals(1, requests.size());
+  }
+
   // https://github.com/microsoft/playwright/issues/3993
   @Test
   void shouldNotWorkForARedirectAndInterception() {

scripts/CLI_VERSION

@@ -1 +1 @@
-1.16.0-next-1632766475000
+1.16.0-next-1633463468000