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: allow getMockImplementation to return "once" implementation #7033

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 5 additions & 5 deletions packages/spy/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -215,12 +215,11 @@ export interface MockInstance<T extends Procedure = Procedure> {
*/
mockRestore(): void
/**
* Performs the same actions as `mockReset` and restores the inner implementation to the original function.
* Returns current permanent mock implementation if there is one.
*
* Note that restoring a mock created with `vi.fn()` will set the implementation to an empty function that returns `undefined`. Restoring a mock created with `vi.fn(impl)` will restore the implementation to `impl`.
* If mock was created with `vi.fn`, it will consider passed down method as a mock implementation.
*
* To automatically call this method before each test, enable the [`restoreMocks`](https://vitest.dev/config/#restoremocks) setting in the configuration.
* @see https://vitest.dev/api/mock#getmockimplementation
* If mock was created with `vi.spyOn`, it will return `undefined` unless a custom implementation was provided.
*/
getMockImplementation(): NormalizedPrecedure<T> | undefined
/**
Expand Down Expand Up @@ -575,7 +574,8 @@ function enhanceSpy<T extends Procedure>(
return stub
}

stub.getMockImplementation = () => implementation
stub.getMockImplementation = () =>
implementationChangedTemporarily ? implementation : (onceImplementations.at(0) || implementation)
stub.mockImplementation = (fn: T) => {
implementation = fn
state.willCall(mockCall)
Expand Down
20 changes: 20 additions & 0 deletions test/core/test/jest-mock.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -518,4 +518,24 @@ describe('jest mock compat layer', () => {
vi.mocked(dogMax.speak).mockReturnValue('woof woof')
expect(dogMax.speak()).toBe('woof woof')
})

it('returns temporary implementations from getMockImplementation()', () => {
const fn = vi.fn()

const temporaryMockImplementation = () => 'mocked value'
fn.mockImplementationOnce(temporaryMockImplementation)
expect(fn.getMockImplementation()).toBe(temporaryMockImplementation)

// After calling it, it should be back to undefined
fn()
expect(fn.getMockImplementation()).toBe(undefined)

const mockImplementation = () => 'other mocked value'
fn.mockImplementation(mockImplementation)
expect(fn.getMockImplementation()).toBe(mockImplementation)

// It should also overwrite permanent implementations
fn.mockImplementationOnce(temporaryMockImplementation)
expect(fn.getMockImplementation()).toBe(temporaryMockImplementation)
})
})
Loading