-
-
Notifications
You must be signed in to change notification settings - Fork 6.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fixed asymmetrical equality of cyclic objects #7730
Changes from all commits
33ea469
73024a2
93613a0
266b0b0
4184759
fc8b1be
2304df8
f2a4f01
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -606,6 +606,59 @@ describe('.toEqual()', () => { | |
}); | ||
expect(actual).toEqual({x: 3}); | ||
}); | ||
|
||
describe('cyclic object equality', () => { | ||
test('properties with the same circularity are equal', () => { | ||
const a = {}; | ||
a.x = a; | ||
const b = {}; | ||
b.x = b; | ||
expect(a).toEqual(b); | ||
expect(b).toEqual(a); | ||
|
||
const c = {}; | ||
c.x = a; | ||
const d = {}; | ||
d.x = b; | ||
expect(c).toEqual(d); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Cool. I like it. |
||
expect(d).toEqual(c); | ||
}); | ||
|
||
test('properties with different circularity are not equal', () => { | ||
const a = {}; | ||
a.x = {y: a}; | ||
const b = {}; | ||
const bx = {}; | ||
b.x = bx; | ||
bx.y = bx; | ||
expect(a).not.toEqual(b); | ||
expect(b).not.toEqual(a); | ||
|
||
const c = {}; | ||
c.x = a; | ||
const d = {}; | ||
d.x = b; | ||
expect(c).not.toEqual(d); | ||
expect(d).not.toEqual(c); | ||
}); | ||
|
||
test('are not equal if circularity is not on the same property', () => { | ||
const a = {}; | ||
const b = {}; | ||
a.a = a; | ||
b.a = {}; | ||
b.a.a = a; | ||
expect(a).not.toEqual(b); | ||
expect(b).not.toEqual(a); | ||
|
||
const c = {}; | ||
c.x = {x: c}; | ||
const d = {}; | ||
d.x = d; | ||
expect(c).not.toEqual(d); | ||
expect(d).not.toEqual(c); | ||
}); | ||
}); | ||
}); | ||
|
||
describe('.toBeInstanceOf()', () => { | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -64,9 +64,9 @@ function asymmetricMatch(a: any, b: any) { | |
function eq( | ||
a: any, | ||
b: any, | ||
aStack: any, | ||
bStack: any, | ||
customTesters: any, | ||
aStack: Array<unknown>, | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. better typing makes me happy! 🙏 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, he committed it better than he found it! There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Same here 🙌 |
||
bStack: Array<unknown>, | ||
customTesters: Array<Tester>, | ||
hasKey: any, | ||
): boolean { | ||
var result = true; | ||
|
@@ -149,14 +149,17 @@ function eq( | |
return false; | ||
} | ||
|
||
// Assume equality for cyclic structures. The algorithm for detecting cyclic | ||
// structures is adapted from ES 5.1 section 15.12.3, abstract operation `JO`. | ||
// Used to detect circular references. | ||
var length = aStack.length; | ||
while (length--) { | ||
// Linear search. Performance is inversely proportional to the number of | ||
// unique nested structures. | ||
if (aStack[length] == a) { | ||
return bStack[length] == b; | ||
// circular references at same depth are equal | ||
// circular reference is not equal to non-circular one | ||
if (aStack[length] === a) { | ||
return bStack[length] === b; | ||
} else if (bStack[length] === b) { | ||
return false; | ||
} | ||
} | ||
// Add the first object to the stack of traversed objects. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To make explicit guarantee that the comparison is symmetrical, do we want to double up on all the assertions?
Like the pair in the last test case.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fair point.
I will add another assertion to the test cases in which cyclic objects have the same shape.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let’s be explicit both for positive
.toEqual
or negative.not.toEqual
There have been multiple new issues this week with inconsistent asymmetrical negative assertions inexpect
package.