[java] Fixing options handling for print command

dennisoelkers · web-flow · commit 11647cc16596 · 2022-04-08T11:50:06.000+05:30
Prior to this change, when executing e.g. a `RemoteWebDriver#print` command, the print options passed to the method were passed through to the chromedriver instance, but serialized in a wrong format, rendering them uneffective. The issues were: - Options were wrapped in an `options` key when chromedriver expected them to be at the top-level of the parameters dict (see [here](https://github.com/chromium/chromium/blob/main/chrome/test/chromedriver/window_commands.cc#L2246)) - Page size options were put into a `pageSize` key, when chromedriver expected it to be a `page` key (see [here](https://github.com/chromium/chromium/blob/main/chrome/test/chromedriver/window_commands.cc#L539)) Also, using the `PageSize` class supplied by selenium was not possible, due to defaulting to constant page sizes, not allowing the consumer to override them. This was addressed by adding a second constructor allowing to specify height/width.
diff --git a/java/src/org/openqa/selenium/print/PageMargin.java b/java/src/org/openqa/selenium/print/PageMargin.java
@@ -30,6 +30,13 @@ public PageMargin() {
     this.right = 1.0;
   }
 
+  public PageMargin(double top, double bottom, double left, double right) {
+    this.top = top;
+    this.bottom = bottom;
+    this.left = left;
+    this.right = right;
+  }
+
   public double getTop() {
     return top;
   }
diff --git a/java/src/org/openqa/selenium/print/PageSize.java b/java/src/org/openqa/selenium/print/PageSize.java
@@ -28,6 +28,11 @@ public PageSize() {
     this.height = 21.59;
     this.width = 27.94;
   }
+
+  public PageSize(double height, double width) {
+    this.height = height;
+    this.width = width;
+  }
   public double getHeight() {
     return height;
   }
diff --git a/java/src/org/openqa/selenium/print/PrintOptions.java b/java/src/org/openqa/selenium/print/PrintOptions.java
@@ -19,11 +19,24 @@
 
 import org.openqa.selenium.internal.Require;
 
+import java.util.HashMap;
+import java.util.Map;
+
 public class PrintOptions {
 
   public enum Orientation {
-    PORTRAIT,
-    LANDSCAPE
+    PORTRAIT("portrait"),
+    LANDSCAPE("landscape");
+
+    private final String serialFormat;
+    Orientation(String serialFormat) {
+      this.serialFormat = serialFormat;
+    }
+
+    @Override
+    public String toString() {
+      return serialFormat;
+    }
   }
   private Orientation orientation = Orientation.PORTRAIT;
   private double scale = 1.0;
@@ -98,4 +111,20 @@ public PageSize getPageSize() {
   public PageMargin getPageMargin() {
     return this.pageMargin;
   }
+
+  public Map<String, Object> toMap() {
+    final Map<String, Object> options = new HashMap<>(7);
+    options.put("page", getPageSize());
+    options.put("orientation", getOrientation().toString());
+    options.put("scale", getScale());
+    options.put("shrinkToFit", getShrinkToFit());
+    options.put("background", getBackground());
+    final String[] effectivePageRanges = getPageRanges();
+    if (effectivePageRanges != null) {
+      options.put("effectivePageRanges", effectivePageRanges);
+    }
+    options.put("margin", getPageMargin());
+
+   return options;
+  }
 }
diff --git a/java/src/org/openqa/selenium/remote/DriverCommand.java b/java/src/org/openqa/selenium/remote/DriverCommand.java
@@ -275,7 +275,7 @@ static CommandPayload SET_ALERT_VALUE(String keysToSend) {
 
   String PRINT_PAGE = "printPage";
   static CommandPayload PRINT_PAGE(PrintOptions options) {
-    return new CommandPayload(PRINT_PAGE, ImmutableMap.of("options", options));
+    return new CommandPayload(PRINT_PAGE, options.toMap());
   }
 
   @Deprecated

Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,13 @@ public PageMargin() {`
`30`	`30`	`this.right = 1.0;`
`31`	`31`	`}`
`32`	`32`
	`33`	`+ public PageMargin(double top, double bottom, double left, double right) {`
	`34`	`+ this.top = top;`
	`35`	`+ this.bottom = bottom;`
	`36`	`+ this.left = left;`
	`37`	`+ this.right = right;`
	`38`	`+ }`
	`39`	`+`
`33`	`40`	`public double getTop() {`
`34`	`41`	`return top;`
`35`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,11 @@ public PageSize() {`
`28`	`28`	`this.height = 21.59;`
`29`	`29`	`this.width = 27.94;`
`30`	`30`	`}`
	`31`	`+`
	`32`	`+ public PageSize(double height, double width) {`
	`33`	`+ this.height = height;`
	`34`	`+ this.width = width;`
	`35`	`+ }`
`31`	`36`	`public double getHeight() {`
`32`	`37`	`return height;`
`33`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -275,7 +275,7 @@ static CommandPayload SET_ALERT_VALUE(String keysToSend) {`
`275`	`275`
`276`	`276`	`String PRINT_PAGE = "printPage";`
`277`	`277`	`static CommandPayload PRINT_PAGE(PrintOptions options) {`
`278`		`- return new CommandPayload(PRINT_PAGE, ImmutableMap.of("options", options));`
	`278`	`+ return new CommandPayload(PRINT_PAGE, options.toMap());`
`279`	`279`	`}`
`280`	`280`
`281`	`281`	`@Deprecated`