Port DocumentState and UnknownDocument. #2160
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -26,6 +26,23 @@ namespace firebase { | |
| namespace firestore { | ||
| namespace model { | ||
|
|
||
| enum class DocumentState { | ||
| /** | ||
| * Local mutations applied via the mutation queue. Document is potentially | ||
| * inconsistent. | ||
| */ | ||
| kLocalMutations, | ||
|
|
||
| /** | ||
| * Mutations applied based on a write acknowledgment. Document is potentially | ||
| * inconsistent. | ||
| */ | ||
| kCommittedMutations, | ||
|
|
||
| /** No mutations applied. Document was sent to us by Watch. */ | ||
| kSynced, | ||
| }; | ||
|
|
||
| /** | ||
| * Represents a document in Firestore with a key, version, data and whether the | ||
| * data has local mutations applied to it. | ||
|
|
@@ -38,7 +55,7 @@ class Document : public MaybeDocument { | |
| Document(FieldValue&& data, | ||
| DocumentKey key, | ||
| SnapshotVersion version, | ||
| DocumentState document_state); | ||
|
|
||
| const FieldValue& data() const { | ||
| return data_; | ||
|
|
@@ -48,22 +65,30 @@ class Document : public MaybeDocument { | |
| return data_.Get(path); | ||
| } | ||
|
|
||
| bool HasLocalMutations() const { | ||
| return document_state_ == DocumentState::kLocalMutations; | ||
| } | ||
|
|
||
| bool HasCommittedMutations() const { | ||
| return document_state_ == DocumentState::kCommittedMutations; | ||
| } | ||
|
|
||
| bool HasPendingWrites() const override { | ||
|
There was a problem hiding this comment. Question: this function uses PascalCase, while the other two very similar functions use snake_case. Can these be in the same style? (no strong preference which) There was a problem hiding this comment. http://go/c-readability-advice#virtual-accessor-names explicitly calls out this situation and suggests PascalCase for this (because it's virtual). OTOH, the style guide says that accessors "may" be snake_case. So I've switched everything to PascalCase. |
||
| return HasLocalMutations() || HasCommittedMutations(); | ||
| } | ||
|
|
||
| protected: | ||
| bool Equals(const MaybeDocument& other) const override; | ||
|
|
||
| private: | ||
| FieldValue data_; // This is of type Object. | ||
| DocumentState document_state_; | ||
| }; | ||
|
|
||
| /** Compares against another Document. */ | ||
| inline bool operator==(const Document& lhs, const Document& rhs) { | ||
| return lhs.version() == rhs.version() && lhs.key() == rhs.key() && | ||
| lhs.HasLocalMutations() == rhs.HasLocalMutations() && | ||
| lhs.data() == rhs.data(); | ||
| } | ||
|
|
||
|
|
||
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -22,8 +22,11 @@ namespace firebase { | |
| namespace firestore { | ||
| namespace model { | ||
|
|
||
| NoDocument::NoDocument(DocumentKey key, | ||
| SnapshotVersion version, | ||
| bool has_committed_mutations) | ||
| : MaybeDocument(std::move(key), std::move(version)), | ||
|
There was a problem hiding this comment. Optional nit: moving There was a problem hiding this comment. For non-primitive types, I usually just std::move it, unless it's really obvious that the thing is small. (really obvious => documented as small.) We can probably assume that with SnapshotVersion (and Timestamp), since it seems unlikely that either will grow. Somewhat related: http://go/c-readability-advice#value-param Proposal: Since you've called this optional, and since we std::move SnapshotVersion's (and probably Timestamp's too) somewhat inconsistently in the rest of the code, I'll defer this for now. But I'll create a followup inspired by the above readability link that: |
||
| has_committed_mutations_(has_committed_mutations) { | ||
| set_type(Type::NoDocument); | ||
| } | ||
|
|
||
|
|
||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| /* | ||
| * Copyright 2018 Google | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| #include "Firestore/core/src/firebase/firestore/model/unknown_document.h" | ||
|
|
||
| #include <utility> | ||
|
|
||
| namespace firebase { | ||
| namespace firestore { | ||
| namespace model { | ||
|
|
||
| UnknownDocument::UnknownDocument(DocumentKey key, SnapshotVersion version) | ||
| : MaybeDocument(std::move(key), std::move(version)) { | ||
| set_type(Type::UnknownDocument); | ||
| } | ||
|
|
||
| } // namespace model | ||
| } // namespace firestore | ||
| } // namespace firebase |
Oops, something went wrong.
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.
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.
Optional nit: maybe add a new line to visually separate the elements?
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.
Done.