Issue #5197: Add descriptive error to Expect CalledWith methods when missing optional arguments

[jessecarfb]

Summary

Issue: #5197
Specifically, formatMismatchedArgs will not add an error message when the received array gets extra argument(s) w/ undefined value since expected[i] and received[i] will both equal undefined (where received[i] is explicitly set to undefined whereas expected[i] is not in the array)

Test plan

Tested using @mrfunkycold repo: https://github.com/mrfunkycold/jest-demo. New error message:

● testFile › 1. when invoked › 1. fails to print the error line
expect(jest.fn()).toHaveBeenCalledWith(expected)

Expected mock function to have been called with:
  Did not expect argument 2 but it was called with undefined.
  11 | 
  12 |     it('1. fails to print the error line', () => {
> 13 |       expect(logger).toHaveBeenCalledWith('errorMsg');
  14 |     });
  15 |   });
  16 | 
  
  at Object.it (src/typescript_version/testFile.test.ts:13:22)

[codecov-io]

Codecov Report

Merging #5547 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #5547   +/-   ##
=======================================
  Coverage   61.67%   61.67%           
=======================================
  Files         213      213           
  Lines        7160     7160           
  Branches        4        4           
=======================================
  Hits         4416     4416           
  Misses       2743     2743           
  Partials        1        1

---

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 4ca959b...b5118f0. Read the comment docs.

[SimenB]

Could you add a test showing that the error message is correct?

[SimenB]

Nice! Could you update the changelog as well? 🙂

[jessecarfb]

Yep, thanks for reviewing @SimenB! Do we update the changelog for every change or is there a minimum bar?

[SimenB]

My rule of thumb is every change that changes some behaviour should get an entry

[SimenB]

Can you rebase? The diff in this PR is hard to read with all the extra commits

[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.