util: assert: fix deepStrictEqual comparing a real array and fake array #30743

ljharb · 2019-12-01T00:08:03Z

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

(following in the tradition of #29029)

Trott · 2019-12-01T01:09:28Z

@nodejs/assert

- Skip one, pending nodejs/node#30743

ljharb · 2019-12-01T16:50:31Z

test/parallel/test-assert-deep.js

@@ -1064,7 +1079,7 @@ assert.throws(
  Object.defineProperty(a, 'length', {
    value: 2
  });
-  assert.notDeepStrictEqual(a, [1, 1]);
+  assertOnlyDeepEqual(a, [1, 1]);


this was the failing test, because it tries the arguments in reverse order

ljharb · 2019-12-01T16:50:50Z

test/parallel/test-assert-deep.js

@@ -1050,6 +1050,21 @@ assert.throws(
  assert.deepStrictEqual(a, b);
 }

+// Verify that an array and the equivalent fake array object


this test was previously passing, but it felt like a good addition anyways.

Trott · 2019-12-01T23:31:00Z

Does this require an update to the documented deepStrictEqual() algorithm in our documentation? https://github.com/nodejs/node/blob/d25db11312e9ef4392042380b812359fad103707/doc/api/assert.md#comparison-details-1

codecov-io · 2019-12-02T04:18:20Z

Codecov Report

❗ No coverage uploaded for pull request base (master@d7b8ae7). Click here to learn what that means.
The diff coverage is n/a.

@@            Coverage Diff            @@
##             master   #30743   +/-   ##
=========================================
  Coverage          ?   97.36%           
=========================================
  Files             ?      187           
  Lines             ?    62171           
  Branches          ?        0           
=========================================
  Hits              ?    60532           
  Misses            ?     1639           
  Partials          ?        0

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 d7b8ae7...66a3dc4. Read the comment docs.

ljharb · 2019-12-02T07:04:51Z

@Trott all this change does is makes sure that what already works for (a, b) also works for (b, a); i don't believe any part of that documentation needs to change.

BridgeAR · 2019-12-02T14:37:09Z

I originally decided against doing full two sides checks because it's a very rare edge case and we can not check both sides for all types (we could do that for built-in types but that would be a lot of overhead).

I am fine to implement this at least for the currently used one sided type checks. That way it's always consistent, no matter what argument is first.

It would be good to keep the performance overhead in mind though. Especially the typed array type check is relatively expensive.

@ljharb I went ahead and opened #30764 as alternative to this one as it addresses all open one sides versions with the least overhead possible.

This veryfies that both input arguments are always of the identical type. It was possible to miss a few cases before. This change applies to all deep equal assert functions (e.g., `assert.deepStrictEqual()`) and to `util.isDeepStrictEqual()`. PR-URL: #30764 Refs: #30743 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

This makes sure the assertion does not depend on the argument order. It also removes comments that do not apply anymore and verifies the behavior for the loose and strict implementation. PR-URL: #30764 Refs: #30743 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

ljharb · 2019-12-07T00:37:36Z

Now that #30764 has landed, I'll update or close this PR soon, based on if there's anything of value left in it.

ljharb · 2019-12-08T05:32:11Z

I updated the PR; there's just a single test case left. Feel free to land or close.

nodejs-github-bot · 2019-12-09T09:16:01Z

CI: https://ci.nodejs.org/job/node-test-pull-request/27514/

This veryfies that both input arguments are always of the identical type. It was possible to miss a few cases before. This change applies to all deep equal assert functions (e.g., `assert.deepStrictEqual()`) and to `util.isDeepStrictEqual()`. PR-URL: #30764 Refs: #30743 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

This makes sure the assertion does not depend on the argument order. It also removes comments that do not apply anymore and verifies the behavior for the loose and strict implementation. PR-URL: #30764 Refs: #30743 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

PR-URL: #30743 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>

bmeck · 2019-12-11T22:33:14Z

Landed in 916cc82

PR-URL: #30743 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>

This veryfies that both input arguments are always of the identical type. It was possible to miss a few cases before. This change applies to all deep equal assert functions (e.g., `assert.deepStrictEqual()`) and to `util.isDeepStrictEqual()`. PR-URL: #30764 Refs: #30743 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

This makes sure the assertion does not depend on the argument order. It also removes comments that do not apply anymore and verifies the behavior for the loose and strict implementation. PR-URL: #30764 Refs: #30743 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

PR-URL: #30743 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>

This veryfies that both input arguments are always of the identical type. It was possible to miss a few cases before. This change applies to all deep equal assert functions (e.g., `assert.deepStrictEqual()`) and to `util.isDeepStrictEqual()`. PR-URL: #30764 Refs: #30743 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

This makes sure the assertion does not depend on the argument order. It also removes comments that do not apply anymore and verifies the behavior for the loose and strict implementation. PR-URL: #30764 Refs: #30743 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

test: assert: fix deepStrictEqual comparing a real array and fake array

66a3dc4

ljharb added the util Issues and PRs related to the built-in util module. label Dec 1, 2019

ljharb requested review from Trott, targos and devsnek December 1, 2019 00:08

ljharb force-pushed the deep_equal_arg_order branch from 684d1ce to 81be8ab Compare December 1, 2019 02:37

ljharb added a commit to inspect-js/node-deep-equal that referenced this pull request Dec 1, 2019

[Tests] require ASSERT tests to pass

657c6ee

- Skip one, pending nodejs/node#30743

devsnek removed their request for review December 1, 2019 05:08

ljharb added a commit to inspect-js/node-deep-equal that referenced this pull request Dec 1, 2019

[Tests] require ASSERT tests to pass

7176175

- Skip one, pending nodejs/node#30743

ljharb force-pushed the deep_equal_arg_order branch from 81be8ab to 3d7c1c7 Compare December 1, 2019 05:58

ljharb requested a review from addaleax December 1, 2019 05:59

ljharb added a commit to inspect-js/node-deep-equal that referenced this pull request Dec 1, 2019

[Tests] require ASSERT tests to pass

6c372ec

- Skip one, pending nodejs/node#30743

ljharb added a commit to inspect-js/node-deep-equal that referenced this pull request Dec 1, 2019

[Tests] require ASSERT tests to pass

7ac77cf

- Skip one, pending nodejs/node#30743

ljharb commented Dec 1, 2019

View reviewed changes

Trott requested a review from BridgeAR December 2, 2019 14:01

BridgeAR mentioned this pull request Dec 2, 2019

assert,util: always verify both sides #30764

Closed

4 tasks

ljharb force-pushed the deep_equal_arg_order branch from 3d7c1c7 to de24d40 Compare December 8, 2019 05:31

ljharb added the test Issues and PRs related to the tests. label Dec 8, 2019

Trott approved these changes Dec 8, 2019

View reviewed changes

ljharb force-pushed the deep_equal_arg_order branch from de24d40 to 66a3dc4 Compare December 9, 2019 06:40

targos approved these changes Dec 9, 2019

View reviewed changes

bmeck added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Dec 11, 2019

bmeck pushed a commit that referenced this pull request Dec 11, 2019

test: assert: fix deepStrictEqual comparing a real array and fake array

916cc82

PR-URL: #30743 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>

bmeck closed this Dec 11, 2019

ljharb deleted the deep_equal_arg_order branch December 11, 2019 23:06

MylesBorins pushed a commit that referenced this pull request Dec 13, 2019

test: assert: fix deepStrictEqual comparing a real array and fake array

5f42b1f

PR-URL: #30743 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>

MylesBorins mentioned this pull request Dec 13, 2019

v13.4.0 proposal #30937

Merged

targos pushed a commit that referenced this pull request Jan 14, 2020

test: assert: fix deepStrictEqual comparing a real array and fake array

cd740a2

PR-URL: #30743 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>

targos mentioned this pull request Jan 15, 2020

v12.15.0 release proposal #31368

Closed

BethGriggs pushed a commit that referenced this pull request Feb 6, 2020

test: assert: fix deepStrictEqual comparing a real array and fake array

a22d5e7

PR-URL: #30743 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>

MylesBorins mentioned this pull request Feb 8, 2020

v12.16.0 proposal #31691

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

util: assert: fix deepStrictEqual comparing a real array and fake array #30743

util: assert: fix deepStrictEqual comparing a real array and fake array #30743

ljharb commented Dec 1, 2019

Trott commented Dec 1, 2019

ljharb Dec 1, 2019

ljharb Dec 1, 2019

Trott commented Dec 1, 2019

codecov-io commented Dec 2, 2019 •

edited

ljharb commented Dec 2, 2019

BridgeAR commented Dec 2, 2019

ljharb commented Dec 7, 2019

ljharb commented Dec 8, 2019

nodejs-github-bot commented Dec 9, 2019

bmeck commented Dec 11, 2019

util: assert: fix deepStrictEqual comparing a real array and fake array #30743

util: assert: fix deepStrictEqual comparing a real array and fake array #30743

Conversation

ljharb commented Dec 1, 2019

Checklist

Trott commented Dec 1, 2019

ljharb Dec 1, 2019

Choose a reason for hiding this comment

ljharb Dec 1, 2019

Choose a reason for hiding this comment

Trott commented Dec 1, 2019

codecov-io commented Dec 2, 2019 • edited

Codecov Report

ljharb commented Dec 2, 2019

BridgeAR commented Dec 2, 2019

ljharb commented Dec 7, 2019

ljharb commented Dec 8, 2019

nodejs-github-bot commented Dec 9, 2019

bmeck commented Dec 11, 2019

codecov-io commented Dec 2, 2019 •

edited