moved to #27911

cli/CHANGELOG.md

@@ -1,4 +1,13 @@
 <!-- See the ../guides/writing-the-cypress-changelog.md for details on writing the changelog. -->
+
+## 12.18.0
+
+_Released 08/01/2024 (PENDING)_
+
+**Features:**
+
+- Added ability to specify the default running browser in cypress config. Addresses [#6646](https://github.com/cypress-io/cypress/issues/6646).
+
 ## 12.17.3
 
 _Released 08/01/2023_
@@ -11,6 +20,7 @@ _Released 08/01/2023_
 
 - Fixed an issue where unnecessary requests were being paused. No longer sends `X-Cypress-Is-XHR-Or-Fetch` header and infers resource type off of the server pre-request object. Fixes [#26620](https://github.com/cypress-io/cypress/issues/26620) and [#26622](https://github.com/cypress-io/cypress/issues/26622).
 
+
 ## 12.17.2
 
 _Released 07/20/2023_

cli/types/cypress.d.ts

@@ -3177,6 +3177,11 @@ declare namespace Cypress {
     setupNodeEvents: (on: PluginEvents, config: PluginConfigOptions) => Promise<PluginConfigOptions | void> | PluginConfigOptions | void
 
     indexHtmlFile: string
+
+    /**
+     * Set a default browser other than electron when user doesn't pass in "--browser".
+     */
+    browser: string
   }
 
   interface EndToEndConfigOptions extends Omit<CoreConfigOptions, 'indexHtmlFile'> {
@@ -3240,10 +3245,6 @@ declare namespace Cypress {
    * Optional options added before the server starts
    */
   interface RuntimeServerConfigOptions {
-    /**
-     * The browser Cypress is running on.
-     */
-    browser: Browser
     // Internal or Unlisted at server/lib/config_options
     autoOpen: boolean
     browserUrl: string

packages/data-context/src/data/ProjectLifecycleManager.ts

@@ -291,6 +291,22 @@ export class ProjectLifecycleManager {
    *  3. The first browser found.
    */
   async setInitialActiveBrowser () {
+    const configBrowser = this.loadedFullConfig?.browser
+
+    if (configBrowser && !this.ctx.coreData.isBrowserGivenByCLI) {
+      if (this.ctx.isRunMode) {
+        Object.defineProperty(this.ctx.modeOptions, 'browser', { value: configBrowser })
+      } else {
+        await this.setActiveBrowserByNameOrPath(configBrowser)
+
+        if (this.ctx.coreData.activeBrowser) {
+          await this.ctx.actions.project.launchProject(this.ctx.coreData.currentTestingType)
+        }
+      }
+
+      return
+    }
+
     if (this.ctx.coreData.cliBrowser) {
       await this.setActiveBrowserByNameOrPath(this.ctx.coreData.cliBrowser)
 

packages/data-context/src/data/coreDataShape.ts

@@ -127,6 +127,7 @@ interface CloudDataShape {
 
 export interface CoreDataShape {
   cliBrowser: string | null
+  isBrowserGivenByCLI: boolean
   cliTestingType: string | null
   activeBrowser: FoundBrowser | null
   machineId: Promise<string | null>
@@ -172,6 +173,7 @@ export function makeCoreData (modeOptions: Partial<AllModeOptions> = {}): CoreDa
   return {
     servers: {},
     cliBrowser: modeOptions.browser ?? null,
+    isBrowserGivenByCLI: modeOptions.isBrowserGivenByCLI ?? false,
     cliTestingType: modeOptions.testingType ?? null,
     machineId: machineId(),
     machineBrowsers: null,

packages/server/lib/modes/index.ts

@@ -10,6 +10,8 @@ export = (mode, options) => {
     return require('./smoke_test').run(options)
   }
 
+  options.isBrowserGivenByCLI = options.browser !== undefined
+
   if (mode === 'run') {
     _.defaults(options, {
       socketId: random.id(10),

packages/types/src/modeOptions.ts

@@ -1,6 +1,7 @@
 export interface CommonModeOptions {
   _?: (string | null)[] | null
   invokedFromCli: boolean
+  isBrowserGivenByCLI?: boolean
   userNodePath?: string
   userNodeVersion?: string
   configFile?: string | null

system-tests/projects/config-default-browser/cypress.config.js

@@ -0,0 +1,8 @@
+const { defineConfig } = require('cypress')
+
+module.exports = defineConfig({
+  e2e: {
+    browser: 'chrome',
+    supportFile: false,
+  },
+})

system-tests/projects/config-default-browser/cypress/e2e/spec.cy.js

@@ -0,0 +1,3 @@
+it('works', () => {
+  expect(1).to.eq(1)
+})

system-tests/projects/default-browser-config/cypress.config.js

@@ -0,0 +1,9 @@
+const { defineConfig } = require("cypress");
+
+module.exports = defineConfig({
+  e2e: {
+    supportFile: false,
+  },
+  video: false,
+  screenshotOnRunFailure: false,
+});

system-tests/projects/default-browser-config/cypress/e2e/spec.cy.js

@@ -0,0 +1,13 @@
+it("Test running without browser config option", () => {
+    cy.exec('cd default-browser-unset && npx cypress run --quiet').then((e) => {
+        expect(e.stdout).to.contain('electron')
+        expect(e.stdout).to.not.contain('chrome')
+    })
+})
+
+it("Test running with browser: 'chrome' config option", () => {
+    cy.exec('cd default-browser-chrome && npx cypress run --quiet').then((e) => {
+        expect(e.stdout).to.contain('chrome')
+        expect(e.stdout).to.not.contain('electron')
+    })
+})

system-tests/test/config_spec.js

@@ -244,4 +244,15 @@ describe('e2e config', () => {
       snapshot: true,
     })
   })
+
+  it('launches browser using config.browser', async function () {
+    await Fixtures.scaffoldProject('config-default-browser')
+
+    return systemTests.exec(this, {
+      project: 'config-default-browser',
+      onStdout: (stdout) => {
+        expect(stdout).to.include('Browser:    Chrome')
+      },
+    })
+  })
 })