misc: replace marionette-client with geckodriver as b2g marionette cl…

…ient is no longer supported (#30250) * misc: replace marionette-client with geckodriver as b2g marionette client is no longer supported [run ci] * install pump [run ci] * refactor to have geckodriver launch the browser and split out webdriver to own class [run ci] fix other failing tests [run ci] fix other failing tests [run ci] pass env variables to firefox * fix sigkill / treekill issues on windows with firefox binary being a dangling process [run ci] * fix issue where browser in headed mode was not starting maximized [run ci] * stub firefox_spec added deps different to get type inference * add comment to geckodriver patch * move capabilities to verbose debug statement * update changelog * address comments from code review * add pending for changelog * update with suggestions from code review * remove debug enable as the process needs to be bound to stderr and stdout * add comment on why we need to bind * add comments from code review * address comments from code review * make sure sessionId is set
cypress-io · Sep 30, 2024 · af3839d · af3839d · cypress-bot · Sep 30, 2024
1 parent 80e70b8
commit af3839d
Show file tree

Hide file tree

Showing 29 changed files with 1,888 additions and 534 deletions.
diff --git a/.circleci/cache-version.txt b/.circleci/cache-version.txt
@@ -1,3 +1,3 @@
 # Bump this version to force CI to re-create the cache from scratch.
 
-09-12-24
+09-24-24
diff --git a/.circleci/workflows.yml b/.circleci/workflows.yml
@@ -30,7 +30,7 @@ mainBuildFilters: &mainBuildFilters
         - /^release\/\d+\.\d+\.\d+$/
         # use the following branch as well to ensure that v8 snapshot cache updates are fully tested
         - 'update-v8-snapshot-cache-on-develop'
-        - 'ryanm/chore/fix-full-snapshot'
+        - 'misc/remove_marionette_for_geckodriver'
         - 'publish-binary'
 
 # usually we don't build Mac app - it takes a long time
@@ -42,7 +42,7 @@ macWorkflowFilters: &darwin-workflow-filters
     - equal: [ develop, << pipeline.git.branch >> ]
     # use the following branch as well to ensure that v8 snapshot cache updates are fully tested
     - equal: [ 'update-v8-snapshot-cache-on-develop', << pipeline.git.branch >> ]
-    - equal: [ 'ryanm/chore/fix-full-snapshot', << pipeline.git.branch >> ]
+    - equal: [ 'misc/remove_marionette_for_geckodriver', << pipeline.git.branch >> ]
     - matches:
         pattern: /^release\/\d+\.\d+\.\d+$/
         value: << pipeline.git.branch >>
@@ -53,7 +53,7 @@ linuxArm64WorkflowFilters: &linux-arm64-workflow-filters
     - equal: [ develop, << pipeline.git.branch >> ]
     # use the following branch as well to ensure that v8 snapshot cache updates are fully tested
     - equal: [ 'update-v8-snapshot-cache-on-develop', << pipeline.git.branch >> ]
-    - equal: [ 'ryanm/chore/fix-full-snapshot', << pipeline.git.branch >> ]
+    - equal: [ 'misc/remove_marionette_for_geckodriver', << pipeline.git.branch >> ]
     - matches:
         pattern: /^release\/\d+\.\d+\.\d+$/
         value: << pipeline.git.branch >>
@@ -76,7 +76,7 @@ windowsWorkflowFilters: &windows-workflow-filters
     - equal: [ develop, << pipeline.git.branch >> ]
     # use the following branch as well to ensure that v8 snapshot cache updates are fully tested
     - equal: [ 'update-v8-snapshot-cache-on-develop', << pipeline.git.branch >> ]
-    - equal: [ 'ryanm/chore/fix-full-snapshot', << pipeline.git.branch >> ]
+    - equal: [ 'misc/remove_marionette_for_geckodriver', << pipeline.git.branch >> ]
     - matches:
         pattern: /^release\/\d+\.\d+\.\d+$/
         value: << pipeline.git.branch >>
@@ -152,7 +152,7 @@ commands:
           name: Set environment variable to determine whether or not to persist artifacts
           command: |
             echo "Setting SHOULD_PERSIST_ARTIFACTS variable"
-            echo 'if ! [[ "$CIRCLE_BRANCH" != "develop" && "$CIRCLE_BRANCH" != "release/"* && "$CIRCLE_BRANCH" != "ryanm/chore/fix-full-snapshot" ]]; then
+            echo 'if ! [[ "$CIRCLE_BRANCH" != "develop" && "$CIRCLE_BRANCH" != "release/"* && "$CIRCLE_BRANCH" != "misc/remove_marionette_for_geckodriver" ]]; then
                 export SHOULD_PERSIST_ARTIFACTS=true
             fi' >> "$BASH_ENV"
   # You must run `setup_should_persist_artifacts` command and be using bash before running this command

diff --git a/cli/CHANGELOG.md b/cli/CHANGELOG.md
@@ -1,4 +1,12 @@
 <!-- See the ../guides/writing-the-cypress-changelog.md for details on writing the changelog. -->
+## 13.15.1
+
+_Released 10/1/2024 (PENDING)_
+
+**Misc:**
+
+- Cypress now consumes [geckodriver](https://firefox-source-docs.mozilla.org/testing/geckodriver/index.html) to help automate the Firefox browser instead of [marionette-client](https://github.com/cypress-io/marionette-client). Addresses [#30217](https://github.com/cypress-io/cypress/issues/30217).
+
 ## 13.15.0
 
 _Released 9/25/2024_

diff --git a/cli/lib/exec/spawn.js b/cli/lib/exec/spawn.js
@@ -11,6 +11,7 @@ const state = require('../tasks/state')
 const xvfb = require('./xvfb')
 const verify = require('../tasks/verify')
 const errors = require('../errors')
+const readline = require('readline')
 
 const isXlibOrLibudevRe = /^(?:Xlib|libudev)/
 const isHighSierraWarningRe = /\*\*\* WARNING/
@@ -236,6 +237,21 @@ module.exports = {
         child.on('exit', resolveOn('exit'))
         child.on('error', reject)
 
+        if (isPlatform('win32')) {
+          const rl = readline.createInterface({
+            input: process.stdin,
+            output: process.stdout,
+          })
+
+          // on windows, SIGINT does not propagate to the child process when ctrl+c is pressed
+          // this makes sure all nested processes are closed(ex: firefox inside the server)
+          rl.on('SIGINT', function () {
+            let kill = require('tree-kill')
+
+            kill(child.pid, 'SIGINT')
+          })
+        }
+
         // if stdio options is set to 'pipe', then
         //   we should set up pipes:
         //  process STDIN (read stream) => child STDIN (writeable)

diff --git a/cli/package.json b/cli/package.json
@@ -60,6 +60,7 @@
     "semver": "^7.5.3",
     "supports-color": "^8.1.1",
     "tmp": "~0.2.3",
+    "tree-kill": "1.2.2",
     "untildify": "^4.0.0",
     "yauzl": "^2.10.0"
   },

diff --git a/cli/test/lib/exec/spawn_spec.js b/cli/test/lib/exec/spawn_spec.js
@@ -7,6 +7,9 @@ const tty = require('tty')
 const path = require('path')
 const EE = require('events')
 const mockedEnv = require('mocked-env')
+const readline = require('readline')
+const proxyquire = require('proxyquire')
+
 const debug = require('debug')('test')
 
 const state = require(`${lib}/tasks/state`)
@@ -22,6 +25,7 @@ const execPath = process.execPath
 const nodeVersion = process.versions.node
 
 const defaultBinaryDir = '/default/binary/dir'
+let mockReadlineEE
 
 describe('lib/exec/spawn', function () {
   beforeEach(function () {
@@ -49,8 +53,11 @@ describe('lib/exec/spawn', function () {
 
     // process.stdin is both an event emitter and a readable stream
     this.processStdin = new EE()
+    mockReadlineEE = new EE()
+
     this.processStdin.pipe = sinon.stub().returns(undefined)
     sinon.stub(process, 'stdin').value(this.processStdin)
+    sinon.stub(readline, 'createInterface').returns(mockReadlineEE)
     sinon.stub(cp, 'spawn').returns(this.spawnedProcess)
     sinon.stub(xvfb, 'start').resolves()
     sinon.stub(xvfb, 'stop').resolves()
@@ -387,6 +394,22 @@ describe('lib/exec/spawn', function () {
       })
     })
 
+    it('propagates treeKill if SIGINT is detected in windows console', async function () {
+      this.spawnedProcess.pid = 7
+      this.spawnedProcess.on.withArgs('close').yieldsAsync(0)
+
+      os.platform.returns('win32')
+
+      const treeKillMock = sinon.stub().returns(0)
+
+      const spawn = proxyquire(`${lib}/exec/spawn`, { 'tree-kill': treeKillMock })
+
+      await spawn.start([], { env: {} })
+
+      mockReadlineEE.emit('SIGINT')
+      expect(treeKillMock).to.have.been.calledWith(7, 'SIGINT')
+    })
+
     it('does not set windowsHide property when in darwin', function () {
       this.spawnedProcess.on.withArgs('close').yieldsAsync(0)
 

diff --git a/...ot-html__/FIREFOX_MARIONETTE_FAILURE.html → ...t-html__/FIREFOX_GECKODRIVER_FAILURE.html b/...ot-html__/FIREFOX_MARIONETTE_FAILURE.html → ...t-html__/FIREFOX_GECKODRIVER_FAILURE.html
diff --git a/packages/errors/src/errors.ts b/packages/errors/src/errors.ts
@@ -1218,11 +1218,11 @@ export const AllCypressErrors = {
 
         The error was: ${fmt.highlightSecondary(errMsg)}`
   },
-  FIREFOX_MARIONETTE_FAILURE: (origin: string, err: Error) => {
+  FIREFOX_GECKODRIVER_FAILURE: (origin: string, err: Error) => {
     return errTemplate`\
         Cypress could not connect to Firefox.
 
-        An unexpected error was received from Marionette: ${fmt.highlightSecondary(origin)}
+        An unexpected error was received from GeckoDriver: ${fmt.highlightSecondary(origin)}
 
         To avoid this error, ensure that there are no other instances of Firefox launched by Cypress running.
 

diff --git a/packages/errors/test/unit/visualSnapshotErrors_spec.ts b/packages/errors/test/unit/visualSnapshotErrors_spec.ts
@@ -1134,7 +1134,7 @@ describe('visual error templates', () => {
         default: ['spec', '1', 'spec must be a string or comma-separated list'],
       }
     },
-    FIREFOX_MARIONETTE_FAILURE: () => {
+    FIREFOX_GECKODRIVER_FAILURE: () => {
       const err = makeErr()
 
       return {

diff --git a/packages/graphql/schemas/schema.graphql b/packages/graphql/schemas/schema.graphql
@@ -1203,7 +1203,7 @@ enum ErrorTypeEnum {
   EXTENSION_NOT_LOADED
   FIREFOX_COULD_NOT_CONNECT
   FIREFOX_GC_INTERVAL_REMOVED
-  FIREFOX_MARIONETTE_FAILURE
+  FIREFOX_GECKODRIVER_FAILURE
   FIXTURE_NOT_FOUND
   FOLDER_NOT_WRITABLE
   FREE_PLAN_EXCEEDS_MONTHLY_PRIVATE_TESTS

diff --git a/packages/launcher/lib/browsers.ts b/packages/launcher/lib/browsers.ts
@@ -9,6 +9,7 @@ export const debug = Debug('cypress:launcher:browsers')
 /** starts a found browser and opens URL if given one */
 export type LaunchedBrowser = cp.ChildProcessByStdio<null, Readable, Readable>
 
+// NOTE: For Firefox, geckodriver is used to launch the browser
 export function launch (
   browser: FoundBrowser,
   url: string,
@@ -28,7 +29,7 @@ export function launch (
 
   const spawnOpts: cp.SpawnOptionsWithStdioTuple<cp.StdioNull, cp.StdioPipe, cp.StdioPipe> = {
     stdio: ['ignore', 'pipe', 'pipe'],
-    // allow setting default env vars such as MOZ_HEADLESS_WIDTH
+    // allow setting default env vars
     // but only if it's not already set by the environment
     env: { ...browserEnv, ...process.env },
   }

diff --git a/packages/server/lib/browsers/browser-cri-client.ts b/packages/server/lib/browsers/browser-cri-client.ts
@@ -216,7 +216,7 @@ export class BrowserCriClient {
    *
    * @param {BrowserCriClientCreateOptions} options the options for creating the browser cri client
    * @param options.browserName the display name of the browser being launched
-   * @param options.fullyManageTabs whether or not to fully manage tabs. This is useful for firefox where some work is done with marionette and some with CDP. We don't want to handle disconnections in this class in those scenarios
+   * @param options.fullyManageTabs whether or not to fully manage tabs. This is useful for firefox where some work is done with GeckoDriver and some with CDP. We don't want to handle disconnections in this class in those scenarios
    * @param options.hosts the hosts to which to attempt to connect
    * @param options.onAsynchronousError callback for any cdp fatal errors
    * @param options.onReconnect callback for when the browser cri client reconnects to the browser