assert: allow circular references #6432

Trott · 2016-04-27T22:40:12Z

Checklist

tests and code linting passes
a test and/or benchmark is included
the commit message follows commit guidelines

Affected core subsystem(s)

assert test

Description of change

assert.deepEqual() and assert.deepStrictEqual() will no longer throw a
RangeError if passed objects with circular references.

Fixes: #6416

addaleax · 2016-04-27T22:44:44Z

lib/assert.js

-    return objEquiv(actual, expected, strict);
+    memos = memos || {actual: [], expected: []};
+
+    if (memos.actual.includes(actual)) {


Maybe use memos.actual.indexOf here and cache it for the next call?

Fishrock123 · 2016-04-27T23:05:04Z

Looks like @nodejs-github-bot wrongly labeled this, investigating at #6432

assert.deepEqual() and assert.deepStrictEqual() will no longer throw a RangeError if passed objects with circular references. Fixes: nodejs#6416

This fixes some bad labelling by ensuring that *every* file affected in the PR actually matches an exclusive label when we're checking for exclusive labels. Refs nodejs/node#6448 nodejs/node#6432 Closes #33

Trott · 2016-04-28T19:41:41Z

Took @addaleax's suggestions, rebased, force-pushed. Hoping to hold off on CI until the pesky issues with tick processor vs. OS X are resolved.

This fixes some bad labelling by ensuring that *every* file affected in the PR actually matches an exclusive label when we're checking for exclusive labels. Refs nodejs/node#6448 nodejs/node#6432 Closes #33

addaleax · 2016-04-28T20:03:15Z

LGTM

jasnell · 2016-04-29T04:14:53Z

LGTM

thefourtheye · 2016-04-29T04:33:19Z

Isn't assert just for the core? Does the core need this change?

Trott · 2016-04-29T04:50:15Z

@thefourtheye asked:

Isn't assert just for the core? Does the core need this change?

It's not difficult to imagine that a test we write might want to compare two objects that contain circular references.

I think it makes sense to fix this bug before we come across that need rather than waiting for it to come up and create problems for the person who is writing that test.

This is a bug fix. If it were a new feature or an API change, the bar would be considerably higher (in my opinion, at least).

jasnell · 2016-04-29T04:54:49Z

+1 to what @Trott said.

thefourtheye · 2016-04-29T06:14:00Z

Well, most of the times we would be able to argue that features are bug fixes and vice versa.

For example, this patch could also be interpreted as, asserting circular references feature. At the same time, #2315 can be argued as, bug while asserting Maps and Sets.

jasnell · 2016-04-29T18:46:07Z

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

Trott · 2016-04-29T23:51:09Z

@thefourtheye I'm taking your comments to mean that you might be skeptical of the need for this, but you aren't opposed to doing this. So I'm going to land this now. (But if I'm wrong, we can revert.)

assert.deepEqual() and assert.deepStrictEqual() will no longer throw a RangeError if passed objects with circular references. PR-URL: nodejs#6432 Fixes: nodejs#6416 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>

Trott · 2016-04-29T23:53:39Z

Landed in d3aafd0.

assert.deepEqual() and assert.deepStrictEqual() will no longer throw a RangeError if passed objects with circular references. PR-URL: #6432 Fixes: #6416 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>

assert.deepEqual() and assert.deepStrictEqual() will no longer throw a RangeError if passed objects with circular references. PR-URL: nodejs#6432 Fixes: nodejs#6416 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>

* assert: `deep{Strict}Equal()` now works correctly with circular references. (Rich Trott) #6432 * debugger: Arrays are now formatted correctly in the debugger repl. (cjihrig) #6448 * deps: Upgrade OpenSSL sources to 1.0.2h (Shigeki Ohtsu) #6550 * net: Introduced a `Socket#connecting` property. (Fedor Indutny) #6404 - Previously this information was only available as the undocumented, internal `_connecting` property. * process: Introduced `process.cpuUsage()`. (Patrick Mueller) #6157 * stream: `Writable#setDefaultEncoding()` now returns `this`. (Alexander Makarenko) #5040 * util: Two new additions to `util.inspect()`: - Added a `maxArrayLength` option to truncate the formatting of Arrays. (James M Snell) #6334 - This is set to `100` by default. - Added a `showProxy` option for formatting proxy intercepting handlers. (James M Snell) #6465 - Inspecting proxies is non-trivial and as such this is off by default. PR-URL: #6557

