feat(jest-mock): add `mockFn.mock.lastCall` to retrieve last argument #12285

Biki-das · 2022-01-31T14:49:26Z

Summary

When switching from using sinon mocks to jest, one of the nice things that sinon provided was the ability to retrieve the last call arguments easily. I know that you can use mockFn.mock.calls[mockFn.mock.calls.length - 1] to retrieve it, but mock.lastCall seems a lot easier when you're doing it in a bunch of places. I wanted to at least try adding it and see what the response was. I understand if this is not needed, but it seems like a nice little improvement.

Test plan

I've updated types, added tests for the feature and updated documentation. I ran yarn test for the entire test suite to verify that it was working.

codecov-commenter · 2022-01-31T15:09:48Z

Codecov Report

Merging #12285 (41a82d4) into main (4f4be57) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main   #12285   +/-   ##
=======================================
  Coverage   67.52%   67.52%           
=======================================
  Files         328      328           
  Lines       17244    17246    +2     
  Branches     5069     5070    +1     
=======================================
+ Hits        11644    11646    +2     
  Misses       5567     5567           
  Partials       33       33

Impacted Files	Coverage Δ
packages/jest-mock/src/index.ts	`84.87% <100.00%> (+0.06%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4f4be57...41a82d4. Read the comment docs.

Biki-das · 2022-02-01T15:42:34Z

hey @SimenB does this sound useful to you?

SimenB

I like it, thanks! Left some nits 🙂

SimenB · 2022-02-02T08:12:45Z

website/versioned_docs/version-25.x/MockFunctionAPI.md

@@ -79,6 +79,16 @@ mockFn.mock.instances[0] === a; // true
 mockFn.mock.instances[1] === b; // true
 ```

+### `mockFn.mock.lastCall`


it should not be added to all versioned docs, only the ones in docs/

SimenB · 2022-02-02T08:13:27Z

packages/jest-mock/src/index.ts

