add BiDi method "BrowsingContext.setViewport(null, null, null)" for resetting mobile emulation mode

Author: asolntsev

java/src/org/openqa/selenium/bidi/browsingcontext/BUILD.bazel

@@ -22,5 +22,6 @@ java_library(
         "//java/src/org/openqa/selenium/json",
         "//java/src/org/openqa/selenium/remote/http",
         artifact("com.google.auto.service:auto-service-annotations"),
+        "@maven//:org_jspecify_jspecify",
     ],
 )

java/src/org/openqa/selenium/bidi/browsingcontext/BrowsingContext.java

@@ -24,6 +24,8 @@
 import java.util.List;
 import java.util.Map;
 import java.util.function.Function;
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.WindowType;
 import org.openqa.selenium.bidi.BiDi;
@@ -36,6 +38,7 @@
 import org.openqa.selenium.json.TypeToken;
 import org.openqa.selenium.print.PrintOptions;
 
+@NullMarked
 public class BrowsingContext {
 
   private static final Json JSON = new Json();
@@ -91,6 +94,7 @@ public BrowsingContext(WebDriver driver, String id) {
 
   public BrowsingContext(WebDriver driver, WindowType type) {
     Require.nonNull("WebDriver", driver);
+    Require.nonNull("WindowType", type);
 
     if (!(driver instanceof HasBiDi)) {
       throw new IllegalArgumentException("WebDriver instance must support BiDi protocol");
@@ -103,6 +107,7 @@ public BrowsingContext(WebDriver driver, WindowType type) {
 
   public BrowsingContext(WebDriver driver, CreateContextParameters parameters) {
     Require.nonNull("WebDriver", driver);
+    Require.nonNull("CreateContextParameters", parameters);
 
     if (!(driver instanceof HasBiDi)) {
       throw new IllegalArgumentException("WebDriver instance must support BiDi protocol");
@@ -302,41 +307,70 @@ public String captureElementScreenshot(String elementId, String handle) {
             }));
   }
 
-  public void setViewport(double width, double height) {
-    Require.positive("Viewport width", width);
-    Require.positive("Viewport height", height);
+  public void setViewport(int width, int height) {
+    setViewport((double) width, (double) height);
+  }
 
-    this.bidi.send(
-        new Command<>(
-            "browsingContext.setViewport",
-            Map.of(CONTEXT, id, "viewport", Map.of("width", width, "height", height))));
+  public void setViewport(int width, int height, double devicePixelRatio) {
+    setViewport((double) width, (double) height, devicePixelRatio);
   }
 
-  public void setViewport(double width, double height, double devicePixelRatio) {
-    Require.positive("Viewport width", width);
-    Require.positive("Viewport height", height);
-    Require.positive("Device pixel ratio.", devicePixelRatio);
+  /**
+   * Set viewport size to given width and height (aka "mobile emulation" mode).
+   *
+   * <p>If both {@code width} and {@code height} are null, then resets viewport to the initial size
+   * (aka "desktop" mode).
+   *
+   * @param width null or positive
+   * @param height null or positive
+   */
+  public void setViewport(@Nullable Double width, @Nullable Double height) {
+    validate(width, height);
 
-    this.bidi.send(
-        new Command<>(
-            "browsingContext.setViewport",
-            Map.of(
-                CONTEXT,
-                id,
-                "viewport",
-                Map.of("width", width, "height", height),
-                "devicePixelRatio",
-                devicePixelRatio)));
+    Map<String, Object> params = new HashMap<>();
+    params.put(CONTEXT, id);
+    params.put("viewport", width == null ? null : Map.of("width", width, "height", height));
+    this.bidi.send(new Command<>("browsingContext.setViewport", params));
   }
 
-  public void resetViewport() {
+  /**
+   * Set viewport's size and pixel ratio (aka "mobile emulation" mode).
+   *
+   * <p>If both {@code width} and {@code height} are null then resets viewport to the initial size
+   * (aka "desktop" mode).
+   *
+   * <p>If {@code devicePixelRatio} is null then resets DPR to browser’s default DPR (usually 1.0 on
+   * desktop).
+   *
+   * @param width null or positive
+   * @param height null or positive
+   * @param devicePixelRatio null or positive
+   */
+  public void setViewport(
+      @Nullable Double width, @Nullable Double height, @Nullable Double devicePixelRatio) {
+    validate(width, height);
+    validate(devicePixelRatio);
+
     Map<String, Object> params = new HashMap<>();
     params.put(CONTEXT, id);
-    params.put("viewport", null);
-    params.put("devicePixelRatio", null);
+    params.put("viewport", width == null ? null : Map.of("width", width, "height", height));
+    params.put("devicePixelRatio", devicePixelRatio);
     this.bidi.send(new Command<>("browsingContext.setViewport", params));
   }
 
+  private void validate(@Nullable Double width, @Nullable Double height) {
+    if (width != null || height != null) {
+      Require.positive("Viewport width", width);
+      Require.positive("Viewport height", height);
+    }
+  }
+
+  private void validate(@Nullable Double devicePixelRatio) {
+    if (devicePixelRatio != null) {
+      Require.positive("Device pixel ratio.", devicePixelRatio);
+    }
+  }
+
   public void activate() {
     this.bidi.send(new Command<>("browsingContext.activate", Map.of(CONTEXT, id)));
   }

java/test/org/openqa/selenium/bidi/browsingcontext/BrowsingContextTest.java

@@ -24,7 +24,6 @@
 import static org.openqa.selenium.support.ui.ExpectedConditions.visibilityOfElementLocated;
 
 import java.util.List;
-import java.util.regex.Pattern;
 import org.junit.jupiter.api.Test;
 import org.openqa.selenium.By;
 import org.openqa.selenium.Dimension;
@@ -42,9 +41,6 @@
 
 class BrowsingContextTest extends JupiterTestBase {
 
-  private static final Pattern CONTEXT_NOT_FOUND =
-      Pattern.compile(".*Browsing Context with id .+ not found.*", Pattern.DOTALL);
-
   @Test
   @NeedsFreshDriver
   void canCreateABrowsingContextForGivenId() {
@@ -233,7 +229,7 @@ void canCloseAWindow() {
 
     assertThatThrownBy(window2::getTree)
         .isInstanceOf(BiDiException.class)
-        .hasMessageMatching(CONTEXT_NOT_FOUND);
+        .hasMessageContaining("not found");
   }
 
   @Test
@@ -246,7 +242,7 @@ void canCloseATab() {
 
     assertThatThrownBy(tab2::getTree)
         .isInstanceOf(BiDiException.class)
-        .hasMessageMatching(CONTEXT_NOT_FOUND);
+        .hasMessageContaining("not found");
   }
 
   @Test
@@ -478,20 +474,27 @@ void canSetViewport() {
     browsingContext.setViewport(250, 300);
     assertThat(getViewportSize()).isEqualTo(new Dimension(250, 300));
 
-    browsingContext.resetViewport();
+    browsingContext.setViewport(null, null);
     assertThat(getViewportSize()).isEqualTo(initialViewportSize);
   }
 
   @Test
   @NeedsFreshDriver
   void canSetViewportWithDevicePixelRatio() {
+    Dimension initialViewportSize = getViewportSize();
+    double initialPixelRation = getDevicePixelRatio();
+
     BrowsingContext browsingContext = new BrowsingContext(driver, driver.getWindowHandle());
     driver.get(appServer.whereIs("formPage.html"));
 
     browsingContext.setViewport(250, 300, 5.5);
 
     assertThat(getViewportSize()).isEqualTo(new Dimension(250, 300));
     assertThat(getDevicePixelRatio()).isEqualTo(5.5);
+
+    browsingContext.setViewport(null, null, null);
+    assertThat(getViewportSize()).isEqualTo(initialViewportSize);
+    assertThat(getDevicePixelRatio()).isEqualTo(initialPixelRation);
   }
 
   @Test