breaking: `.should()` and `.and()` are now queries. #25738

BlueWinds · 2023-02-07T16:34:12Z

Additional details

In Cypress 12, assertions belong to the commands that they follow after. When you write cy.get('button').should('be.visible'), the .should() executes as part of verifyUpcomingAssertions while .get() is the current Cypress command. This means that if an assertion fails, the command it's attached to fails as well; it also makes assertions very much a 'special case', working differently from every other command.

This PR changes that. .should() and .and() are now queries, and follow the same logic as every other query. This means they are safe to chain off of, they are re-executed when reading an alias that includes them, and they pass or fail independently of any other command, resulting in a clearer debugging experience.

.should('not.exist') still skip the previous command's implicit existence checks - the logic to do this is somewhat more straightforward now, with verifyUpcomingAssertions explicitly invoking a method hasUpcomingExistenceAssertions() and skipping the implicit existence checks if it returns true.

Steps to test

How has the user experience changed?

PR Tasks

Have tests been added/updated?
Has a PR for user-facing changes been opened in cypress-documentation? Restructure API namespace for Cy13 cypress-documentation#5053
- Update the 12.0.0 migration docs with an addendum speaking to assertions also joining the queries category in 13.x.x.
- Mention that aliases are 'locators'
[n/a] Have API changes been updated in the type definitions?

…-as-query

