Add equality and hash functions to DocumentReference to fix reference querying #68
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Currently, querying documents by a reference field (e.g.
.where("reference_field", "==", reference)) results in incorrect results due to document references not being compared properly. Even if there are documents with references that have the same path as the document reference passed into the query, no documents get returned.To address this, I've implemented
__eq__and__hash__to be more similar to the actualBaseDocumentReferenceimplementations (see here and here)._clientis included in the original implementation, but is not present in mocked base document. Therefore, I've opted to only hash / compare_path.