Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v12 Migration Guide #4862

Merged
merged 26 commits into from
Dec 2, 2022
Merged

v12 Migration Guide #4862

merged 26 commits into from
Dec 2, 2022

Conversation

emilyrohrbough
Copy link
Member

@emilyrohrbough emilyrohrbough commented Nov 15, 2022

@vercel
Copy link

vercel bot commented Nov 15, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
cypress-documentation ✅ Ready (Inspect) Visit Preview Dec 2, 2022 at 6:05PM (UTC)

@emilyrohrbough emilyrohrbough changed the title Remove pages and references to functionality obsoleted by multidomain GA v12 Migration Guide Nov 15, 2022
@emilyrohrbough emilyrohrbough linked an issue Nov 15, 2022 that may be closed by this pull request
@BlueWinds BlueWinds self-requested a review November 15, 2022 19:29
Copy link
Contributor

@nagash77 nagash77 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Starting at line 565 in the writing-and-organizing-tests.md it refers to test isolation being experimental. This should be updated

content/guides/references/migration-guide.md Outdated Show resolved Hide resolved
content/guides/references/migration-guide.md Outdated Show resolved Hide resolved
content/guides/references/migration-guide.md Outdated Show resolved Hide resolved
cy.findByTestId('popover').findAllByRole('button').first().as('button')
```

### Command / Cypress API Changes
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It feels like this should be at a different header level than the elements below it, or removed entirely (the ### headers below seem like they stand on their own just fine).

@@ -2,6 +2,345 @@
title: Migration Guide
---

## Migrating to Cypress version 12.0
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to add in here somewhere a section about retryability, linking to the rewritten guide.

Cypress 12 has improved and changed the way we retry commands by introducing a new type of Cypress command: Queries. Many commands you're already familiar with are now queries, such as .get(), .find(), and .children(). You can learn more about queries - and the way they protect you from Detached From DOM errors - in our guide on Retry-ability.

In most cases, you won't need to change your tests to take advantage of this functionality, but it does have one implication to be aware of, in the form of a new Best Practice for writing Cypress tests:

  • Action commands (such as .click(), .type(), and .trigger()) should be at the end of chains, not the middle.

See the guide linked above for more details.

updated version number
Ben M and others added 4 commits November 29, 2022 09:25
removed the word "recently" that was describing a talk we gave 4 years ago
content/guides/references/migration-guide.md Outdated Show resolved Hide resolved
### Behavior Changes in Alias Resolution

Cypress always re-queries aliases when they are referenced. This can result in
certain tests that used to pass failing. For example,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you might mean "to start failing"

content/guides/references/migration-guide.md Outdated Show resolved Hide resolved
@emilyrohrbough emilyrohrbough merged commit 97d7533 into v12 Dec 2, 2022
@emilyrohrbough emilyrohrbough deleted the v12-migration-guide branch December 2, 2022 19:06
@AtofStryker
Copy link
Contributor

@emilyrohrbough do we need to update the testIsolation bits?

@emilyrohrbough
Copy link
Member Author

@AtofStryker yeah, doing it on #4890

debrisapron pushed a commit that referenced this pull request Dec 6, 2022
Co-authored-by: Matt Schile <[email protected]>
Co-authored-by: Blue F <[email protected]>
Co-authored-by: DEBRIS APRON <[email protected]>
Co-authored-by: Ben M <[email protected]>
Closes undefined
mjhenkes added a commit that referenced this pull request Dec 6, 2022
* Remove pages and references to functionality obsoleted by multidomain GA

* fix: Explain error thrown when cypress commands in .should() callback (#4755)

* fix: Explain error thrown when cypress commands in .should() callback

* Improve layout of previous changes and provide second example of how to fix

* Update content/api/commands/should.md

Co-authored-by: Rachel <[email protected]>

* Apply suggestions from code review

Co-authored-by: Zach Bloomquist <[email protected]>

* Run prettier

* Run prettier again...?

* One more prettier run... :/

Co-authored-by: Rachel <[email protected]>
Co-authored-by: Zach Bloomquist <[email protected]>

* docs: removing Cookies.defaults/preserveOnce (#4779)

* docs: remove experimentalSessionAndOrigin (#4807)

* Update cookie commands domain option description (#4861)

* docs: Queries, Detached DOM, and Retry-Ability (#4835)

* First rework of retryability guide

* Update each command's Yields section, and all guides, with information about queries vs commands

* Add Custom Queries page

* Minor formatting tweaks

* Review changes

* Review updates

* Update based on review + last week meetings

* More review updates

* Fix tests

* breaking: drop node 12, 13, 15 and 17 support (#4879)

* Add docs for new local/session storage commands (#4876)

* feat: update okta login guide for realworld app (#4883)

* feat: update okta login guide for realworld app

* chore: make changes to okta to have parity with cognito changes

* chore: address code review comments

* feat: update cognito login guide for realworld app (#4882)

* feat: update cognito login guide for realworld app

* chore: update guide from comments in code review

* properly close alert tag

* Update content/guides/end-to-end-testing/amazon-cognito-authentication.md

* chore: address comments from code review

* fix linting

* v12 Migration Guide (#4862)

Co-authored-by: Matt Schile <[email protected]>
Co-authored-by: Blue F <[email protected]>
Co-authored-by: DEBRIS APRON <[email protected]>
Co-authored-by: Ben M <[email protected]>
Closes undefined

* Small update to cy.origin API docs for v12

* Update auth examples for v12 on custom commands page

* 12: update test isolation docs to use true/false instead of on/off (#4890)

Co-authored-by: Chris Breiding <[email protected]>
Co-authored-by: Matt Henkes <[email protected]>
Co-authored-by: Bill Glesias <[email protected]>

* docs: add documentation for experimentalOriginDependencies (#4897)

* Documentation updates for v12 (#4880)

* re-add websecurity, links to websecurity, and trade-offs guides

* chore: revamp documentation around web security page

* chore: update same-origin tradeoff to be new navigation rules, including our SD chart, to help paint users a clear picture with cy.origin

* chore: link to the experimental modify obstructive third party code doc in web security from origin

* chore: update Error Messages section to reflect allowing cross origin visiting

* update best practices: visiting external sites

* remove node 12 from installing cypress section

* chore: update key differences to plug session and origin over programmatic login

* chore: update with suggestions from code review

* add okta/amazon guide links in trade-offs and update workarounds

* feat: add cross origin testing guide

* update image for command time out with visit

* chore: readd legacy errors and add a Note section to explain that this is only for cypress v11 and under

* chore: update suggestions from code review

* chore: add suggestions from code review

* fix: fix okta alert banner (needed a new line)

* fix: broken image in error messages

* chore: update error header for on link to address cypress-io/cypress-services#5040 (comment)

* Update cy.session API docs for v12 (#4851)

Co-authored-by: Emily Rohrbough <[email protected]>
Closes #4507

* Remove pages and references to functionality obsoleted by multidomain GA

* fix: Explain error thrown when cypress commands in .should() callback (#4755)

* fix: Explain error thrown when cypress commands in .should() callback

* Improve layout of previous changes and provide second example of how to fix

* Update content/api/commands/should.md

Co-authored-by: Rachel <[email protected]>

* Apply suggestions from code review

Co-authored-by: Zach Bloomquist <[email protected]>

* Run prettier

* Run prettier again...?

* One more prettier run... :/

Co-authored-by: Rachel <[email protected]>
Co-authored-by: Zach Bloomquist <[email protected]>

* docs: removing Cookies.defaults/preserveOnce (#4779)

* docs: remove experimentalSessionAndOrigin (#4807)

* Update cookie commands domain option description (#4861)

* docs: Queries, Detached DOM, and Retry-Ability (#4835)

* First rework of retryability guide

* Update each command's Yields section, and all guides, with information about queries vs commands

* Add Custom Queries page

* Minor formatting tweaks

* Review changes

* Review updates

* Update based on review + last week meetings

* More review updates

* Fix tests

* breaking: drop node 12, 13, 15 and 17 support (#4879)

* Add docs for new local/session storage commands (#4876)

* feat: update okta login guide for realworld app (#4883)

* feat: update okta login guide for realworld app

* chore: make changes to okta to have parity with cognito changes

* chore: address code review comments

* feat: update cognito login guide for realworld app (#4882)

* feat: update cognito login guide for realworld app

* chore: update guide from comments in code review

* properly close alert tag

* Update content/guides/end-to-end-testing/amazon-cognito-authentication.md

* chore: address comments from code review

* fix linting

* v12 Migration Guide (#4862)

Co-authored-by: Matt Schile <[email protected]>
Co-authored-by: Blue F <[email protected]>
Co-authored-by: DEBRIS APRON <[email protected]>
Co-authored-by: Ben M <[email protected]>
Closes undefined

* 12: update test isolation docs to use true/false instead of on/off (#4890)

Co-authored-by: Chris Breiding <[email protected]>
Co-authored-by: Matt Henkes <[email protected]>
Co-authored-by: Bill Glesias <[email protected]>

* docs: add documentation for experimentalOriginDependencies (#4897)

* Documentation updates for v12 (#4880)

* re-add websecurity, links to websecurity, and trade-offs guides

* chore: revamp documentation around web security page

* chore: update same-origin tradeoff to be new navigation rules, including our SD chart, to help paint users a clear picture with cy.origin

* chore: link to the experimental modify obstructive third party code doc in web security from origin

* chore: update Error Messages section to reflect allowing cross origin visiting

* update best practices: visiting external sites

* remove node 12 from installing cypress section

* chore: update key differences to plug session and origin over programmatic login

* chore: update with suggestions from code review

* add okta/amazon guide links in trade-offs and update workarounds

* feat: add cross origin testing guide

* update image for command time out with visit

* chore: readd legacy errors and add a Note section to explain that this is only for cypress v11 and under

* chore: update suggestions from code review

* chore: add suggestions from code review

* fix: fix okta alert banner (needed a new line)

* fix: broken image in error messages

* chore: update error header for on link to address cypress-io/cypress-services#5040 (comment)

* Update auth examples for v12 on custom commands page

* Small update to cy.origin API docs for v12

* Update cy.session API docs for v12 (#4851)

Co-authored-by: Emily Rohrbough <[email protected]>
Closes #4507

* chore: address docs feedback post merge (#4899)

* .within() now throws an error if given more than one subject (#4898)

* .within() now throws error when passed more than one subject.

* Add migration guide, update based on reviews

* Update Logging In section of Testing Your App page (#4885)

Co-authored-by: Emily Rohrbough <[email protected]>
Closes #4498

* Update End-to-End Testing -> Auth0 Authentication docs for v12 (#4895)

Co-authored-by: Bill Glesias <[email protected]>

* Cypress.Session Cypress API (#4900)

* docs around Cypress.session api

* data not date

* Update content/api/cypress-api/session.md

Co-authored-by: Matt Henkes <[email protected]>

* Update content/api/cypress-api/session.md

Co-authored-by: Matt Henkes <[email protected]>

* Update content/api/cypress-api/session.md

Co-authored-by: Matt Henkes <[email protected]>

* Update content/api/cypress-api/session.md

Co-authored-by: Matt Henkes <[email protected]>

* fix markdown

* Update content/api/cypress-api/session.md

* Apply suggestions from code review

Co-authored-by: Matt Henkes <[email protected]>

* V12 ChangeLog (#4896)

Co-authored-by: Matt Schile <[email protected]>
Co-authored-by: Blue F <[email protected]>
Co-authored-by: DEBRIS APRON <[email protected]>
Co-authored-by: Ben M <[email protected]>
Co-authored-by: Ryan Manuel <[email protected]>
Co-authored-by: Chris Breiding <[email protected]>

Co-authored-by: DEBRIS APRON <[email protected]>
Co-authored-by: Blue F <[email protected]>
Co-authored-by: Rachel <[email protected]>
Co-authored-by: Zach Bloomquist <[email protected]>
Co-authored-by: Matt Schile <[email protected]>
Co-authored-by: Matt Henkes <[email protected]>
Co-authored-by: Chris Breiding <[email protected]>
Co-authored-by: Bill Glesias <[email protected]>
Co-authored-by: Ben M <[email protected]>
Co-authored-by: Ryan Manuel <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

v12 Migration Guide
6 participants