fix: add baseUrl to TestConfigOverrides

[imadx]

• Closes Cypress.config('baseUrl', 'someUrl.com') after v10 upgrade #22374
• Closes Dynamically setting baseUrl with TestConfigOverrides #22072

User-facing changelog

Corrected the Typescript types to include baseUrl as a valid test config override option. Fixes #22374 and #22072.

Additional details

The documentation mentions that baseUrl is also configurable and can be changed at run time.
https://docs.cypress.io/guides/references/configuration#Test-Configuration

However, the types are missing baseUrl there for TestConfigOverrides.

Steps to test

Updating baseUrl in a test with Cypress.config("baseUrl", baseUrl); can be used to test the behaviour.

How has the user experience changed?

Before

After

There is no typescript warning

PR Tasks

• Have tests been added/updated?
• Has the original issue (or this PR, if no issue exists) been tagged with a release in ZenHub? (user-facing changes only)
• Has a PR for user-facing changes been opened in cypress-documentation?
• Have API changes been updated in the type definitions?

[cypress-bot]

Thanks for taking the time to open a PR!

• 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.
• Become familiar with the Code Review Checklist for guidelines on coding standards and what needs to be done before a PR can be merged.

[CLAassistant]

All committers have signed the CLA.

[lmiller1990]

Do we still get a warning if we do:

import { defineConfig } from 'cypress'

export default defineConfig({
  baseUrl: 'http://...'
})

This should be invalid. The valid way would be:

import { defineConfig } from 'cypress'

export default defineConfig({
  e2e: {
    baseUrl: 'http://...'
  }
})

It looks like this should still work as expected, just looking to clarify.

Also, this might fix #22072. If it's not too much extra work, could you see if this issue is fixed by your change? (and ideally add a test, if we haven't got one). This should work and be correctly typed, now, too:

it('something', { baseUrl: '...' }, () => {
  // ...
})

We have no way to know at compile time if the current test is e2e or component, so I think we just need to allow this.

[imadx]

@imiller thanks for checking!!

Do we still get a warning if we do:

import { defineConfig } from 'cypress'

export default defineConfig({
  baseUrl: 'http://...'
})

This should be invalid. The valid way would be:

import { defineConfig } from 'cypress'

export default defineConfig({
  e2e: {
    baseUrl: 'http://...'
  }
})

👇 This still warns as expected when trying to use baseUrl in the parent level

---

Also, this might fix #22072. If it's not too much extra work, could you see if this issue is fixed by your change? (and ideally add a test, if we haven't got one). This should work and be correctly typed, now, too:

it('something', { baseUrl: '...' }, () => {
  // ...
})

We have no way to know at compile time if the current test is e2e or component, so I think we just need to allow this.

There are existing .js tests for testconfigOverrides from the looks of it.
I just updated the typings-related tests here

Edit: fixed the links to the tests

[ryanthemanuel]

Looks good and does close #22072 as well. I added that to the description. Thanks for the PR!

[lmiller1990]

@imadx I will get this one merged up, thanks!

[lmiller1990]

I re-pushed the same commit and created a new CI run, and the failing tests are fine: https://github.com/cypress-io/cypress/compare/issue-22445-rerun

The fails here are some unrelated. I'm confident they are not related to this change, I am going to merge this.

[lmiller1990]

I am still finding out the problem with CI. Please wait a bit - I'm going to get this merged as soon as I find out why your branch fails, but my identical fork doesn't.

[imadx]

@lmiller1990, is it okay if I rebase from cypress-io:develop and push the changes?
There seem to be quite a few changes from several contributions there.

Or if you have a passing fork, I think it's okay if we can get that merged if someone is waiting on this.

[imadx]

I actually have the rebased changes here at #22532
Don't have permission though to get the tests to run from the looks of it.

[lmiller1990]

Thanks, I merged in develop that should have a fix that might help with the CI. Specifically this PR landed #22326. Let's see how it goes.

[cypress]

---

Test summary

4908 • 0 • 59 • 0 • 0

---

Run details

Project	cypress
Status	Passed
Commit	56d8d26
Started	Jun 28, 2022 12:28 AM
Ended	Jun 28, 2022 12:43 AM
Duration	15:01 💡
OS	Linux Debian - 10.11
Browser	Electron 100

View run in Cypress Dashboard ➡️

---

This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard

[lmiller1990]

We did it, it's passing. Let's merge.

[imadx]

Nice one. Thanks, @lmiller1990 for getting this through 🚀

[lmiller1990]

It should be out now in 10.3.0!