implement TargetIdGenerator in C++ for Firestore
#701
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| # 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. | ||
|
|
||
| cc_library( | ||
| firebase_firestore_core | ||
| SOURCES | ||
| target_id_generator.cc | ||
| ) | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| /* | ||
| * 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/core/target_id_generator.h" | ||
|
|
||
| #include <stdio.h> | ||
| #include <atomic> | ||
|
There was a problem hiding this comment. As discussed in chat, the atomic changes in here are unnecessary. Target ID generators are never shared between threads. |
||
|
|
||
| namespace firebase { | ||
| namespace firestore { | ||
| namespace core { | ||
|
|
||
| TargetIdGenerator::TargetIdGenerator(const TargetIdGenerator& value) | ||
| : generator_id_(value.generator_id_), | ||
| previous_id_(value.previous_id_.load()) { | ||
| } | ||
|
|
||
| TargetIdGenerator::TargetIdGenerator(TargetIdGeneratorId generator_id, | ||
| TargetId after) | ||
| : generator_id_(generator_id) { | ||
| const TargetId after_without_generator = (after >> kReservedBits) | ||
| << kReservedBits; | ||
| const TargetId after_generator = after - after_without_generator; | ||
| const TargetId generator = static_cast<TargetId>(generator_id); | ||
| if (after_generator >= generator) { | ||
| // For example, if: | ||
| // self.generatorID = 0b0000 | ||
| // after = 0b1011 | ||
| // afterGenerator = 0b0001 | ||
| // Then: | ||
| // previous = 0b1010 | ||
| // next = 0b1100 | ||
| previous_id_ = after_without_generator | generator; | ||
| } else { | ||
| // For example, if: | ||
| // self.generatorID = 0b0001 | ||
| // after = 0b1010 | ||
| // afterGenerator = 0b0000 | ||
| // Then: | ||
| // previous = 0b1001 | ||
| // next = 0b1011 | ||
| previous_id_ = (after_without_generator | generator) - (1 << kReservedBits); | ||
| } | ||
| } | ||
|
|
||
| TargetId TargetIdGenerator::NextId() { | ||
| TargetId increment = 1 << kReservedBits; | ||
| // This guarantees previous_id_ is incremented atomically and the return | ||
| // result is the result of the increment. | ||
| return previous_id_.fetch_add(increment) + increment; | ||
| } | ||
|
|
||
| } // namespace core | ||
| } // namespace firestore | ||
| } // namespace firebase | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| /* | ||
| * 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. | ||
| */ | ||
|
|
||
| #ifndef FIRESTORE_CORE_SRC_FIREBASE_FIRESTORE_CORE_TARGET_ID_GENERATOR_H_ | ||
| #define FIRESTORE_CORE_SRC_FIREBASE_FIRESTORE_CORE_TARGET_ID_GENERATOR_H_ | ||
|
|
||
| #include "Firestore/core/src/firebase/firestore/core/types.h" | ||
|
|
||
| #include <atomic> | ||
|
|
||
| namespace firebase { | ||
| namespace firestore { | ||
| namespace core { | ||
|
|
||
| /** The set of all valid generators. */ | ||
| enum class TargetIdGeneratorId { LocalStore = 0, SyncEngine = 1 }; | ||
|
|
||
| /** | ||
| * Generates monotonically increasing integer IDs. There are separate generators | ||
| * for different scopes. While these generators will operate independently of | ||
| * each other, they are scoped, such that no two generators will ever produce | ||
| * the same ID. This is useful, because sometimes the backend may group IDs from | ||
| * separate parts of the client into the same ID space. | ||
| */ | ||
| class TargetIdGenerator { | ||
| public: | ||
| TargetIdGenerator(const TargetIdGenerator& value); | ||
|
|
||
| /** | ||
| * Creates and returns the TargetIdGenerator for the local store. | ||
| * | ||
| * @param after An ID to start at. Every call to NextId returns a larger id. | ||
| * @return A shared instance of TargetIdGenerator. | ||
| */ | ||
| static TargetIdGenerator LocalStoreTargetIdGenerator(TargetId after) { | ||
| return TargetIdGenerator(TargetIdGeneratorId::LocalStore, after); | ||
| } | ||
|
|
||
| /** | ||
| * Creates and returns the TargetIdGenerator for the sync engine. | ||
| * | ||
| * @param after An ID to start at. Every call to NextId returns a larger id. | ||
| * @return A shared instance of TargetIdGenerator. | ||
| */ | ||
| static TargetIdGenerator SyncEngineTargetIdGenerator(TargetId after) { | ||
| return TargetIdGenerator(TargetIdGeneratorId::SyncEngine, after); | ||
| } | ||
|
|
||
| TargetIdGeneratorId generator_id() { | ||
| return generator_id_; | ||
| } | ||
|
|
||
| TargetId NextId(); | ||
|
|
||
| private: | ||
| TargetIdGenerator(TargetIdGeneratorId generator_id, TargetId after); | ||
| TargetIdGeneratorId generator_id_; | ||
| std::atomic<TargetId> previous_id_; | ||
|
|
||
| static const int kReservedBits = 1; | ||
| }; | ||
|
|
||
| } // namespace core | ||
| } // namespace firestore | ||
| } // namespace firebase | ||
|
|
||
| #endif // FIRESTORE_CORE_SRC_FIREBASE_FIRESTORE_CORE_TARGET_ID_GENERATOR_H_ |
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
| 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. | ||
| */ | ||
|
|
||
| #ifndef FIRESTORE_CORE_SRC_FIREBASE_FIRESTORE_CORE_TYPES_H_ | ||
| #define FIRESTORE_CORE_SRC_FIREBASE_FIRESTORE_CORE_TYPES_H_ | ||
|
|
||
| #include <stdint.h> | ||
|
|
||
| namespace firebase { | ||
| namespace firestore { | ||
| namespace core { | ||
|
|
||
| typedef int32_t TargetId; | ||
|
|
||
| } // namespace core | ||
| } // namespace firestore | ||
| } // namespace firebase | ||
|
|
||
| #endif // FIRESTORE_CORE_SRC_FIREBASE_FIRESTORE_CORE_TYPES_H_ |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| # 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. | ||
|
|
||
| cc_test( | ||
| firebase_firestore_core_test | ||
| SOURCES | ||
| target_id_generator_test.cc | ||
| DEPENDS | ||
| firebase_firestore_core | ||
| ) |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| /* | ||
| * 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/core/target_id_generator.h" | ||
|
|
||
| #include "gtest/gtest.h" | ||
|
|
||
| namespace firebase { | ||
| namespace firestore { | ||
| namespace core { | ||
|
|
||
| TEST(TargetIdGenerator, Constructor) { | ||
| TargetIdGenerator local_store_generator = | ||
| TargetIdGenerator::LocalStoreTargetIdGenerator(0); | ||
| TargetIdGenerator sync_engine_generator = | ||
| TargetIdGenerator::SyncEngineTargetIdGenerator(0); | ||
| EXPECT_EQ(TargetIdGeneratorId::LocalStore, | ||
| local_store_generator.generator_id()); | ||
| EXPECT_EQ(2, local_store_generator.NextId()); | ||
| EXPECT_EQ(TargetIdGeneratorId::SyncEngine, | ||
| sync_engine_generator.generator_id()); | ||
| EXPECT_EQ(1, sync_engine_generator.NextId()); | ||
| } | ||
|
|
||
| TEST(TargetIdGenerator, SkipPast) { | ||
| EXPECT_EQ(1, TargetIdGenerator::SyncEngineTargetIdGenerator(-1).NextId()); | ||
| EXPECT_EQ(3, TargetIdGenerator::SyncEngineTargetIdGenerator(2).NextId()); | ||
| EXPECT_EQ(5, TargetIdGenerator::SyncEngineTargetIdGenerator(4).NextId()); | ||
|
|
||
| for (int i = 4; i < 12; ++i) { | ||
| TargetIdGenerator a = TargetIdGenerator::LocalStoreTargetIdGenerator(i); | ||
| TargetIdGenerator b = TargetIdGenerator::SyncEngineTargetIdGenerator(i); | ||
| EXPECT_EQ(i + 2 & ~1, a.NextId()); | ||
| EXPECT_EQ(i + 1 | 1, b.NextId()); | ||
| } | ||
|
|
||
| EXPECT_EQ(13, TargetIdGenerator::SyncEngineTargetIdGenerator(12).NextId()); | ||
| EXPECT_EQ(24, TargetIdGenerator::LocalStoreTargetIdGenerator(22).NextId()); | ||
| } | ||
|
|
||
| TEST(TargetIdGenerator, Increment) { | ||
| TargetIdGenerator a = TargetIdGenerator::LocalStoreTargetIdGenerator(0); | ||
| EXPECT_EQ(2, a.NextId()); | ||
| EXPECT_EQ(4, a.NextId()); | ||
| EXPECT_EQ(6, a.NextId()); | ||
|
|
||
| TargetIdGenerator b = TargetIdGenerator::LocalStoreTargetIdGenerator(46); | ||
| EXPECT_EQ(48, b.NextId()); | ||
| EXPECT_EQ(50, b.NextId()); | ||
| EXPECT_EQ(52, b.NextId()); | ||
| EXPECT_EQ(54, b.NextId()); | ||
|
|
||
| TargetIdGenerator c = TargetIdGenerator::SyncEngineTargetIdGenerator(0); | ||
| EXPECT_EQ(1, c.NextId()); | ||
| EXPECT_EQ(3, c.NextId()); | ||
| EXPECT_EQ(5, c.NextId()); | ||
|
|
||
| TargetIdGenerator d = TargetIdGenerator::SyncEngineTargetIdGenerator(46); | ||
| EXPECT_EQ(47, d.NextId()); | ||
| EXPECT_EQ(49, d.NextId()); | ||
| EXPECT_EQ(51, d.NextId()); | ||
| EXPECT_EQ(53, d.NextId()); | ||
| } | ||
|
|
||
| } // namespace core | ||
| } // 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.
Please add headers too.
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