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

Add mockFn.mock.lastCall to easily retrieve the last call arguments #10863

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/MockFunctionAPI.md
Expand Up @@ -77,6 +77,16 @@ mockFn.mock.instances[0] === a; // true
mockFn.mock.instances[1] === b; // true
```

### `mockFn.mock.lastCall`

An array containing the call arguments of the last call that was made to this mock function. If the function was not called, it will return `undefined`.

For example: A mock function `f` that has been called twice, with the arguments `f('arg1', 'arg2')`, and then with the arguments `f('arg3', 'arg4')`, would have a `mock.lastCall` array that looks like this:

```js
['arg3', 'arg4'];
```

### `mockFn.mockClear()`

Resets all information stored in the [`mockFn.mock.calls`](#mockfnmockcalls) and [`mockFn.mock.instances`](#mockfnmockinstances) arrays.
Expand Down
3 changes: 3 additions & 0 deletions docs/MockFunctions.md
Expand Up @@ -75,6 +75,9 @@ expect(someMockFunction.mock.instances.length).toBe(2);
// The object returned by the first instantiation of this function
// had a `name` property whose value was set to 'test'
expect(someMockFunction.mock.instances[0].name).toEqual('test');

// The first argument of the last call to the function was 'test'
expect(someMockFunction.mock.lastCall[0]).toBe('test');
```

## Mock Return Values
Expand Down
26 changes: 26 additions & 0 deletions packages/jest-mock/src/__tests__/index.test.ts
Expand Up @@ -1064,6 +1064,32 @@ describe('moduleMocker', () => {
expect(fn.getMockName()).toBe('myMockFn');
});

test('jest.fn should provide the correct lastCall', () => {
const mock = jest.fn();

expect(mock.mock.lastCall).toBeUndefined();

mock('first');
mock('second');
mock('last', 'call');

expect(mock).toHaveBeenLastCalledWith('last', 'call');
expect(mock.mock.lastCall).toEqual(['last', 'call']);
});

test('lastCall gets reset by mockReset', () => {
const mock = jest.fn();

mock('first');
mock('last', 'call');

expect(mock.mock.lastCall).toEqual(['last', 'call']);

mock.mockReset();

expect(mock.mock.lastCall).toBeUndefined();
});

test('mockName gets reset by mockReset', () => {
const fn = jest.fn();
expect(fn.getMockName()).toBe('jest.fn()');
Expand Down
8 changes: 8 additions & 0 deletions packages/jest-mock/src/index.ts
Expand Up @@ -101,6 +101,10 @@ type MockFunctionState<T, Y extends Array<unknown>> = {
calls: Array<Y>;
instances: Array<T>;
invocationCallOrder: Array<number>;
/**
* Getter for retrieving the last call arguments
*/
lastCall?: Y;
/**
* List of results of calls to the mock function.
*/
Expand Down Expand Up @@ -456,6 +460,9 @@ class ModuleMockerClass {
state = this._defaultMockState();
this._mockState.set(f, state);
}

state.lastCall = state.calls[state.calls.length - 1];

return state;
}

Expand All @@ -476,6 +483,7 @@ class ModuleMockerClass {
calls: [],
instances: [],
invocationCallOrder: [],
lastCall: undefined,
results: [],
};
}
Expand Down