assert: fix deepEqual inconsistencies #14491

BridgeAR · 2017-07-26T02:04:09Z

I moved some tests over to assert-deep as they now always test all variations and it makes more sense to keep the deep-equal tests in there anyway.

Note: the original test added in #13318 was actually faulty.

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

Affected core subsystem(s)

assert

targos · 2017-07-26T06:03:37Z

lib/assert.js

-    if (memos.actual.has(actual)) {
-      return memos.actual.get(actual) === memos.expected.get(expected);
+    // We prevent up to two set.has(x) calls by directly retrieving the value
+    // and checking for undefined.


What about sets that contain the undefined value?

It should say map.has(x) and not set. The only values in the map are numbers as it is a internal value.

~~Sorry, my question is: what if actual or expected is the undefined value (I'm not sure it can be)? In that case, map.has(actual) is not the same as map.get(actual) !== undefined.~~

Edit: forget it, I was really confused by this map/set thing...

Trott · 2017-07-27T16:35:19Z

@nodejs/testing

Trott · 2017-07-28T18:55:57Z

@nodejs/collaborators This could use some reviews.

mcollina

Can you move the tests in a separate commit to simplifying reviews? Or fire a different PR that moves the tests? I would prefer the latter.

Looking at this PR it is not clear which case is added.

BridgeAR · 2017-07-28T21:22:07Z

@mcollina I tried to do exactly that. The first commit changes the code and adds the regression tests. The second one moves them. The third one is a fixup for commit 1.

If you still prefer me to open a second PR as follow up, I'll do that.

mcollina · 2017-07-28T21:31:47Z

test/parallel/test-assert-deep.js

@@ -303,6 +303,26 @@ assertOnlyDeepEqual(
  new Set([undefined])
 );

+// Circular structures


Can you please add a link to the issues that originated this bug?

mcollina · 2017-07-28T21:32:57Z

@BridgeAR one is fine then, but when landing we should keep them separate.

I saw 3 commits vs 2 that I was expecting. Can you squash the last one in the first? (the comment fixup)

Fixes nodejs#14441

BridgeAR · 2017-07-28T22:29:43Z

@mcollina done

mcollina

LGTM

XadillaX

LGTM if CI is green.

XadillaX · 2017-07-31T05:41:51Z

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

tniessen

Subsystem of the second commit should be `test´ IMO.

BridgeAR · 2017-08-01T00:51:20Z

@tniessen you are absolutely correct. Fixed

PR-URL: nodejs#14491 Fixes: nodejs#14441 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Tobias Nießen <tniessen@tnie.de>

tniessen · 2017-08-01T11:57:57Z

Landed in a8149c4 8db3997.

CI on master: https://ci.nodejs.org/job/node-test-commit-linuxone/7669/

addaleax · 2017-08-01T18:26:09Z

Hi! 😄 Once again, this doesn’t land cleanly on 8.x; if you can, please follow the guide and raise a backport PR.

Fwiw, only the test: commit is making trouble, if necessary we can just skip it.

BridgeAR · 2017-08-01T19:01:47Z

@addaleax I guess it is not be necessary to backport these as those tests are probably never touched

PR-URL: #14491 Fixes: #14441 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Tobias Nießen <tniessen@tnie.de>

BridgeAR · 2017-09-20T23:20:33Z

@addaleax @jasnell it seems like this patch applies cleanly right now (even the tests). I think it does not make sense to open a PR for that in that case (just going through my PRs with the backporting label).

addaleax · 2017-09-20T23:31:04Z

Great – in that case the label can be removed and this should be picked up by the tooling automatically again :)

PR-URL: #14491 Fixes: #14441 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Tobias Nießen <tniessen@tnie.de>

MylesBorins · 2017-10-17T04:49:09Z

Should this be backported to v6.x-staging? If yes please follow the guide and raise a backport PR, if no let me know or add the dont-land-on label.

BridgeAR · 2017-10-20T13:19:36Z

This should not be backported because the issue does not exist in v6.

felixfbecker · 2019-08-15T18:55:20Z

lib/assert.js

+    // We prevent up to two map.has(x) calls by directly retrieving the value
+    // and checking for undefined. The map can only contain numbers, so it is
+    // safe to check for undefined only.
+    const expectedMemoA = memos.actual.get(actual);


Hey @BridgeAR, old PR, I know, but I am trying to understand the implementation in latest master and am confused by this code. Why is this variable called expectedMemoA, if it comes from the actual Map? Shouldn't it be called actualMemo?

nodejs-github-bot added the assert Issues and PRs related to the assert subsystem. label Jul 26, 2017

BridgeAR mentioned this pull request Jul 26, 2017

test: add known-issue test for issue 14441 #14488

Closed

3 tasks

targos reviewed Jul 26, 2017

View reviewed changes

mcollina reviewed Jul 28, 2017

View reviewed changes

assert: fix deepEqual inconsistencies

dd2df00

Fixes nodejs#14441

BridgeAR force-pushed the fix-assert-deep-equal branch from 4078eeb to 55ac919 Compare July 28, 2017 22:29

mcollina approved these changes Jul 28, 2017

View reviewed changes

XadillaX approved these changes Jul 31, 2017

View reviewed changes

tniessen approved these changes Jul 31, 2017

View reviewed changes

test: clean up some assert deepEqual tests

b7ecf4d

BridgeAR force-pushed the fix-assert-deep-equal branch from 55ac919 to b7ecf4d Compare August 1, 2017 00:50

tniessen closed this Aug 1, 2017

addaleax added the backport-requested-v8.x label Aug 1, 2017

BridgeAR added dont-land-on-v6.x and removed dont-land-on-v6.x labels Sep 20, 2017

jasnell pushed a commit that referenced this pull request Sep 20, 2017

assert: fix deepEqual inconsistencies

7fa175f

PR-URL: #14491 Fixes: #14441 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Tobias Nießen <tniessen@tnie.de>

jasnell mentioned this pull request Sep 20, 2017

Node.js 8.6.0 Release Proposal #15509

Merged

addaleax removed the backport-requested-v8.x label Sep 20, 2017

jasnell pushed a commit that referenced this pull request Sep 25, 2017

test: clean up some assert deepEqual tests

b122714

PR-URL: #14491 Fixes: #14441 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Tobias Nießen <tniessen@tnie.de>

MylesBorins added the backport-requested-v6.x label Oct 17, 2017

BridgeAR added backport-requested-v6.x and removed backport-requested-v6.x labels Oct 20, 2017

BridgeAR deleted the fix-assert-deep-equal branch April 1, 2019 23:37

felixfbecker reviewed Aug 15, 2019

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

assert: fix deepEqual inconsistencies #14491

assert: fix deepEqual inconsistencies #14491

BridgeAR commented Jul 26, 2017 •

edited

Loading

targos Jul 26, 2017

BridgeAR Jul 26, 2017

targos Jul 26, 2017 •

edited

Loading

Trott commented Jul 27, 2017

Trott commented Jul 28, 2017

mcollina left a comment

BridgeAR commented Jul 28, 2017 •

edited

Loading

mcollina Jul 28, 2017

BridgeAR Jul 28, 2017

mcollina commented Jul 28, 2017

BridgeAR commented Jul 28, 2017

mcollina left a comment

XadillaX left a comment

XadillaX commented Jul 31, 2017

tniessen left a comment

BridgeAR commented Aug 1, 2017

tniessen commented Aug 1, 2017

addaleax commented Aug 1, 2017

BridgeAR commented Aug 1, 2017

BridgeAR commented Sep 20, 2017

addaleax commented Sep 20, 2017

MylesBorins commented Oct 17, 2017

BridgeAR commented Oct 20, 2017

felixfbecker Aug 15, 2019

assert: fix deepEqual inconsistencies #14491

assert: fix deepEqual inconsistencies #14491

Conversation

BridgeAR commented Jul 26, 2017 • edited Loading

Checklist

Affected core subsystem(s)

targos Jul 26, 2017

Choose a reason for hiding this comment

BridgeAR Jul 26, 2017

Choose a reason for hiding this comment

targos Jul 26, 2017 • edited Loading

Choose a reason for hiding this comment

Trott commented Jul 27, 2017

Trott commented Jul 28, 2017

mcollina left a comment

Choose a reason for hiding this comment

BridgeAR commented Jul 28, 2017 • edited Loading

mcollina Jul 28, 2017

Choose a reason for hiding this comment

BridgeAR Jul 28, 2017

Choose a reason for hiding this comment

mcollina commented Jul 28, 2017

BridgeAR commented Jul 28, 2017

mcollina left a comment

Choose a reason for hiding this comment

XadillaX left a comment

Choose a reason for hiding this comment

XadillaX commented Jul 31, 2017

tniessen left a comment

Choose a reason for hiding this comment

BridgeAR commented Aug 1, 2017

tniessen commented Aug 1, 2017

addaleax commented Aug 1, 2017

BridgeAR commented Aug 1, 2017

BridgeAR commented Sep 20, 2017

addaleax commented Sep 20, 2017

MylesBorins commented Oct 17, 2017

BridgeAR commented Oct 20, 2017

felixfbecker Aug 15, 2019

Choose a reason for hiding this comment

BridgeAR commented Jul 26, 2017 •

edited

Loading

targos Jul 26, 2017 •

edited

Loading

BridgeAR commented Jul 28, 2017 •

edited

Loading