Fix bug in Record.equals when comparing against Map #1903
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
leebyron
requested changes
May 8, 2022
src/Record.js
Outdated
| this === other || (other && recordSeq(this).equals(recordSeq(other))) | ||
| this === other || | ||
| (other && | ||
| this._keys && |
There was a problem hiding this comment.
this._keys should always be set because the instance doing the comparison is a Record
| it('if compared against Map should return false', () => { | ||
| const MyType = Record({ a: 1, b: 2 }); | ||
| const t1 = MyType(); | ||
| expect(t1.equals(Map({ a: 1, b: 2 }))).toBeFalsy(); |
There was a problem hiding this comment.
For completeness can you add a test which flips the operands to ensure the symmetric property?
leebyron
reviewed
May 8, 2022
src/Record.js
Outdated
| this === other || | ||
| (other && | ||
| this._keys && | ||
| other._keys && |
There was a problem hiding this comment.
I wonder if the proper way to do this should be isRecord(other)?
There was a problem hiding this comment.
It's definitely semantically more obvious what the check is doing but it depends on the guarantee that Record will always have _keys instantiated, which we will be alerted on if that is ever violated with this newly added unit test.
leebyron
approved these changes
May 9, 2022
| @@ -120,7 +120,8 @@ export class Record { | |||
|
|
|||
| equals(other) { | |||
| return ( | |||
| this === other || (other && recordSeq(this).equals(recordSeq(other))) | |||
| this === other || | |||
| (isRecord(other) && recordSeq(this).equals(recordSeq(other))) | |||
There was a problem hiding this comment.
More correct and more clear. Nice!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit fixes a bug introduced by this change, which removed a check that '._keys' exists on the object being compared in Record.equals. This leads to a runtime uncaught error when a Record instance is compared against a Map instance.