gecko-dev/remote
Emilio Cobos Álvarez 7e23a4287f Bug 1760836 - Support printing to an nsIOutputStream. r=jfkthame,jrmuizel,webdriver-reviewers,geckoview-reviewers,agi
The trickiest bits are the PrintTargetCG ones, the rest is just plumbing
and cleanups and tests, but let me know if you want those to be split
out, can do.

The GTK change to nsPrintSettingsGTK::GetResolution is a no-op (we only
read resolution on windows), but I did that because we assume that it
doesn't fail and GTK returns a sane default anyways.

Differential Revision: https://phabricator.services.mozilla.com/D142199
2022-03-30 18:51:58 +00:00
..
cdp Bug 1760836 - Support printing to an nsIOutputStream. r=jfkthame,jrmuizel,webdriver-reviewers,geckoview-reviewers,agi 2022-03-30 18:51:58 +00:00
components Bug 1760259 - [remote] Apply RecommendedPreferences on command-line-startup r=webdriver-reviewers,whimboo 2022-03-24 11:26:06 +00:00
doc Bug 1759434 - [remote] Update Remote Protocol docs for running specific Puppeteer tests only. r=webdriver-reviewers,jdescottes 2022-03-15 07:10:36 +00:00
marionette Bug 1760836 - Support printing to an nsIOutputStream. r=jfkthame,jrmuizel,webdriver-reviewers,geckoview-reviewers,agi 2022-03-30 18:51:58 +00:00
server Bug 1750689 - [remote] Support allowed hosts & origins from preferences in RemoteAgent websocket handshake r=webdriver-reviewers,whimboo,jgraham,freddyb 2022-03-10 16:16:15 +00:00
shared Backed out 3 changesets (bug 1703953) for causing multiple failures. CLOSED TREE 2022-03-29 17:01:58 +03:00
test Bug 1732958 - [puppeteer] Skip 2 new mandatory tests on Firefox r=webdriver-reviewers,whimboo 2022-01-04 12:11:45 +00:00
webdriver-bidi Bug 1758502 - [webdriver-bidi] Implement the browsingContext.close command r=webdriver-reviewers,whimboo 2022-03-27 08:58:11 +00:00
.eslintrc.js Bug 1719850 - [marionette] Enforce no-unused-vars for global variables in marionette eslint configuration r=webdriver-reviewers,whimboo 2021-07-09 17:22:09 +00:00
.gitignore
jar.mn Bug 1756809 - [remote] Emit DOMContentLoaded as an internal event from WindowGlobalMessageHandler r=webdriver-reviewers,whimboo 2022-03-04 18:54:19 +00:00
mach_commands.py Bug 1759248 - don't mess up paths for npm/node on Windows when running puppeteer tests, r=whimboo,jgraham,webdriver-reviewers 2022-03-28 12:03:25 +00:00
moz.build Bug 1694136 - [remote] Move all documentation files for remote protocols under remote/doc r=webdriver-reviewers,whimboo 2021-12-01 20:04:44 +00:00
README.md

The Firefox remote agent is a low-level debugging interface based on the CDP protocol.

With it, you can inspect the state and control execution of documents running in web content, instrument Gecko in interesting ways, simulate user interaction for automation purposes, and debug JavaScript execution.

This component provides an experimental and partial implementation of a remote devtools interface using the CDP protocol and transport layer.

See https://firefox-source-docs.mozilla.org/remote/ for documentation.

It is available in Firefox and is started this way:

% ./mach run --remote-debugging-port

Puppeteer

Puppeteer is a Node library which provides a high-level API to control Chrome, Chromium, and Firefox over the Chrome DevTools Protocol. Puppeteer runs headless by default, but can be configured to run full (non-headless) browsers.

To verify that our implementation of the CDP protocol is valid we do not only run xpcshell and browser-chrome mochitests in Firefox CI but also the Puppeteer unit tests.

Expectation Data

With the tests coming from upstream, it is not guaranteed that they all pass in Gecko-based browsers. For this reason it is necessary to provide metadata about the expected results of each test. This is provided in a manifest file under test/puppeteer-expected.json.

For each test of the Puppeteer unit test suite an equivalent entry will exist in this manifest file. By default tests are expected to PASS.

Tests that are intermittent may be marked with multiple statuses using a list of possibilities e.g. for a test that usually passes, but intermittently fails:

"Page.click should click the button (click.spec.ts)": [
  "PASS", "FAIL"
],

Disabling Tests

Tests are disabled by using the manifest file test/puppeteer-expected.json. For example, if a test is unstable, it can be disabled using SKIP:

"Workers Page.workers (worker.spec.ts)": [
  "SKIP"
],

For intermittents it's generally preferable to give the test multiple expectations rather than disable it.

Autogenerating Expectation Data

After changing some code it may be necessary to update the expectation data for the relevant tests. This can of course be done manually, but mach is able to automate the process:

mach puppeteer-test --write-results

By default it writes the output to test/puppeteer-expected.json.

Given that the unit tests run in Firefox CI only for Linux it is advised to download the expectation data (available as artifact) from the TaskCluster job.