@@ -536,6 +543,7 @@ export class ModuleMocker {
      calls: [],
      instances: [],
      invocationCallOrder: [],
+      lastCall: undefined,


it should just not be here I think, not set to undefined (which might be a return value)

SimenB · 2022-02-02T08:13:38Z

packages/jest-mock/src/index.ts

@@ -516,6 +520,9 @@ export class ModuleMocker {
      state = this._defaultMockState();
      this._mockState.set(f, state);
    }
+
+    state.lastCall = state.calls[state.calls.length - 1];


check if state.calls.length > 0 first

CHANGELOG.md

Biki-das · 2022-02-02T08:15:43Z

thanks @SimenB , will surely update this with the required changes

packages/jest-mock/src/__tests__/index.test.ts

Co-authored-by: Simen Bekkhus <sbekkhus91@gmail.com>

mrazauskas · 2022-02-02T09:03:17Z

Hm.. Jest has .lastCalledWith() and many other matchers (like .toBeCalled(), .toBeCalledTimes(), etc) to make mockFn related assertions. It seemed to me like a good design decision – slim .mock object with raw data and a set of matchers to make specific assertions based on that data. To quote the docs: "These matchers are sugar for common forms of inspecting the .mock property."

If there is a need users can add more custom matchers, hence keeping the .mock object generic makes sense. The point here is that extensibility is handled through matchers, not through getters on mockFn.mock (for instance, callCount could be another candidate).

I think the proposal in this PR is overlapping with current functionality (the .lastCalledWith() matcher) and does not follow current design (if I get it right).

Just wanted to leave a note. Might be I miss some use case.

SimenB · 2022-02-02T09:11:33Z

My main motivation is that it'd make jest-mock more usable outside of expect

Biki-das · 2022-02-02T09:12:09Z

My main motivation is that it'd make jest-mock more usable outside of expect

yes that is the intention that i also had while introducing this one

mrazauskas · 2022-02-02T09:17:56Z

My main motivation is that it'd make jest-mock more usable outside of expect

You know it better (; As I said, might be I miss some use cases.

Biki-das · 2022-02-04T18:51:12Z

hey @SimenB is there any problem with my PR'S i am not getting any feedback , or am i doing something wrong?

SimenB

Thanks!

hey @SimenB is there any problem with my PR'S i am not getting any feedback , or am i doing something wrong?

Nope, my energy just goes in bursts 🙂

Biki-das · 2022-02-05T07:54:24Z

Thanks!

hey @SimenB is there any problem with my PR'S i am not getting any feedback , or am i doing something wrong?

Nope, my energy just goes in bursts 🙂

I understand , sorry for my pings, take care.

SimenB · 2022-02-05T07:58:26Z

No worries!

github-actions · 2022-03-08T00:06:43Z

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

Added mockFn.mock.lastCall

1058178

facebook-github-bot added the cla signed label Jan 31, 2022

Added changelog

e2f8668

SimenB requested changes Feb 2, 2022

View reviewed changes

SimenB reviewed Feb 2, 2022

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

Biki-das added 2 commits February 2, 2022 14:07

Applied suggested changes

c2fd2ca

Corrected return state

a612ce0

SimenB reviewed Feb 2, 2022

View reviewed changes

packages/jest-mock/src/__tests__/index.test.ts Outdated Show resolved Hide resolved

packages/jest-mock/src/__tests__/index.test.ts Outdated Show resolved Hide resolved

Biki-das and others added 2 commits February 2, 2022 14:26

Update packages/jest-mock/src/__tests__/index.test.ts

255b0a8

Co-authored-by: Simen Bekkhus <sbekkhus91@gmail.com>

Update packages/jest-mock/src/__tests__/index.test.ts

41a82d4

Co-authored-by: Simen Bekkhus <sbekkhus91@gmail.com>

Biki-das requested a review from SimenB February 2, 2022 09:31

Update CHANGELOG.md

0003b14

SimenB approved these changes Feb 5, 2022

View reviewed changes

SimenB changed the title ~~Doc :- Added mockFn.mock.lastCall to retreive last Arguement~~ feat(jest-mock): add mockFn.mock.lastCall to retrieve last argument Feb 5, 2022

SimenB merged commit b2db6cf into jestjs:main Feb 5, 2022

Biki-das mentioned this pull request Feb 5, 2022

Jest got a new mock sinonjs/sinon#2443

Closed

SimenB mentioned this pull request Feb 24, 2022

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

Closed

munierujp mentioned this pull request Feb 24, 2022

chore(deps): minor update jest to v27.5.1 npm-update-package/example-pat#78

Closed

github-actions bot locked as resolved and limited conversation to collaborators Mar 8, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(jest-mock): add `mockFn.mock.lastCall` to retrieve last argument #12285

feat(jest-mock): add `mockFn.mock.lastCall` to retrieve last argument #12285

Biki-das commented Jan 31, 2022 •

edited

codecov-commenter commented Jan 31, 2022 •

edited

Biki-das commented Feb 1, 2022

SimenB left a comment

SimenB Feb 2, 2022

SimenB Feb 2, 2022

SimenB Feb 2, 2022

Biki-das commented Feb 2, 2022

mrazauskas commented Feb 2, 2022

SimenB commented Feb 2, 2022

Biki-das commented Feb 2, 2022

mrazauskas commented Feb 2, 2022

Biki-das commented Feb 4, 2022

SimenB left a comment

Biki-das commented Feb 5, 2022

SimenB commented Feb 5, 2022

github-actions bot commented Mar 8, 2022

feat(jest-mock): add mockFn.mock.lastCall to retrieve last argument #12285

feat(jest-mock): add mockFn.mock.lastCall to retrieve last argument #12285

Conversation

Biki-das commented Jan 31, 2022 • edited

Summary

Test plan

codecov-commenter commented Jan 31, 2022 • edited

Codecov Report

Biki-das commented Feb 1, 2022

SimenB left a comment

Choose a reason for hiding this comment

SimenB Feb 2, 2022

Choose a reason for hiding this comment

SimenB Feb 2, 2022

Choose a reason for hiding this comment

SimenB Feb 2, 2022

Choose a reason for hiding this comment

Biki-das commented Feb 2, 2022

mrazauskas commented Feb 2, 2022

SimenB commented Feb 2, 2022

Biki-das commented Feb 2, 2022

mrazauskas commented Feb 2, 2022

Biki-das commented Feb 4, 2022

SimenB left a comment

Choose a reason for hiding this comment

Biki-das commented Feb 5, 2022

SimenB commented Feb 5, 2022

github-actions bot commented Mar 8, 2022

feat(jest-mock): add `mockFn.mock.lastCall` to retrieve last argument #12285

feat(jest-mock): add `mockFn.mock.lastCall` to retrieve last argument #12285

Biki-das commented Jan 31, 2022 •

edited

codecov-commenter commented Jan 31, 2022 •

edited