feat: route.fallback with overrides (#958)

Author: yury-s

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

@@ -485,7 +485,7 @@ void handleRoute(RouteImpl route) {
       maybeDisableNetworkInterception();
     }
     if (handled != Router.HandleResult.Handled){
-      route.resume(null);
+      route.resume();
     }
   }
 

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

@@ -23,7 +23,6 @@
 import com.microsoft.playwright.options.*;
 
 import java.io.IOException;
-import java.io.OutputStream;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
@@ -1048,6 +1047,13 @@ protected void handleEvent(String event, JsonObject params) {
       if (add != null) {
         WaitUntilState state = loadStateFromProtocol(add.getAsString());
         loadStates.add(state);
+        if (parentFrame == null && page != null) {
+          if (state == LOAD) {
+            page.listeners.notify(PageImpl.EventType.LOAD, page);
+          } else if (state == DOMCONTENTLOADED) {
+            page.listeners.notify(PageImpl.EventType.DOMCONTENTLOADED, page);
+          }
+        }
         internalListeners.notify(InternalEventType.LOADSTATE, state);
       }
       JsonElement remove = params.get("remove");

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

@@ -175,10 +175,6 @@ protected void handleEvent(String event, JsonObject params) {
           }
         }
       }
-    } else if ("load".equals(event)) {
-      listeners.notify(EventType.LOAD, this);
-    } else if ("domcontentloaded".equals(event)) {
-      listeners.notify(EventType.DOMCONTENTLOADED, this);
     } else if ("frameAttached".equals(event)) {
       String guid = params.getAsJsonObject("frame").get("guid").getAsString();
       FrameImpl frame = connection.getExistingObject(guid);

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

@@ -42,6 +42,14 @@ public class RequestImpl extends ChannelOwner implements Request {
   String failure;
   Timing timing;
   boolean didFailOrFinish;
+  private FallbackOverrides fallbackOverrides;
+
+  static class FallbackOverrides {
+    String url;
+    String method;
+    byte[] postData;
+    Map<String, String> headers;
+  }
 
   RequestImpl(ChannelOwner parent, String type, String guid, JsonObject initializer) {
     super(parent, type, guid, initializer);
@@ -75,6 +83,9 @@ public FrameImpl frame() {
 
   @Override
   public Map<String, String> headers() {
+    if (fallbackOverrides != null && fallbackOverrides.headers != null) {
+      return new RawHeaders(Utils.toHeadersList(fallbackOverrides.headers)).headers();
+    }
     return headers.headers();
   }
 
@@ -95,19 +106,26 @@ public boolean isNavigationRequest() {
 
   @Override
   public String method() {
+    if (fallbackOverrides != null && fallbackOverrides.method != null) {
+      return fallbackOverrides.method;
+    }
     return initializer.get("method").getAsString();
   }
 
   @Override
   public String postData() {
-    if (postData == null) {
+    byte[] buffer = postDataBuffer();
+    if (buffer == null) {
       return null;
     }
-    return new String(postData, StandardCharsets.UTF_8);
+    return new String(buffer, StandardCharsets.UTF_8);
   }
 
   @Override
   public byte[] postDataBuffer() {
+    if (fallbackOverrides != null && fallbackOverrides.postData != null) {
+      return fallbackOverrides.postData;
+    }
     return postData;
   }
 
@@ -156,6 +174,13 @@ public Timing timing() {
 
   @Override
   public String url() {
+    if (fallbackOverrides != null && fallbackOverrides.url != null) {
+      return fallbackOverrides.url;
+    }
+    return originalUrl();
+  }
+
+  String originalUrl() {
     return initializer.get("url").getAsString();
   }
 
@@ -164,6 +189,9 @@ Request finalRequest() {
   }
 
   private RawHeaders getRawHeaders() {
+    if (fallbackOverrides != null && fallbackOverrides.headers != null) {
+      return new RawHeaders(Utils.toHeadersList(fallbackOverrides.headers));
+    }
     if (rawHeaders != null) {
       return rawHeaders;
     }
@@ -176,4 +204,26 @@ private RawHeaders getRawHeaders() {
     rawHeaders = new RawHeaders(asList(gson().fromJson(rawHeadersJson, HttpHeader[].class)));
     return rawHeaders;
   }
+
+  void applyFallbackOverrides(FallbackOverrides overrides) {
+    if (fallbackOverrides == null) {
+      fallbackOverrides = new FallbackOverrides();
+    }
+    if (overrides.url != null) {
+      fallbackOverrides.url = overrides.url;
+    }
+    if (overrides.method != null) {
+      fallbackOverrides.method = overrides.method;
+    }
+    if (overrides.headers != null) {
+      fallbackOverrides.headers = overrides.headers;
+    }
+    if (overrides.postData != null) {
+      fallbackOverrides.postData = overrides.postData;
+    }
+  }
+
+  FallbackOverrides fallbackOverridesForResume() {
+    return fallbackOverrides;
+  }
 }

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

@@ -17,6 +17,7 @@
 package com.microsoft.playwright.impl;
 
 import com.google.gson.JsonObject;
+import com.microsoft.playwright.Frame;
 import com.microsoft.playwright.PlaywrightException;
 import com.microsoft.playwright.Route;
 
@@ -27,9 +28,10 @@
 import java.util.LinkedHashMap;
 import java.util.Map;
 
+import static com.microsoft.playwright.impl.Utils.convertType;
+
 public class RouteImpl extends ChannelOwner implements Route {
   private boolean handled;
-  private boolean lastHandlerGaveUp;
 
   public RouteImpl(ChannelOwner parent, String type, String guid, JsonObject initializer) {
     super(parent, type, guid, initializer);
@@ -45,55 +47,69 @@ public void abort(String errorCode) {
     });
   }
 
-  boolean takeLastHandlerGaveUp() {
-    boolean result = lastHandlerGaveUp;
-    lastHandlerGaveUp = false;
-    return result;
+  boolean isHandled() {
+    return handled;
   }
 
   @Override
   public void resume(ResumeOptions options) {
     startHandling();
-    withLogging("Route.resume", () -> resumeImpl(options));
+    applyOverrides(convertType(options, FallbackOptions.class));
+    withLogging("Route.resume", () -> resumeImpl(request().fallbackOverridesForResume()));
   }
 
   @Override
   public void fallback(FallbackOptions options) {
-    if (lastHandlerGaveUp) {
+    if (handled) {
       throw new PlaywrightException("Route is already handled!");
     }
-    lastHandlerGaveUp = true;
+    applyOverrides(options);
   }
 
-  private void resumeImpl(ResumeOptions options) {
+  private void applyOverrides(FallbackOptions options) {
     if (options == null) {
-      options = new ResumeOptions();
-    }
-    JsonObject params = new JsonObject();
-    if (options.url != null) {
-      params.addProperty("url", options.url);
-    }
-    if (options.method != null) {
-      params.addProperty("method", options.method);
-    }
-    if (options.headers != null) {
-      params.add("headers", Serialization.toProtocol(options.headers));
+      return;
     }
+    RequestImpl.FallbackOverrides overrides = new RequestImpl.FallbackOverrides();
+    overrides.url = options.url;
+    overrides.method = options.method;
+    overrides.headers = options.headers;
     if (options.postData != null) {
-      byte[] bytes = null;
-      if (options.postData instanceof byte[]) {
-        bytes = (byte[]) options.postData;
-      } else if (options.postData instanceof String) {
-        bytes = ((String) options.postData).getBytes(StandardCharsets.UTF_8);
-      } else {
-        throw new PlaywrightException("postData must be either String or byte[], found: " + options.postData.getClass().getName());
+      overrides.postData = getPostDataBytes(options.postData);
+    }
+    request().applyFallbackOverrides(overrides);
+  }
+
+  private void resumeImpl(RequestImpl.FallbackOverrides options) {
+    JsonObject params = new JsonObject();
+    if (options != null) {
+      if (options.url != null) {
+        params.addProperty("url", options.url);
+      }
+      if (options.method != null) {
+        params.addProperty("method", options.method);
+      }
+      if (options.headers != null) {
+        params.add("headers", Serialization.toProtocol(options.headers));
+      }
+      if (options.postData != null) {
+        String base64 = Base64.getEncoder().encodeToString(options.postData);
+        params.addProperty("postData", base64);
       }
-      String base64 = Base64.getEncoder().encodeToString(bytes);
-      params.addProperty("postData", base64);
     }
     sendMessageAsync("continue", params);
   }
 
+  private static byte[] getPostDataBytes(Object postData) {
+    if (postData instanceof byte[]) {
+      return (byte[]) postData;
+    }
+    if (postData instanceof String) {
+      return ((String) postData).getBytes(StandardCharsets.UTF_8);
+    }
+    throw new PlaywrightException("postData must be either String or byte[], found: " + postData.getClass().getName());
+  }
+
   @Override
   public void fulfill(FulfillOptions options) {
     startHandling();

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

@@ -38,11 +38,11 @@ private static class RouteInfo {
       this.times = times;
     }
 
-    boolean handle(Route route) {
+    boolean handle(RouteImpl route) {
       if (times != null && times <= 0) {
         return false;
       }
-      if (!matcher.test(route.request().url())) {
+      if (!matcher.test(route.request().originalUrl())) {
         return false;
       }
       if (times != null) {
@@ -80,11 +80,10 @@ HandleResult handle(RouteImpl route) {
         if (info.isDone()) {
           it.remove();
         }
-        if (route.takeLastHandlerGaveUp()) {
-          result = HandleResult.MatchedHandlerButNotHandled;
-          continue;
+        if (route.isHandled()) {
+          return HandleResult.Handled;
         }
-        return HandleResult.Handled;
+        result = HandleResult.MatchedHandlerButNotHandled;
       }
     }
     return result;

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

@@ -277,6 +277,17 @@ static Map<String, String> toHeadersMap(List<HttpHeader> headers) {
     return map;
   }
 
+  static List<HttpHeader> toHeadersList(Map<String, String> headers) {
+    List<HttpHeader> list = new ArrayList<>();
+    for (Map.Entry<String, String> entry: headers.entrySet()) {
+      HttpHeader header = new HttpHeader();
+      header.name = entry.getKey();
+      header.value = entry.getValue();
+      list.add(header);
+    }
+    return list;
+  }
+
   static String toJsRegexFlags(Pattern pattern) {
     String regexFlags = "";
     if ((pattern.flags() & Pattern.CASE_INSENSITIVE) != 0) {

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

@@ -0,0 +1,66 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.microsoft.playwright;
+
+import com.microsoft.playwright.options.LoadState;
+import org.junit.jupiter.api.Test;
+
+import java.io.OutputStreamWriter;
+import java.util.ArrayList;
+import java.util.List;
+
+import static java.util.Arrays.asList;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+public class TestPageAutowaitingBasic extends TestBase {
+  @Test
+  void shouldWorkWithNoWaitAfterTrue() {
+    server.setRoute("/empty.html", exchange -> {});
+    page.setContent("<a id='anchor' href='${server.EMPTY_PAGE}'>empty.html</a>");
+    page.click("a", new Page.ClickOptions().setNoWaitAfter(true));
+  }
+
+  @Test
+  void shouldWorkWithDblclickNoWaitAfterTrue() {
+    server.setRoute("/empty.html", exchange -> {});
+    page.setContent("<a id='anchor' href='${server.EMPTY_PAGE}'>empty.html</a>");
+    page.dblclick("a", new Page.DblclickOptions().setNoWaitAfter(true));
+  }
+
+  @Test
+  void shouldWorkWithWaitForLoadStateLoad() {
+    List<String> messages = new ArrayList<>();
+    server.setRoute("/empty.html", exchange -> {
+      messages.add("route");
+      exchange.getResponseHeaders().add("content-type", "text/html");
+      exchange.sendResponseHeaders(200, 0);
+      try (OutputStreamWriter writer = new OutputStreamWriter(exchange.getResponseBody())) {
+        writer.write("<link rel='stylesheet' href='./one-style.css'>");
+      } catch (RuntimeException e) {
+        e.printStackTrace();
+        throw e;
+      }
+    });
+    page.setContent("<a id='anchor' href='" + server.EMPTY_PAGE + "'>empty.html</a>");
+
+    page.onLoad(p -> messages.add("clickload"));
+    page.click("a");
+    page.waitForLoadState(LoadState.LOAD);
+    messages.add("load");
+    assertEquals(asList("route", "clickload", "load"), messages);
+  }
+}