feat: add Cypress.Commands.overwriteQuery #25674

BlueWinds · 2023-02-01T20:45:27Z

Closes Can we please overwrite query commands #25078

Additional details

Queries can now be overwritten in a similar way to other commands, via the use of Cypress.Commands.overwriteQuery(). Queries cannot overwrite non-queries, and non-queries cannot overwrite queries; like over like only.

The upcoming documentation PR will contain more examples and details.

Steps to test

How has the user experience changed?

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? Docs for Cypress.Commands.overwriteQuery cypress-documentation#5048
Have API changes been updated in the type definitions?

cypress · 2023-02-01T21:19:56Z

Passing run #44015 ↗︎

0	567	0	0	0

Details:

Merge branch 'develop' into issue-25078-overwrite-queries
Project: cypress	Commit: `4b2f7aa8e7`
Status: Passed	Duration: 07:19 💡
Started: Feb 13, 2023 5:31 PM	Ended: Feb 13, 2023 5:39 PM

_{This comment has been generated by cypress-bot as a result of this
project's GitHub integration settings.}

cli/CHANGELOG.md

emilyrohrbough · 2023-02-01T21:39:38Z

packages/driver/src/cypress/commands.ts

@@ -173,6 +171,26 @@ export default {
        queries[name] = fn
        cy.addQuery({ name, fn })
      },
+
+      overwriteQuery (name: string, fn: () => QueryFunction) {


Why wouldn't this logic be 1:1 with add command beyond the error handling and using addQuery?

The main difference is that queries don't have the concept of "parent/child" built into the API the same way that non-query commands do.

The call signature of a parent command is fn(...args) (not accepting a subject at all), while a child command is fn(subject, ...args) (taking the subject as the first argument).

All queries use the signature of fn(...args), so we get to skip the conditional check of slicing the subject off of args - it's never there, and the args require no manipulation.

The other difference that the commands object stores commands[name] = { name, fn, type, prevSubject } while queries stores only queries[name] = fn.

This is because when a command is overwritten, it needs to maintain the same type and previousSubject values as the original; queries have neither of these, and all we need to create the overwrite is the original function.

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

Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com>

…ite-queries

flotwig

LGTM

cli/CHANGELOG.md

Co-authored-by: Zach Bloomquist <git@chary.us>

gugarzon · 2023-02-14T15:36:43Z

Hello,

Could you tell me in which release these changes will be available?

BlueWinds · 2023-02-14T15:44:37Z

Hello,

Could you tell me in which release these changes will be available?

#25078 (comment)

Release should go out today or tomorrow.

emilyrohrbough · 2023-02-16T16:55:31Z

@gugarzon This was released in 12.6.0 yesterday!

* fix: update newProject ref when switching between organizations in SelectCloudProjectModal (#25730) * chore: debug page tooltip distance and artifact border (#25727) * misc: debug page tooltip distance and artifact border * add changelog entry * fix CT test * fix: Improve error handling around calls to `this.next` in middleware (#25702) * chore: update changelog validation example (#25742) * misc: improve debug loading text wrap responsiveness (#25703) * misc: Increase max failures in IATR badge to 99 (#25737) * chore: exclude collaborator issues/PRs from triage project (#25769) * feat: add --auto-cancel-after-failures flag (#25237) Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> Co-authored-by: Matt Schile <mschile@cypress.io> Co-authored-by: Ryan Pei <ryanppei@gmail.com> Co-authored-by: Emily Rohrbough <emilyrohrbough@yahoo.com> * chore: Update v8 snapshot cache (#25592) * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * Update update_v8_snapshot_cache.yml * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache --------- Co-authored-by: cypress-bot[bot] <2f0651858c6e38e0+cypress-bot[bot]@users.noreply.github.com> Co-authored-by: Ryan Manuel <ryanm@cypress.io> Co-authored-by: cypress-bot[bot] <47117332+cypress-bot[bot]@users.noreply.github.com> * fix: implement new graphql fields for spec counts (#25757) Co-authored-by: Stokes Player <stokes@cypress.io> Co-authored-by: Mike Plummer <mike-plummer@users.noreply.github.com> * feat: Bundle cy.origin() dependencies at runtime (#25626) Co-authored-by: cypress-bot[bot] <2f0651858c6e38e0+cypress-bot[bot]@users.noreply.github.com> Co-authored-by: Ryan Manuel <ryanm@cypress.io> * chore: remove zenhub from release process (#25701) Co-authored-by: Matt Schile <mschile@cypress.io> * feat: add Cypress.Commands.overwriteQuery (#25674) * feat: add Cypress.Commands.overwriteQuery Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> Co-authored-by: Zach Bloomquist <git@chary.us> * fix: spawn child process with process.env in macOS arm64 (#25753) Co-authored-by: Matt Schile <mschile@cypress.io> Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> Co-authored-by: Zach Bloomquist <github@chary.us> * chore: lint system tests in CI (#25673) * fix: Suppress filesystem errors during glob search (#25774) * chore: issue with ts-loader missing in binary and problematic esbuild norewrite construct (#25797) * chore: update changelog linting (#25809) * docs(guides): add more detail to code-signing (#25794) Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> * chore: update workflows.yml to include the v8 snapshot update branch (#25784) Co-authored-by: cypress-bot[bot] <+cypress-bot[bot]@users.noreply.github.com> * chore: internal request preflight (#25772) --------- Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: cypress-bot[bot] <2f0651858c6e38e0+cypress-bot[bot]@users.noreply.github.com> Co-authored-by: Ryan Manuel <ryanm@cypress.io> Co-authored-by: Matt Henkes <mjhenkes@gmail.com> Co-authored-by: Zach Bloomquist <git@chary.us> * chore: bump for 12.6.0 release (#25812) * chore: release @cypress/webpack-batteries-included-preprocessor-v2.4.0 [skip ci] * chore: release @cypress/webpack-preprocessor-v5.17.0 [skip ci] * test: skip flaky GitDataSource test (#25825) * chore: making our add-to-triage-board workflow reusable within the Cypress-io org (#25820) * chore: Making our add to triage workflow callable from other projects inside the Cypress-io org in Github * chore: updated cypress-example-kitchensink version (#25828) * fix: duplicate and expired cookies (#25761) * chore: add regression tests for duplicate cookies and bad expiry times * avoid prepending domain with dot for cookies that are set with the server side jar. This is to avoid the cookie being duplicated if it is set or overridden in a different context (request that can actually set the cookie or via document.domain) * feat: use cookie.toString() in the cookie patch to more accurately set cookies on the document, which should include other properties besides key=value * fix: add logic to handle expired cookies in the document.cookie patch, as well as in CDP * chore: build binary for cookie fixes for users to test * chore: change name of fixture to something more accurate * chore: comment why we are using the toughCookie toString method in the patch * [run ci] * chore: add changelog entry * [run ci] * fix: revert back to key=value when getting document.cookie as those are the only values are displayed (oversight on my end) * [run ci] * chore: make compatible with cypress.require * fix: add tests for hostOnly/non hostOnly cookies to make sure property gets sent up to automation client correctly. No longer need custom cookie prop to determine destination * [run ci] * fix: stale unit test * chore: adjust comments * [run ci] * fix: bad domain logic * [run ci] * chore: remove irrelevant comment * [run ci] * fix: adjust cookie login text to spec hostOnly cookie within the cookie patch. This should yield the same behavior as we are bound to same origin within the spec bridge * [run ci] * [run ci] * fix: allow for cookies on request of same key to take precedence over cookies in the jar, regardless of how many hierachy cookies exist in the jar * chore: fix cookie misc tests for cy.origin (dont run cy.origin) * [run ci] * chore: skip misc cookie tests in webkit as headless behavior doesn't clear cookies between tests correctly * Revert "fix: allow for cookies on request of same key to take precedence over cookies in the jar, regardless of how many hierachy cookies exist in the jar" This reverts commit 17de188. * [run ci] * chore: split changelog entry into two parts * chore: update logic to remove else statement and add comments * [run ci] * chore: readd windows snapshot branch in workflows * [run ci] * chore: fix workflows from bad merge * [run ci] * Revert "chore: split changelog entry into two parts" This reverts commit 4352ef5. * [run ci] * fix: Fix type definitions for cy.reload() (#25779) Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> * misc: Debug header updates (#25823) * fix: allow running tests outside Vite project root folder (#25801) * fix: allow running tests outside Vite project root folder * update snapshots * add changelog entry --------- Co-authored-by: Lachlan Miller <lachlan.miller.1990@outlook.com> * fix: mount component in [data-cy-root] (#25807) * fix(angular): mount component in [data-cy-root] * fix e2e test * add changelog entry * changelog [skip ci] * changelog --------- Co-authored-by: Lachlan Miller <lachlan.miller.1990@outlook.com> * chore: updating add to triage baord github action to use org secret (#25868) * chore: updating add to triage board github action to use org secret * chore: release @cypress/angular-v2.0.2 [skip ci] * chore: release @cypress/vite-dev-server-v5.0.3 [skip ci] * chore: Update v8 snapshot cache (#25822) Co-authored-by: cypress-bot[bot] <+cypress-bot[bot]@users.noreply.github.com> Co-authored-by: Ryan Manuel <ryanm@cypress.io> * feat: support host only cookies (#25853) * feat: allow setCookie API to take a hostOnly option * chore: add jsdoc/typescript description to render to users * chore: add changelog entry * [run ci] * chore: fix types * chore: fix cookie login tests * chore: update e2e cookie system tests * [run ci] * chore: fix cookie command tests. localhost cookies are calculated as hostOnly, which is consistent with how cypress works today * chore: fix system tests for cookies. * [run ci] * chore: fix system tests * chore: skip hostOnly assertions in webkit (for now) * [run ci] * chore: add property definitions to setCookieOptions * [run ci] * chore: add comments to hostOnly prop in firefox when setting a cookie * fix(webpack-dev-server): touch component-index during onSpecsChange to avoid writing to app file (#25861) * testing: try disabling uTimesSync and see what happens * build binaries [run ci] * fix: touch component index file instead of browser.js * build binaries [run ci] * update test * fix test * add test for custom HTML file in config * use existing component index in webpack-dev-server unit tests --------- Co-authored-by: Lachlan Miller <lachlan.miller.1990@outlook.com> * chore: release @cypress/webpack-dev-server-v3.2.4 [skip ci] * chore: improve types for server automation cookie client (#25836) * chore: improve types for automation cookies * [run ci] * fix: the cookie_behavior tests by syncing cookies immediately if … (#25855) * fix: fix the cookie_behavior tests by syncing cookies immediately if the application is already stable * chore: add changelog entry * [run ci] * chore: address comments from code review * feat: Public API for CT Framework Definitions (#25780) * chore: rework component onboarding in launchpad (#25713) * chore: refactoring and types * rework source of frameworks * revert rename * fix tests * fix more tests * types * update code * use same public API internally * rename interfaces * rename * work on dev server api * fix types * fix test * attempt to support getDevServerConfig * tests * add function to define framework [skip ci] * rework a lot of types * fix test * update tests and types * refactor * revert changes * lint * fix test * revert * remove * add "community" label [skip ci] * refactor * types * lint * fix bug * update function name * address feedback * improve types with Pick * refactor using type guard * correct label --------- Co-authored-by: Zachary Williams <ZachJW34@gmail.com> * chore: typing error * feat: scan for 3rd party ct plugins (#25749) * chore: refactoring and types * rework source of frameworks * revert rename * fix tests * fix more tests * types * update code * use same public API internally * rename interfaces * rename * work on dev server api * fix types * fix test * attempt to support getDevServerConfig * tests * add function to define framework [skip ci] * rework a lot of types * fix test * update tests and types * refactor * revert changes * lint * fix test * revert * remove * add "community" label [skip ci] * refactor * types * lint * fix bug * update function name * address feedback * feat: scan for 3rd party ct plugins * add e2e test * unit tests [run ci] * tweak resolution * rebase, address comments * fix windows paths * remove .gitignore * fix test --------- Co-authored-by: Lachlan Miller <lachlan.miller.1990@outlook.com> * lint config * spacing * try fix race cond * fix import error * build binary * try update snapshot * try using require * support namespaced definitions (#25804) * remove category * add icon prop * support esm -> cjs compiled typescript * fix test * misc: add CTA footer to launchpad framework dropdown (#25831) * remove test project dependencies * rebase * windows * windows again * add changelog entry * changelog * revert workflow * remove worklfow --------- Co-authored-by: Zachary Williams <ZachJW34@gmail.com> Co-authored-by: Adam Stone-Lord <adams@cypress.io> * chore: release @cypress/webpack-dev-server-v3.3.0 [skip ci] * fix: Add missing error message when `req.continue` is used incorrectly (#25884) --------- Co-authored-by: Adam Stone-Lord <adams@cypress.io> Co-authored-by: Zachary Williams <ZachJW34@gmail.com> Co-authored-by: Mike Plummer <mike-plummer@users.noreply.github.com> Co-authored-by: Matt Schile <mschile@cypress.io> Co-authored-by: Alejandro Estrada <estrada9166@gmail.com> Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> Co-authored-by: Ryan Pei <ryanppei@gmail.com> Co-authored-by: Emily Rohrbough <emilyrohrbough@yahoo.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: cypress-bot[bot] <2f0651858c6e38e0+cypress-bot[bot]@users.noreply.github.com> Co-authored-by: Ryan Manuel <ryanm@cypress.io> Co-authored-by: cypress-bot[bot] <47117332+cypress-bot[bot]@users.noreply.github.com> Co-authored-by: Mark Noonan <mark@cypress.io> Co-authored-by: Stokes Player <stokes@cypress.io> Co-authored-by: Chris Breiding <chrisbreiding@users.noreply.github.com> Co-authored-by: Zach Bloomquist <git@chary.us> Co-authored-by: willmsC <50909991+willmsC@users.noreply.github.com> Co-authored-by: Zach Bloomquist <github@chary.us> Co-authored-by: cypress-bot[bot] <+cypress-bot[bot]@users.noreply.github.com> Co-authored-by: Tim Griesser <tgriesser10@gmail.com> Co-authored-by: Matt Henkes <mjhenkes@gmail.com> Co-authored-by: semantic-release-bot <semantic-release-bot@martynus.net> Co-authored-by: Ben M <benm@cypress.io> Co-authored-by: Bill Glesias <bglesias@gmail.com> Co-authored-by: Podles <78863563+podlesny-j@users.noreply.github.com> Co-authored-by: Paolo Caleffi <p.caleffi@dreamonkey.com> Co-authored-by: Lachlan Miller <lachlan.miller.1990@outlook.com>

BlueWinds added 4 commits February 1, 2023 12:11

feat: add Cypress.Commands.overwriteQuery

4802ab9

Add changelog entry

27c666a

Add types for overwriteQuery

9eaa132

Fix changelog entry

151a71f

emilyrohrbough reviewed Feb 1, 2023

View reviewed changes

cli/CHANGELOG.md Outdated Show resolved Hide resolved

emilyrohrbough reviewed Feb 1, 2023

View reviewed changes

packages/driver/cypress/e2e/cypress/cy.cy.js Show resolved Hide resolved

Blue F and others added 3 commits February 1, 2023 13:55

Update cli/CHANGELOG.md

bc6b29c

Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com>

Merge remote-tracking branch 'origin/develop' into issue-25078-overwr…

621c5d8

…ite-queries

TS fix

2890d70

BlueWinds mentioned this pull request Feb 6, 2023

Docs for Cypress.Commands.overwriteQuery cypress-io/cypress-documentation#5048

Merged

BlueWinds and others added 2 commits February 6, 2023 11:04

Changelog fix

58e19c7

Merge branch 'develop' into issue-25078-overwrite-queries

2e2b77a

BlueWinds requested review from emilyrohrbough and flotwig February 7, 2023 19:21

flotwig approved these changes Feb 8, 2023

View reviewed changes

cli/CHANGELOG.md Outdated Show resolved Hide resolved

BlueWinds requested a review from mjhenkes February 8, 2023 17:12

Update cli/CHANGELOG.md

1327452

Co-authored-by: Zach Bloomquist <git@chary.us>

mjhenkes approved these changes Feb 9, 2023

View reviewed changes

emilyrohrbough mentioned this pull request Feb 10, 2023

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

Merged

Merge branch 'develop' into issue-25078-overwrite-queries

4b2f7aa

BlueWinds merged commit a11e266 into develop Feb 13, 2023

BlueWinds deleted the issue-25078-overwrite-queries branch February 13, 2023 19:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add Cypress.Commands.overwriteQuery #25674

feat: add Cypress.Commands.overwriteQuery #25674

BlueWinds commented Feb 1, 2023 •

edited

cypress bot commented Feb 1, 2023 •

edited

emilyrohrbough Feb 1, 2023

BlueWinds Feb 1, 2023 •

edited

flotwig left a comment

gugarzon commented Feb 14, 2023

BlueWinds commented Feb 14, 2023 •

edited

emilyrohrbough commented Feb 16, 2023

feat: add Cypress.Commands.overwriteQuery #25674

feat: add Cypress.Commands.overwriteQuery #25674

Conversation

BlueWinds commented Feb 1, 2023 • edited

Additional details

Steps to test

How has the user experience changed?

PR Tasks

cypress bot commented Feb 1, 2023 • edited

Passing run #44015 ↗︎

emilyrohrbough Feb 1, 2023

Choose a reason for hiding this comment

BlueWinds Feb 1, 2023 • edited

Choose a reason for hiding this comment

flotwig left a comment

Choose a reason for hiding this comment

gugarzon commented Feb 14, 2023

BlueWinds commented Feb 14, 2023 • edited

emilyrohrbough commented Feb 16, 2023

BlueWinds commented Feb 1, 2023 •

edited

cypress bot commented Feb 1, 2023 •

edited

BlueWinds Feb 1, 2023 •

edited

BlueWinds commented Feb 14, 2023 •

edited