gecko-dev/remote
2023-03-01 11:05:57 +00:00
..
cdp Bug 1819320 - [cdp] Use waitForNewTab to monitor the load of invalid URLs in browser_createTarget.js r=webdriver-reviewers,whimboo 2023-03-01 11:05:57 +00:00
components Bug 1794552 - [marionette] Fix Bugzilla components for Marionette related files. r=webdriver-reviewers,Sasha,jgraham DONTBUILD 2023-02-09 19:38:39 +00:00
doc Bug 1817934 - [puppeteer] Update Puppeteer vendoring documentation. r=webdriver-reviewers,jdescottes 2023-02-25 10:14:25 +00:00
marionette Bug 1806810 - [bidi] Implement "browsingContext.print" as PDF command. r=webdriver-reviewers,whimboo 2023-03-01 08:18:54 +00:00
server Bug 1792341 - Migrate more toolkit/modules consumers to use direct ES module import. r=Gijs,webdriver-reviewers,perftest-reviewers,necko-reviewers,geckoview-reviewers,preferences-reviewers,application-update-reviewers,pip-reviewers,credential-management-reviewers,sgalich,owlish,bytesized,AlexandruIonescu,whimboo,mconley,mixedpuppy 2022-10-18 11:21:26 +00:00
shared Bug 1806810 - [bidi] Implement "browsingContext.print" as PDF command. r=webdriver-reviewers,whimboo 2023-03-01 08:18:54 +00:00
test/puppeteer Bug 1817934 - [puppeteer] Update test expection data. r=webdriver-reviewers,jdescottes 2023-02-25 10:14:26 +00:00
webdriver-bidi Bug 1806810 - [bidi] Implement "browsingContext.print" as PDF command. r=webdriver-reviewers,whimboo 2023-03-01 08:18:54 +00:00
.gitignore Bug 1797744 - [puppeteer] Sync vendored puppeteer to v19.6.0. r=webdriver-reviewers,jdescottes,whimboo 2023-01-27 16:50:45 +00:00
jar.mn Bug 1692468 - [marionette] Move Element Reference store as node cache into content process. r=jgraham,webdriver-reviewers,jdescottes 2023-01-01 20:24:02 +00:00
mach_commands.py Bug 1817934 - [puppeteer] Update Puppeteer vendoring documentation. r=webdriver-reviewers,jdescottes 2023-02-25 10:14:25 +00:00
moz.build
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.