fix: vitest custom tester with toMatchObject

[sukovanej]

Currently, the usage of the custom tester breaks expect(...).toMatchObject(...). Failing example:

    expect({ a: 1, b: 2 }).toMatchObject({ a: 1 })

The reason is that toMatchObject in vitest is implemented as an equality check with subsetEquality as a last custom tester. Our custom tester currently doesn't have any skip logic to allow continuation of the testers pipeline it's part of. Another problematic thing is that the toMatchObject is not commutative, and it uses equality which is commutative. Therefore in equal impl of Option, Either, ... the matching breaks when the arguments are passed to Equal.equals in an opposite order.

[changeset-bot]

🦋 Changeset detected

Latest commit: 9db3161

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 24 packages

Name	Type
effect	Patch
@effect/vitest	Patch
@effect/cli	Patch
@effect/experimental	Patch
@effect/opentelemetry	Patch
@effect/platform-browser	Patch
@effect/platform-bun	Patch
@effect/platform-node-shared	Patch
@effect/platform-node	Patch
@effect/platform	Patch
@effect/printer-ansi	Patch
@effect/printer	Patch
@effect/rpc-http	Patch
@effect/rpc	Patch
@effect/schema	Patch
@effect/sql-mssql	Patch
@effect/sql-mysql2	Patch
@effect/sql-pg	Patch
@effect/sql-sqlite-bun	Patch
@effect/sql-sqlite-node	Patch
@effect/sql-sqlite-react-native	Patch
@effect/sql-sqlite-wasm	Patch
@effect/sql	Patch
@effect/typeclass	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[mikearnaldi]

Not sure why but this makes some tests fail, also not sure about the early escape of Equal

[sukovanej]

Not sure why but this makes some tests fail, also not sure about the early escape of Equal

It really looks like the assertion in the failing test is incorrect. I'm not sure why it'd occur just now tho.

[sukovanej]

also not sure about the early escape of Equal

Me neither, but I'm not aware of any better solution. Also, I have another example that will fail even with the proposed change.

  it("Data.struct", () => {
    const alice = Data.struct({ name: "Alice", age: 30 })

    expect(alice).toMatchObject(Data.struct({ name: "Alice" }))
  })

[mikearnaldi]

also not sure about the early escape of Equal

Me neither, but I'm not aware of any better solution. Also, I have another example that will fail even with the proposed change.

  it("Data.struct", () => {
    const alice = Data.struct({ name: "Alice", age: 30 })

    expect(alice).toMatchObject(Data.struct({ name: "Alice" }))
  })

Is that because of the symbols?

[sukovanej]

also not sure about the early escape of Equal

Me neither, but I'm not aware of any better solution. Also, I have another example that will fail even with the proposed change.

  it("Data.struct", () => {
    const alice = Data.struct({ name: "Alice", age: 30 })

    expect(alice).toMatchObject(Data.struct({ name: "Alice" }))
  })

Is that because of the symbols?

It's because of hash check in compareBoth.

[mikearnaldi]

Hash checks are nullified when structural is enabled, they are all 0

…

On Sat, 4 May 2024, 11:33 Milan Suk, ***@***.***> wrote: also not sure about the early escape of Equal Me neither, but I'm not aware of any better solution. Also, I have another example that will fail even with the proposed change. it("Data.struct", () => { const alice = Data.struct({ name: "Alice", age: 30 }) expect(alice).toMatchObject(Data.struct({ name: "Alice" })) }) Is that because of the symbols? It's because of hash check in compareBoth. — Reply to this email directly, view it on GitHub <#2688 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AFZAKCQVLJNVM44DLMBUFUTZASTP3AVCNFSM6AAAAABHEOINSWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDAOJUGA4TMMZQGE> . You are receiving this because your review was requested.Message ID: ***@***.***>

[sukovanej]

I debugged that locally, the circuit shorts in here. Even if the hash check wasn't there it would return false on comparison inside of the equal of the StructuralPrototype.