fix: time out on the client when the driver stops responding

Fixes: #1990
Fixes: #1810

Author: yury-s

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

@@ -357,15 +357,20 @@ public CDPSession newCDPSession(Page page) {
     JsonObject params = new JsonObject();
     params.add("page", ((PageImpl) page).toProtocolRef());
     JsonObject result = sendMessage("newCDPSession", params, NO_TIMEOUT).getAsJsonObject();
-    return connection.getExistingObject(result.getAsJsonObject("session").get("guid").getAsString());
+    CDPSessionImpl session = connection.getExistingObject(result.getAsJsonObject("session").get("guid").getAsString());
+    session.timeoutSettings = ((PageImpl) page).timeoutSettings;
+    return session;
   }
 
   @Override
   public CDPSession newCDPSession(Frame frame) {
     JsonObject params = new JsonObject();
     params.add("frame", ((FrameImpl) frame).toProtocolRef());
     JsonObject result = sendMessage("newCDPSession", params, NO_TIMEOUT).getAsJsonObject();
-    return connection.getExistingObject(result.getAsJsonObject("session").get("guid").getAsString());
+    CDPSessionImpl session = connection.getExistingObject(result.getAsJsonObject("session").get("guid").getAsString());
+    PageImpl page = ((FrameImpl) frame).page();
+    session.timeoutSettings = page != null ? page.timeoutSettings : timeoutSettings;
+    return session;
   }
 
   @Override

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

