feat: ability to specify the default browser in cypress config #30517

alexsch01 · 2024-11-01T18:25:34Z

Closes Cannot specify the default running browser in cypress configuration file #6646

Additional details

Why was this change necessary?

I would like every cypress test I write to go against Chrome instead of Electron

What is affected by this change?

cypress config file option "defaultBrowser" will be used for this so it will have to be documented -
cypress-io/cypress-documentation#5991

putting in "defaultBrowser": "chrome" in the cypress config file will work the same way as "--browser chrome" in the CLI

Any implementation details to explain?

configDefaultBrowser gets the "defaultBrowser" attribute from the object created from the cypress config file

The browser option in the cypress configuration file is only used if configDefaultBrowser exists and if '--browser' / '-b' is not part of the CLI args list.

Steps to test

In a Cypress project, put defaultBrowser: "chrome" in their cypress config file
npx cypress run
Notice how it launches Google Chrome
In a Cypress project, remove defaultBrowser: "chrome" from their cypress config file
npx cypress run
Notice how it launches Electron

How has the user experience changed?

User can pass in defaultBrowser: "BROWSER" to their cypress config file and they won't need to pass in --browser BROWSER to launch BROWSER

User can still pass in --browser electron to open the Electron browser if cypress config file has the option defaultBrowser set

PR Tasks

Have tests been added/updated?
Has a PR for user-facing changes been opened in cypress-documentation?
Have API changes been updated in the type definitions?

cypress-app-bot · 2024-11-01T18:25:49Z

Create a Draft Pull Request if your PR is not ready for review. Mark the PR as Ready for Review when you're ready for a Cypress team member to review the PR.

* Update coreDataShape.ts * Update ProjectLifecycleManager.ts

* Update modeOptions.ts * Update index.ts * Update ProjectLifecycleManager.ts

alexsch01 · 2024-11-03T18:40:24Z

@jennifer-shehane can you review this? I have simplified the implementation as much as I can. It is still using defaultBrowser as the option since Cypress internally already uses the browser option for something else

After you review it, I'll make a PR for the cypress-documentation repo

alexsch01 · 2024-11-04T21:37:46Z

run-webpack-dev-server-integration-tests
seems unrelated to my change

driver-integration-tests-webkit
unsure if this PR changes this behavior

* oops * oops

alexsch01 · 2024-11-05T17:38:52Z

@jennifer-shehane can you allow the contributor-pr to run? weird why it needs approval when you did the commit

alexsch01 · 2024-11-06T13:20:57Z

I just fixed the system-test for defaultBrowser, ran the test successfully locally

mschile · 2024-11-06T17:27:13Z

Hi @alexsch01 👋, thanks for this contribution! I approved the contributor-pr in circleci to kick off the rest of the workflow. It appears there are some unit tests that need to be updated to account for the new config value.

alexsch01 · 2024-11-06T18:01:16Z

driver-integration-tests-electron (2718711) - cypress-io/cypress
doesn't seem related

mschile · 2024-11-06T18:36:36Z

driver-integration-tests-electron (2718711) - cypress-io/cypress doesn't seem related

Yeah, don't worry about that one but the other ones appear to be related.

* make test run with all versions of system-tests * Update index.spec.ts.js * Update index.spec.ts.js * Update utils.spec.ts * Update results_spec.ts.js

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

packages/data-context/test/unit/data/ProjectLifecycleManager.spec.ts

alexsch01 · 2024-11-13T16:01:53Z

`unit-tests`

lerna ERR! yarn test exited 1 in '@packages/https-proxy'

Not related to my changes

alexsch01 · 2024-11-14T00:34:24Z

run-app-integration-tests-chrome

mschile · 2024-11-14T01:29:40Z

I'll take a look.

alexsch01 · 2024-11-14T11:56:22Z

FYI: I updated isBrowserGivenByCli so it gets set regardless of which mode you are in

packages/server/lib/modes/index.ts

alexsch01 · 2024-11-14T16:22:31Z

system-tests-chrome
don't believe it is related to this PR

alexsch01 · 2024-11-14T17:30:38Z

Thanks for re-running, all tests passed!

mschile · 2024-11-14T19:50:47Z

@alexsch01, thanks again for the contribution! 🎉

alexsch01 · 2024-11-15T12:08:05Z

I tested the beta build for this PR and it works great!

cypress-bot · 2024-11-19T20:08:36Z

Released in 13.16.0.

This comment thread has been locked. If you are still experiencing this issue after upgrading to
Cypress v13.16.0, please open a new issue.

feat: ability to specify the default browser in cypress config file

44e0c99

alexsch01 mentioned this pull request Nov 1, 2024

moved #27911

Closed

alexsch01 added 10 commits November 1, 2024 14:48

don't need setActiveBrowserByNameOrPath for run mode

24e3dda

restore readonly on attribute

f8789ab

simplify cypress open version

2f82876

