v12 Migration Guide #4862

emilyrohrbough · 2022-11-15T19:06:27Z

Closes v12 Migration Guide #4502

vercel · 2022-11-15T19:06:31Z

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)

nagash77

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

BlueWinds · 2022-11-23T17:11:39Z

content/guides/references/migration-guide.md

+cy.findByTestId('popover').findAllByRole('button').first().as('button')
+```
+
+### Command / Cypress API Changes


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).

BlueWinds · 2022-11-23T17:27:03Z

content/guides/references/migration-guide.md

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

+## Migrating to Cypress version 12.0


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

removed the word "recently" that was describing a talk we gave 4 years ago

Co-authored-by: Matt Schile <mschile@cypress.io>

Co-authored-by: DEBRIS APRON <debrisapron@gmail.com>

content/guides/references/migration-guide.md

Co-authored-by: DEBRIS APRON <debrisapron@gmail.com>

content/guides/references/migration-guide.md

Co-authored-by: DEBRIS APRON <debrisapron@gmail.com>

content/guides/core-concepts/writing-and-organizing-tests.md

content/guides/references/migration-guide.md

nagash77 · 2022-12-02T15:20:52Z

content/guides/references/migration-guide.md

+### 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,


I think you might mean "to start failing"

content/guides/references/migration-guide.md

Co-authored-by: Ben M <benm@cypress.io>

content/guides/references/migration-guide.md

Co-authored-by: Ben M <benm@cypress.io>

AtofStryker · 2022-12-02T19:39:04Z

@emilyrohrbough do we need to update the testIsolation bits?

emilyrohrbough · 2022-12-02T19:41:52Z

@AtofStryker yeah, doing it on #4890

Co-authored-by: Matt Schile <mschile@cypress.io> Co-authored-by: Blue F <blue@everblue.info> Co-authored-by: DEBRIS APRON <debrisapron@gmail.com> Co-authored-by: Ben M <benm@cypress.io> Closes undefined

* 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 <rachel@cypress.io> * Apply suggestions from code review Co-authored-by: Zach Bloomquist <git@chary.us> * Run prettier * Run prettier again...? * One more prettier run... :/ Co-authored-by: Rachel <rachel@cypress.io> Co-authored-by: Zach Bloomquist <git@chary.us> * 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 <mschile@cypress.io> Co-authored-by: Blue F <blue@everblue.info> Co-authored-by: DEBRIS APRON <debrisapron@gmail.com> Co-authored-by: Ben M <benm@cypress.io> 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 <chrisbreiding@users.noreply.github.com> Co-authored-by: Matt Henkes <mjhenkes@gmail.com> Co-authored-by: Bill Glesias <bglesias@gmail.com> * 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 <emilyrohrbough@users.noreply.github.com> 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 <rachel@cypress.io> * Apply suggestions from code review Co-authored-by: Zach Bloomquist <git@chary.us> * Run prettier * Run prettier again...? * One more prettier run... :/ Co-authored-by: Rachel <rachel@cypress.io> Co-authored-by: Zach Bloomquist <git@chary.us> * 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 <mschile@cypress.io> Co-authored-by: Blue F <blue@everblue.info> Co-authored-by: DEBRIS APRON <debrisapron@gmail.com> Co-authored-by: Ben M <benm@cypress.io> Closes undefined * 12: update test isolation docs to use true/false instead of on/off (#4890) Co-authored-by: Chris Breiding <chrisbreiding@users.noreply.github.com> Co-authored-by: Matt Henkes <mjhenkes@gmail.com> Co-authored-by: Bill Glesias <bglesias@gmail.com> * 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 <emilyrohrbough@users.noreply.github.com> 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 <emilyrohrbough@users.noreply.github.com> Closes #4498 * Update End-to-End Testing -> Auth0 Authentication docs for v12 (#4895) Co-authored-by: Bill Glesias <bglesias@gmail.com> * 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 <mjhenkes@gmail.com> * Update content/api/cypress-api/session.md Co-authored-by: Matt Henkes <mjhenkes@gmail.com> * Update content/api/cypress-api/session.md Co-authored-by: Matt Henkes <mjhenkes@gmail.com> * Update content/api/cypress-api/session.md Co-authored-by: Matt Henkes <mjhenkes@gmail.com> * fix markdown * Update content/api/cypress-api/session.md * Apply suggestions from code review Co-authored-by: Matt Henkes <mjhenkes@gmail.com> * V12 ChangeLog (#4896) Co-authored-by: Matt Schile <mschile@cypress.io> Co-authored-by: Blue F <blue@everblue.info> Co-authored-by: DEBRIS APRON <debrisapron@gmail.com> Co-authored-by: Ben M <benm@cypress.io> Co-authored-by: Ryan Manuel <ryanm@cypress.io> Co-authored-by: Chris Breiding <chrisbreiding@users.noreply.github.com> Co-authored-by: DEBRIS APRON <debrisapron@gmail.com> Co-authored-by: Blue F <blue@everblue.info> Co-authored-by: Rachel <rachel@cypress.io> Co-authored-by: Zach Bloomquist <git@chary.us> Co-authored-by: Matt Schile <mschile@cypress.io> Co-authored-by: Matt Henkes <mjhenkes@gmail.com> Co-authored-by: Chris Breiding <chrisbreiding@users.noreply.github.com> Co-authored-by: Bill Glesias <bglesias@gmail.com> Co-authored-by: Ben M <benm@cypress.io> Co-authored-by: Ryan Manuel <ryanm@cypress.io>

r1 - migration guide content

1c50105

emilyrohrbough changed the title ~~Remove pages and references to functionality obsoleted by multidomain GA~~ v12 Migration Guide Nov 15, 2022

vercel bot deployed to Preview November 15, 2022 19:08 View deployment

emilyrohrbough linked an issue Nov 15, 2022 that may be closed by this pull request

v12 Migration Guide #4502

Closed

BlueWinds self-requested a review November 15, 2022 19:29

nagash77 previously requested changes Nov 16, 2022

View reviewed changes

r2 - remove test isolation experimental reference

5e1a18a

emilyrohrbough requested a review from nagash77 November 16, 2022 15:36

vercel bot deployed to Preview November 16, 2022 15:39 View deployment

mschile reviewed Nov 16, 2022

View reviewed changes

content/guides/references/migration-guide.md Outdated Show resolved Hide resolved

mschile reviewed Nov 16, 2022

View reviewed changes

content/guides/references/migration-guide.md Outdated Show resolved Hide resolved

mschile reviewed Nov 16, 2022

View reviewed changes

content/guides/references/migration-guide.md Outdated Show resolved Hide resolved

include should in v12 changes

2435390

vercel bot deployed to Preview November 21, 2022 22:00 View deployment

BlueWinds reviewed Nov 23, 2022

View reviewed changes

Update 12.0.0.md

e998b1d

updated version number

vercel bot deployed to Preview November 29, 2022 14:25 View deployment

Ben M and others added 4 commits November 29, 2022 09:25

Update writing-and-organizing-tests.md

48d4807

removed the word "recently" that was describing a talk we gave 4 years ago

Update content/guides/references/migration-guide.md

4c82587

Co-authored-by: Matt Schile <mschile@cypress.io>

Update content/guides/references/migration-guide.md

05fb3e3

Co-authored-by: Matt Schile <mschile@cypress.io>

Update content/guides/references/migration-guide.md

820f134

Co-authored-by: Matt Schile <mschile@cypress.io>

vercel bot deployed to Preview November 29, 2022 14:31 View deployment

emilyrohrbough added 2 commits November 29, 2022 13:45

.

c35e709

add dropped node support to migration guide

eb94eb4

vercel bot deployed to Preview November 29, 2022 20:00 View deployment

updates / pr feedback

93ae489

vercel bot deployed to Preview November 30, 2022 22:22 View deployment

use blues words

73a2b4a

vercel bot deployed to Preview November 30, 2022 22:30 View deployment

Apply suggestions from code review

90f63b8

Co-authored-by: DEBRIS APRON <debrisapron@gmail.com>

emilyrohrbough commented Dec 1, 2022

View reviewed changes

content/guides/references/migration-guide.md Outdated Show resolved Hide resolved

Apply suggestions from code review

a739fc7

emilyrohrbough commented Dec 1, 2022

View reviewed changes

content/guides/references/migration-guide.md Outdated Show resolved Hide resolved

Apply suggestions from code review

4f6fd8e

vercel bot deployed to Preview December 1, 2022 20:15 View deployment

emilyrohrbough and others added 2 commits December 2, 2022 09:10

Update content/guides/core-concepts/writing-and-organizing-tests.md

b0ae517

Co-authored-by: DEBRIS APRON <debrisapron@gmail.com>

Update content/guides/references/migration-guide.md

2766b72

Co-authored-by: DEBRIS APRON <debrisapron@gmail.com>

vercel bot deployed to Preview December 2, 2022 15:16 View deployment

emilyrohrbough commented Dec 2, 2022

View reviewed changes

content/guides/references/migration-guide.md Outdated Show resolved Hide resolved

emilyrohrbough and others added 2 commits December 2, 2022 09:16

Apply suggestions from code review

f9f731d

Update content/guides/references/migration-guide.md

e3c1bd8

Co-authored-by: DEBRIS APRON <debrisapron@gmail.com>

emilyrohrbough requested a review from debrisapron December 2, 2022 15:17

vercel bot deployed to Preview December 2, 2022 15:20 View deployment

nagash77 reviewed Dec 2, 2022

View reviewed changes

emilyrohrbough and others added 2 commits December 2, 2022 11:58

Update content/guides/core-concepts/writing-and-organizing-tests.md

da37846

Co-authored-by: Ben M <benm@cypress.io>

Update content/guides/references/migration-guide.md

e482ae3

Co-authored-by: Ben M <benm@cypress.io>

emilyrohrbough commented Dec 2, 2022

View reviewed changes

content/guides/references/migration-guide.md Outdated Show resolved Hide resolved

emilyrohrbough and others added 3 commits December 2, 2022 11:59

Update content/guides/references/migration-guide.md

01f930b

Update content/guides/references/migration-guide.md

26d7407

Co-authored-by: Ben M <benm@cypress.io>

fix markdown

ec98686

emilyrohrbough requested a review from nagash77 December 2, 2022 18:02

vercel bot deployed to Preview December 2, 2022 18:05 View deployment

debrisapron approved these changes Dec 2, 2022

View reviewed changes

emilyrohrbough merged commit 97d7533 into v12 Dec 2, 2022

emilyrohrbough deleted the v12-migration-guide branch December 2, 2022 19:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

v12 Migration Guide #4862

v12 Migration Guide #4862

emilyrohrbough commented Nov 15, 2022 •

edited

vercel bot commented Nov 15, 2022 •

edited

nagash77 left a comment

BlueWinds Nov 23, 2022

BlueWinds Nov 23, 2022

nagash77 Dec 2, 2022

AtofStryker commented Dec 2, 2022

emilyrohrbough commented Dec 2, 2022

v12 Migration Guide #4862

v12 Migration Guide #4862

Conversation

emilyrohrbough commented Nov 15, 2022 • edited

vercel bot commented Nov 15, 2022 • edited

nagash77 left a comment

Choose a reason for hiding this comment

BlueWinds Nov 23, 2022

Choose a reason for hiding this comment

BlueWinds Nov 23, 2022

Choose a reason for hiding this comment

nagash77 Dec 2, 2022

Choose a reason for hiding this comment

AtofStryker commented Dec 2, 2022

emilyrohrbough commented Dec 2, 2022

emilyrohrbough commented Nov 15, 2022 •

edited

vercel bot commented Nov 15, 2022 •

edited