chore: Upgrade Cypress from v9 to v12 #37810
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gatsbot
bot
added
the
status: triage needed
LekoArts
added
topic: automation
pieh
previously approved these changes
Mar 30, 2023
LekoArts
commented
Apr 5, 2023
| @@ -1,5 +1,3 @@ | |||
| import { parseSrcset } from "srcset" | |||
LekoArts
commented
Apr 5, 2023
| @@ -19,13 +19,15 @@ | |||
| }, | |||
| "devDependencies": { | |||
| "@cypress/snapshot": "^2.1.7", | |||
| "@simonsmith/cypress-image-snapshot": "^6.0.1", | |||
There was a problem hiding this comment.
cypress-image-snapshot doesn't work with Cypress 12 and this is a fork
LekoArts
commented
Apr 5, 2023
| @@ -39,8 +41,8 @@ | |||
| "test": "cross-env CYPRESS_SUPPORT=y npm run build && npm run start-server-and-test", | |||
| "start-server-and-test": "start-server-and-test serve http://localhost:9000 cy:run", | |||
| "serve": "gatsby serve", | |||
| "cy:open": "cypress open", | |||
| "cy:run": "node ../../scripts/cypress-run-with-conditional-record-flag.js --browser chrome" | |||
| "cy:open": "cypress open --browser chrome --e2e", | |||
There was a problem hiding this comment.
Cypress now also has component testing so this tells it to directly open the e2e test suite with the chrome browser
LekoArts
commented
Apr 5, 2023
| @@ -27,15 +27,18 @@ after(() => { | |||
| const errorPlaceholder = `false` | |||
| const errorReplacement = `true` | |||
|
|
|||
| describe(`testing error overlay and ability to automatically recover runtime errors cause by content changes (page queries variant)`, () => { | |||
| it(`displays content initially (no errors yet)`, () => { | |||
| describe(`testing error overlay and ability to automatically recover runtime errors cause by content changes (page queries variant)`, { testIsolation: false } , () => { | |||
There was a problem hiding this comment.
New default in Cypress 12 is test isolation but these tests kinda rely on them so we opt-out
LekoArts
commented
Apr 5, 2023
| it(`plain less`, () => { | ||
| // we don't want to visit page for each test - we want to visit once and then test HMR | ||
| cy.window().then(win => { | ||
| cy.spy(win.console, `log`).as(`hmrConsoleLog`) |
There was a problem hiding this comment.
This is already getting set inside the support/e2e.ts file with the
Cypress.Commands.overwrite("visit")
overwrite
LekoArts
commented
Apr 5, 2023
| window.notReloaded = true | ||
| window.___navigate(`/deep-link-page/`) | ||
| }) | ||
| // just setting some property on the window |
There was a problem hiding this comment.
Adjusted from https://glebbahmutov.com/blog/detect-page-reload/
LekoArts
commented
Apr 5, 2023
| @@ -15,7 +15,7 @@ describe(`Production build tests`, () => { | |||
|
|
|||
| // we expect 2 `componentDidMount` calls - 1 for initial page and 1 for second page | |||
| cy.lifecycleCallCount(`componentDidMount`).should(`equal`, 2) | |||
| cy.lifecycleCallCount(`render`).should(`equal`, Cypress.env(`TEST_PLUGIN_OFFLINE`) ? 3 : 2) | |||
| cy.lifecycleCallCount(`render`).should(`equal`, 2) | |||
LekoArts
commented
Apr 5, 2023
There was a problem hiding this comment.
The paths for the snapshots changed. You can check the E2E test to compare the paths it generates now to this
LekoArts
commented
Apr 5, 2023
| @@ -10,8 +10,7 @@ const IS_CI = !!( | |||
| false | |||
| ) | |||
|
|
|||
| const shouldRecord = | |||
| !!process.env.CYPRESS_PROJECT_ID && !!process.env.CYPRESS_RECORD_KEY && IS_CI | |||
| const shouldRecord = !!process.env.CYPRESS_RECORD_KEY && IS_CI | |||
There was a problem hiding this comment.
projectId is now mostly in the config file itself, so this had to go
LekoArts
commented
Apr 5, 2023
| @@ -22,6 +21,10 @@ const cypressArgs = [`run`, ...process.argv.slice(2)] | |||
|
|
|||
| if (shouldRecord) { | |||
| cypressArgs.push(`--record`) | |||
|
|
|||
| if (process.env.CYPRESS_GROUP_NAME) { | |||
| cypressArgs.push(`--group`, process.env.CYPRESS_GROUP_NAME) | |||
There was a problem hiding this comment.
--group alone fails if --record is not also given
pieh
approved these changes
Apr 6, 2023
This was referenced May 13, 2024
This was referenced May 13, 2024
This was referenced May 14, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This updates our E2E tests from Cypress v9 to v12. Migration guide: https://docs.cypress.io/guides/references/migration-guide
I did also do some other following changes while at it:
start-server-and-testto v2 (no breaking changes for us)cypress-image-snapshotto@simonsmith/cypress-image-snapshotbecause the former isn't compatible with Cypress v12Tests
All tests should still run fully and pass.