Fix FirestoreDataConverter.fromFirestore() being called with QueryDocumentSnapshot from exp #4284
Conversation
This file contains hidden or 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
🦋 Changeset detectedLatest commit: 4aa48fe The changes in this PR will be included in the next version bump. This PR includes changesets to release 8 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
Size Analysis Report |
dconeybe
changed the title
Contributor
schmidt-sebastian
left a comment
schmidt-sebastian
left a comment
There was a problem hiding this comment.
Thank you for this fix! I have a couple of lame suggestions for you, but I am impressed. Especially with the PR description :)
schmidt-sebastian
approved these changes
Jan 19, 2021
Merged
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
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.
FirestoreDataConverter.fromFirestore()was being invoked with an instance ofQueryDocumentSnapshotfrom the experimental SDK; however, it was expected to be invoked with an instance ofQueryDocumentSnapshotfrom the Classic SDK. This worked okay, except that the object was lacking attributes likeref, which are only provided by the Classic SDK.The root cause is that the
FirestoreDataConverterprovided by the user was registered directly with theQueryDocumentSnapshotfrom the experimental SDK, and therefore was invoked with types from the experimental SDK. The fix is to instead register a "wrapper" data converter with theQueryDocumentSnapshotthat calls the underlying data converter with the equivalent objects from the Classic SDK.There was, however, a side effect of this change that caused
isEqual()methods (e.g.DocumentReference.isEqual()) to incorrectly returnfalseif compared with anotherDocumentReferencecreated with the same converter instance. This is because the implementation ofisEqual()compares the converters using the===operator. The wrapper instances that wrapped the same converters were distinct objects, and thus did not compare equal using===. The fix was to store each converter in aWeakMapmapping it to its wrapper instance so that the same wrapper instance can be used for each given converter, causingisEqual()to compare correctly.Fixes #4278