add BiDi method "BrowsingContext.resetViewport"

Implementation detail: according to BiDi spec (https://www.w3.org/TR/webdriver-bidi/#command-browsingContext-setViewport), we have to call method "setViewport" with "viewport" parameter equal to "null".

Author: asolntsev

java/src/org/openqa/selenium/bidi/Command.java

@@ -17,7 +17,10 @@
 
 package org.openqa.selenium.bidi;
 
+import static java.util.Collections.unmodifiableMap;
+
 import java.lang.reflect.Type;
+import java.util.HashMap;
 import java.util.Map;
 import java.util.function.Function;
 import org.openqa.selenium.internal.Require;
@@ -48,7 +51,8 @@ public Command(
       Function<JsonInput, X> mapper,
       boolean sendsResponse) {
     this.method = Require.nonNull("Method name", method);
-    this.params = Map.copyOf(Require.nonNull("Command parameters", params));
+    this.params =
+        unmodifiableMap(new HashMap<String, Object>(Require.nonNull("Command parameters", params)));
     this.mapper = Require.nonNull("Mapper for result", mapper);
     this.sendsResponse = sendsResponse;
   }

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

@@ -329,6 +329,14 @@ public void setViewport(double width, double height, double devicePixelRatio) {
                 devicePixelRatio)));
   }
 
+  public void resetViewport() {
+    Map<String, Object> params = new HashMap<>();
+    params.put(CONTEXT, id);
+    params.put("viewport", null);
+    params.put("devicePixelRatio", null);
+    this.bidi.send(new Command<>("browsingContext.setViewport", params));
+  }
+
   public void activate() {
     this.bidi.send(new Command<>("browsingContext.activate", Map.of(CONTEXT, id)));
   }

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

@@ -134,4 +134,9 @@ public static BrowsingContextInfo fromJson(JsonInput input) {
     return new BrowsingContextInfo(
         id, url, children, clientWindow, originalOpener, userContext, parentBrowsingContext);
   }
+
+  @Override
+  public String toString() {
+    return String.format("BrowsingContextInfo(%s %s)", id, url);
+  }
 }

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

@@ -17,13 +17,15 @@
 
 package org.openqa.selenium.bidi.browsingcontext;
 
-import static org.assertj.core.api.AssertionsForClassTypes.assertThat;
-import static org.assertj.core.api.AssertionsForClassTypes.assertThatExceptionOfType;
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
 import static org.openqa.selenium.support.ui.ExpectedConditions.alertIsPresent;
 import static org.openqa.selenium.support.ui.ExpectedConditions.titleIs;
 import static org.openqa.selenium.support.ui.ExpectedConditions.visibilityOfElementLocated;
 
+import java.awt.*;
 import java.util.List;
+import java.util.regex.Pattern;
 import org.junit.jupiter.api.Test;
 import org.openqa.selenium.By;
 import org.openqa.selenium.JavascriptExecutor;
