gecko-dev/remote
Henrik Skupin b4875f996c Bug 1800737 - [marionette] Simplify element staleness check. r=webdriver-reviewers,jgraham,jdescottes
By using the `document.isActive()` helper it can be
more easily determined if a given element is in the
active document or not.

Differential Revision: https://phabricator.services.mozilla.com/D162156
2022-11-16 11:17:15 +00:00
..
cdp Bug 1795322 - Update toolkit modules references in marionette related code. r=whimboo,webdriver-reviewers 2022-10-26 08:06:33 +00:00
components Backed out 19 changesets (bug 1541508) for causing xpcshell failures on test_notHeadlessByDefault.js CLOSED TREE 2022-11-01 22:38:52 -04:00
doc Bug 1793311 - [marionette] Fix documentation for Python tests. r=webdriver-reviewers,jdescottes DONTBUILD 2022-11-02 21:32:26 +00:00
marionette Bug 1800737 - [marionette] Simplify element staleness check. r=webdriver-reviewers,jgraham,jdescottes 2022-11-16 11:17:15 +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 1797115 - [bidi] Rename log entry level warning to warn r=webdriver-reviewers,jgraham 2022-11-08 17:27:01 +00:00
test Bug 1791532 - [puppeteer] Sync puppeteer v17.1.2 r=webdriver-reviewers,jdescottes 2022-10-27 07:22:47 +00:00
webdriver-bidi Bug 1792875 - [webdriver-bidi] Store WebSocket connection details for WebDriver BiDi in a JSON file. r=webdriver-reviewers,jdescottes,jgraham 2022-11-14 20:08:24 +00:00
.gitignore Bug 1791532 - [puppeteer] Sync puppeteer v17.1.2 r=webdriver-reviewers,jdescottes 2022-10-27 07:22:47 +00:00
jar.mn Bug 1790468 - [remote] Convert /remote/server JSM modules to ESM r=webdriver-reviewers,whimboo 2022-09-30 11:08:07 +00:00
mach_commands.py Bug 1791532 - [puppeteer] Sync puppeteer v17.1.2 r=webdriver-reviewers,jdescottes 2022-10-27 07:22:47 +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.