feat: implement webdriver BiDi for Firefox versions 135 and greater #30870

AtofStryker · 2025-01-14T15:15:13Z

Closes misc: Connect WebDriver BiDi client to Firefox inside Cypress to replace CDP / Classic WebDriver #30220

Additional details

Automates firefox with WedDriver BiDi instead of Chrome Devtools Protocol.

With Chrome Devtools Protocol being deprecated in Firefox 129 and slated for removal in the Firefox browser, Cypress has made the decision to automate Firefox with WedDriver BiDi.

This PR gets the basics cut over to BiDi, mainly the server's middleware prerequest logic and association, along with being able to associate the Application Under Test (AUT)

Currently, this is only enabled automatically for Firefox 135 and up. This PR also only cuts over to BiDi what is absolutely necessary. The rest of the work can be handled in #30221. This also should not be a major impact to users as the automation client is abstracted.

See #30447 for more additional details

Steps to test

Unit tests are added/modified in the server package, but the best way to test is to run cypress against firefox 135 and greater on this branch. To make sure there aren't regressions with the CDP implementation for firefox 134 and below, we run the driver tests additionally on an older version of firefox

How has the user experience changed?

Webdriver BiDi is now the default automation client for Firefox version 135 and up. A warning will be printed to the console (regardless of Firefox version) if CDP is in use for Firefox:

We are also adding a snippet in the docs on the update. If needed, FORCE_FIREFOX_CDP can be set as an env variable to force CDP on. The current plan is for CDP support for Firefox to be removed in Cypress 15.

PR Tasks

Have tests been added/updated?
Has a PR for user-facing changes been opened in cypress-documentation? chore: add firefox webdriver bidi docs cypress-documentation#6103
Have API changes been updated in the type definitions?

cypress · 2025-01-14T18:24:57Z

cypress Run #60569

Run Properties: Passed #60569 • a8e36860a4: update firefox warning

Project	`cypress`
Branch Review	`feat/implement_bidi`
Run status	`Passed #60569`
Run duration	`17m 55s`
Commit	`a8e36860a4: update firefox warning`
Committer	`AtofStryker`
View all properties for this run ↗︎

Test results
Failures	`0`
Flaky	`2`
Pending	`77`
Skipped	`0`
Passing	`5623`
View all changes introduced in this branch ↗︎

Warning

No Report: Something went wrong and we could not generate a report for the Application Quality products.

AtofStryker · 2025-02-10T19:44:02Z

packages/extension/app/v2/background.js

the header attachment is completely handled within the bidi_automation class

packages/proxy/lib/http/util/prerequests.ts

packages/proxy/lib/http/request-middleware.ts

packages/server/lib/browsers/bidi_automation.ts

packages/proxy/lib/http/request-middleware.ts

cacieprins · 2025-02-21T16:21:16Z

packages/proxy/lib/http/request-middleware.ts

I know it's not currently typical for the middleware here, but can this be in a separate file and exported from request-middleware.ts? That conforms a little closer to SRP, and would be a good move forward for the middlewares here

exported from request-middleware or imported? I'm a bit hesitant to introduce a one off pattern here for a function so small, unless we refactor the middleware in a separate PR.

Both, considering how the default export from this file is used - but I think that pattern needs a larger look. Leave it for now!

cacieprins · 2025-02-21T17:14:17Z

packages/server/lib/browsers/firefox.ts

these two conditionals can be combined

updated this in 279b7561ba

Oh, I was thinking of combining the nested ifs, rather than the isCDPForced

packages/server/lib/browsers/firefox.ts

ryanthemanuel · 2025-02-21T18:53:59Z

packages/proxy/lib/http/request-middleware.ts

Is this spelled out in a spec somewhere? Just curious if we might need to know if this might change in the future. Do we have any firefox tests that would break in that case?

in the Bidi spec or the cookie spec. I don't think they are in either. If it does change my guess is it wouldn't have an impact since we are only checking for the deviation. but that would mean the code would effectively be dead

ryanthemanuel · 2025-02-21T18:57:56Z

packages/server/lib/browsers/bidi_automation.ts

Do we need to unsubscribe to BIDI_EVENTS here as well?

We could but its a bit hard to accomplish. We could probably do it instance kill but the events effectively get unsubscribed when geckodriver and firefox are killed AFAIK

packages/server/lib/browsers/firefox.ts

ryanthemanuel

Couple of small questions and suggestions but looks good overall.

packages/errors/src/errors.ts

mschile · 2025-02-21T22:14:55Z

packages/server/lib/browsers/bidi_automation.ts

I can't remember, did we talk about whether or not this would be considered a breaking change? Like if someone is intercepting a certain resource type but the types are different now so the intercept breaks.

We did briefly which was one of the rationales around deprecating the field. The idea that we are trying our best to map these 1:1 and the types be the same shouldn't make it a breaking change, but it's difficult to predict the behavior for each type. That being said I don't think its a breaking change but there could be bugs that we will need to fix. I feel confident on fetch and xhr types, but the fonts might be a little more nuanced which is in use as seen here. Worse case, if a bug is present with the mapping, the user can opt out with the FORCE_FIREFOX_CDP until we fix it

mschile · 2025-02-21T22:20:46Z

packages/server/lib/browsers/types.ts

Does this have any impact on the public API?
https://docs.cypress.io/api/cypress-api/browser#Syntax
https://docs.cypress.io/api/cypress-api/isbrowser

it doesn't but independently I think the type is wrong since its a string in both chrome and firefox. I can update it on the docs PR

the types are actually correct here https://github.com/cypress-io/cypress/blob/develop/cli/types/cypress.d.ts#L107 but incorrect in the docs, so I added them to the docs PR cypress-io/cypress-documentation#6103