@@ -26,6 +26,8 @@
 public class CDPSessionImpl extends ChannelOwner implements CDPSession {
   private final ListenerCollection<String> listeners = new ListenerCollection<>(new HashMap<>(), this);
   private final ListenerCollection<EventType> typedListeners = new ListenerCollection<>(new HashMap<>(), this);
+  // Set for page and frame sessions, browser sessions have no timeout.
+  TimeoutSettings timeoutSettings;
 
   enum EventType {
     CLOSE,
@@ -71,7 +73,7 @@ public JsonObject send(String method, JsonObject params) {
       args.add("params", params);
     }
     args.addProperty("method", method);
-    JsonElement response = connection.sendMessage(guid, "send", args);
+    JsonElement response = sendMessage("send", args, timeoutSettings == null ? NO_TIMEOUT : timeoutSettings.timeout(null));
     if (response == null) return null;
     else return response.getAsJsonObject().get("result").getAsJsonObject();
   }

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

@@ -29,6 +29,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.concurrent.ThreadLocalRandom;
+import java.util.concurrent.TimeUnit;
 
 import static com.microsoft.playwright.impl.Serialization.gson;
 import static java.lang.System.currentTimeMillis;
@@ -69,6 +70,9 @@ public class Connection {
   private final Map<String, WaitableResult<JsonElement>> callbacks = new HashMap<>();
   private String title;
   private boolean titleReported = false;
+  // How long past a call's timeout to wait for the driver's reply. The driver may spend up to 3s
+  // in tracing instrumentation both before and after the call itself.
+  private static final long DRIVER_RESPONSE_GRACE_MS = 10_000;
   private static final boolean isLogging;
   static {
     String debug = System.getenv("DEBUG");
@@ -145,7 +149,20 @@ public JsonElement sendMessage(String guid, String method, JsonObject params) {
   }
 
   public JsonElement sendMessage(String guid, String method, JsonObject params, Double timeout) {
-    return root.runUntil(() -> {}, internalSendMessage(guid, method, params, timeout, true, true));
+    WaitableResult<JsonElement> result = internalSendMessage(guid, method, params, timeout, true, true);
+    if (timeout == null || timeout == 0) {
+      return root.runUntil(() -> {}, result);
+    }
+    // The timeout is enforced by the driver, but if the driver or the browser hangs no reply ever
+    // comes. Give up once the driver is well past the timeout and has stopped sending messages.
+    long deadline = System.nanoTime() + TimeUnit.MILLISECONDS.toNanos(timeout.longValue() + DRIVER_RESPONSE_GRACE_MS);
+    while (!result.isDone()) {
+      if (!processOneMessage() && System.nanoTime() - deadline > 0) {
+        result.completeExceptionally(new TimeoutError("Timeout " + timeout.longValue() + "ms exceeded while waiting for the driver to respond to " +
+          method + ". The driver or the browser process is not responding."));
+      }
+    }
+    return result.get();
   }
 
   public WaitableResult<JsonElement> sendMessageAsync(String guid, String method, JsonObject params) {
@@ -232,14 +249,16 @@ void unregisterObject(String guid) {
     objects.remove(guid);
   }
 
-  void processOneMessage() {
+  // Returns false if no message arrived within the poll interval.
+  boolean processOneMessage() {
     JsonObject message = transport.poll(Duration.ofMillis(10));
     if (message == null) {
-      return;
+      return false;
     }
     Gson gson = gson();
     Message messageObj = gson.fromJson(message, Message.class);
     dispatch(messageObj);
+    return true;
   }
 
   private static String formatCallLog(JsonArray log) {

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

@@ -44,6 +44,29 @@ void shouldWork() {
     assertEquals("bar", foo);
   }
 
+  @Test
+  void shouldRespectDefaultTimeout() {
+    page.context().setDefaultTimeout(500);
+    CDPSession cdpSession = page.context().newCDPSession(page);
+    JsonObject params = new JsonObject();
+    params.addProperty("expression", "new Promise(() => {})");
+    params.addProperty("awaitPromise", true);
+    TimeoutError e = assertThrows(TimeoutError.class, () -> cdpSession.send("Runtime.evaluate", params));
+    assertTrue(e.getMessage().contains("Timeout 500ms exceeded"), e.getMessage());
+  }
+
+  @Test
+  void shouldNotTimeOutWhenDefaultTimeoutIsZero() {
+    page.setDefaultTimeout(0);
+    CDPSession cdpSession = page.context().newCDPSession(page);
+    JsonObject params = new JsonObject();
+    params.addProperty("expression", "new Promise(f => setTimeout(() => f(42), 100))");
+    params.addProperty("awaitPromise", true);
+    params.addProperty("returnByValue", true);
+    JsonObject result = cdpSession.send("Runtime.evaluate", params);
+    assertEquals(42, result.getAsJsonObject("result").get("value").getAsInt());
+  }
+
   @Test
   void shouldSendEvents() {
     CDPSession cdpSession = page.context().newCDPSession(page);

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

@@ -0,0 +1,70 @@
+/*
+ * 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 org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.condition.DisabledOnOs;
+import org.junit.jupiter.api.condition.OS;
+
+import java.lang.reflect.Field;
+
+import static org.junit.jupiter.api.Assertions.*;
+import static org.junit.jupiter.api.Assumptions.assumeTrue;
+
+public class TestUnresponsiveDriver {
+  @Test
+  @DisabledOnOs(OS.WINDOWS)
+  void shouldThrowTimeoutErrorWhenDriverStopsResponding() throws Exception {
+    try (Playwright playwright = Playwright.create()) {
+      Browser browser = Utils.getBrowserTypeFromEnv(playwright).launch(TestBase.createLaunchOptions());
+      Page page = browser.newPage();
+      long pid = driverPid(playwright);
+      signal("STOP", pid);
+      try {
+        long start = System.nanoTime();
+        TimeoutError e = assertThrows(TimeoutError.class,
+          () -> page.waitForFunction("() => false", null, new Page.WaitForFunctionOptions().setTimeout(100)));
+        long elapsedMs = (System.nanoTime() - start) / 1_000_000;
+        assertTrue(e.getMessage().contains("Timeout 100ms exceeded while waiting for the driver to respond to waitForFunction"), e.getMessage());
+        assertTrue(elapsedMs < 20_000, "elapsed: " + elapsedMs);
+      } finally {
+        signal("CONT", pid);
+      }
+      // The driver's late reply to the abandoned call must not break the connection.
+      assertEquals(2, page.evaluate("1 + 1"));
+    }
+  }
+
+  private static long driverPid(Playwright playwright) throws Exception {
+    Field field = playwright.getClass().getDeclaredField("driverProcess");
+    field.setAccessible(true);
+    Process process = (Process) field.get(playwright);
+    long pid = -1;
+    try {
+      // Process.pid() is only available since Java 9.
+      pid = (long) Process.class.getMethod("pid").invoke(process);
+    } catch (NoSuchMethodException e) {
+      assumeTrue(false, "Process.pid() is not available");
+    }
+    return pid;
+  }
+
+  private static void signal(String signal, long pid) throws Exception {
+    Process kill = new ProcessBuilder("kill", "-" + signal, Long.toString(pid)).inheritIO().start();
+    assertEquals(0, kill.waitFor());
+  }
+}