put isBrowserGivenByCli on modeOptions (#4)

11bd244

* Update coreDataShape.ts * Update ProjectLifecycleManager.ts

Update cypress.d.ts

c1fc1b2

use isBrowserGivenByCli only for run mode (#5)

66d26b1

* Update modeOptions.ts * Update index.ts * Update ProjectLifecycleManager.ts

make defaultBrowser more conformant

d4a68ba

Update CHANGELOG.md

8028e51

Update CHANGELOG.md

77ffd7a

Update CHANGELOG.md

5d6202d

jennifer-shehane assigned alexsch01 Nov 4, 2024

Merge branch 'develop' into defaultBrowser-config

17c40b3

oops (#6)

d036d96

* oops * oops

mschile requested review from mschile and cacieprins November 5, 2024 17:04

Merge branch 'develop' into defaultBrowser-config

08fb3a3

changes (#7)

7aaf2a9

more test fixes (#8)

b7cb459

* make test run with all versions of system-tests * Update index.spec.ts.js * Update index.spec.ts.js * Update utils.spec.ts * Update results_spec.ts.js

alexsch01 requested review from brian-mann and jennifer-shehane as code owners November 6, 2024 18:58

mschile reviewed Nov 12, 2024

View reviewed changes

packages/data-context/src/data/ProjectLifecycleManager.ts Outdated Show resolved Hide resolved

mschile reviewed Nov 12, 2024

View reviewed changes

packages/data-context/test/unit/data/ProjectLifecycleManager.spec.ts Outdated Show resolved Hide resolved

alexsch01 added 6 commits November 12, 2024 17:44

hopefully fix lint, add to test

e3c754d

Update ProjectLifecycleManager.spec.ts

f550b4c

Update ProjectLifecycleManager.spec.ts

75c30d2

Update ProjectLifecycleManager.spec.ts

337bfb5

more accurate

d6f72b6

Update CHANGELOG.md

3371d54

alexsch01 requested a review from mschile November 13, 2024 16:02

alexsch01 changed the title ~~feat: ability to specify the default browser in cypress config file~~ feat: ability to specify the default browser in cypress config Nov 13, 2024

mschile and others added 3 commits November 13, 2024 14:53

pr updates

92fc352

Merge branch 'develop' into defaultBrowser-config

6b8fad3

a few more updates

c859819

mschile approved these changes Nov 13, 2024

View reviewed changes

mschile and others added 2 commits November 13, 2024 19:36

fix cy-in-cy tests

959efeb

can once again pass --browser CLI in open mode

3d5cd9d

Update CHANGELOG.md

1bed710

cacieprins approved these changes Nov 14, 2024

View reviewed changes

mschile merged commit 82f45c5 into cypress-io:develop Nov 14, 2024
69 checks passed

cypress-bot bot locked as resolved and limited conversation to collaborators Nov 19, 2024

alexsch01 deleted the defaultBrowser-config branch November 21, 2024 11:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: ability to specify the default browser in cypress config #30517

feat: ability to specify the default browser in cypress config #30517

alexsch01 commented Nov 1, 2024 •

edited

Loading

cypress-app-bot commented Nov 1, 2024

alexsch01 commented Nov 3, 2024 •

edited

Loading

alexsch01 commented Nov 4, 2024 •

edited

Loading

alexsch01 commented Nov 5, 2024 •

edited

Loading

alexsch01 commented Nov 6, 2024 •

edited

Loading

mschile commented Nov 6, 2024

alexsch01 commented Nov 6, 2024

mschile commented Nov 6, 2024

alexsch01 commented Nov 13, 2024

alexsch01 commented Nov 14, 2024

mschile commented Nov 14, 2024

alexsch01 commented Nov 14, 2024 •

edited

Loading

alexsch01 commented Nov 14, 2024

alexsch01 commented Nov 14, 2024

mschile commented Nov 14, 2024

alexsch01 commented Nov 15, 2024

cypress-bot bot commented Nov 19, 2024

feat: ability to specify the default browser in cypress config #30517

feat: ability to specify the default browser in cypress config #30517

Conversation

alexsch01 commented Nov 1, 2024 • edited Loading

Additional details

Steps to test

How has the user experience changed?

PR Tasks

cypress-app-bot commented Nov 1, 2024

alexsch01 commented Nov 3, 2024 • edited Loading

alexsch01 commented Nov 4, 2024 • edited Loading

alexsch01 commented Nov 5, 2024 • edited Loading

alexsch01 commented Nov 6, 2024 • edited Loading

mschile commented Nov 6, 2024

alexsch01 commented Nov 6, 2024

mschile commented Nov 6, 2024

alexsch01 commented Nov 13, 2024

unit-tests

alexsch01 commented Nov 14, 2024

mschile commented Nov 14, 2024

alexsch01 commented Nov 14, 2024 • edited Loading

alexsch01 commented Nov 14, 2024

alexsch01 commented Nov 14, 2024

mschile commented Nov 14, 2024

alexsch01 commented Nov 15, 2024

cypress-bot bot commented Nov 19, 2024

alexsch01 commented Nov 1, 2024 •

edited

Loading

alexsch01 commented Nov 3, 2024 •

edited

Loading

alexsch01 commented Nov 4, 2024 •

edited

Loading

alexsch01 commented Nov 5, 2024 •

edited

Loading

alexsch01 commented Nov 6, 2024 •

edited

Loading

`unit-tests`

alexsch01 commented Nov 14, 2024 •

edited

Loading