* fix: match alternate edge version string format (#25457) * fix: match alternate edge version string format * chore: add changelog entry * Apply suggestions from code review * Update cli/CHANGELOG.md * Update cli/CHANGELOG.md * chore: update changelog to release on Tuesday for 12.5 * [run ci] --------- Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> Co-authored-by: Bill Glesias <bglesias@gmail.com> * chore: Use upstream cypress-testing-library again (#25548) * chore: Use upstream cypress-testing-library again * Update cypress-example-kitchensink commit hash * Revert "Update cypress-example-kitchensink commit hash" This reverts commit 8de5d1f. --------- Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> * fix(deps): update dependency underscore.string to v3.3.6 🌟 (#25574) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Bill Glesias <bglesias@gmail.com> * feat: Debug page [IATR] (#25488) Co-authored-by: Zachary Williams <ZachJW34@gmail.com> Co-authored-by: Ankit <ankit@cypress.io> Co-authored-by: Stokes Player <stokes.player@gmail.com> Co-authored-by: elevatebart <bart@cypress.io> Co-authored-by: Rocky <25568640+rockindahizzy@users.noreply.github.com> Co-authored-by: Stokes Player <stokes@cypress.io> Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> Co-authored-by: Mark Noonan <mark@cypress.io> Co-authored-by: Mike Plummer <mikep@cypress.io> Co-authored-by: amehta265 <65267668+amehta265@users.noreply.github.com> Co-authored-by: Adam Stone-Lord <adams@cypress.io> Co-authored-by: Mike Plummer <mike-plummer@users.noreply.github.com> Co-authored-by: Lachlan Miller <lachlan.miller.1990@outlook.com> * chore: fix changlelog section parsing and reference right ENV (#25633) * test: skip flaky migration test (#25378) * chore: Update README to add Cloud badges (#25645) * perf: remove reporter logs for collapsed tests in run mode (#25632) Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> * chore: 12.5.0 release (#25648) * dependency: update dependency simple-git to v3.16.0 [security] (#25603) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Zachary Williams <zachjw34@gmail.com> Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> * chore: renovate semantic types and percy ci updates (#25651) --------- Co-authored-by: Steven Collins <steven@carboncollins.uk> Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> Co-authored-by: Bill Glesias <bglesias@gmail.com> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Stokes Player <stokes@cypress.io> Co-authored-by: Zachary Williams <ZachJW34@gmail.com> Co-authored-by: Ankit <ankit@cypress.io> Co-authored-by: Stokes Player <stokes.player@gmail.com> Co-authored-by: elevatebart <bart@cypress.io> Co-authored-by: Rocky <25568640+rockindahizzy@users.noreply.github.com> Co-authored-by: Mark Noonan <mark@cypress.io> Co-authored-by: Mike Plummer <mikep@cypress.io> Co-authored-by: amehta265 <65267668+amehta265@users.noreply.github.com> Co-authored-by: Adam Stone-Lord <adams@cypress.io> Co-authored-by: Mike Plummer <mike-plummer@users.noreply.github.com> Co-authored-by: Lachlan Miller <lachlan.miller.1990@outlook.com> Co-authored-by: Jennifer Shehane <jennifer@cypress.io> Co-authored-by: Matt Schile <mschile@cypress.io>

* Update cli/CHANGELOG.md Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> * Update cli/CHANGELOG.md Co-authored-by: Matt Henkes <mjhenkes@gmail.com> --------- Co-authored-by: Emily Rohrbough <emilyrohrbough@yahoo.com> Co-authored-by: Matt Henkes <mjhenkes@gmail.com>

…ypress into issue-25134-should-as-query

…-should-as-query

packages/driver/src/cypress/state.ts

emilyrohrbough · 2023-03-02T14:17:17Z

cli/CHANGELOG.md

@@ -5,6 +5,8 @@ _Released 03/1/2023 (PENDING)_

 **Breaking Changes:**

+- The [`.should()` and `.and()`](/api/commands/should) assertions are now queries. This means that they are fully retryable, and it is safe to chain further commands that interact with the DOM after them. Assertions are also now re-run as part of aliases. Addresses [#25134](https://github.com/cypress-io/cypress/issues/25134) and [#25491](https://github.com/cypress-io/cypress/issues/25491). Addressed in [#25738](https://github.com/cypress-io/cypress/pull/25738).


Suggested change

- The [`.should()` and `.and()`](/api/commands/should) assertions are now queries. This means that they are fully retryable, and it is safe to chain further commands that interact with the DOM after them. Assertions are also now re-run as part of aliases. Addresses [#25134](https://github.com/cypress-io/cypress/issues/25134) and [#25491](https://github.com/cypress-io/cypress/issues/25491). Addressed in [#25738](https://github.com/cypress-io/cypress/pull/25738).

- The [`.should()`](https://docs.cypress.io/api/commands/should) and [`.and()`](/api/commands/and) assertions are now queries. This means that they are fully retryable, and it is safe to chain further commands that interact with the DOM after them. Assertions are also now re-run as part of aliases. Addresses [#25134](https://github.com/cypress-io/cypress/issues/25134) and [#25491](https://github.com/cypress-io/cypress/issues/25491).

This means that they are fully retryable, and it is safe to chain further commands that interact with the DOM after them.

I don't know what this means and if users will either since assertions were documented such that they retried to pass.

emilyrohrbough · 2023-03-02T14:22:20Z

packages/app/src/specs/generators/FileChooser.cy.tsx

@@ -237,10 +237,10 @@ describe('<FileChooser />', () => {
    .should('have.value', newExtension)

    // debounce should cause this to hit
-    .get('@onUpdateExtensionSpy').should('not.have.been.calledWith', newExtension)
+    cy.get('@onUpdateExtensionSpy').should('not.have.been.calledWith', newExtension)


Same as above, would have thought .type() broken the change so this change wouldn't have been needed.

emilyrohrbough · 2023-03-02T14:23:54Z

packages/driver/cypress/e2e/commands/aliasing.cy.js

+    it('includes assertions in the subject chain', () => {
+      cy.get('#button').should('have.css', 'font-family').as('font')
+
+      cy.get('@font').should('be.a', 'string')
+    })


This test isn't verifying the assertions are in the chain. Looks like some verification was missed?

emilyrohrbough · 2023-03-02T14:29:50Z

packages/driver/cypress/e2e/commands/assertions.cy.js


-          expect(getLog.get('state')).to.eq('pending')
+          expect(getLog.get('state')).to.eq('passed')


When an assertion fails and the command is requried, do we set this get status back to pending? Or how are we showing this subject changed from the yielded value? Console props?

emilyrohrbough · 2023-03-02T14:31:13Z

packages/driver/cypress/e2e/commands/assertions.cy.js

-          expect(err.message).to.include('looks like you are trying to call a child command before running a parent command')
-
+      // https://github.com/cypress-io/cypress/issues/25491
+      it('throws a good error when aliased subject disappears', function (done) {


Suggested change

it('throws a good error when aliased subject disappears', function (done) {

it('throws an error when aliased subject disappears', function (done) {

emilyrohrbough · 2023-03-02T14:33:41Z

packages/driver/cypress/e2e/commands/assertions.cy.js


-    it('sets type to parent when assertion did not involve current subject and didnt have arguments', (done) => {


Did you intended to drop this test?

emilyrohrbough · 2023-03-02T14:36:16Z

packages/driver/cypress/e2e/commands/connectors.cy.js

@@ -1245,7 +1226,8 @@ describe('src/cy/commands/connectors', () => {
          .onCall(0).returns(undefined)
          .onCall(1).returns(undefined)
          .onCall(2).returns(undefined)
-          .onCall(3).returns(true),
+          .onCall(3).returns(true)
+          .onCall(4).returns(true),


doesn't look needed?

… and and() will not be queries in v13. see cypress-io/cypress#25738

… is no longer applicable due to cypress-io/cypress#25738

* .readFile() is now a query (#5017) * .readFile() is now a query * Add section on new .readFile() superpowers * Fix page slug for readFile * Prettier run * Update guides to better support users in Cy 13, where assertions are now commands * Review updates * Apply suggestions from code review Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> * Partial review feedback (more to come) * Review updates * Prettier run * fix: update retry ability guide and migration guide now that should() and and() will not be queries in v13. see cypress-io/cypress#25738 * chore: correct number of queries in example * revert: images changes due to should() and and() being queries, which is no longer applicable due to cypress-io/cypress#25738 * chore: lint guides --------- Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> Co-authored-by: Bill Glesias <bglesias@gmail.com>

* BREAKING: update documentation by setting default video: false for v13.0.0 (#5300) * BREAKING: update documentation by setting default video: false * Update docs/guides/overview/why-cypress.mdx Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> * Update docs/guides/end-to-end-testing/migration/protractor-to-cypress.mdx Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> * Update docs/guides/continuous-integration/introduction.mdx Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> * Update docs/guides/guides/screenshots-and-videos.mdx Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> * chore: re-order video bits * Update docs/guides/end-to-end-testing/migration/protractor-to-cypress.mdx * chore: linting --------- Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> * breaking: update documentation by setting videoCompression: false (#5301) * BREAKING: update documentation by setting default video: false * BREAKING: update documentation by setting videoCompression: false * Update docs/guides/guides/screenshots-and-videos.mdx Co-authored-by: Chris Breiding <chrisbreiding@users.noreply.github.com> * apply suggestion from code review * chore: attempt to rework the video encoding section * Update docs/guides/guides/screenshots-and-videos.mdx Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> * chore: address comments in code review * chore: update video encoding guide to flow a bit more evenly --------- Co-authored-by: Chris Breiding <chrisbreiding@users.noreply.github.com> Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> * BREAKING: remove the videoUploadOnPasses configuration option (#5306) * BREAKING: remove the videoUploadOnPasses configuration option * chore: add history entry of removed videoUploadOnPasses config option * .readFile() is now a query (#5017) (#5316) * .readFile() is now a query * Add section on new .readFile() superpowers * Fix page slug for readFile * Prettier run Co-authored-by: Blue F <blue@everblue.info> * Update guides for Cy 13, where assertions are now commands (#5081) * .readFile() is now a query (#5017) * .readFile() is now a query * Add section on new .readFile() superpowers * Fix page slug for readFile * Prettier run * Update guides to better support users in Cy 13, where assertions are now commands * Review updates * Apply suggestions from code review Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> * Partial review feedback (more to come) * Review updates * Prettier run * fix: update retry ability guide and migration guide now that should() and and() will not be queries in v13. see cypress-io/cypress#25738 * chore: correct number of queries in example * revert: images changes due to should() and and() being queries, which is no longer applicable due to cypress-io/cypress#25738 * chore: lint guides --------- Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> Co-authored-by: Bill Glesias <bglesias@gmail.com> * Apply suggestions from code review Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com> * Remove nodeVersion documentation (#5318) * Remove reference to 'nodeVersion' * added history, removed changes to legacy * docs: v13 video and TR migration info (#5383) * added video config migration info * added tr migration info * PR feedback * PR feedback * PR feedback * Apply suggestions from code review Co-authored-by: Bill Glesias <bglesias@gmail.com> * Update docs/guides/references/migration-guide.mdx Co-authored-by: Jennifer Shehane <jennifer@cypress.io> --------- Co-authored-by: Bill Glesias <bglesias@gmail.com> Co-authored-by: Jennifer Shehane <jennifer@cypress.io> * Update results for module API and after:spec handler (#5379) * docs: adding documentation for runner-ui cli flags (#5424) * docs: test replay docs (#5349) * sidebar content shuffle * main feature content & link updates * add screenshots * add url to vpn whitelist * add TR banner * add & reorder faq * build test replay partial * add TR partial to related content * add TR link to related "see more" sections * content tweaks * include TR content in body copy * add troubleshooting * remove old images * add PR feedback * add command log notes * remove dead link * update images * replace runs page screenshots * Apply suggestions from code review Co-authored-by: Jennifer Shehane <jennifer@cypress.io> Co-authored-by: Bill Glesias <bglesias@gmail.com> Co-authored-by: Jennifer Shehane <jennifer@cypress.io> * add more faqs * restore missing partial export * fix links * swap in screenshot of new network panel * Apply suggestions from code review Co-authored-by: Bill Glesias <bglesias@gmail.com> * fix command line merge issue * lint * Update docs/guides/cloud/debugging/recorded-runs.mdx Co-authored-by: Bill Glesias <bglesias@gmail.com> * Apply suggestions from code review Co-authored-by: Bill Glesias <bglesias@gmail.com> --------- Co-authored-by: Jennifer Shehane <jennifer@cypress.io> Co-authored-by: Bill Glesias <bglesias@gmail.com> * Fix JavaScript caps * Fix caps of JavaScript * Fix typo * Write a document around Cloud data storage and controls (#5425) Co-authored-by: Paul Jaffre <jaffrepaul@gmail.com> Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com> * add changelog, remove node 16 support, and update docker image refere… (#5434) * add changelog, remove node 16 support, and update docker image reference to be on at least node 18 * Update docs/guides/references/changelog.mdx * docs: minor v13 updates (#5438) * match data callout with data storage page * remove mention from artifacts panel * remove submitting feature requests callout * build & insert cloud free plan partial * docs: update v13 content urls (#5428) * update content urls * add todo * replace v13 changelog urls * docs: v13 changelog summary (#5441) * changelog summary * Update docs/guides/references/changelog.mdx Co-authored-by: Jennifer Shehane <jennifer@cypress.io> * tweak verbaige & lint --------- Co-authored-by: Jennifer Shehane <jennifer@cypress.io> * Apply suggestions from code review Co-authored-by: Bill Glesias <bglesias@gmail.com> * lint * Update docs/faq/questions/cloud-faq.mdx Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com> * include TR note in cypress screenshot api options (#5445) * docs: additional test replay content (#5447) * add TR cost faq * add centos troubleshooting * sync up changelog * Update _cloud_free_plan.mdx minor text update --------- Co-authored-by: Bill Glesias <bglesias@gmail.com> Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> Co-authored-by: Chris Breiding <chrisbreiding@users.noreply.github.com> Co-authored-by: Blue F <blue@everblue.info> Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com> Co-authored-by: Paul Jaffre <jaffrepaul@gmail.com> Co-authored-by: Jennifer Shehane <jennifer@cypress.io> Co-authored-by: Matt Schile <mschile@cypress.io> Co-authored-by: Chris Breiding <chrisbreiding@gmail.com> Co-authored-by: Paul Jaffre <paul@cypress.io>

BlueWinds and others added 30 commits December 28, 2022 11:58

feat: .should()/.and() are now queries.

c91f2d3

Fixes for various issues in original commit

de19704

Merge remote-tracking branch 'origin/develop' into issue-25134-should…

18206a8

…-as-query

Fix bad subject after verifyUpcomingAssertions [run ci]

ef4a45f

Fixes for several more issues [run ci]

e3e8bb5

Merge remote-tracking branch 'origin/develop' into issue-25134-should…

4d5e952

…-as-query

Update readFile() to be a query

d4e1f61

Merge remote-tracking branch 'origin/develop' into issue-25134-should…

04bdadf

…-as-query

Fixes for various issues; still WIP

ac3f049

Fix for remaining known failures [run ci]

34c4650

Fix last two tests [run ci]

55a50b2

Fix for remaining known failures [run ci]

06c8362

Merge remote-tracking branch 'origin/develop' into issue-25134-should…

58c53b8

…-as-query

Add additional assertion test, fix log message name [run ci]

cdf8da7

Additional test fixes

cfc6551

Fix for additional test failures [run ci]

4f5e65d

Merge branch 'develop' into issue-25134-should-as-query

e623112

Merge branch 'develop' into issue-25134-should-as-query

48ab58d

Update cypress-example-kitchensink commit hash

11422b9

Clean up no-longer-needed stack trace logic

ed2e933

Merge branch 'develop' into issue-25134-should-as-query

cc7b011

Add entry to changelog

26be2d7

Merge branch 'release/13.0.0' into issue-25134-should-as-query

e0a97ee

Merge branch 'issue-25134-should-as-query' of github.com:cypress-io/c…

04b5966

…ypress into issue-25134-should-as-query

Fix changelog again

4dc8617

Fix changelog again

9dc14b1

Tweak changelog validation to work better on release branches

cba984e

add versions.

5bb5eaf

BlueWinds self-assigned this Feb 14, 2023

This was referenced Feb 14, 2023

Remove Cypress.ensure.isChildCommand #25811

Closed

Documentation for Cypress.ensure cypress-io/cypress-documentation#5054

Merged

Refactor .should()/.and() to be "standalone" commands #24904

Closed

BlueWinds added 4 commits February 21, 2023 09:36

Merge remote-tracking branch 'origin/release/13.0.0' into issue-25134…

d57437d

…-should-as-query

Review changes

63b100c

Fix changelog entry

5eb3e85

Remove test for .should() only being usable as child

b48cf50

BlueWinds requested a review from chrisbreiding February 23, 2023 17:13

chrisbreiding reviewed Feb 28, 2023

View reviewed changes

packages/driver/src/cypress/state.ts Show resolved Hide resolved

chrisbreiding approved these changes Feb 28, 2023

View reviewed changes

Review feedback

4b6d9f9

emilyrohrbough reviewed Mar 2, 2023

View reviewed changes

Merge branch 'develop' into issue-25134-should-as-query

84f7c2d

emilyrohrbough changed the base branch from release/13.0.0 to merge-develop-into-13 April 4, 2023 13:15

Base automatically changed from merge-develop-into-13 to release/13.0.0 May 5, 2023 18:58

mjhenkes deleted the branch old-release/13.0.0 June 13, 2023 20:15

mjhenkes closed this Jun 13, 2023

AtofStryker mentioned this pull request Jul 6, 2023

Update guides for Cy 13, where assertions are now commands cypress-io/cypress-documentation#5081

Merged

AtofStryker added a commit to cypress-io/cypress-documentation that referenced this pull request Jul 6, 2023

fix: update retry ability guide and migration guide now that should()…

94ea50a

… and and() will not be queries in v13. see cypress-io/cypress#25738

AtofStryker added a commit to cypress-io/cypress-documentation that referenced this pull request Jul 6, 2023

revert: images changes due to should() and and() being queries, which…

fe5ee25

… is no longer applicable due to cypress-io/cypress#25738

cjcrandall mentioned this pull request Aug 12, 2023

Chains of query commands do not retry anything before an assertion #25134

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

breaking: `.should()` and `.and()` are now queries. #25738

breaking: `.should()` and `.and()` are now queries. #25738

BlueWinds commented Feb 7, 2023 •

edited

Loading

emilyrohrbough Mar 2, 2023 •

edited

Loading

emilyrohrbough Mar 2, 2023

emilyrohrbough Mar 2, 2023

emilyrohrbough Mar 2, 2023

emilyrohrbough Mar 2, 2023

emilyrohrbough Mar 2, 2023

emilyrohrbough Mar 2, 2023

		@@ -5,6 +5,8 @@ _Released 03/1/2023 (PENDING)_

		Breaking Changes:

		- The [`.should()` and `.and()`](/api/commands/should) assertions are now queries. This means that they are fully retryable, and it is safe to chain further commands that interact with the DOM after them. Assertions are also now re-run as part of aliases. Addresses [#25134](https://github.com/cypress-io/cypress/issues/25134) and [#25491](https://github.com/cypress-io/cypress/issues/25491). Addressed in [#25738](https://github.com/cypress-io/cypress/pull/25738).


		expect(getLog.get('state')).to.eq('pending')
		expect(getLog.get('state')).to.eq('passed')

	it('throws a good error when aliased subject disappears', function (done) {
	it('throws an error when aliased subject disappears', function (done) {


		it('sets type to parent when assertion did not involve current subject and didnt have arguments', (done) => {

breaking: .should() and .and() are now queries. #25738

breaking: .should() and .and() are now queries. #25738

Conversation

BlueWinds commented Feb 7, 2023 • edited Loading

Additional details

Steps to test

How has the user experience changed?

PR Tasks

emilyrohrbough Mar 2, 2023 • edited Loading

Choose a reason for hiding this comment

emilyrohrbough Mar 2, 2023

Choose a reason for hiding this comment

emilyrohrbough Mar 2, 2023

Choose a reason for hiding this comment

emilyrohrbough Mar 2, 2023

Choose a reason for hiding this comment

emilyrohrbough Mar 2, 2023

Choose a reason for hiding this comment

emilyrohrbough Mar 2, 2023

Choose a reason for hiding this comment

emilyrohrbough Mar 2, 2023

Choose a reason for hiding this comment

breaking: `.should()` and `.and()` are now queries. #25738

breaking: `.should()` and `.and()` are now queries. #25738

BlueWinds commented Feb 7, 2023 •

edited

Loading

emilyrohrbough Mar 2, 2023 •

edited

Loading