* assert: `deep{Strict}Equal()` now works correctly with circular references. (Rich Trott) #6432 * debugger: Arrays are now formatted correctly in the debugger repl. (cjihrig) #6448 * deps: Upgrade OpenSSL sources to 1.0.2h (Shigeki Ohtsu) #6550 - Please see our blog post for more info on the security contents of this release: - https://nodejs.org/en/blog/vulnerability/openssl-may-2016/ * net: Introduced a `Socket#connecting` property. (Fedor Indutny) #6404 - Previously this information was only available as the undocumented, internal `_connecting` property. * process: Introduced `process.cpuUsage()`. (Patrick Mueller) #6157 * stream: `Writable#setDefaultEncoding()` now returns `this`. (Alexander Makarenko) #5040 * util: Two new additions to `util.inspect()`: - Added a `maxArrayLength` option to truncate the formatting of Arrays. (James M Snell) #6334 - This is set to `100` by default. - Added a `showProxy` option for formatting proxy intercepting handlers. (James M Snell) #6465 - Inspecting proxies is non-trivial and as such this is off by default. PR-URL: #6557

assert.deepEqual() and assert.deepStrictEqual() will no longer throw a RangeError if passed objects with circular references. fix: twada#3 refs:nodejs/node#6416 nodejs/node#6432

MylesBorins · 2016-06-01T23:51:37Z

@Trott lts?

Trott · 2016-06-02T00:03:40Z

@thealphanerd Yes, if it lands cleanly.

assert.deepEqual() and assert.deepStrictEqual() will no longer throw a RangeError if passed objects with circular references. PR-URL: #6432 Fixes: #6416 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>

Trott added the assert Issues and PRs related to the assert subsystem. label Apr 27, 2016

nodejs-github-bot added the test Issues and PRs related to the tests. label Apr 27, 2016

addaleax reviewed Apr 27, 2016
View reviewed changes

Fishrock123 mentioned this pull request Apr 27, 2016

Added doc, benchmark and deps/X node core PR labels nodejs/github-bot#32

Merged

Fishrock123 removed the test Issues and PRs related to the tests. label Apr 27, 2016

Trott added 2 commits April 28, 2016 11:03

assert: allow circular references

6d13a40

assert.deepEqual() and assert.deepStrictEqual() will no longer throw a RangeError if passed objects with circular references. Fixes: nodejs#6416

squash me

26eb196

Trott force-pushed the ada branch from f7dc16e to 26eb196 Compare April 28, 2016 18:40

phillipj mentioned this pull request Apr 28, 2016

Fix for bad node core PR exclusive labels. nodejs/github-bot#34

Merged

addaleax mentioned this pull request Apr 29, 2016

test: move assert to improve clarity #6428

Closed

2 tasks

Trott closed this Apr 29, 2016

This was referenced May 4, 2016

Propose v6.1.0 wrong base please ignore #6556

Closed

Propose v6.1.0 (Openssl update) #6557

Merged

twada mentioned this pull request May 6, 2016

Allow circular references twada/universal-deep-strict-equal#3

Closed

azu mentioned this pull request May 6, 2016

feat(assert): Allow circular references twada/universal-deep-strict-equal#4

Merged

alberto mentioned this pull request May 7, 2016

Test failing in node 6.1 eslint/eslint#6111

Closed

Trott added the lts-watch-v4.x label Jun 2, 2016

MylesBorins added land-on-v4.x and removed lts-watch-v4.x labels Jul 11, 2016

MylesBorins mentioned this pull request Jul 12, 2016

v4.5.0 proposal #7688

Merged

Trott deleted the ada branch January 13, 2022 22:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

assert: allow circular references #6432

assert: allow circular references #6432

Trott commented Apr 27, 2016

addaleax Apr 27, 2016

Fishrock123 commented Apr 27, 2016

Trott commented Apr 28, 2016

addaleax commented Apr 28, 2016

jasnell commented Apr 29, 2016

thefourtheye commented Apr 29, 2016

Trott commented Apr 29, 2016

jasnell commented Apr 29, 2016

thefourtheye commented Apr 29, 2016

jasnell commented Apr 29, 2016

Trott commented Apr 29, 2016

Trott commented Apr 29, 2016

MylesBorins commented Jun 1, 2016

Trott commented Jun 2, 2016

assert: allow circular references #6432

assert: allow circular references #6432

Conversation

Trott commented Apr 27, 2016

Checklist

Affected core subsystem(s)

Description of change

addaleax Apr 27, 2016

Choose a reason for hiding this comment

Fishrock123 commented Apr 27, 2016

Trott commented Apr 28, 2016

addaleax commented Apr 28, 2016

jasnell commented Apr 29, 2016

thefourtheye commented Apr 29, 2016

Trott commented Apr 29, 2016

jasnell commented Apr 29, 2016

thefourtheye commented Apr 29, 2016

jasnell commented Apr 29, 2016

Trott commented Apr 29, 2016

Trott commented Apr 29, 2016

MylesBorins commented Jun 1, 2016

Trott commented Jun 2, 2016