fix(spy): fix mockImplementation for function overload and unions#6181
Merged
sheremet-va merged 4 commits intovitest-dev:mainfrom Jul 22, 2024
Merged
Conversation
sheremet-va
approved these changes
Jul 22, 2024
This was referenced Aug 12, 2024
This was referenced Aug 28, 2024
This was referenced Sep 5, 2024
This was referenced Sep 10, 2024
This was referenced Sep 23, 2024
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
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.
Description
Previously we had
mockImplementation(fn: T)whereT extends (...args: any[]) => any, but suchTcan include arbitrary overload and union types, so it looks like it's important to have singly picked function type(...args: Paramters<T>) => ReturnType<T>for the most reasonable usability.There are probably two ways to solve this. One way is like this PR to
NormalizedPrecedure<T>insideMockInstance<T>. Another way which Jest does is to have a wrapperSpiedFunction<T>forMockInstance<(...args: Parameters<T>) => ReturnType<T>>.I think what Jest does still have issues left (though I'm not sure if it's intentional or not). For example,
SpiedFunctiondoesn't cover the case ofvi.mockedhelper, so it would fail the example from OP #6155. So, I thought it's more robust to go with the former approach.Please don't delete this checklist! Before submitting the PR, please make sure you do the following:
pnpm-lock.yamlunless you introduce a new test example.Tests
pnpm test:ci.Documentation
pnpm run docscommand.Changesets
feat:,fix:,perf:,docs:, orchore:.