Firefox launch geckodriver dependency information

[MikeMcC399]

Situation

cypress@13.15.1 notes

Cypress now consumes geckodriver to help automate the Firefox browser instead of marionette-client. Addresses #30217.

The mozilla/geckodriver is required to test Firefox. It is not part of the Firefox distribution, nor is it included in Cypress. If the driver is unavailable, then testing against Firefox fails.

This is not mentioned in References > Launching Browsers > Firefox Browsers.

Suggestion

Add an explanation about the use of mozilla/geckodriver and the npm wrapper package geckodriver to References > Launching Browsers > Firefox Browsers and explain how to test with Firefox and without a network connection.

Related

• Cypress tests fail in air-gapped network on Firefox cypress#31036 (comment)
• Cypress tests fail in air-gapped network on Firefox cypress-docker-images#1298
• Cypress cannot open firefox - getaddrinfo EAI_AGAIN error cypress#31230
• Allow Disabling Automated Firefox Extension Installation via Cypress Env Variable cypress#31316

[MikeMcC399]

I will follow up with a suggestion for documentation.

• I also plan to submit a PR to implement Add geckodriver to factory process cypress-docker-images#1351 as the first stage to automate the installation of geckodriver in Cypress Docker images. This would be a good base to add documentation as it would simplify the description of what to do.

[MikeMcC399]

This is a draft of how it could be explained:

This is pending resolutions of issues:

• Add geckodriver to factory process cypress-docker-images#1351
• Add geckodriver to cypress/browsers and cypress/included cypress-docker-images#1354

[MikeMcC399]

• This issue was also reported in Missing X server or $DISPLAY cypress#31484 and it appears to be a CircleCI issue where a DISPLAY value is set without a corresponding X11 server being active.

[298:0530/145637.343053:ERROR:ozone_platform_x11.cc(240)] Missing X server or $DISPLAY
[298:0530/145637.343068:ERROR:env.cc(255)] The platform failed to initialize.  Exiting.
The Test Runner unexpectedly exited via a exit event with signal SIGSEGV