912611 - Implement `highlights` option of `Client#screenshot`

Status: RESOLVED FIXED

(Testing Graveyard :: JSMarionette, defect)

Description

[Mike Pennisi [:jugglinmike]]

Currently, there is a bug in the Marionette server that prevents the `highlights` screenshot option from functioning correctly. Once bug 912244 is resolved, extend the `Client#screenshot` API to accept an optional array of elements to highlight.

Comment 1

[Mike Pennisi [:jugglinmike]]

Attachment: Pull request on GitHub.com

Hey Gareth,

I copied the documentation for this method from the equivalent method in the Python client: https://marionette_client.readthedocs.org/en/latest/#marionette.Marionette.screenshot

Comment 2

[Gareth Aye [:gaye] (back from PTO)]

Comment on attachment 8356241 [details] [review]
Pull request on GitHub.com

LGTM! Once the server bug lands shall we also land an end-to-end test?

Comment 3

[Mike Pennisi [:jugglinmike]]

I don't know if we can write a stable test for this behavior. I suppose we could navigate to a simple document served from the repo itself and screenshot that, but comparing expected base64 encodings would be susceptible to false negatives if the platform's compression algorithm changed. Maybe we can find a good image reference test library for Node...

Although even then, the logic for drawing the border (which specifies its width and color) lives in the Marionette server. Changes there would cause unexpected failures on our end (even with fuzzy tests).

Comment 4

[Mike Pennisi [:jugglinmike]]

master: https://github.com/mozilla-b2g/marionette-js-client/commit/fbffc548181ca4797e2dc9422e11c440bd56f58d

Thanks for the review, Gareth!