chore: roll driver to 1.40.0-alpha-nov-13-2023 (#1420)

README.md

@@ -11,9 +11,9 @@ Playwright is a Java library to automate [Chromium](https://www.chromium.org/Hom
 
 |          | Linux | macOS | Windows |
 |   :---   | :---: | :---: | :---:   |
-| Chromium <!-- GEN:chromium-version -->119.0.6045.9<!-- GEN:stop --> | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+| Chromium <!-- GEN:chromium-version -->120.0.6099.18<!-- GEN:stop --> | :white_check_mark: | :white_check_mark: | :white_check_mark: |
 | WebKit <!-- GEN:webkit-version -->17.4<!-- GEN:stop --> | ✅ | ✅ | ✅ |
-| Firefox <!-- GEN:firefox-version -->118.0.1<!-- GEN:stop --> | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+| Firefox <!-- GEN:firefox-version -->119.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.
 

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

@@ -80,8 +80,8 @@ default APIResponse delete(String url) {
   APIResponse delete(String url, RequestOptions params);
   /**
    * All responses returned by {@link APIRequestContext#get APIRequestContext.get()} and similar methods are stored in the
-   * memory, so that you can later call {@link APIResponse#body APIResponse.body()}. This method discards all stored
-   * responses, and makes {@link APIResponse#body APIResponse.body()} throw "Response disposed" error.
+   * memory, so that you can later call {@link APIResponse#body APIResponse.body()}.This method discards all its resources,
+   * calling any method on disposed {@code APIRequestContext} will throw an exception.
    *
    * @since v1.16
    */

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

@@ -56,6 +56,20 @@ public interface Browser extends AutoCloseable {
    */
   void offDisconnected(Consumer<Browser> handler);
 
+  class CloseOptions {
+    /**
+     * The reason to be reported to the operations interrupted by the browser closure.
+     */
+    public String reason;
+
+    /**
+     * The reason to be reported to the operations interrupted by the browser closure.
+     */
+    public CloseOptions setReason(String reason) {
+      this.reason = reason;
+      return this;
+    }
+  }
   class NewContextOptions {
     /**
      * Whether to automatically download all the attachments. Defaults to {@code true} where all the downloads are accepted.
@@ -1165,7 +1179,25 @@ public StartTracingOptions setScreenshots(boolean screenshots) {
    *
    * @since v1.8
    */
-  void close();
+  default void close() {
+    close(null);
+  }
+  /**
+   * In case this browser is obtained using {@link BrowserType#launch BrowserType.launch()}, closes the browser and all of
+   * its pages (if any were opened).
+   *
+   * <p> In case this browser is connected to, clears all created contexts belonging to this browser and disconnects from the
+   * browser server.
+   *
+   * <p> <strong>NOTE:</strong> This is similar to force quitting the browser. Therefore, you should call {@link BrowserContext#close
+   * BrowserContext.close()} on any {@code BrowserContext}'s you explicitly created earlier with {@link Browser#newContext
+   * Browser.newContext()} **before** calling {@link Browser#close Browser.close()}.
+   *
+   * <p> The {@code Browser} object itself is considered to be disposed and cannot be used anymore.
+   *
+   * @since v1.8
+   */
+  void close(CloseOptions options);
   /**
    * Returns an array of all open browser contexts. In a newly created browser, this will return zero browser contexts.
    *

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

@@ -186,6 +186,20 @@ public interface BrowserContext extends AutoCloseable {
    */
   void offResponse(Consumer<Response> handler);
 
+  class CloseOptions {
+    /**
+     * The reason to be reported to the operations interrupted by the context closure.
+     */
+    public String reason;
+
+    /**
+     * The reason to be reported to the operations interrupted by the context closure.
+     */
+    public CloseOptions setReason(String reason) {
+      this.reason = reason;
+      return this;
+    }
+  }
   class ExposeBindingOptions {
     /**
      * Whether to pass the argument as a handle, instead of passing by value. When passing a handle, only one argument is
@@ -504,7 +518,17 @@ public WaitForPageOptions setTimeout(double timeout) {
    *
    * @since v1.8
    */
-  void close();
+  default void close() {
+    close(null);
+  }
+  /**
+   * Closes the browser context. All the pages that belong to the browser context will be closed.
+   *
+   * <p> <strong>NOTE:</strong> The default browser context cannot be closed.
+   *
+   * @since v1.8
+   */
+  void close(CloseOptions options);
   /**
    * If no URLs are specified, this method returns all cookies. If URLs are specified, only cookies that affect those URLs
    * are returned.

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

@@ -486,6 +486,11 @@ class LaunchPersistentContextOptions {
      * An object containing additional HTTP headers to be sent with every request. Defaults to none.
      */
     public Map<String, String> extraHTTPHeaders;
+    /**
+     * Firefox user preferences. Learn more about the Firefox user preferences at <a
+     * href="https://support.mozilla.org/en-US/kb/about-config-editor-firefox">{@code about:config}</a>.
+     */
+    public Map<String, Object> firefoxUserPrefs;
     /**
      * Emulates {@code "forced-colors"} media feature, supported values are {@code "active"}, {@code "none"}. See {@link
      * Page#emulateMedia Page.emulateMedia()} for more details. Passing {@code null} resets emulation to system defaults.
@@ -786,6 +791,14 @@ public LaunchPersistentContextOptions setExtraHTTPHeaders(Map<String, String> ex
       this.extraHTTPHeaders = extraHTTPHeaders;
       return this;
     }
+    /**
+     * Firefox user preferences. Learn more about the Firefox user preferences at <a
+     * href="https://support.mozilla.org/en-US/kb/about-config-editor-firefox">{@code about:config}</a>.
+     */
+    public LaunchPersistentContextOptions setFirefoxUserPrefs(Map<String, Object> firefoxUserPrefs) {
+      this.firefoxUserPrefs = firefoxUserPrefs;
+      return this;
+    }
     /**
      * Emulates {@code "forced-colors"} media feature, supported values are {@code "active"}, {@code "none"}. See {@link
      * Page#emulateMedia Page.emulateMedia()} for more details. Passing {@code null} resets emulation to system defaults.

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

@@ -650,12 +650,23 @@ public ClickOptions setTrial(boolean trial) {
     }
   }
   class CloseOptions {
+    /**
+     * The reason to be reported to the operations interrupted by the page closure.
+     */
+    public String reason;
     /**
      * Defaults to {@code false}. Whether to run the <a
      * href="https://developer.mozilla.org/en-US/docs/Web/Events/beforeunload">before unload</a> page handlers.
      */
     public Boolean runBeforeUnload;
 
+    /**
+     * The reason to be reported to the operations interrupted by the page closure.
+     */
+    public CloseOptions setReason(String reason) {
+      this.reason = reason;
+      return this;
+    }
     /**
      * Defaults to {@code false}. Whether to run the <a
      * href="https://developer.mozilla.org/en-US/docs/Web/Events/beforeunload">before unload</a> page handlers.

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

@@ -1,8 +1,7 @@
 package com.microsoft.playwright.impl;
 
-import com.google.gson.JsonArray;
-import com.google.gson.JsonElement;
-import com.google.gson.JsonObject;
+import com.google.gson.*;
+import com.google.gson.stream.JsonReader;
 import com.microsoft.playwright.APIRequestContext;
 import com.microsoft.playwright.APIResponse;
 import com.microsoft.playwright.PlaywrightException;
@@ -11,6 +10,7 @@
 import com.microsoft.playwright.options.RequestOptions;
 
 import java.io.File;
+import java.io.StringReader;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Path;
 import java.util.Base64;
@@ -85,11 +85,14 @@ private APIResponse fetchImpl(String url, RequestOptionsImpl options) {
       byte[] bytes = null;
       if (options.data instanceof byte[]) {
         bytes = (byte[]) options.data;
-      } else if (options.data instanceof String && !isJsonContentType(options.headers)) {
-        bytes = ((String) options.data).getBytes(StandardCharsets.UTF_8);
+      } else if (options.data instanceof String) {
+        String stringData = (String) options.data;
+        if (!isJsonContentType(options.headers) || isJsonParsable(stringData)) {
+          bytes = (stringData).getBytes(StandardCharsets.UTF_8);
+        }
       }
       if (bytes == null) {
-        params.add("jsonData", gson().toJsonTree(options.data));
+        params.addProperty("jsonData", gson().toJson(options.data));
       } else {
         String base64 = Base64.getEncoder().encodeToString(bytes);
         params.addProperty("postData", base64);
@@ -202,4 +205,21 @@ private static RequestOptionsImpl ensureOptions(RequestOptions options, String m
     }
     return impl;
   }
+
+  private static boolean isJsonParsable(String value) {
+    try {
+      JsonElement result = JsonParser.parseString(value);
+      if (result != null && result.isJsonPrimitive()) {
+        JsonPrimitive primitive = result.getAsJsonPrimitive();
+        if (primitive.isString() && value.equals(primitive.getAsString())) {
+          // Gson parses unquoted strings too, but we don't want to treat them
+          // as valid JSON.
+          return false;
+        }
+      }
+      return true;
+    } catch (JsonSyntaxException error) {
+      return false;
+    }
+  }
 }

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

@@ -34,9 +34,6 @@ public ArtifactImpl(ChannelOwner parent, String type, String guid, JsonObject in
 
   public InputStream createReadStream() {
     JsonObject result = sendMessage("stream").getAsJsonObject();
-    if (!result.has("stream")) {
-      return null;
-    }
     Stream stream = connection.getExistingObject(result.getAsJsonObject("stream").get("guid").getAsString());
     return stream.stream();
   }

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

@@ -51,6 +51,8 @@ class BrowserContextImpl extends ChannelOwner implements BrowserContext {
   private final WaitableEvent<EventType, ?> closePromise;
   final Map<String, BindingCallback> bindings = new HashMap<>();
   PageImpl ownerPage;
+  private String closeReason;
+
   private static final Map<EventType, String> eventSubscriptions() {
     Map<EventType, String> result = new HashMap<>();
     result.put(EventType.CONSOLE, "console");
@@ -115,6 +117,16 @@ void setBaseUrl(String spec) {
     }
   }
 
+  String effectiveCloseReason() {
+    if (closeReason != null) {
+      return closeReason;
+    }
+    if (browser != null) {
+      return browser.closeReason;
+    }
+    return null;
+  }
+
   @Override
   public void onClose(Consumer<BrowserContext> handler) {
     listeners.add(EventType.CLOSE, handler);
@@ -242,18 +254,22 @@ public CDPSession newCDPSession(Frame frame) {
   }
 
   @Override
-  public void close() {
-    withLogging("BrowserContext.close", () -> closeImpl());
+  public void close(CloseOptions options) {
+    withLogging("BrowserContext.close", () -> closeImpl(options));
   }
 
   @Override
   public List<Cookie> cookies(String url) {
     return cookies(url == null ? new ArrayList<>() : Collections.singletonList(url));
   }
 
-  private void closeImpl() {
+  private void closeImpl(CloseOptions options) {
     if (!closeWasCalled) {
       closeWasCalled = true;
+      if (options == null) {
+        options = new CloseOptions();
+      }
+      closeReason = options.reason;
       for (Map.Entry<String, HarRecorder> entry : harRecorders.entrySet()) {
         JsonObject params = new JsonObject();
         params.addProperty("harId", entry.getKey());
@@ -275,7 +291,8 @@ private void closeImpl() {
         }
         artifact.delete();
       }
-      sendMessage("close");
+      JsonObject params = gson().toJsonTree(options).getAsJsonObject();
+      sendMessage("close", params);
     }
     runUntil(() -> {}, closePromise);
   }
@@ -594,7 +611,7 @@ private class WaitableContextClose<R> extends WaitableEvent<EventType, R> {
 
     @Override
     public R get() {
-      throw new PlaywrightException("Context closed");
+      throw new TargetClosedError(effectiveCloseReason());
     }
   }
 
@@ -752,9 +769,10 @@ void didClose() {
     listeners.notify(EventType.CLOSE, this);
   }
 
-  WritableStream createTempFile(String name) {
+  WritableStream createTempFile(String name, long lastModifiedMs) {
     JsonObject params = new JsonObject();
     params.addProperty("name", name);
+    params.addProperty("lastModifiedMs", lastModifiedMs);
     JsonObject json = sendMessage("createTempFile", params).getAsJsonObject();
     return connection.getExistingObject(json.getAsJsonObject("writableStream").get("guid").getAsString());
   }

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

@@ -42,6 +42,7 @@ class BrowserImpl extends ChannelOwner implements Browser {
   BrowserTypeImpl browserType;
   BrowserType.LaunchOptions launchOptions;
   private Path tracePath;
+  String closeReason;
 
   enum EventType {
     DISCONNECTED,
@@ -67,11 +68,15 @@ public BrowserType browserType() {
   }
 
   @Override
-  public void close() {
-    withLogging("Browser.close", () -> closeImpl());
+  public void close(CloseOptions options) {
+    withLogging("Browser.close", () -> closeImpl(options));
   }
 
-  private void closeImpl() {
+  private void closeImpl(CloseOptions options) {
+    if (options == null) {
+      options = new CloseOptions();
+    }
+    closeReason = options.reason;
     if (isConnectedOverWebSocket) {
       try {
         connection.close();