Proposing a get endpoint for Take Screenshot that with fullpage option #1536

k7z45 · 2020-07-16T17:38:42Z

Due to the high demand from
https://bugs.chromium.org/p/chromedriver/issues/detail?id=294,
come up with initial proposal for the spec

Preview | Diff

Due to the high demand from https://bugs.chromium.org/p/chromedriver/issues/detail?id=294, come up with initial proposal for the spec

jgraham · 2020-07-17T11:26:31Z

geckodriver supports this, but it's a new endpoint rather than a parameter (…/screenshot/full). Since the existing endpoint is a GET and we don't have other cases that use parameters on the GET, that design would make more sense to me.

k7z45 · 2020-07-17T19:30:21Z

Thanks for the comment, made the change accordingly.

jgraham

Note that merging this also requires some web-platform-tests to be submitted/approved for the feature.

jgraham · 2020-07-20T09:50:42Z

index.html

+  <li><p>Return {<var>x</var>, <var>y</var>, <var>width</var>, <var>height</var>}.
+</ol>
+
+<p>In order to <dfn>draw a bounding box from the fullpage region</dfn>,


Could this just reuse the "draw a bounding box from the framebuffer" steps? It seems to be mostly duplicated.

The definition of "draw a bounding box from the framebuffer" uses initial viewport to define the width and height of the paint which is not the case here since we want the width and height of the entire page instead of just visible area.

jgraham · 2020-07-20T09:53:13Z

index.html

