feat: allow extending toEqual (fix #2875) #4880

tigranmk · 2024-01-05T09:26:23Z

Description

This PR solves issue #2875 .

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

It's really useful if your PR references an issue where it is discussed ahead of time. If the feature is substantial or introduces breaking changes without a discussion, PR might be closed.
Ideally, include a test that fails without this PR but passes with it.
Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Tests

Run the tests with pnpm test:ci.

Documentation

If you introduce new functionality, document it. You can run documentation with pnpm run docs command.

Changesets

Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.

netlify · 2024-01-05T09:26:28Z

✅ Deploy Preview for fastidious-cascaron-4ded94 canceled.

Name	Link
🔨 Latest commit	`7018ef5`
🔍 Latest deploy log	https://app.netlify.com/sites/fastidious-cascaron-4ded94/deploys/65a158629bef8c0008661393

sheremet-va · 2024-01-05T09:50:04Z

Is this a duplicate of #4586?

tigranmk · 2024-01-05T11:07:07Z

Is this a duplicate of #4586?

Seems, yes. I have not noticed it, as #4586 is not attached to #2875 .

I can see some differences between jest-asymmetric-matchers.ts and jest-asymmetric-matchers.ts files and not only.
I will leave comment in #4586

tigranmk · 2024-01-08T13:07:02Z

@sheremet-va As #4586 is closed, maybe you can review this one ?

docs/api/expect.md

sheremet-va

LGTM 👍🏻

hi-ogawa

Looks nice! I didn't look into the implementation, but a few wordings in documentation felt off, so I made some suggestions there.

docs/api/expect.md

hi-ogawa

Jest's spy related matchers (e.g. toHaveBeenCalledWith, toHaveReturnedWith) seem to also use custom testers for argument/return values comparison.
https://github.com/jestjs/jest/blob/2178fa2183cb7cb2ac3e262388499bafd032ef03/packages/expect/src/spyMatchers.ts#L64-L65
https://github.com/jestjs/jest/pull/13654/files#diff-9ce99fa9b58d394529495c6d13e759f0a3a6e892420327289ab50aa33f18a4a1

Probably you missed updating these parts of jestEquals?

vitest/packages/expect/src/jest-expect.ts

Lines 482 to 485 in 9ec3f74

    
           def(['toHaveBeenCalledWith', 'toBeCalledWith'], function (...args) { 
        
             const spy = getSpy(this) 
        
             const spyName = spy.getMockName() 
        
             const pass = spy.mock.calls.some(callArg => jestEquals(callArg, args, [iterableEquality]))

packages/expect/src/jest-utils.ts

tigranmk · 2024-01-12T12:31:12Z

Probably you missed updating these parts of jestEquals?

Yes, thanks for noticing it, already updated.

hi-ogawa · 2024-01-12T13:46:34Z

test/core/test/expect.test.ts

+  const arePersonsEqual = (a: unknown, b: unknown, customTesters: Array<Tester>) => {
+    const isAPerson = a instanceof Person
+    const isBPerson = b instanceof Person
+
+    if (isAPerson && isBPerson)
+      return a.name === b.name && equals(a.address, b.address, customTesters)


Tests look good!

Just this one, I think using this.equals reflects API better than using equals export. Maybe you should rewrite it to function arePersonsEqual(this: TesterContext, a: unknown, ...) { ... }?

tigranmk force-pushed the feat/allow-extending-toEqual branch from a69fae9 to 40fce2e Compare January 5, 2024 09:49

tigranmk mentioned this pull request Jan 8, 2024

feat: add expect.addEqualityTesters API #4586

Closed

6 tasks

tigranmk force-pushed the feat/allow-extending-toEqual branch from 40fce2e to ec0b4a9 Compare January 8, 2024 11:51

sheremet-va requested changes Jan 8, 2024

View reviewed changes

docs/api/expect.md Outdated Show resolved Hide resolved

tigranmk force-pushed the feat/allow-extending-toEqual branch from ec0b4a9 to a0f502e Compare January 8, 2024 15:49

sheremet-va approved these changes Jan 8, 2024

View reviewed changes

sheremet-va added this to the 1.2.0 milestone Jan 8, 2024

tigranmk force-pushed the feat/allow-extending-toEqual branch from a0f502e to f423825 Compare January 8, 2024 16:14

hi-ogawa reviewed Jan 10, 2024

View reviewed changes

docs/api/expect.md Outdated Show resolved Hide resolved

docs/api/expect.md Outdated Show resolved Hide resolved

docs/api/expect.md Outdated Show resolved Hide resolved

docs/api/expect.md Outdated Show resolved Hide resolved

hi-ogawa reviewed Jan 10, 2024

View reviewed changes

docs/api/expect.md Outdated Show resolved Hide resolved

tigranmk force-pushed the feat/allow-extending-toEqual branch 4 times, most recently from 4e97ba4 to 2bd4de2 Compare January 10, 2024 13:24

tigranmk requested a review from hi-ogawa January 10, 2024 13:54

hi-ogawa approved these changes Jan 10, 2024

View reviewed changes

tigranmk force-pushed the feat/allow-extending-toEqual branch 2 times, most recently from 338521c to 422d479 Compare January 10, 2024 15:06

hi-ogawa reviewed Jan 12, 2024

View reviewed changes

packages/expect/src/jest-utils.ts Show resolved Hide resolved

feat: allow extending toEqual (fix vitest-dev#2875)

c69fb7b

tigranmk force-pushed the feat/allow-extending-toEqual branch from 422d479 to c69fb7b Compare January 12, 2024 12:30

tigranmk requested a review from hi-ogawa January 12, 2024 12:32

Merge branch 'main' into feat/allow-extending-toEqual

fca9ac2

hi-ogawa reviewed Jan 12, 2024

View reviewed changes

hi-ogawa approved these changes Jan 12, 2024

View reviewed changes

This was referenced Apr 14, 2024

fix(expect): fix toEqual and toMatchObject with circular references #5535

Merged

Cannot test object with multiple circular references #5533

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: allow extending toEqual (fix #2875) #4880

feat: allow extending toEqual (fix #2875) #4880

tigranmk commented Jan 5, 2024 •

edited

Loading

netlify bot commented Jan 5, 2024 •

edited

Loading

sheremet-va commented Jan 5, 2024

tigranmk commented Jan 5, 2024 •

edited

Loading

tigranmk commented Jan 8, 2024

sheremet-va left a comment

hi-ogawa left a comment

hi-ogawa left a comment •

edited

Loading

tigranmk commented Jan 12, 2024

hi-ogawa Jan 12, 2024

	def(['toHaveBeenCalledWith', 'toBeCalledWith'], function (...args) {
	const spy = getSpy(this)
	const spyName = spy.getMockName()
	const pass = spy.mock.calls.some(callArg => jestEquals(callArg, args, [iterableEquality]))

feat: allow extending toEqual (fix #2875) #4880

feat: allow extending toEqual (fix #2875) #4880

Conversation

tigranmk commented Jan 5, 2024 • edited Loading

Description

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

Tests

Documentation

Changesets

netlify bot commented Jan 5, 2024 • edited Loading

✅ Deploy Preview for fastidious-cascaron-4ded94 canceled.

sheremet-va commented Jan 5, 2024

tigranmk commented Jan 5, 2024 • edited Loading

tigranmk commented Jan 8, 2024

sheremet-va left a comment

Choose a reason for hiding this comment

hi-ogawa left a comment

Choose a reason for hiding this comment

hi-ogawa left a comment • edited Loading

Choose a reason for hiding this comment

tigranmk commented Jan 12, 2024

hi-ogawa Jan 12, 2024

Choose a reason for hiding this comment

tigranmk commented Jan 5, 2024 •

edited

Loading

netlify bot commented Jan 5, 2024 •

edited

Loading

tigranmk commented Jan 5, 2024 •

edited

Loading

hi-ogawa left a comment •

edited

Loading