Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(spy): fix mockImplementation for function overload and unions #6181

Merged
merged 4 commits into from
Jul 22, 2024

Conversation

hi-ogawa
Copy link
Contributor

@hi-ogawa hi-ogawa commented Jul 21, 2024

Description

Previously we had mockImplementation(fn: T) where T extends (...args: any[]) => any, but such T can 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> inside MockInstance<T>. Another way which Jest does is to have a wrapper SpiedFunction<T> for MockInstance<(...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, SpiedFunction doesn't cover the case of vi.mocked helper, 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:

  • It's really useful if your PR references an issue where it is discussed ahead of time. If the feature is substantial or introduces breaking changes without a discussion, PR might be closed.
  • Ideally, include a test that fails without this PR but passes with it.
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Tests

  • Run the tests with pnpm test:ci.

Documentation

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs command.

Changesets

  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.

@hi-ogawa hi-ogawa marked this pull request as ready for review July 22, 2024 01:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants