docs: update `toHaveBeenCalledWith` to include type of equality check #12222

Biki-das · 2022-01-06T15:32:37Z

The documentation for .toHaveBeenCalledWith doesn't state the type of equality check performed on the argument.

This means that anyone expecting the object argument used in the mock function .toStrictEqual the passed argument will be confused as the call is actually .toEqual and doesn't compare object classes.

FAIL ./index.test.js
✕ toHaveBeenCalledWith doesn't compare objects strictly (22 ms)

● toHaveBeenCalledWith doesn't compare objects strictly

expect(received).toStrictEqual(expected) // deep equality

- Expected  - 1
+ Received  + 1

- Object {
+ AClass {
    "id": 1,
    "name": "Parent A",
  }

   9 |   expect(utils.f2).toHaveBeenCalledWith(data) // passes
  10 |   expect(utils.f2.mock.calls[0][0]).toEqual(data) // passes
> 11 |   expect(utils.f2.mock.calls[0][0]).toStrictEqual(data) // fails  
     |                                     ^
  12 | })
  13 |

Biki-das · 2022-01-14T15:55:37Z

@SimenB ping

docs/ExpectAPI.md

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

website/versioned_docs/version-26.x/ExpectAPI.md

SimenB · 2022-02-05T08:09:40Z

website/versioned_docs/version-27.0/ExpectAPI.md

@@ -674,7 +674,7 @@ Although the `.toBe` matcher **checks** referential identity, it **reports** a d

 Also under the alias: `.toBeCalled()`

-Use `.toHaveBeenCalled` to ensure that a mock function got called.
+Use `.toHaveBeenCalled` to ensure that a mock function got called.The specific arguments are checked with a `.toEqual` call.


this is put in the wrong call

SimenB · 2022-02-05T08:09:47Z

website/versioned_docs/version-27.1/ExpectAPI.md

@@ -674,7 +674,7 @@ Although the `.toBe` matcher **checks** referential identity, it **reports** a d

 Also under the alias: `.toBeCalled()`

-Use `.toHaveBeenCalled` to ensure that a mock function got called.
+Use `.toHaveBeenCalled` to ensure that a mock function got called.The specific arguments are checked with a `.toEqual` call.


SimenB · 2022-02-05T08:09:50Z

website/versioned_docs/version-27.2/ExpectAPI.md

@@ -674,7 +674,7 @@ Although the `.toBe` matcher **checks** referential identity, it **reports** a d

 Also under the alias: `.toBeCalled()`

-Use `.toHaveBeenCalled` to ensure that a mock function got called.
+Use `.toHaveBeenCalled` to ensure that a mock function got called.The specific arguments are checked with a `.toEqual` call.


SimenB · 2022-02-05T08:09:55Z

website/versioned_docs/version-27.4/ExpectAPI.md

@@ -674,7 +674,7 @@ Although the `.toBe` matcher **checks** referential identity, it **reports** a d

 Also under the alias: `.toBeCalled()`

-Use `.toHaveBeenCalled` to ensure that a mock function got called.
+Use `.toHaveBeenCalled` to ensure that a mock function got called.The specific arguments are checked with a `.toEqual` call.


codecov-commenter · 2022-02-05T08:42:16Z

Codecov Report

Merging #12222 (0c604b4) into main (4f4be57) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main   #12222   +/-   ##
=======================================
  Coverage   67.52%   67.52%           
=======================================
  Files         328      328           
  Lines       17244    17244           
  Branches     5069     5069           
=======================================
  Hits        11644    11644           
  Misses       5567     5567           
  Partials       33       33

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...0c604b4. Read the comment docs.

SimenB · 2022-02-05T08:55:21Z

@Biki-das you've only merged one of the suggestions and not addressed the comment where I didn't leave a suggestion 🙂

Biki-das · 2022-02-05T09:02:49Z

@Biki-das you've only merged one of the suggestions and not addressed the comment where I didn't leave a suggestion 🙂

oh sorry, @SimenB made a new one , see if this works

docs/ExpectAPI.md

Biki-das · 2022-02-07T14:46:48Z

@SimenB , sorry for this mess up here, i was able to understand the changes and applied them as you said, thanks!

SimenB

thanks! 27.5 as well? 🙂

Biki-das · 2022-02-07T14:48:36Z

thanks! 27.5 as well? 🙂

sure

SimenB

perfect, thanks!

github-actions · 2022-03-11T00:07:32Z

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.

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

Doc: stated type of equality check performed on argument

a19a2ff

SimenB requested changes Feb 5, 2022

View reviewed changes

Biki-das requested a review from SimenB February 5, 2022 08:43

fixed wrong call

6ca76bf

SimenB reviewed Feb 5, 2022

View reviewed changes

docs/ExpectAPI.md Outdated Show resolved Hide resolved

Biki-das requested a review from SimenB February 6, 2022 06:05

Applied changes as requested

51304f2

SimenB approved these changes Feb 7, 2022

View reviewed changes

Merge branch 'main' of https://github.com/facebook/jest into 3

b687cf5

Added changes to 27.5

debfe3e

Biki-das requested a review from SimenB February 7, 2022 14:51

SimenB approved these changes Feb 7, 2022

View reviewed changes

SimenB changed the title ~~Doc: update toHaveBeenCalledWith to include type of equality check~~ docs: update toHaveBeenCalledWith to include type of equality check Feb 7, 2022

SimenB merged commit 92f3279 into jestjs:main Feb 7, 2022

Biki-das deleted the 3 branch February 7, 2022 14:56

SimenB mentioned this pull request Feb 7, 2022

doc: update toHaveBeenCalledWith to include type of equality check #11026

Closed

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: update `toHaveBeenCalledWith` to include type of equality check #12222

docs: update `toHaveBeenCalledWith` to include type of equality check #12222

Biki-das commented Jan 6, 2022

Biki-das commented Jan 14, 2022

SimenB Feb 5, 2022

SimenB Feb 5, 2022

SimenB Feb 5, 2022

SimenB Feb 5, 2022

codecov-commenter commented Feb 5, 2022 •

edited

Loading

SimenB commented Feb 5, 2022

Biki-das commented Feb 5, 2022 •

edited

Loading

Biki-das commented Feb 7, 2022

SimenB left a comment

Biki-das commented Feb 7, 2022

SimenB left a comment

github-actions bot commented Mar 11, 2022

docs: update toHaveBeenCalledWith to include type of equality check #12222

docs: update toHaveBeenCalledWith to include type of equality check #12222

Conversation

Biki-das commented Jan 6, 2022

Biki-das commented Jan 14, 2022

SimenB Feb 5, 2022

Choose a reason for hiding this comment

SimenB Feb 5, 2022

Choose a reason for hiding this comment

SimenB Feb 5, 2022

Choose a reason for hiding this comment

SimenB Feb 5, 2022

Choose a reason for hiding this comment

codecov-commenter commented Feb 5, 2022 • edited Loading

Codecov Report

SimenB commented Feb 5, 2022

Biki-das commented Feb 5, 2022 • edited Loading

Biki-das commented Feb 7, 2022

SimenB left a comment

Choose a reason for hiding this comment

Biki-das commented Feb 7, 2022

SimenB left a comment

Choose a reason for hiding this comment

github-actions bot commented Mar 11, 2022

docs: update `toHaveBeenCalledWith` to include type of equality check #12222

docs: update `toHaveBeenCalledWith` to include type of equality check #12222

codecov-commenter commented Feb 5, 2022 •

edited

Loading

Biki-das commented Feb 5, 2022 •

edited

Loading