+
+ <li><p>Let <var>width</var> be the value
+  returned by
+  <p><a>max</a>(document.body.scrollWidth, document.documentElement.scrollWidth,


Are there really no defined relations that enforce an ordering between any of these properties?

I am not sure what you mean regarding ordering of the properties. I took this "heuristics" from https://javascript.info/size-and-scroll-window. In reality, ChromeDriver implementation will probably utilize CDP https://chromedevtools.github.io/devtools-protocol/tot/Page/#method-getLayoutMetrics and use the contentSize width and height directly.

k7z45 · 2020-07-20T22:14:41Z

Note that merging this also requires some web-platform-tests to be submitted/approved for the feature.

Will work on web-platform-tests once I have "verbal" approval for this.

sideshowbarker · 2020-07-21T01:02:21Z

Hi @k7z45 — in order to accept this PR we need to make our tooling recognize that you’re already a participant in the Browser Testing and Tools Working Group.

You can do that by using https://www.w3.org/users/myprofile to log into your W3C account — and from there, follow the Connected Accounts link in the sidebar to connect your W3C account with your GitHub account.

If you don’t remember your W3C username or password, you can use https://www.w3.org/accounts/recover to recover them.

k7z45 · 2020-07-21T01:44:16Z

Thanks Michael! Just did that.

sideshowbarker · 2020-07-21T01:57:10Z

Thanks @k7z45 — https://labs.w3.org/repo-manager/pr/id/w3c/webdriver/1536 shows this is now green for the IPR check

This commit is to add tests using GET screenshot/full for WebDriver proposed at [1]. The tests are copied from take_screenshot/ and modified to use the full page screenshot endpoint. In iframe.py test_source_origin test, the cross origin test full page screenshot does not generate the same png as the same origin one. This behavior has been verified by taking the full page screenshot in browser DevTools directly using Capture full size screenshot[2]. Added a function to get full page dimensions using document.scrollingElement.scroll{Width,Height}. [1] w3c/webdriver#1536 [2] https://www.deconetwork.com/blog/how-to-take-full-webpage-screenshots-instantly/#:~:text=Click%20Command%2BShift%2BP%20on,Select%20Capture%20full%20size%20screenshot.

k7z45 · 2020-11-26T00:44:57Z

Hi @jgraham ,
PTAL pending review web-platform-tests: web-platform-tests/wpt#26652 for the feature.

index.html

whimboo · 2020-11-30T13:33:09Z

index.html

@@ -9082,6 +9090,45 @@ <h2>Screen capture</h2>
 <li><p>Return <a>success</a> with <var>canvas</var>.
 </ol>

+<p>In order to <dfn>draw a scrollable region from the framebuffer</dfn>,


What exactly is that part about? Is it for the document element, or a child node? For child nodes we have Take Element Screenshot. Otherwise check you do below we already have at the top of the former list.

I feel we don't have to repeat all the steps again.

This is for describing taking the screenshot for the full page instead of only the visible viewport.
It's for document.scrollingElement.
I did not use "draw a bounding box from the framebuffer" because I think step 2 and step 3
do not satisfy the requirement for full page screenshot.

"2. Let paint width be the initial viewport’s width – min(rectangle x coordinate, rectangle x coordinate + rectangle width dimension).
3. Let paint height be the initial viewport’s height – min(rectangle y coordinate, rectangle y coordinate + rectangle height dimension)."

Notice the - denotes the minus sign, so I think for Take Screenshot and Take Element Screenshot, the width and height will not be greater than the visible viewport's width and height but the full page screenshot takes the document.scrollingElement.scrollWidth and scrollHeight which can be greater. So I removed step 2 and 3 and uses the scrollWidth and Height directly for paint width and height.

@whimboo Could you take a look, please?

index.html

jugglinmike · 2023-09-12T17:52:17Z

I'm interested in bringing this functionality to WebDriver BiDi. Whether it belongs here in WebDriver "classic" is not a topic I can comment on, but I'm interested in learning if the normative text proposed here is viable for either spec.

Specifically, I haven't found any implementer's perspective on @jgraham's 2021 comment:

One challenge is that the fullPage option may not be trivial to specify; I think we skipped it for WebDriver Classic but in practice implementations have it, although I don't know they all work the same The typical kind of problem is "what if you haven't already rendered the whole page, but just some tiles. Then you might need to simulate scrolling to render the whole page, but what about position:fixed headers, or content that changes duirng scroll". So really you want "render the entire current layout tree as if the viewport length was unbounded", but that might not actually be a thing that's supported in engines.

@chrishtr you and I investigated a Chrome rendering bug a number of years ago; is there any chance you could weigh in here or perhaps refer me to someone more appropriate?

@juliandescottes could you direct me to a subject-matter expert at Mozilla?

whimboo · 2023-09-12T18:40:12Z

For Chrome there is https://bugs.chromium.org/p/chromium/issues/detail?id=770769&desc=2 which at least for headless seems to still limit the maximum height to 16384px.

For Firefox we currently have the limit set to 32767px for both height and width, and a maximum texture size of 472907776.

As of now we do not have problems in capturing full page screenshots for pages exceeding the visible viewport.

whimboo · 2023-09-12T18:41:07Z

Note that we will discuss the full screenshot feature for BiDi during the TPAC sessions on Thursday or Friday this week.

Proposing a post endpoint for Take Screenshot that with fullpage option

f37036b

Due to the high demand from https://bugs.chromium.org/p/chromedriver/issues/detail?id=294, come up with initial proposal for the spec

k7z45 requested review from AutomatedTester, jgraham, shs96c and andreastt as code owners July 16, 2020 17:38

Use GET with /screenshot/full instead

e134c44

jgraham requested changes Jul 20, 2020

View reviewed changes

k7z45 requested a review from jgraham July 20, 2020 22:15

k7z45 mentioned this pull request Sep 16, 2020

Implement full page screenshot for Chrome SeleniumHQ/selenium#8705

Closed

Simplify wording and width/height calculation

16a640d

k7z45 changed the title ~~Proposing a post endpoint for Take Screenshot that with fullpage option~~ Proposing a get endpoint for Take Screenshot that with fullpage option Nov 26, 2020

k7z45 mentioned this pull request Nov 26, 2020

[wdspec] Add tests for proposed full page screen endpoint web-platform-tests/wpt#26652

Open

whimboo reviewed Nov 30, 2020

View reviewed changes

Moved Take Full Screenshot right after Take Screenshot

1a802aa

k7z45 requested a review from whimboo December 15, 2020 04:16

whimboo mentioned this pull request Jul 19, 2021

Screenshot domain/command w3c/webdriver-bidi#120

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Proposing a get endpoint for Take Screenshot that with fullpage option #1536

Proposing a get endpoint for Take Screenshot that with fullpage option #1536

k7z45 commented Jul 16, 2020 •

edited by pr-preview bot

jgraham commented Jul 17, 2020

k7z45 commented Jul 17, 2020

jgraham left a comment

jgraham Jul 20, 2020

k7z45 Jul 20, 2020

jgraham Jul 20, 2020

k7z45 Jul 20, 2020

k7z45 commented Jul 20, 2020 •

edited

sideshowbarker commented Jul 21, 2020

k7z45 commented Jul 21, 2020

sideshowbarker commented Jul 21, 2020

k7z45 commented Nov 26, 2020 •

edited

whimboo Nov 30, 2020

k7z45 Nov 30, 2020

k7z45 Feb 5, 2021

jugglinmike commented Sep 12, 2023

whimboo commented Sep 12, 2023

whimboo commented Sep 12, 2023

Proposing a get endpoint for Take Screenshot that with fullpage option #1536

Are you sure you want to change the base?

Proposing a get endpoint for Take Screenshot that with fullpage option #1536

Conversation

k7z45 commented Jul 16, 2020 • edited by pr-preview bot

jgraham commented Jul 17, 2020

k7z45 commented Jul 17, 2020

jgraham left a comment

Choose a reason for hiding this comment

jgraham Jul 20, 2020

Choose a reason for hiding this comment

k7z45 Jul 20, 2020

Choose a reason for hiding this comment

jgraham Jul 20, 2020

Choose a reason for hiding this comment

k7z45 Jul 20, 2020

Choose a reason for hiding this comment

k7z45 commented Jul 20, 2020 • edited

sideshowbarker commented Jul 21, 2020

k7z45 commented Jul 21, 2020

sideshowbarker commented Jul 21, 2020

k7z45 commented Nov 26, 2020 • edited

whimboo Nov 30, 2020

Choose a reason for hiding this comment

k7z45 Nov 30, 2020

Choose a reason for hiding this comment

k7z45 Feb 5, 2021

Choose a reason for hiding this comment

jugglinmike commented Sep 12, 2023

whimboo commented Sep 12, 2023

whimboo commented Sep 12, 2023

k7z45 commented Jul 16, 2020 •

edited by pr-preview bot

k7z45 commented Jul 20, 2020 •

edited

k7z45 commented Nov 26, 2020 •

edited