Make error messages more explicit for toBeCalledWith assertions

[mkubilayk]

Summary

This adds more information to toBeCalledWith assertion fail messages by specifically telling which argument(s) didn't match with the expected value(s).

Fix #3523.

I'm not exactly sure about messages. Please have a look and share your ideas. Currently it reports back all argument mismatches from the last 3 (CALL_PRINT_LIMIT) calls for toBeCalledWith fails. All argument mismatches from the last call for lastCalledWith fails.

const fn = jest.fn();

fn(undefined, { foo: 'bar', fizz: 'buzz' });
fn({}, { foo: 'bar', fizz: 'buzz1' }, 2);
fn({}, { fizz: 'buzz' }, 3, 'extra');

expect(fn).toHaveBeenCalledWith(
    expect.anything(),
    expect.objectContaining({ fizz: 'buzz' }),
    3
);

const fn = jest.fn();

fn(undefined, { foo: 'bar', fiz: 'buzz' });
fn({}, { foo: 'bar', fizz: 'buzz1' });

expect(fn).toHaveBeenLastCalledWith(
    expect.anything(), 
    expect.objectContaining({ fizz: 'buzz' })
);

[thymikee]

wow, looks so much better!

[thymikee]

Could we reverse the ordering so it reads chronologically?
Also cc: @aaronabramov @cpojer what do you think?

[mkubilayk]

Sure. Do you still want to show the last N calls but in chronological order? Or have the reports from the first N calls? Either way it's going to be inconsistent with what we have in toBeCalled, though.

[thymikee]

Maybe let's wait with that until we get more feedback on this

[codecov-io]

Codecov Report

Merging #3913 into master will increase coverage by 0.08%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master    #3913      +/-   ##
==========================================
+ Coverage   59.85%   59.93%   +0.08%     
==========================================
  Files         196      196              
  Lines        6760     6777      +17     
  Branches        6        6              
==========================================
+ Hits         4046     4062      +16     
- Misses       2711     2712       +1     
  Partials        3        3

Impacted Files	Coverage Δ
packages/jest-matchers/src/spy_matchers.js	94.59% <100%> (-0.49%)	⬇️
packages/jest-matchers/src/utils.js	96.29% <100%> (+0.29%)	⬆️

---

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 a7acc5a...5b78d9b. Read the comment docs.

[cpojer]

I don't want this dependency. Can you inline it or find something that isn't lodash? Thanks.

[mkubilayk]

Will update. 👍

[cpojer]

Yeah I like it.

[mkubilayk]

@cpojer removed the dependency.

[cpojer]

Awesome! Thank you for making this work.

[github-actions]

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.