archive-gh-me/vitest
1
0
Fork 0
mirror of https://github.com/vitest-dev/vitest.git synced 2025-12-08 18:26:03 +00:00
Code Issues Projects Releases Wiki Activity

fix(spy): don't allow Promise in mockImplementation (#4859)

Browse Source
This commit is contained in:
Vladimir 2024-01-03 18:47:00 +01:00 committed by GitHub
parent 1fee63f259
commit 072e02bf83
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 27 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
packages/spy/src/index.ts
View File

@ -154,7 +154,7 @@ export interface MockInstance<TArgs extends any[] = any[], TReturns = any> {
* const increment = vi.fn().mockImplementation(count => count + 1);
* expect(increment(3)).toBe(4);
*/
mockImplementation(fn: ((...args: TArgs) => TReturns) | (() => Promise<TReturns>)): this
mockImplementation(fn: ((...args: TArgs) => TReturns)): this
/**
* Accepts a function that will be used as a mock implementation during the next call. Can be chained so that multiple function calls produce different results.
* @example
@ -162,7 +162,7 @@ export interface MockInstance<TArgs extends any[] = any[], TReturns = any> {
* expect(fn(3)).toBe(4);
* expect(fn(3)).toBe(3);
*/
mockImplementationOnce(fn: ((...args: TArgs) => TReturns) | (() => Promise<TReturns>)): this
mockImplementationOnce(fn: ((...args: TArgs) => TReturns)): this
/**
* Overrides the original mock implementation temporarily while the callback is being executed.
* @example
@ -479,16 +479,16 @@ function enhanceSpy<TArgs extends any[], TReturns>(
stub.mockReturnValueOnce = (val: TReturns) => stub.mockImplementationOnce(() => val)
stub.mockResolvedValue = (val: Awaited<TReturns>) =>
stub.mockImplementation(() => Promise.resolve(val as TReturns))
stub.mockImplementation(() => Promise.resolve(val as TReturns) as any)
stub.mockResolvedValueOnce = (val: Awaited<TReturns>) =>
stub.mockImplementationOnce(() => Promise.resolve(val as TReturns))
stub.mockImplementationOnce(() => Promise.resolve(val as TReturns) as any)
stub.mockRejectedValue = (val: unknown) =>
stub.mockImplementation(() => Promise.reject(val))
stub.mockImplementation(() => Promise.reject(val) as any)
stub.mockRejectedValueOnce = (val: unknown) =>
stub.mockImplementationOnce(() => Promise.reject(val))
stub.mockImplementationOnce(() => Promise.reject(val) as any)
Object.defineProperty(stub, 'mock', {
get: () => mockContext,

21
test/core/test/jest-mock.test.ts
View File

@ -52,6 +52,27 @@ describe('jest mock compat layer', () => {
expect(mock2.getMockImplementation()).toBeUndefined()
})
it('implementation types allow only function returned types', () => {
function fn() {
return 1
}
function asyncFn() {
return Promise.resolve(1)
}
const mock1 = vi.fn(fn)
const mock2 = vi.fn(asyncFn)
mock1.mockImplementation(() => 2)
// @ts-expect-error promise is not allowed
mock1.mockImplementation(() => Promise.resolve(2))
// @ts-expect-error non-promise is not allowed
mock2.mockImplementation(() => 2)
mock2.mockImplementation(() => Promise.resolve(2))
})
it('implementation sync fn', () => {
const originalFn = function () {
return 'original'