cypress-io · mschile · Nov 14, 2024 · Nov 1, 2024 · Nov 1, 2024 · Nov 1, 2024
diff --git a/cli/CHANGELOG.md b/cli/CHANGELOG.md
@@ -3,6 +3,10 @@
 
 _Released 11/5/2024 (PENDING)_
 
+**Features:**
+
+- Added new [`defaultBrowser`](https://docs.cypress.io/app/references/configuration) configuration option to specify the default browser to launch. Addresses [#6646](https://github.com/cypress-io/cypress/issues/6646).
+
 **Bugfixes:**
 
 - Fixed an issue where the Cypress runner could hang in `after` or `afterEach` hooks that run Cypress commands after a page load timeout error occurs. Addresses [#30238](https://github.com/cypress-io/cypress/issues/30238).

diff --git a/cli/types/cypress.d.ts b/cli/types/cypress.d.ts
@@ -3216,6 +3216,11 @@ declare namespace Cypress {
     setupNodeEvents: (on: PluginEvents, config: PluginConfigOptions) => Promise<PluginConfigOptions | void> | PluginConfigOptions | void
 
     indexHtmlFile: string
+
+    /**
+     * The default browser to launch if the "--browser" command line option is not provided.
+     */
+    defaultBrowser: string
   }
 
   interface EndToEndConfigOptions extends Omit<CoreConfigOptions, 'indexHtmlFile'> {

diff --git a/packages/config/__snapshots__/index.spec.ts.js b/packages/config/__snapshots__/index.spec.ts.js
@@ -26,6 +26,7 @@ exports['config/src/index .getDefaultValues returns list of public config keys 1
     'specPattern': '**/*.cy.{js,jsx,ts,tsx}',
     'indexHtmlFile': 'cypress/support/component-index.html',
   },
+  'defaultBrowser': null,
   'defaultCommandTimeout': 4000,
   'downloadsFolder': 'cypress/downloads',
   'e2e': {
@@ -117,6 +118,7 @@ exports['config/src/index .getDefaultValues returns list of public config keys f
     'specPattern': '**/*.cy.{js,jsx,ts,tsx}',
     'indexHtmlFile': 'cypress/support/component-index.html',
   },
+  'defaultBrowser': null,
   'defaultCommandTimeout': 4000,
   'downloadsFolder': 'cypress/downloads',
   'e2e': {
@@ -206,6 +208,7 @@ exports['config/src/index .getPublicConfigKeys returns list of public config key
   'chromeWebSecurity',
   'clientCertificates',
   'component',
+  'defaultBrowser',
   'defaultCommandTimeout',
   'downloadsFolder',
   'e2e',

diff --git a/packages/config/src/options.ts b/packages/config/src/options.ts
@@ -169,6 +169,10 @@ const driverConfigOptions: Array<DriverConfigOption> = [
       indexHtmlFile: 'cypress/support/component-index.html',
     },
     validation: isValidConfig,
+  }, {
+    name: 'defaultBrowser',
+    defaultValue: null,
+    validation: validate.isString,
   }, {
     name: 'defaultCommandTimeout',
     defaultValue: 4000,

diff --git a/packages/config/test/project/utils.spec.ts b/packages/config/test/project/utils.spec.ts
@@ -1054,6 +1054,7 @@ describe('config/src/project/utils', () => {
             browsers: { value: [], from: 'default' },
             chromeWebSecurity: { value: true, from: 'default' },
             clientCertificates: { value: [], from: 'default' },
+            defaultBrowser: { value: null, from: 'default' },
             defaultCommandTimeout: { value: 4000, from: 'default' },
             downloadsFolder: { value: 'cypress/downloads', from: 'default' },
             env: {},
@@ -1152,6 +1153,7 @@ describe('config/src/project/utils', () => {
             browsers: { value: [], from: 'default' },
             chromeWebSecurity: { value: true, from: 'default' },
             clientCertificates: { value: [], from: 'default' },
+            defaultBrowser: { value: null, from: 'default' },
             defaultCommandTimeout: { value: 4000, from: 'default' },
             downloadsFolder: { value: 'cypress/downloads', from: 'default' },
             execTimeout: { value: 60000, from: 'default' },

diff --git a/packages/data-context/src/DataContext.ts b/packages/data-context/src/DataContext.ts
@@ -425,4 +425,12 @@ export class DataContext {
       this.#awaitingEmptyRequestCount.push(resolve)
     })
   }
+
+  updateCliBrowser (browser: string) {
+    // in open mode, prevent cliBrowser from being changed after browser is opened
+    if (this.isRunMode || !this.coreData.cliBrowser) {
+      (this._modeOptions as Partial<AllModeOptions>).browser = browser
+      this.coreData.cliBrowser = browser
+    }
+  }
 }
diff --git a/packages/data-context/src/data/ProjectLifecycleManager.ts b/packages/data-context/src/data/ProjectLifecycleManager.ts
@@ -308,10 +308,20 @@ export class ProjectLifecycleManager {
   /**
    * Sets the initial `activeBrowser` depending on these criteria, in order of preference:
    *  1. The value of `--browser` passed via CLI.
-   *  2. The last browser selected in `open` mode (by name and channel) for this project.
-   *  3. The first browser found.
+   *  2. The value of `defaultBrowser` in `cypress.config`.
+   *  3. The last browser selected in `open` mode (by name and channel) for this project.
+   *  4. The first browser found.
    */
   async setInitialActiveBrowser () {
+    const configBrowser = this.loadedFullConfig?.defaultBrowser
+
+    // if we have a defaultBrowser from the config and a CLI browser wasn't passed,
+    // update the cliBrowser to the defaultBrowser from the config
+    // since we want the defaultBrowser to behave as if it was passed via CLI
+    if (configBrowser && !this.ctx.modeOptions.isBrowserGivenByCli) {
+      this.ctx.updateCliBrowser(configBrowser)
+    }
+
     if (this.ctx.coreData.cliBrowser) {
       await this.setActiveBrowserByNameOrPath(this.ctx.coreData.cliBrowser)
 

diff --git a/packages/server/lib/modes/index.ts b/packages/server/lib/modes/index.ts
@@ -18,6 +18,7 @@ export = (mode, options) => {
       quiet: false,
       morgan: false,
       report: true,
+      isBrowserGivenByCli: options.browser !== undefined,
     })
   }
 

diff --git a/packages/types/src/modeOptions.ts b/packages/types/src/modeOptions.ts
@@ -24,6 +24,7 @@ export interface RunModeOptions extends CommonModeOptions {
   parallel?: boolean | null
   ciBuildId?: string | null
   tag?: (string)[] | null
+  isBrowserGivenByCli: boolean
 }
 
 export type TestingType = 'e2e' | 'component'

@@ -16,6 +16,7 @@ exports['module api and after:run results'] = `
     "blockHosts": null,
     "chromeWebSecurity": true,
     "clientCertificates": [],
+    "defaultBrowser": null,
     "defaultCommandTimeout": 4000,
     "downloadsFolder": "/path/to/downloadsFolder",
     "env": {},

diff --git a/system-tests/projects/config-defaultBrowser/cypress.config.js b/system-tests/projects/config-defaultBrowser/cypress.config.js
@@ -0,0 +1,6 @@
+module.exports = {
+  e2e: {
+    supportFile: false,
+  },
+  defaultBrowser: 'chrome',
+}
diff --git a/system-tests/projects/config-defaultBrowser/cypress/e2e/spec.cy.js b/system-tests/projects/config-defaultBrowser/cypress/e2e/spec.cy.js
@@ -0,0 +1,3 @@
+it('works', () => {
+  expect(1).to.eq(1)
+})
diff --git a/system-tests/test/config_spec.js b/system-tests/test/config_spec.js
@@ -243,4 +243,17 @@ describe('e2e config', () => {
       snapshot: true,
     })
   })
+
+  it('launches browser using config.defaultBrowser', async function () {
+    await Fixtures.scaffoldProject('config-defaultBrowser')
+
+    return systemTests.exec(this, {
+      project: 'config-defaultBrowser',
+      command: 'cypress',
+      args: ['run', '--dev', '--project', path.resolve(process.cwd(), './projects/config-defaultBrowser')],
+      onStdout: (stdout) => {
+        expect(stdout).to.include('Browser:        Chrome')
+      },
+    })
+  })
 })