gecko-dev/remote
Julian Descottes 90d71ea71d Bug 1832891 - [remote] Set timeout to 5s for waitForInitialNavigation for new contexts r=webdriver-reviewers,whimboo, a=dmeehan
Extending the timeout only when we explicitly create a new window or tab should be safe.
On the other hand, initial windows from the browser or new tabs created by the browser UI can remain on the initial document forever, for instance on Android.
So for those cases we keep the current unloadTimeout value.

Differential Revision: https://phabricator.services.mozilla.com/D179710
2023-06-06 13:55:39 +00:00
..
cdp Bug 1787997 - Refactor remote UUID Usage to a Shared UUID Module r=jdescottes,webdriver-reviewers 2023-05-25 07:36:22 +00:00
components Bug 1826062 - Automatic fixes for Prettier 2.0.5 upgrade. r=mossop,perftest-reviewers,webcompat-reviewers,geckoview-reviewers,denschub,devtools-reviewers,sparky,owlish 2023-05-20 12:26:49 +00:00
doc Bug 1827713 - Move marionette/Building.md shell commands into code blocks so they render on firefox-source-docs.mozilla.org r=whimboo 2023-04-17 18:29:26 +00:00
marionette Bug 1832891 - [remote] Set timeout to 5s for waitForInitialNavigation for new contexts r=webdriver-reviewers,whimboo, a=dmeehan 2023-06-06 13:55:39 +00:00
server Bug 1826366 - [remote] Apply lint --fix for valid-jsdoc in remote r=webdriver-reviewers,whimboo 2023-04-05 16:25:47 +00:00
shared Bug 1832891 - [remote] Set timeout to 5s for waitForInitialNavigation for new contexts r=webdriver-reviewers,whimboo, a=dmeehan 2023-06-06 13:55:39 +00:00
test/puppeteer Bug 1836093 - [remote] Disable browser.translations.enable in automation r=webdriver-reviewers,whimboo 2023-06-01 06:21:23 +00:00
webdriver-bidi Bug 1832891 - [remote] Set timeout to 5s for waitForInitialNavigation for new contexts r=webdriver-reviewers,whimboo, a=dmeehan 2023-06-06 13:55:39 +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 1787997 - Refactor remote UUID Usage to a Shared UUID Module r=jdescottes,webdriver-reviewers 2023-05-25 07:36:22 +00:00
mach_commands.py Bug 1824908 - [puppeteer] Sync vendored puppeteer to v20.1.0. r=webdriver-reviewers,whimboo 2023-05-09 12:51:05 +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.