@@ -40,6 +42,9 @@
 
 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() {
@@ -136,9 +141,9 @@ void canGetTreeWithAChild() {
 
     List<BrowsingContextInfo> contextInfoList = parentWindow.getTree();
 
-    assertThat(contextInfoList.size()).isEqualTo(1);
+    assertThat(contextInfoList).hasSize(1);
     BrowsingContextInfo info = contextInfoList.get(0);
-    assertThat(info.getChildren().size()).isEqualTo(1);
+    assertThat(info.getChildren()).hasSize(1);
     assertThat(info.getId()).isEqualTo(referenceContextId);
     assertThat(info.getChildren().get(0).getUrl()).contains("formPage.html");
   }
@@ -155,7 +160,7 @@ void canGetTreeWithDepth() {
 
     List<BrowsingContextInfo> contextInfoList = parentWindow.getTree(0);
 
-    assertThat(contextInfoList.size()).isEqualTo(1);
+    assertThat(contextInfoList).hasSize(1);
     BrowsingContextInfo info = contextInfoList.get(0);
     assertThat(info.getChildren()).isNull(); // since depth is 0
     assertThat(info.getId()).isEqualTo(referenceContextId);
@@ -176,7 +181,7 @@ void canGetTreeWithRootAndDepth() {
 
     List<BrowsingContextInfo> contextInfoList = parentWindow.getTree(referenceContextId, 1);
 
-    assertThat(contextInfoList.size()).isEqualTo(1);
+    assertThat(contextInfoList).hasSize(1);
     BrowsingContextInfo info = contextInfoList.get(0);
     assertThat(info.getChildren()).isNotNull(); // since depth is 1
     assertThat(info.getId()).isEqualTo(referenceContextId);
@@ -199,7 +204,7 @@ void canGetTreeWithRoot() {
 
     List<BrowsingContextInfo> contextInfoList = parentWindow.getTree(tab.getId());
 
-    assertThat(contextInfoList.size()).isEqualTo(1);
+    assertThat(contextInfoList).hasSize(1);
     BrowsingContextInfo info = contextInfoList.get(0);
     assertThat(info.getId()).isEqualTo(tab.getId());
     assertThat(info.getOriginalOpener()).isNull();
@@ -215,7 +220,7 @@ void canGetAllTopLevelContexts() {
 
     List<BrowsingContextInfo> contextInfoList = window1.getTopLevelContexts();
 
-    assertThat(contextInfoList.size()).isEqualTo(2);
+    assertThat(contextInfoList).hasSize(2);
   }
 
   @Test
@@ -226,7 +231,9 @@ void canCloseAWindow() {
 
     window2.close();
 
-    assertThatExceptionOfType(BiDiException.class).isThrownBy(window2::getTree);
+    assertThatThrownBy(window2::getTree)
+        .isInstanceOf(BiDiException.class)
+        .hasMessageMatching(CONTEXT_NOT_FOUND);
   }
 
   @Test
@@ -237,7 +244,9 @@ void canCloseATab() {
 
     tab2.close();
 
-    assertThatExceptionOfType(BiDiException.class).isThrownBy(tab2::getTree);
+    assertThatThrownBy(tab2::getTree)
+        .isInstanceOf(BiDiException.class)
+        .hasMessageMatching(CONTEXT_NOT_FOUND);
   }
 
   @Test
@@ -397,7 +406,7 @@ void canCaptureScreenshot() {
 
     String screenshot = browsingContext.captureScreenshot();
 
-    assertThat(screenshot.length()).isPositive();
+    assertThat(screenshot).isNotEmpty();
   }
 
   @Test
@@ -423,7 +432,7 @@ void canCaptureScreenshotWithAllParameters() {
                 .origin(CaptureScreenshotParameters.Origin.DOCUMENT)
                 .clipRectangle(clipRectangle));
 
-    assertThat(screenshot.length()).isPositive();
+    assertThat(screenshot).isNotEmpty();
   }
 
   @Test
@@ -440,7 +449,7 @@ void canCaptureScreenshotOfViewport() {
         browsingContext.captureBoxScreenshot(
             elementRectangle.getX(), elementRectangle.getY(), 5, 5);
 
-    assertThat(screenshot.length()).isPositive();
+    assertThat(screenshot).isNotEmpty();
   }
 
   @Test
@@ -455,24 +464,22 @@ void canCaptureElementScreenshot() {
     String screenshot =
         browsingContext.captureElementScreenshot(((RemoteWebElement) element).getId());
 
-    assertThat(screenshot.length()).isPositive();
+    assertThat(screenshot).isNotEmpty();
   }
 
   @Test
   @NeedsFreshDriver
   void canSetViewport() {
+    Dimension initialViewportSize = getViewportSize();
+
     BrowsingContext browsingContext = new BrowsingContext(driver, driver.getWindowHandle());
     driver.get(appServer.whereIs("formPage.html"));
 
     browsingContext.setViewport(250, 300);
+    assertThat(getViewportSize()).isEqualTo(new Dimension(250, 300));
 
-    List<Long> newViewportSize =
-        (List<Long>)
-            ((JavascriptExecutor) driver)
-                .executeScript("return [window.innerWidth, window.innerHeight];");
-
-    assertThat(newViewportSize.get(0)).isEqualTo(250);
-    assertThat(newViewportSize.get(1)).isEqualTo(300);
+    browsingContext.resetViewport();
+    assertThat(getViewportSize()).isEqualTo(initialViewportSize);
   }
 
   @Test
@@ -481,20 +488,10 @@ void canSetViewportWithDevicePixelRatio() {
     BrowsingContext browsingContext = new BrowsingContext(driver, driver.getWindowHandle());
     driver.get(appServer.whereIs("formPage.html"));
 
-    browsingContext.setViewport(250, 300, 5);
-
-    List<Long> newViewportSize =
-        (List<Long>)
-            ((JavascriptExecutor) driver)
-                .executeScript("return [window.innerWidth, window.innerHeight];");
-
-    assertThat(newViewportSize.get(0)).isEqualTo(250);
-    assertThat(newViewportSize.get(1)).isEqualTo(300);
-
-    Long newDevicePixelRatio =
-        (Long) ((JavascriptExecutor) driver).executeScript("return window.devicePixelRatio");
+    browsingContext.setViewport(250, 300, 5.5);
 
-    assertThat(newDevicePixelRatio).isEqualTo(5);
+    assertThat(getViewportSize()).isEqualTo(new Dimension(250, 300));
+    assertThat(getDevicePixelRatio()).isEqualTo(5.5);
   }
 
   @Test
@@ -507,7 +504,7 @@ void canPrintPage() {
 
     String printPage = browsingContext.print(printOptions);
 
-    assertThat(printPage.length()).isPositive();
+    assertThat(printPage).isNotEmpty();
     // Comparing expected PDF is a hard problem.
     // As long as we are sending the parameters correctly it should be fine.
     // Trusting the browsers to do the right thing.
@@ -571,4 +568,16 @@ private String promptPage() {
   private boolean getDocumentFocus() {
     return (boolean) ((JavascriptExecutor) driver).executeScript("return document.hasFocus();");
   }
+
+  private Dimension getViewportSize() {
+    List<Number> dimensions =
+        (List<Number>)
+            ((JavascriptExecutor) driver)
+                .executeScript("return [window.innerWidth, window.innerHeight];");
+    return new Dimension(dimensions.get(0).intValue(), dimensions.get(1).intValue());
+  }
+
+  private Number getDevicePixelRatio() {
+    return (Number) ((JavascriptExecutor) driver).executeScript("return window.devicePixelRatio");
+  }
 }