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.

Sign up for GitHub

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

feat(vitest): add return type and promisable mockFactory #6139

Merged
merged 11 commits into from
Aug 12, 2024
Merged

feat(vitest): add return type and promisable mockFactory #6139

Changes from 4 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
f6bb50c
fix: add return type and promisable mockFactory
syi0808 Jul 15, 2024
01332f4
fix: remove importOriginal generic because of type error
syi0808 Jul 15, 2024
e441e4a
fix: remove partial
syi0808 Jul 15, 2024
c30f0fc
fix: change to promise union type
syi0808 Jul 23, 2024
221209c
fix: remove record
syi0808 Aug 4, 2024
8e23ed0
test: fix test
syi0808 Aug 4, 2024
a23b8cf
fix: add partial and remove null
syi0808 Aug 5, 2024
5603801
add ts-expect-error comment
syi0808 Aug 5, 2024
679af8a
docs: add changes about mock and doMock
syi0808 Aug 6, 2024
d1b1062
Merge branch 'main' into fix/mock-factory-support-return-type
syi0808 Aug 6, 2024
78143bd
docs: remove incorrect information, add a note about return types
sheremet-va Aug 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions packages/vitest/src/types/mocker.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
type Promisable<T> = T | Promise<T>

export type MockFactoryWithHelper<M = unknown> = (
importOriginal: <T extends M>() => Promise<T>
) => any
importOriginal: <T extends M = M>() => Promise<T>
) => Promisable<Record<keyof M, any> | null>
Copy link

@acidoxee acidoxee Jul 23, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My apologies if my initial issue wasn't clear, but what I meant with a "compatible" mock type was not only regarding the keys in the export map, but their values as well.

Ensuring compatible top-level keys would already be a welcome improvement of course, but this doesn't address the correctness of the exports themselves. I'd still be able to provide a completely false (type-wise) mock from the factory, and TypeScript wouldn't tell me anything about it. I would still need to manually add the Awaited<ReturnType<typeof importOriginal>> return type to each of my factories to ensure my mocks are correct.

I reckon being this strict would probably break some people's current types in tests, because they actually have no idea that their mocks are incomplete or plain wrong, but that's the point. I'd understand that some people would want wildly different mocks than their runtime version, even if it breaks their types and the initial module's signature, but in that case they can still escape type validation with a manual any, while the default could be strict adherence to the original module's signature. WDYT?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was a change to keep it as compatible as possible. For typescript users, I thought maybe it could be a breaking change.

I think there are advantages to both from different perspectives. If necessary, I will revise it according to the opinions of other users or maintainers.

export type MockFactory = () => any

export type MockMap = Map<string, Record<string, string | null | MockFactory>>
Expand Down
Loading