assert: add `matchObjectStrict` and `matchObject` by synapse · Pull Request #53415 · nodejs/node · GitHub

What is this PR doing:

Added 2 new assert functions matchObjectStrict & matchObject
Added tests to check different object types (Feel free to suggest more types to be tested)
Added a new section in the Assert documentation to explain the usage

The compareBranch (used by matchObject) works as follows:

matchObject recursively traverses the actual objects, Map, and Set and rely on deepEqual to compare its values (event across different realms) - N.B. array are directly compared using deepEqual and will not match if they are from different realms
if the value is a plain object then it will retrigger the compareBranch from that branch onward
else will compare the actual and expected values using the built-in isDeepEqual or isDeepStrictEqual based on the loose/strict param
it compares keys - (using Reflect.ownKeys() instead of Object.keys() to include symbol properties)
checks for recursive object values

There are a lot of unrelated changes, making this hard to review. Consider removing those (maybe a problem with the configuration of your text editor?), and run the linters (NODE=node make test-doc -j and make lint-js).

That's hardly what's happening, is it? At least I find the wording very confusing (I would expect the same behavior as strictEqual with the current wording), we should explain in more details what's happening here, what's being compared: is it only own properties? is the prototype important?

Is it actually any? What happens if we pass a primitive?

It's any because it compares the values (and the keys), which could be primitives. I'll add a couple of tests for primitives too.

@nodejs/assert

Feel free to suggest more types to be tested.

Should't this fall back on assert.deepEqual and assert.deepStrictEqual respectively when dealing with anything but simple objects?

If I pass two different KeyObject or CryptoKey instances to matchObject, despite them being different cryptographic keys this doens't throw.

