gecko-dev/remote
Henrik Skupin 96a354322c Bug 1721148 - [remote] Report WebSocket handshake failures to the client. r=webdriver-reviewers,jgraham
When a WebSocket upgrade fails we currently do not
send any details of the error. As such it makes
it hard to figure out the real underlying issue.

Further some clients like curl are hanging and do
not immediately exit when the response has been
received. Specifying the Content-Length header
within the response fixes it.

Differential Revision: https://phabricator.services.mozilla.com/D120575
2021-07-23 16:12:32 +00:00
..
cdp Bug 1713784 - [remote] Implement basic support for session.new command. r=webdriver-reviewers,jdescottes,jgraham 2021-07-21 09:45:06 +00:00
components Bug 1691446 - [remote] Rename webdriverBiDi to webDriverBiDi. r=webdriver-reviewers,jdescottes 2021-07-16 11:56:49 +00:00
doc Bug 1719667 - [remote] Do not set recommended preferences when not wanted r=webdriver-reviewers,whimboo 2021-07-09 08:42:47 +00:00
marionette Bug 1721327 - [remote] Share Marionette's assertion module with WebDriver BiDi. r=webdriver-reviewers,jdescottes 2021-07-21 09:45:06 +00:00
server Bug 1721148 - [remote] Report WebSocket handshake failures to the client. r=webdriver-reviewers,jgraham 2021-07-23 16:12:32 +00:00
shared Bug 1713784 - [remote] Implement basic support for session.new command. r=webdriver-reviewers,jdescottes,jgraham 2021-07-21 09:45:06 +00:00
test Bug 1714068 - Bug 1707588 - [puppeteer] Sync vendored puppeteer to v10.0.0 r=webdriver-reviewers,whimboo 2021-06-23 12:37:53 +00:00
webdriver-bidi Bug 1713784 - [remote] Implement basic support for session.new command. r=webdriver-reviewers,jdescottes,jgraham 2021-07-21 09:45:06 +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 Bug 1595528 - [remote] Add local Chromium folder to ignore list. r=remote-protocol-reviewers,maja_zf 2019-11-12 21:19:11 +00:00
README.md Bug 1701674 - [remote] Add handling of expectation data to readme. r=remote-protocol-reviewers,jdescottes 2021-04-27 12:43:31 +00:00
jar.mn Bug 1721327 - [remote] Share Marionette's assertion module with WebDriver BiDi. r=webdriver-reviewers,jdescottes 2021-07-21 09:45:06 +00:00
mach_commands.py Bug 1696251 - Replace self with command_context where possible in existing mach commands. r=mhentges,webdriver-reviewers,perftest-reviewers,whimboo 2021-07-19 16:04:25 +00:00
moz.build Bug 1693805 - [remote] Add support for handling WebDriver BiDi connections. r=webdriver-reviewers,jgraham,jdescottes 2021-07-09 08:00:52 +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.