mschile

Looks great overall! Added a couple questions.

…utover). [run ci]

… the code easier to read

cypress-bot · 2025-02-25T21:06:57Z

Released in 14.1.0.

This comment thread has been locked. If you are still experiencing this issue after upgrading to
Cypress v14.1.0, please open a new issue.

AtofStryker changed the base branch from develop to chore/update_wdio_deps January 14, 2025 15:15

AtofStryker force-pushed the feat/implement_bidi branch from d8df75c to 21ebfa8 Compare January 15, 2025 15:40

AtofStryker marked this pull request as draft January 15, 2025 15:43

AtofStryker force-pushed the feat/implement_bidi branch 2 times, most recently from 6d48392 to ab077a7 Compare January 22, 2025 15:26

AtofStryker force-pushed the feat/implement_bidi branch 2 times, most recently from 5264fcb to 8b3b779 Compare January 22, 2025 21:20

cacieprins mentioned this pull request Feb 7, 2025

Tab key events can be dispatched to the AUT #31050

Closed

3 tasks

AtofStryker force-pushed the feat/implement_bidi branch 6 times, most recently from 3d23335 to 534be08 Compare February 7, 2025 20:47

AtofStryker force-pushed the chore/update_wdio_deps branch from 46edeb9 to 9c6e162 Compare February 10, 2025 18:02

AtofStryker force-pushed the feat/implement_bidi branch from 534be08 to aecd4f6 Compare February 10, 2025 18:29

AtofStryker commented Feb 10, 2025

View reviewed changes

packages/proxy/lib/http/util/prerequests.ts Outdated Show resolved Hide resolved

AtofStryker commented Feb 10, 2025

View reviewed changes

packages/proxy/lib/http/request-middleware.ts Outdated Show resolved Hide resolved

AtofStryker commented Feb 10, 2025

View reviewed changes

packages/server/lib/browsers/bidi_automation.ts Outdated Show resolved Hide resolved

AtofStryker force-pushed the feat/implement_bidi branch from aecd4f6 to be3a9dd Compare February 10, 2025 20:13

AtofStryker linked an issue Feb 10, 2025 that may be closed by this pull request

misc: Connect WebDriver BiDi client to Firefox inside Cypress to replace CDP / Classic WebDriver #30220

Closed

AtofStryker changed the title ~~feat: implement webdriver BiDi~~ feat: implement webdriver BiDi for Firefox versions 135 and greater Feb 10, 2025

AtofStryker force-pushed the chore/update_wdio_deps branch from 9c6e162 to 5219967 Compare February 10, 2025 20:41

AtofStryker self-assigned this Feb 10, 2025

Base automatically changed from chore/update_wdio_deps to develop February 10, 2025 21:27

AtofStryker force-pushed the feat/implement_bidi branch 3 times, most recently from af8f1cd to d605883 Compare February 10, 2025 22:16

AtofStryker force-pushed the feat/implement_bidi branch from a7417d7 to 58fac0b Compare February 19, 2025 17:50

AtofStryker requested a review from ryanthemanuel February 19, 2025 17:51

cacieprins requested changes Feb 21, 2025

View reviewed changes

AtofStryker force-pushed the feat/implement_bidi branch from 58fac0b to 279b756 Compare February 21, 2025 18:41

AtofStryker requested a review from cacieprins February 21, 2025 18:42

ryanthemanuel reviewed Feb 21, 2025

View reviewed changes

packages/server/lib/browsers/firefox.ts Outdated Show resolved Hide resolved

ryanthemanuel approved these changes Feb 21, 2025

View reviewed changes

cacieprins approved these changes Feb 21, 2025

View reviewed changes

mschile reviewed Feb 21, 2025

View reviewed changes

packages/errors/src/errors.ts Outdated Show resolved Hide resolved

mschile reviewed Feb 21, 2025

View reviewed changes

mschile requested changes Feb 21, 2025

View reviewed changes

AtofStryker added 9 commits February 24, 2025 08:21

feat: implement BiDi automation client base (without full extension c…

2629b0a

…utover). [run ci]

chore: implement suggestions from code review. [run ci]

1b48ceb

update error text to be in line with documentation

3622647

address comments from code review

4dd4bc3

address comments from code review

ffd1c88

make bidi, cdp, and both active protocols object enumerations to make…

83d2228

… the code easier to read

address additional comments from code review

d6c6bff

fix errors from refactor

65aebe3

update firefox warning

a8e3686

AtofStryker force-pushed the feat/implement_bidi branch from 6872595 to a8e3686 Compare February 24, 2025 13:21

AtofStryker requested a review from mschile February 24, 2025 13:21

mschile approved these changes Feb 24, 2025

View reviewed changes

AtofStryker merged commit 5da0995 into develop Feb 24, 2025
135 of 137 checks passed

AtofStryker deleted the feat/implement_bidi branch February 24, 2025 18:17

cypress-bot bot locked as resolved and limited conversation to collaborators Feb 25, 2025

feat: implement webdriver BiDi for Firefox versions 135 and greater #30870

feat: implement webdriver BiDi for Firefox versions 135 and greater #30870

Uh oh!

Conversation

AtofStryker commented Jan 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Additional details

Steps to test

How has the user experience changed?

PR Tasks

Uh oh!

cypress bot commented Jan 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ryanthemanuel left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mschile Feb 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mschile left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cypress-bot bot commented Feb 25, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

AtofStryker commented Jan 14, 2025 •

edited

Loading

cypress bot commented Jan 14, 2025 •

edited

Loading

mschile Feb 21, 2025 •

edited

Loading