If it falled back on on assert.deepEqual and assert.deepStrictEqual then handling of those respective objects would be handled (#50897).

lib/internal/util/comparisons.js already has these already in

Based on the docs I find it very confusing to discern between this and assert.deep(Strict)Equal. "Matching" suggests (to me at least) that the "expected" argument might be an object with more properties than "actual" but that's not what's documented nor implemented.

Feel free to suggest more types to be tested.

Should't this fall back on assert.deepEqual and assert.deepStrictEqual respectively when dealing with anything but simple objects?

If I pass two different KeyObject or CryptoKey instances to matchObject, despite them being different cryptographic keys this doens't throw.

If it falled back on on assert.deepEqual and assert.deepStrictEqual then handling of those respective objects would be handled (#50897).

lib/internal/util/comparisons.js already has these already in

Should be handled now

please remove merge commit. changes generally LGTM, I think this is a great addition to node:assert

@nodejs/assert How sure are we that we want to add this? If it lands, should it be added as experimental for a while to give us the option to change it as we see fit for a while or even remove it entirely without waiting for a major release?

I'm still not convinced that this is sufficiently different from deepEqual and deepStrictEqual to warrant a new API. At the absolute least the documentation does not provide enough information for someone to be able to decide which to use

@jasnell If the expected object has fewer properties than the actual object, deepEqual will throw an error based on your example. On the other hand, matchObject will compare the existing properties and values in the expected object, allowing for a partial comparison.

Yeah I get that, I just do not think there's enough justification for a new api. A new option to the existing method could do the same.

There was some conversation in the original issue about whether it should be:

a new method, e.g. matchObject
an option to the existing method, e.g. deepStrictEqual(..., { partial: tru })
a utility function for the existing method, e.g. deepStrictEqual(..., objectContaining(...))

here @synapse decided to go with option 1, lacking a clear consensus on which option made the most sense

I'm still not convinced that this is sufficiently different from deepEqual and deepStrictEqual to warrant a new API. At the absolute least the documentation does not provide enough information for someone to be able to decide which to use

I agree. I would love to see node:assert have a match function equivalent to https://github.com/tapjs/tapjs/blob/8f2baa7eb5e1f4cd0fcf8b60da4fb4e41ea680f1/docs/src/content/docs/api/asserts/index.md?plain=1#L318-L338

But the proposal here seems like a less consistent deepStrictEqual.

Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>

these seem flipped - the strict variant should not allow type coercion, and the loose variant should permit it.

@synapse See #50399 (comment).

This PR can be closed as work on the linked issue is being done elsewhere.

This PR can be closed as work on the linked issue is being done elsewhere.

Where is that work happening?

This PR can be closed as work on the linked issue is being done elsewhere.

Where is that work happening?

#54630

This issue/PR was marked as stalled, it will be automatically closed in 30 days. If it should remain open, please leave a comment explaining why it should remain open.

@synapse are you still interested in this PR, given that it is possibly superceded by #54630?

@synapse are you still interested in this PR, given that it is possibly superceded by #54630?

No, I will close this off

This PR can be closed as work on the linked issue is being done elsewhere.

Where is that work happening?

#54630

Thank you.

nodejs-github-bot added assert Issues and PRs related to the assert subsystem. needs-ci PRs that need a full CI run. labels Jun 11, 2024

aduh95 reviewed Jun 11, 2024

View reviewed changes

aduh95 changed the title lib: Added assert.matchObjectStrict & assert.matchObject assert: add matchObjectStrict and matchObject Jun 11, 2024

aduh95 reviewed Jun 11, 2024

View reviewed changes

Comment thread doc/api/assert.md Outdated

aduh95 reviewed Jun 11, 2024

View reviewed changes

Comment thread lib/assert.js Outdated

aduh95 reviewed Jun 11, 2024

View reviewed changes

Comment thread lib/assert.js Outdated

aduh95 reviewed Jun 11, 2024

View reviewed changes

Comment thread lib/assert.js Outdated

aduh95 reviewed Jun 11, 2024

View reviewed changes

Comment thread test/parallel/test-assert-objects.js Outdated

aduh95 reviewed Jun 11, 2024

View reviewed changes

Comment thread test/parallel/test-assert-objects.js Outdated

aduh95 reviewed Jun 11, 2024

View reviewed changes

Comment thread test/parallel/test-assert-objects.js Outdated

panva reviewed Jun 11, 2024

View reviewed changes

Comment thread doc/api/assert.md Outdated

atlowChemi reviewed Jun 11, 2024

View reviewed changes

Comment thread lib/assert.js Outdated

aduh95 reviewed Jun 13, 2024

View reviewed changes

Comment thread lib/assert.js Outdated

aduh95 reviewed Jun 13, 2024

View reviewed changes

Comment thread lib/assert.js Outdated

aduh95 reviewed Jun 13, 2024

View reviewed changes

Comment thread lib/assert.js Outdated

aduh95 reviewed Jun 13, 2024

View reviewed changes

Comment thread lib/assert.js Outdated

aduh95 reviewed Jun 13, 2024

View reviewed changes

Comment thread lib/assert.js Outdated

aduh95 reviewed Jun 13, 2024

View reviewed changes

Comment thread lib/assert.js Outdated

aduh95 reviewed Jun 13, 2024

View reviewed changes

Comment thread test/parallel/test-assert-objects.js

aduh95 reviewed Jun 13, 2024

View reviewed changes

Comment thread lib/assert.js Outdated

aduh95 reviewed Jun 13, 2024

View reviewed changes

Comment thread doc/api/assert.md Outdated

synapse force-pushed the main branch from 562b4a4 to b52f40a Compare June 13, 2024 13:12

aduh95 reviewed Jun 13, 2024

View reviewed changes

Comment thread doc/api/assert.md Outdated

synapse force-pushed the main branch 2 times, most recently from 9b2b89c to c7e9950 Compare June 13, 2024 14:18

aduh95 reviewed Jun 14, 2024

View reviewed changes

Comment thread test/parallel/test-assert-objects.js Outdated

aduh95 reviewed Jun 14, 2024

View reviewed changes

Comment thread test/parallel/test-assert-objects.js Outdated

aduh95 reviewed Jun 14, 2024

View reviewed changes

Comment thread test/parallel/test-assert-objects.js Outdated

aduh95 reviewed Jun 14, 2024

View reviewed changes

Comment thread test/parallel/test-assert-objects.js Outdated

aduh95 reviewed Jun 14, 2024

View reviewed changes

Comment thread test/parallel/test-assert-objects.js Outdated

aduh95 reviewed Jun 15, 2024

View reviewed changes

Comment thread doc/api/assert.md Outdated

Trott added the commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. label Jun 16, 2024

Trott force-pushed the main branch 2 times, most recently from d977fd6 to 6921e96 Compare June 16, 2024 22:02

Trott added the semver-minor PRs that contain new features and should be released in the next minor version. label Jun 16, 2024

jasnell reviewed Jun 17, 2024

View reviewed changes

synapse force-pushed the main branch from 5c1a693 to 00744fe Compare June 17, 2024 07:32

assert: add matchObjectStrict() and matchObject()

4164f10

Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>

synapse force-pushed the main branch from 00744fe to 4164f10 Compare June 17, 2024 07:35

ljharb reviewed Jul 12, 2024

View reviewed changes

danielbayley mentioned this pull request Aug 19, 2024

Proposal: assert.matchObject #50399

Closed

puskin mentioned this pull request Aug 29, 2024

assert: add partialDeepStrictEqual #54630

Merged

avivkeller added the stalled Issues and PRs that are stalled. label Sep 23, 2024

synapse closed this Sep 23, 2024

coderabbitai Bot mentioned this pull request Jul 16, 2026

node:crypto: sync the crypto suite to Node v26.3.0 and fix surfaced gaps oven-sh/bun#32623

Merged

+              - `expected` {any}
+              - `message` {string|Error}
+              Tests strict equality between the `actual` and `expected` parameters.

		present in the `actual` parameter with equivalent values, permitting type coercion
		where necessary.

assert: add `matchObjectStrict` and `matchObject` by synapse · Pull Request #53415 · nodejs/node · GitHub

Uh oh!

Uh oh!

assert: add matchObjectStrict and matchObject - #53415

assert: add matchObjectStrict and matchObject#53415synapse wants to merge 1 commit intonodejs:mainnodejs/node:mainfrom synapse:mainsynapse/node:mainCopy head branch name to clipboard

Conversation

synapse commented Jun 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aduh95 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

synapse Jun 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

targos commented Jun 11, 2024

Uh oh!

panva left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

panva commented Jun 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

synapse commented Jun 11, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MoLow commented Jun 14, 2024

Uh oh!

Uh oh!

Trott commented Jun 16, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

danielbayley commented Aug 19, 2024

Uh oh!

simoneb commented Sep 13, 2024

Uh oh!

jsumners commented Sep 23, 2024

assert: add matchObjectStrict and matchObject#53415
synapse wants to merge 1 commit into
nodejs:mainfrom
synapse:main

synapse commented Jun 11, 2024 •
edited
Loading

synapse Jun 11, 2024 •
edited
Loading

panva left a comment •
edited
Loading

panva commented Jun 11, 2024 •
edited
Loading