[🐛 Bug][java]: Setting page ranges of PrintOptions does not work when print pdf

[silentsoft]

What happened?

Description

Setting page ranges of PrintOptions does not work when print pdf.

If I want to print pdf for google.com with 25cm x 5cm paper size for page 1 and 2 only:

    public static void main(String[] args) throws Exception {
        WebDriverManager.chromedriver().setup();

        ChromeOptions chromeOptions = new ChromeOptions();
        chromeOptions.setHeadless(true);

        ChromeDriver driver = new ChromeDriver(chromeOptions);
        driver.get("https://google.com");

        PrintOptions printOptions = new PrintOptions();
        printOptions.setPageSize(new PageSize(5, 25));
        printOptions.setPageRanges("1-2");
        Pdf pdf = driver.print(printOptions);

        Path output = Paths.get(System.getProperty("user.dir"), "result.pdf");
        Files.write(output, OutputType.BYTES.convertFromBase64Png(pdf.getContent()));

        driver.quit();
    }

This line is ignored.

    printOptions.setPageRanges("1-2");

Reason

toMap() function in PrintOptions.java class should set pageRanges as a key not effectivePageRanges.

As-is

  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;
  }

To-be

  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("pageRanges", effectivePageRanges);
    }
    options.put("margin", getPageMargin());

   return options;
  }

Test

Super simple hack code to figure out that pageRanges works or not:

    public static void main(String[] args) throws Exception {
        WebDriverManager.chromedriver().setup();

        ChromeOptions chromeOptions = new ChromeOptions();
        chromeOptions.setHeadless(true);

        ChromeDriver driver = new ChromeDriver(chromeOptions);
        driver.get("https://google.com");

        PrintOptions printOptions = new PrintOptions() {
            @Override
            public Map<String, Object> toMap() {
                Map<String, Object> map = super.toMap();
                map.put("pageRanges", new String[]{"1-2"});
                return map;
            }
        };
        printOptions.setPageSize(new PageSize(5, 25));
        Pdf pdf = driver.print(printOptions);

        Path output = Paths.get(System.getProperty("user.dir"), "result.pdf");
        Files.write(output, OutputType.BYTES.convertFromBase64Png(pdf.getContent()));

        driver.quit();
    }

How can we reproduce the issue?

public static void main(String[] args) throws Exception {
    // WebDriverManager.chromedriver().setup();

    ChromeOptions chromeOptions = new ChromeOptions();
    chromeOptions.setHeadless(true);

    ChromeDriver driver = new ChromeDriver(chromeOptions);
    driver.get("https://google.com");

    PrintOptions printOptions = new PrintOptions();
    printOptions.setPageSize(new PageSize(5, 25));
    printOptions.setPageRanges("1-2");
    Pdf pdf = driver.print(printOptions);

    Path output = Paths.get(System.getProperty("user.dir"), "result.pdf");
    Files.write(output, OutputType.BYTES.convertFromBase64Png(pdf.getContent()));

    driver.quit();
}

Relevant log output

N/A

Operating System

macOS Monterey 12.1

Selenium version

Java 4.5.3

What are the browser(s) and version(s) where you see this issue?

Chrome 106. But I think this affects all browsers.

What are the browser driver(s) and version(s) where you see this issue?

Chrome Driver 106.0.5249.61

Are you using Selenium Grid?

No

[github-actions]

@silentsoft, thank you for creating this issue. We will troubleshoot it as soon as we can.

---

Info for maintainers

Triage this issue by using labels.

If information is missing, add a helpful comment and then I-issue-template label.

If the issue is a question, add the I-question label.

If the issue is valid but there is no time to troubleshoot it, consider adding the help wanted label.

If the issue requires changes or fixes from an external project (e.g., ChromeDriver, GeckoDriver, MSEdgeDriver, W3C), add the applicable G-* label, and it will provide the correct link and auto-close the issue.

After troubleshooting the issue, please add the R-awaiting answer label.

Thank you!

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.