gecko-dev/remote
Julian Descottes 1fd12674d3 Bug 1725111 - [remote] Add new context descriptor type TOP_BROWSING_CONTEXT r=webdriver-reviewers,whimboo
Depends on D131439

Add a new CONTEXT_DESCRIPTOR_TYPES for top level browsing contexts, called TOP_BROWSING_CONTEXT.
The corresponding context descriptor id should be a browserId.
The FrameTransport is updated to support both CONTEXT_DESCRIPTOR_TYPES: ALL and TOP_BROWSING_CONTEXT.
A browser mochitest is added to check that broadcasts are correctly filtered for a top level browsing context.

Differential Revision: https://phabricator.services.mozilla.com/D131440
2021-11-23 20:23:09 +00:00
..
cdp Bug 1617611: Annotate each failing test individually. r=webdriver-reviewers,necko-reviewers,ckerschb,whimboo,valentin 2021-11-17 11:04:34 +00:00
components Bug 1735162 - [marionette] Write Marionette port to MarionetteActivePort file in profile directory. r=webdriver-reviewers,jdescottes 2021-10-15 14:45:28 +00:00
doc Bug 1734084 - [remote] Fix indentation of commands in remote/doc/Testing.md r=webdriver-reviewers,whimboo 2021-10-05 08:06:54 +00:00
marionette Bug 1673438 -[remote] Refactored evaluate.fromJSON parameters into an options object r=whimboo,webdriver-reviewers 2021-11-16 11:25:52 +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 1725111 - [remote] Add new context descriptor type TOP_BROWSING_CONTEXT r=webdriver-reviewers,whimboo 2021-11-23 20:23:09 +00:00
test Bug 1740798 - [puppeteer] Remove multiple results from test "Page.click should click the button". r=webdriver-reviewers,jgraham 2021-11-18 09:12:03 +00:00
webdriver-bidi Bug 1725111 - [remote] Use contextDescriptor as broadcasting argument for MessageHandler commands r=webdriver-reviewers,whimboo 2021-11-23 20:23:08 +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 1713443 - [remote] Support shared global session data that supports BiDi and CDP r=webdriver-reviewers,whimboo,ochameau 2021-11-11 22:01:46 +00:00
mach_commands.py Bug 1736859 - Explicitly disable fission if '--enable-fission' is not set in |mach puppeteer-test|, r=jgraham,webdriver-reviewers 2021-10-28 14:52:29 +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.