fix: force gtk version 3 to avoid Electron 36 from crashing (#32372)

* Fix: force gtk version 3 to avoid https://www.electronjs.org/blog/electron-36-0\#behavior-changed-gtk-4-is-the-default-when-running-on-gnome

* Update cli/CHANGELOG.md

Co-authored-by: Mike McCready <[email protected]>

* add suggestions from code review

* empty

---------

Co-authored-by: Mike McCready <[email protected]>

Author: AtofStryker

.circleci/workflows.yml

@@ -38,7 +38,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'
-        - 'chore/updates_post_15'
+        - 'fix/set_fixed_gtk_version'
 
 # usually we don't build Mac app - it takes a long time
 # but sometimes we want to really confirm we are doing the right thing
@@ -49,7 +49,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: [ 'chore/updates_post_15', << pipeline.git.branch >> ]
+      - equal: [ 'fix/set_fixed_gtk_version', << pipeline.git.branch >> ]
       - matches:
           pattern: /^release\/\d+\.\d+\.\d+$/
           value: << pipeline.git.branch >>
@@ -60,7 +60,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: [ 'chore/updates_post_15', << pipeline.git.branch >> ]
+      - equal: [ 'fix/set_fixed_gtk_version', << pipeline.git.branch >> ]
       - matches:
           pattern: /^release\/\d+\.\d+\.\d+$/
           value: << pipeline.git.branch >>
@@ -83,7 +83,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: [ 'chore/updates_post_15', << pipeline.git.branch >> ]
+      - equal: [ 'fix/set_fixed_gtk_version', << pipeline.git.branch >> ]
       - matches:
           pattern: /^release\/\d+\.\d+\.\d+$/
           value: << pipeline.git.branch >>
@@ -157,7 +157,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" != "chore/updates_post_15" ]]; then
+            echo 'if ! [[ "$CIRCLE_BRANCH" != "develop" && "$CIRCLE_BRANCH" != "release/"* && "$CIRCLE_BRANCH" != "fix/set_fixed_gtk_version" ]]; 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

cli/CHANGELOG.md

@@ -10,6 +10,7 @@ _Released 08/26/2025 (PENDING)_
 **Bugfixes:**
 
 - Fixed an issue where OS distributions and releases were sometimes not properly populated for Module API results and Cloud recordings. Fixes [#30533](https://github.com/cypress-io/cypress/issues/30533). Addressed in [#32283](https://github.com/cypress-io/cypress/pull/32283).
+- Fixed an issue where Cypress would fail to run on GNOME if GTK 4 and GTK 2/3 were detected in the Electron process. Addresses [#32361](https://github.com/cypress-io/cypress/issues/32361).
 - Fixed an issue where the open Studio button would incorrectly show for component tests. Addressed in [#32315](https://github.com/cypress-io/cypress/pull/32315).
 - Fixed an issue where the TypeScript compiler wasn't being resolved correctly when `@cypress/webpack-batteries-included-preprocessor` was used as a standalone package. Fixes [#32338](https://github.com/cypress-io/cypress/issues/32338).
 

packages/server/lib/util/chromium_flags.ts

@@ -113,4 +113,10 @@ export const formatElectronFlags = (flags) => {
 
 export const DEFAULT_CHROME_FLAGS = formatChromeFlags(DEFAULT_FLAGS)
 
-export const DEFAULT_ELECTRON_FLAGS = formatElectronFlags(DEFAULT_CHROME_FLAGS)
+export const DEFAULT_ELECTRON_FLAGS = [
+  ...formatElectronFlags(DEFAULT_CHROME_FLAGS),
+  // NOTE: Can likely be removed with Electron upgrade to 37+.
+  // @see https://github.com/electron/electron/issues/46538
+  // @see https://github.com/cypress-io/cypress/issues/32361
+  ...formatElectronFlags(['--gtk-version=3']),
+]

packages/server/test/unit/environment_spec.js

@@ -44,6 +44,16 @@ describe('lib/environment', () => {
     return process.env['CYPRESS_INTERNAL_ENV'] = env
   })
 
+  // @see https://github.com/electron/electron/issues/46538
+  // @see https://github.com/cypress-io/cypress/issues/32361
+  context('sets gtk-version=3 in Electron >= 36', () => {
+    it('sets launch args', () => {
+      sinon.stub(app.commandLine, 'appendSwitch')
+      require(`../../lib/environment`)
+      expect(app.commandLine.appendSwitch).to.have.been.calledWith('--gtk-version', '3')
+    })
+  })
+
   context('parses ELECTRON_EXTRA_LAUNCH_ARGS', () => {
     let restore = null