cherry-pick(#982): feat: roll driver to 1.23.1-beta, implement routeF…

…romHar.update (#983)

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

@@ -184,6 +184,10 @@ class RouteFromHAROptions {
      * <p> Defaults to abort.
      */
     public HarNotFound notFound;
+    /**
+     * If specified, updates the given HAR with the actual network information instead of serving from file.
+     */
+    public Boolean update;
     /**
      * A glob pattern, regular expression or predicate to match the request URL. Only requests with URL matching the pattern
      * will be surved from the HAR file. If not specified, all requests are served from the HAR file.
@@ -203,26 +207,25 @@ public RouteFromHAROptions setNotFound(HarNotFound notFound) {
       return this;
     }
     /**
-     * A glob pattern, regular expression or predicate to match the request URL. Only requests with URL matching the pattern
-     * will be surved from the HAR file. If not specified, all requests are served from the HAR file.
+     * If specified, updates the given HAR with the actual network information instead of serving from file.
      */
-    public RouteFromHAROptions setUrl(String url) {
-      this.url = url;
+    public RouteFromHAROptions setUpdate(boolean update) {
+      this.update = update;
       return this;
     }
     /**
      * A glob pattern, regular expression or predicate to match the request URL. Only requests with URL matching the pattern
      * will be surved from the HAR file. If not specified, all requests are served from the HAR file.
      */
-    public RouteFromHAROptions setUrl(Pattern url) {
+    public RouteFromHAROptions setUrl(String url) {
       this.url = url;
       return this;
     }
     /**
      * A glob pattern, regular expression or predicate to match the request URL. Only requests with URL matching the pattern
      * will be surved from the HAR file. If not specified, all requests are served from the HAR file.
      */
-    public RouteFromHAROptions setUrl(Predicate<String> url) {
+    public RouteFromHAROptions setUrl(Pattern url) {
       this.url = url;
       return this;
     }

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

@@ -2007,6 +2007,10 @@ class RouteFromHAROptions {
      * <p> Defaults to abort.
      */
     public HarNotFound notFound;
+    /**
+     * If specified, updates the given HAR with the actual network information instead of serving from file.
+     */
+    public Boolean update;
     /**
      * A glob pattern, regular expression or predicate to match the request URL. Only requests with URL matching the pattern
      * will be surved from the HAR file. If not specified, all requests are served from the HAR file.
@@ -2026,26 +2030,25 @@ public RouteFromHAROptions setNotFound(HarNotFound notFound) {
       return this;
     }
     /**
-     * A glob pattern, regular expression or predicate to match the request URL. Only requests with URL matching the pattern
-     * will be surved from the HAR file. If not specified, all requests are served from the HAR file.
+     * If specified, updates the given HAR with the actual network information instead of serving from file.
      */
-    public RouteFromHAROptions setUrl(String url) {
-      this.url = url;
+    public RouteFromHAROptions setUpdate(boolean update) {
+      this.update = update;
       return this;
     }
     /**
      * A glob pattern, regular expression or predicate to match the request URL. Only requests with URL matching the pattern
      * will be surved from the HAR file. If not specified, all requests are served from the HAR file.
      */
-    public RouteFromHAROptions setUrl(Pattern url) {
+    public RouteFromHAROptions setUrl(String url) {
       this.url = url;
       return this;
     }
     /**
      * A glob pattern, regular expression or predicate to match the request URL. Only requests with URL matching the pattern
      * will be surved from the HAR file. If not specified, all requests are served from the HAR file.
      */
-    public RouteFromHAROptions setUrl(Predicate<String> url) {
+    public RouteFromHAROptions setUrl(Pattern url) {
       this.url = url;
       return this;
     }

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

@@ -27,13 +27,16 @@
 import java.net.URL;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.util.*;
 import java.util.function.Consumer;
 import java.util.function.Predicate;
 import java.util.regex.Pattern;
 
+import static com.microsoft.playwright.impl.Serialization.addHarUrlFilter;
 import static com.microsoft.playwright.impl.Serialization.gson;
 import static com.microsoft.playwright.impl.Utils.isSafeCloseError;
+import static com.microsoft.playwright.impl.Utils.toJsRegexFlags;
 import static java.nio.charset.StandardCharsets.UTF_8;
 import static java.nio.file.Files.readAllBytes;
 import static java.util.Arrays.asList;
@@ -51,7 +54,17 @@ class BrowserContextImpl extends ChannelOwner implements BrowserContext {
   final TimeoutSettings timeoutSettings = new TimeoutSettings();
   Path videosDir;
   URL baseUrl;
-  Path recordHarPath;
+  final Map<String, HarRecorder> harRecorders = new HashMap<>();
+
+  static class HarRecorder {
+    final Path path;
+    final HarContentPolicy contentPolicy;
+
+    HarRecorder(Path har, HarContentPolicy policy) {
+      path = har;
+      contentPolicy = policy;
+    }
+  }
 
   enum EventType {
     CLOSE,
@@ -74,6 +87,12 @@ enum EventType {
     this.request = connection.getExistingObject(initializer.getAsJsonObject("APIRequestContext").get("guid").getAsString());
   }
 
+  void setRecordHar(Path path, HarContentPolicy policy) {
+    if (path != null) {
+      harRecorders.put("", new HarRecorder(path, policy));
+    }
+  }
+
   void setBaseUrl(String spec) {
     try {
       this.baseUrl = new URL(spec);
@@ -178,15 +197,31 @@ private void closeImpl() {
     }
     isClosedOrClosing = true;
     try {
-      if (recordHarPath != null)  {
-        JsonObject json = sendMessage("harExport").getAsJsonObject();
+      for (Map.Entry<String, HarRecorder> entry : harRecorders.entrySet()) {
+        JsonObject params = new JsonObject();
+        params.addProperty("harId", entry.getKey());
+        JsonObject json = sendMessage("harExport", params).getAsJsonObject();
         ArtifactImpl artifact = connection.getExistingObject(json.getAsJsonObject("artifact").get("guid").getAsString());
         // In case of CDP connection browser is null but since the connection is established by
         // the driver it is safe to consider the artifact local.
         if (browser() != null && browser().isRemote) {
           artifact.isRemote = true;
         }
-        artifact.saveAs(recordHarPath);
+
+        // Server side will compress artifact if content is attach or if file is .zip.
+        HarRecorder harParams = entry.getValue();
+        boolean isCompressed = harParams.contentPolicy == HarContentPolicy.ATTACH || harParams.path.toString().endsWith(".zip");
+        boolean needCompressed = harParams.path.toString().endsWith(".zip");
+        if (isCompressed && !needCompressed) {
+          String tmpPath = harParams.path + ".tmp";
+          artifact.saveAs(Paths.get(tmpPath));
+          JsonObject unzipParams = new JsonObject();
+          unzipParams.addProperty("zipFile", tmpPath);
+          unzipParams.addProperty("harFile", harParams.path.toString());
+          connection.localUtils.sendMessage("harUnzip", unzipParams);
+        } else {
+          artifact.saveAs(harParams.path);
+        }
         artifact.delete();
       }
 
@@ -351,6 +386,10 @@ public void routeFromHAR(Path har, RouteFromHAROptions options) {
     if (options == null) {
       options = new RouteFromHAROptions();
     }
+    if (options.update != null && options.update) {
+      recordIntoHar(null, har, options);
+      return;
+    }
     UrlMatcher matcher = UrlMatcher.forOneOf(baseUrl, options.url);
     HARRouter harRouter = new HARRouter(connection.localUtils, har, options.notFound);
     onClose(context -> harRouter.dispose());
@@ -368,6 +407,22 @@ private void route(UrlMatcher matcher, Consumer<Route> handler, RouteOptions opt
     });
   }
 
+  void recordIntoHar(PageImpl page, Path har, RouteFromHAROptions options) {
+    JsonObject params = new JsonObject();
+    if (page != null) {
+      params.add("page", page.toProtocolRef());
+    }
+    JsonObject jsonOptions = new JsonObject();
+    jsonOptions.addProperty("path", har.toAbsolutePath().toString());
+    jsonOptions.addProperty("content", HarContentPolicy.ATTACH.name().toLowerCase());
+    jsonOptions.addProperty("mode", HarMode.MINIMAL.name().toLowerCase());
+    addHarUrlFilter(jsonOptions, options.url);
+    params.add("options", jsonOptions);
+    JsonObject json = sendMessage("harStart", params).getAsJsonObject();
+    String harId = json.get("harId").getAsString();
+    harRecorders.put(harId, new HarRecorder(har, HarContentPolicy.ATTACH));
+  }
+
   @Override
   public void setDefaultNavigationTimeout(double timeout) {
     withLogging("BrowserContext.setDefaultNavigationTimeout", () -> {

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

@@ -30,6 +30,7 @@
 import java.util.function.Consumer;
 import java.util.regex.Pattern;
 
+import static com.microsoft.playwright.impl.Serialization.addHarUrlFilter;
 import static com.microsoft.playwright.impl.Serialization.gson;
 import static com.microsoft.playwright.impl.Utils.*;
 import static com.microsoft.playwright.impl.Utils.convertType;
@@ -137,24 +138,22 @@ private BrowserContextImpl newContextImpl(NewContextOptions options) {
     }
     JsonObject recordHar = null;
     Path recordHarPath = options.recordHarPath;
+    HarContentPolicy harContentPolicy = null;
     if (options.recordHarPath != null) {
       recordHar = new JsonObject();
       recordHar.addProperty("path", options.recordHarPath.toString());
       if (options.recordHarContent != null) {
-        recordHar.addProperty("content", options.recordHarContent.toString().toLowerCase());
+        harContentPolicy = options.recordHarContent;
       } else if (options.recordHarOmitContent != null && options.recordHarOmitContent) {
-        recordHar.addProperty("content", HarContentPolicy.OMIT.toString().toLowerCase());
+        harContentPolicy = HarContentPolicy.OMIT;
       }
-      if (options.recordHarMode != null) {
-        recordHar.addProperty("mode", options.recordHarMode.toString().toLowerCase());
+      if (harContentPolicy != null) {
+        recordHar.addProperty("content", harContentPolicy.name().toLowerCase());
       }
-      if (options.recordHarUrlFilter instanceof String) {
-        recordHar.addProperty("urlGlob", (String) options.recordHarUrlFilter);
-      } else if (options.recordHarUrlFilter instanceof Pattern) {
-        Pattern pattern = (Pattern) options.recordHarUrlFilter;
-        recordHar.addProperty("urlRegexSource", pattern.pattern());
-        recordHar.addProperty("urlRegexFlags", toJsRegexFlags(pattern));
+      if (options.recordHarMode != null) {
+        recordHar.addProperty("mode", options.recordHarMode.name().toLowerCase());
       }
+      addHarUrlFilter(recordHar, options.recordHarUrlFilter);
       options.recordHarPath = null;
       options.recordHarMode = null;
       options.recordHarOmitContent = null;
@@ -210,7 +209,7 @@ private BrowserContextImpl newContextImpl(NewContextOptions options) {
     if (options.baseURL != null) {
       context.setBaseUrl(options.baseURL);
     }
-    context.recordHarPath = recordHarPath;
+    context.setRecordHar(recordHarPath, harContentPolicy);
     contexts.add(context);
     return context;
   }
@@ -231,9 +230,7 @@ private void startTracingImpl(Page page, StartTracingOptions options) {
     }
     JsonObject params = gson().toJsonTree(options).getAsJsonObject();
     if (page != null) {
-      JsonObject jsonPage = new JsonObject();
-      jsonPage.addProperty("guid", ((PageImpl) page).guid);
-      params.add("page", jsonPage);
+      params.add("page", ((PageImpl) page).toProtocolRef());
     }
     sendMessage("startTracing", params);
   }

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

@@ -22,12 +22,15 @@
 import com.microsoft.playwright.Browser;
 import com.microsoft.playwright.BrowserType;
 import com.microsoft.playwright.PlaywrightException;
+import com.microsoft.playwright.options.HarContentPolicy;
 
 import java.io.IOException;
 import java.nio.file.Path;
 import java.util.function.Consumer;
 
+import static com.microsoft.playwright.impl.Serialization.addHarUrlFilter;
 import static com.microsoft.playwright.impl.Serialization.gson;
+import static com.microsoft.playwright.impl.Utils.convertType;
 
 class BrowserTypeImpl extends ChannelOwner implements BrowserType {
   LocalUtils localUtils;
@@ -152,20 +155,52 @@ public BrowserContextImpl launchPersistentContext(Path userDataDir, LaunchPersis
   private BrowserContextImpl launchPersistentContextImpl(Path userDataDir, LaunchPersistentContextOptions options) {
     if (options == null) {
       options = new LaunchPersistentContextOptions();
+    } else {
+      // Make a copy so that we can nullify some fields below.
+      options = convertType(options, LaunchPersistentContextOptions.class);
     }
-    JsonObject params = gson().toJsonTree(options).getAsJsonObject();
-    params.addProperty("userDataDir", userDataDir.toString());
+    JsonObject recordHar = null;
+    Path recordHarPath = options.recordHarPath;
+    HarContentPolicy harContentPolicy = null;
     if (options.recordHarPath != null) {
-      JsonObject recordHar = new JsonObject();
+      recordHar = new JsonObject();
       recordHar.addProperty("path", options.recordHarPath.toString());
+      if (options.recordHarContent != null) {
+        harContentPolicy = options.recordHarContent;
+      } else if (options.recordHarOmitContent != null && options.recordHarOmitContent) {
+        harContentPolicy = HarContentPolicy.OMIT;
+      }
+      if (harContentPolicy != null) {
+        recordHar.addProperty("content", harContentPolicy.name().toLowerCase());
+      }
+      if (options.recordHarMode != null) {
+        recordHar.addProperty("mode", options.recordHarMode.toString().toLowerCase());
+      }
+      addHarUrlFilter(recordHar, options.recordHarUrlFilter);
+      options.recordHarPath = null;
+      options.recordHarMode = null;
+      options.recordHarOmitContent = null;
+      options.recordHarContent = null;
+      options.recordHarUrlFilter = null;
+    } else {
       if (options.recordHarOmitContent != null) {
-        recordHar.addProperty("omitContent", true);
+        throw new PlaywrightException("recordHarOmitContent is set but recordHarPath is null");
+      }
+      if (options.recordHarUrlFilter != null) {
+        throw new PlaywrightException("recordHarUrlFilter is set but recordHarPath is null");
       }
-      params.remove("recordHarPath");
-      params.remove("recordHarOmitContent");
+      if (options.recordHarMode != null) {
+        throw new PlaywrightException("recordHarMode is set but recordHarPath is null");
+      }
+      if (options.recordHarContent != null) {
+        throw new PlaywrightException("recordHarContent is set but recordHarPath is null");
+      }
+    }
+
+    JsonObject params = gson().toJsonTree(options).getAsJsonObject();
+    params.addProperty("userDataDir", userDataDir.toString());
+    if (recordHar != null) {
       params.add("recordHar", recordHar);
-    } else if (options.recordHarOmitContent != null) {
-      throw new PlaywrightException("recordHarOmitContent is set but recordHarPath is null");
     }
     if (options.recordVideoDir != null) {
       JsonObject recordVideo = new JsonObject();
@@ -195,7 +230,7 @@ private BrowserContextImpl launchPersistentContextImpl(Path userDataDir, LaunchP
     if (options.baseURL != null) {
       context.setBaseUrl(options.baseURL);
     }
-    context.recordHarPath = options.recordHarPath;
+    context.setRecordHar(recordHarPath, harContentPolicy);
     return context;
   }
 

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

@@ -108,4 +108,10 @@ <T> T runUntil(Runnable code, Waitable<T> waitable) {
 
   void handleEvent(String event, JsonObject parameters) {
   }
+
+  JsonObject toProtocolRef() {
+    JsonObject json = new JsonObject();
+    json.addProperty("guid", guid);
+    return json;
+  }
 }

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

@@ -510,9 +510,7 @@ FrameExpectResult expect(String expression, FrameExpectOptions options) {
 
   JsonObject toProtocol() {
     JsonObject result = new JsonObject();
-    JsonObject frameJson = new JsonObject();
-    frameJson.addProperty("guid", frame.guid);
-    result.add("frame", frameJson);
+    result.add("frame", frame.toProtocolRef());
     result.addProperty("selector", selector);
     return result;
   }

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

@@ -974,6 +974,10 @@ public void routeFromHAR(Path har, RouteFromHAROptions options) {
     if (options == null) {
       options = new RouteFromHAROptions();
     }
+    if (options.update != null && options.update) {
+      browserContext.recordIntoHar(this, har, convertType(options, BrowserContext.RouteFromHAROptions.class));
+      return;
+    }
     UrlMatcher matcher = UrlMatcher.forOneOf(browserContext.baseUrl, options.url);
     HARRouter harRouter = new HARRouter(connection.localUtils, har, options.notFound);
     onClose(context -> harRouter.dispose());