breaking: Remove deprecated cy.stub(obj, method, fn) signature #31548
Conversation
This file contains hidden or 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
BREAKING: Remove deprecated cy.stub(obj, method, fn) signature
cypress
|
||||||||||||||||||||||||||||||||||||||||
| Project |
cypress
|
| Branch Review |
remove-deprecated-cy-stub-sig
|
| Run status |
|
| Run duration | 18m 56s |
| Commit |
|
| Committer | Jennifer Shehane |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
11
|
Pending
|
1099
|
Skipped
|
0
|
Passing
|
26561
|
| View all changes introduced in this branch ↗︎ | |
UI Coverage
45.92%
|
|
|---|---|
|
Untested elements
|
187
|
|
Tested elements
|
163
|
Accessibility
92.7%
|
|
|---|---|
|
Failed rules
|
3 critical
8 serious
2 moderate
2 minor
|
|
Failed elements
|
886
|
jennifer-shehane
requested review from
AtofStryker
and removed request for
AtofStryker
AtofStryker
approved these changes
May 2, 2025
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.
Additional details
This signature was removed from sinon in v3. This removes the signature that we deprecated long ago in cy.stub.
This did require some updates in places where we were still using it, so could break some users.
Steps to test
Test pass. Using cy.stub(obj, method, fn) should no longer work properly.
How has the user experience changed?
There would be TypeScript errors for TS users using this signature.
It looks like the stub will just silently not apply with the updates. Here's an example of using the old signature - the assertion now fails since the stub wasn't properly applied.
PR Tasks
cypress-documentation?type definitions?