gecko-dev/remote
Julian Descottes 42dc9793cb Bug 1636453 - [cdp] Support Page.navigate for hash navigation r=webdriver-reviewers,whimboo
Depends on D146985

The previous changeset changed the implementation of navigatedWithinDocument to
be emitted in the proper scenarios (ie, same document navigation).

However our Page.navigate implementation would still timeout waiting on a
network request if you tried to programmatically perform a hash navigation.
Meaning hash navigation was only working when triggered from the page.

With this changeset, we try to detect hash navigations in Page.navigate and
treat them as "network-less" navigations (same as for non http/https navigations)

Differential Revision: https://phabricator.services.mozilla.com/D147076
2022-05-23 19:06:12 +00:00
..
cdp Bug 1636453 - [cdp] Support Page.navigate for hash navigation r=webdriver-reviewers,whimboo 2022-05-23 19:06:12 +00:00
components Bug 1726465 - [marionette] Initialize Marionette before the first top-level window has been opened. r=webdriver-reviewers,agi,jdescottes,mossop,bytesized 2022-05-10 15:08:18 +00:00
doc Bug 1765167 - Part 8: Stop using Cu.import in remote/. r=webdriver-reviewers,whimboo 2022-05-03 06:32:31 +00:00
marionette Backed out changeset 400255519b66 (bug 1533058) for causing multiple web platform tests failures CLOSED TREE 2022-05-13 12:14:22 -04:00
server Bug 1717899 - [remote] Extend the lifetime of the Remote Agent to the Firefox session. r=webdriver-reviewers,jdescottes 2022-04-27 05:43:23 +00:00
shared Bug 1767924 - Handle navigation between urls with the same hashes. r=webdriver-reviewers,jdescottes 2022-05-23 08:01:38 +00:00
test Bug 1636453 - [cdp] Support Page.navigate for hash navigation r=webdriver-reviewers,whimboo 2022-05-23 19:06:12 +00:00
webdriver-bidi Bug 1770195 - [bidi] cleanup method declarations in windowglobal/log.jsm r=webdriver-reviewers,whimboo 2022-05-19 20:24:32 +00:00
.eslintrc.js
.gitignore Bug 1759169 - [remote] Initialize the Remote Agent before the first top-level window has been opened. r=webdriver-reviewers,geckoview-reviewers,jdescottes,agi,mossop 2022-04-25 17:20:43 +00:00
README.md
jar.mn Bug 1723137: Create a shared module for PDF creation. r=whimboo,webdriver-reviewers 2022-04-12 13:26:11 +00:00
mach_commands.py Bug 1757701 - [puppeteer] Disable Husky when installing Puppeteer via npm. r=webdriver-reviewers,jdescottes 2022-05-17 21:52:11 +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.