gecko-dev/remote
Julian Descottes 876d3096fd Bug 1880160 - [bidi] Ignore file channels in BiDi network listener r=webdriver-reviewers,Sasha
File channels do not support the same APIs as other channels and make the NetworkEventRecord throw.
Support should be added in Bug 1826210.

Differential Revision: https://phabricator.services.mozilla.com/D202558
2024-02-23 14:55:57 +00:00
..
cdp Bug 1780071 - autofix violations of no-comparison-or-assignment-inside-ok in misc other folders r=webdriver-reviewers,necko-reviewers,sync-reviewers,profiler-reviewers,sgalich,whimboo,markh,kershaw,julienw 2024-02-19 21:47:41 +00:00
components Bug 1880535 - Enable ESLint rule no-unused-private-class-members. r=Gijs,webdriver-reviewers,webcompat-reviewers,extension-reviewers,application-update-reviewers,devtools-reviewers,translations-reviewers,bytesized,twisniewski,jhirsch,robwu,whimboo 2024-02-20 22:09:21 +00:00
doc Bug 1872252 - [remote] Make mach puppeteer-test to use WebDriver BiDi by default r=webdriver-reviewers,whimboo 2024-01-29 10:45:49 +00:00
marionette Bug 1780071 - autofix violations of no-comparison-or-assignment-inside-ok in misc other folders r=webdriver-reviewers,necko-reviewers,sync-reviewers,profiler-reviewers,sgalich,whimboo,markh,kershaw,julienw 2024-02-19 21:47:41 +00:00
server
shared Bug 1880160 - [bidi] Ignore file channels in BiDi network listener r=webdriver-reviewers,Sasha 2024-02-23 14:55:57 +00:00
test/puppeteer Bug 1880391 - [puppeteer] Upgrade node module ljharb/through to fix bustage. r=webdriver-reviewers,Sasha 2024-02-15 17:57:44 +00:00
webdriver-bidi Bug 1880477 - [bidi] Add basic support for network.provideResponse command r=webdriver-reviewers,Sasha 2024-02-22 16:17:20 +00:00
.gitignore Bug 1862701 - [remote] Sync to puppeteer version v21.5.2. r=webdriver-reviewers,Sasha 2023-11-21 22:29:39 +00:00
jar.mn Bug 1870848 - [remote] Introduce shared webdriver helper UserContextManager r=webdriver-reviewers,whimboo 2024-01-24 14:15:41 +00:00
mach_commands.py Bug 1877214 - [remote] Fix lint failure in mach_commands.py r=webdriver-reviewers,Sasha 2024-01-31 08:46:34 +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.