Migrate FSTBatchID to C++ BatchId (#1700)

Author: wilhuff

Firestore/Example/Benchmarks/FSTLevelDBBenchmarkTests.mm

@@ -20,7 +20,6 @@
 
 #include "benchmark/benchmark.h"
 
-#import "Firestore/Source/Core/FSTTypes.h"
 #import "Firestore/Source/Local/FSTLevelDB.h"
 #import "Firestore/Source/Local/FSTLocalSerializer.h"
 #import "Firestore/Source/Model/FSTDocumentKey.h"

Firestore/Example/Tests/Integration/FSTDatastoreTests.mm

@@ -47,6 +47,7 @@
 namespace util = firebase::firestore::util;
 using firebase::firestore::auth::EmptyCredentialsProvider;
 using firebase::firestore::core::DatabaseInfo;
+using firebase::firestore::model::BatchId;
 using firebase::firestore::model::DatabaseId;
 using firebase::firestore::model::DocumentKeySet;
 using firebase::firestore::model::Precondition;
@@ -118,7 +119,7 @@ - (void)applySuccessfulWriteWithResult:(FSTMutationBatchResult *)batchResult {
   [expectation fulfill];
 }
 
-- (void)rejectFailedWriteWithBatchID:(FSTBatchID)batchID error:(NSError *)error {
+- (void)rejectFailedWriteWithBatchID:(BatchId)batchID error:(NSError *)error {
   HARD_FAIL("Not implemented");
 }
 

Firestore/Example/Tests/Local/FSTLRUGarbageCollectorTests.mm

@@ -21,7 +21,6 @@
 #include <unordered_set>
 
 #import "Firestore/Example/Tests/Util/FSTHelpers.h"
-#import "Firestore/Source/Core/FSTTypes.h"
 #import "Firestore/Source/Local/FSTLRUGarbageCollector.h"
 #import "Firestore/Source/Local/FSTMutationQueue.h"
 #import "Firestore/Source/Local/FSTPersistence.h"

Firestore/Example/Tests/Local/FSTLevelDBMigrationsTests.mm

@@ -45,6 +45,7 @@
 using firebase::firestore::local::LevelDbTargetDocumentKey;
 using firebase::firestore::local::LevelDbTargetKey;
 using firebase::firestore::local::LevelDbTransaction;
+using firebase::firestore::model::BatchId;
 using firebase::firestore::model::TargetId;
 using firebase::firestore::testutil::Key;
 using firebase::firestore::util::OrderedCode;
@@ -119,7 +120,7 @@ - (void)testSetsVersionNumber {
 
 - (void)testDropsTheQueryCache {
   std::string userID{"user"};
-  FSTBatchID batchID = 1;
+  BatchId batchID = 1;
   TargetId targetID = 2;
 
   FSTDocumentKey *key1 = Key("documents/1");

Firestore/Example/Tests/Local/FSTLevelDBMutationQueueTests.mm

@@ -36,6 +36,7 @@
 
 using firebase::firestore::auth::User;
 using firebase::firestore::local::LevelDbMutationKey;
+using firebase::firestore::model::BatchId;
 using firebase::firestore::util::OrderedCode;
 using leveldb::DB;
 using leveldb::Slice;
@@ -57,7 +58,7 @@ @interface FSTLevelDBMutationQueueTests : FSTMutationQueueTests
  * Creates a key that's structurally the same as LevelDbMutationKey except it allows for
  * nonstandard table names.
  */
-std::string MutationLikeKey(absl::string_view table, absl::string_view userID, FSTBatchID batchID) {
+std::string MutationLikeKey(absl::string_view table, absl::string_view userID, BatchId batchID) {
   std::string key;
   OrderedCode::WriteString(&key, table);
   OrderedCode::WriteString(&key, userID);
@@ -119,7 +120,7 @@ - (void)testLoadNextBatchID_findsMaxAcrossUsers {
 - (void)testLoadNextBatchID_onlyFindsMutations {
   // Write higher-valued batchIDs in nearby "tables"
   std::vector<std::string> tables{"mutatio", "mutationsa", "bears", "zombies"};
-  FSTBatchID highBatchID = 5;
+  BatchId highBatchID = 5;
   for (const auto &table : tables) {
     [self setDummyValueForKey:MutationLikeKey(table, "", highBatchID++)];
   }

Firestore/Example/Tests/Remote/FSTWatchChange+Testing.h

@@ -16,7 +16,6 @@
 
 #import <Foundation/Foundation.h>
 
-#import "Firestore/Source/Core/FSTTypes.h"
 #import "Firestore/Source/Remote/FSTWatchChange.h"
 
 NS_ASSUME_NONNULL_BEGIN

Firestore/Example/Tests/SpecTests/FSTSyncEngineTestDriver.h

@@ -19,7 +19,6 @@
 #include <map>
 #include <unordered_map>
 
-#import "Firestore/Source/Core/FSTTypes.h"
 #import "Firestore/Source/Remote/FSTRemoteStore.h"
 #import "Firestore/Source/Util/FSTDispatchQueue.h"
 

Firestore/Example/Tests/Util/FSTHelpers.h

@@ -19,7 +19,6 @@
 #include <string>
 #include <vector>
 
-#import "Firestore/Source/Core/FSTTypes.h"
 #import "Firestore/Source/Model/FSTDocumentDictionary.h"
 #import "Firestore/Source/Remote/FSTRemoteEvent.h"
 

Firestore/Example/Tests/Util/FSTIntegrationTestCase.h

@@ -18,7 +18,6 @@
 #import <XCTest/XCTest.h>
 
 #import "Firestore/Example/Tests/Util/XCTestCase+Await.h"
-#import "Firestore/Source/Core/FSTTypes.h"
 
 #import "FIRFirestoreSource.h"
 

Firestore/Source/Core/FSTEventManager.h

@@ -16,7 +16,6 @@
 
 #import <Foundation/Foundation.h>
 
-#import "Firestore/Source/Core/FSTTypes.h"
 #import "Firestore/Source/Core/FSTViewSnapshot.h"
 #import "Firestore/Source/Remote/FSTRemoteStore.h"
 

Firestore/Source/Core/FSTFirestoreClient.h

@@ -17,7 +17,6 @@
 #import <Foundation/Foundation.h>
 #include <memory>
 
-#import "Firestore/Source/Core/FSTTypes.h"
 #import "Firestore/Source/Core/FSTViewSnapshot.h"
 #import "Firestore/Source/Remote/FSTRemoteStore.h"
 

Firestore/Source/Core/FSTListenSequence.h

@@ -16,7 +16,7 @@
 
 #import <Foundation/Foundation.h>
 
-#import "FSTTypes.h"
+#import "Firestore/Source/Core/FSTTypes.h"
 
 NS_ASSUME_NONNULL_BEGIN
 

Firestore/Source/Core/FSTSyncEngine.h

@@ -16,7 +16,6 @@
 
 #import <Foundation/Foundation.h>
 
-#import "Firestore/Source/Core/FSTTypes.h"
 #import "Firestore/Source/Remote/FSTRemoteStore.h"
 
 #include "Firestore/core/src/firebase/firestore/auth/user.h"

Firestore/Source/Core/FSTSyncEngine.mm

@@ -49,6 +49,7 @@
 using firebase::firestore::auth::HashUser;
 using firebase::firestore::auth::User;
 using firebase::firestore::core::TargetIdGenerator;
+using firebase::firestore::model::BatchId;
 using firebase::firestore::model::DocumentKey;
 using firebase::firestore::model::DocumentKeySet;
 using firebase::firestore::model::SnapshotVersion;
@@ -162,7 +163,7 @@ @implementation FSTSyncEngine {
   /** Used for creating the TargetId for the listens used to resolve limbo documents. */
   TargetIdGenerator _targetIdGenerator;
 
-  /** Stores user completion blocks, indexed by user and FSTBatchID. */
+  /** Stores user completion blocks, indexed by user and BatchId. */
   std::unordered_map<User, NSMutableDictionary<NSNumber *, FSTVoidErrorBlock> *, HashUser>
       _mutationCompletionBlocks;
 
@@ -246,7 +247,7 @@ - (void)writeMutations:(NSArray<FSTMutation *> *)mutations
   [self.remoteStore fillWritePipeline];
 }
 
-- (void)addMutationCompletionBlock:(FSTVoidErrorBlock)completion batchID:(FSTBatchID)batchID {
+- (void)addMutationCompletionBlock:(FSTVoidErrorBlock)completion batchID:(BatchId)batchID {
   NSMutableDictionary<NSNumber *, FSTVoidErrorBlock> *completionBlocks =
       _mutationCompletionBlocks[_currentUser];
   if (!completionBlocks) {
@@ -407,7 +408,7 @@ - (void)applySuccessfulWriteWithResult:(FSTMutationBatchResult *)batchResult {
   [self emitNewSnapshotsWithChanges:changes remoteEvent:nil];
 }
 
-- (void)rejectFailedWriteWithBatchID:(FSTBatchID)batchID error:(NSError *)error {
+- (void)rejectFailedWriteWithBatchID:(BatchId)batchID error:(NSError *)error {
   [self assertDelegateExistsForSelector:_cmd];
 
   // The local store may or may not be able to apply the write result and raise events immediately
@@ -419,7 +420,7 @@ - (void)rejectFailedWriteWithBatchID:(FSTBatchID)batchID error:(NSError *)error
   [self emitNewSnapshotsWithChanges:changes remoteEvent:nil];
 }
 
-- (void)processUserCallbacksForBatchID:(FSTBatchID)batchID error:(NSError *_Nullable)error {
+- (void)processUserCallbacksForBatchID:(BatchId)batchID error:(NSError *_Nullable)error {
   NSMutableDictionary<NSNumber *, FSTVoidErrorBlock> *completionBlocks =
       _mutationCompletionBlocks[_currentUser];
 

Firestore/Source/Core/FSTTypes.h

@@ -23,13 +23,8 @@ NS_ASSUME_NONNULL_BEGIN
 @class FSTMaybeDocument;
 @class FSTTransaction;
 
-/** FSTBatchID is a locally assigned ID for a batch of mutations that have been applied. */
-typedef firebase::firestore::model::BatchId FSTBatchID;
-
 typedef int64_t FSTListenSequenceNumber;
 
-typedef NSNumber FSTBoxedTargetID;
-
 /**
  * FSTVoidBlock is a block that's called when a specific event happens but that otherwise has
  * no information associated with it.

Firestore/Source/Local/FSTDocumentReference.h

@@ -26,7 +26,7 @@ NS_ASSUME_NONNULL_BEGIN
  * and a document key that the target or batch references.
  *
  * A reference can be from either listen targets (identified by their TargetId) or mutation batches
- * (identified by their FSTBatchID). See FSTGarbageCollector for more details.
+ * (identified by their BatchId). See FSTGarbageCollector for more details.
  *
  * Not to be confused with FIRDocumentReference.
  */

Firestore/Source/Local/FSTLRUGarbageCollector.h

@@ -16,7 +16,6 @@
 
 #import <Foundation/Foundation.h>
 
-#import "Firestore/Source/Core/FSTTypes.h"
 #import "Firestore/Source/Local/FSTQueryData.h"
 #include "Firestore/core/src/firebase/firestore/model/document_key.h"
 
@@ -97,4 +96,4 @@ extern const FSTListenSequenceNumber kFSTListenSequenceNumberInvalid;
  */
 - (int)removeOrphanedDocumentsThroughSequenceNumber:(FSTListenSequenceNumber)sequenceNumber;
 
-@end
+@end

Firestore/Source/Local/FSTLRUGarbageCollector.mm

@@ -118,4 +118,4 @@ - (int)removeOrphanedDocumentsThroughSequenceNumber:(FSTListenSequenceNumber)seq
   return [_delegate removeOrphanedDocumentsThroughSequenceNumber:sequenceNumber];
 }
 
-@end
+@end

Firestore/Source/Local/FSTLevelDBMutationQueue.h

@@ -21,6 +21,7 @@
 #import "Firestore/Source/Local/FSTMutationQueue.h"
 
 #include "Firestore/core/src/firebase/firestore/auth/user.h"
+#include "Firestore/core/src/firebase/firestore/model/types.h"
 #include "leveldb/db.h"
 
 @class FSTLevelDB;
@@ -47,7 +48,7 @@ NS_ASSUME_NONNULL_BEGIN
  * Returns one larger than the largest batch ID that has been stored. If there are no mutations
  * returns 0. Note that batch IDs are global.
  */
-+ (FSTBatchID)loadNextBatchIDFromDB:(leveldb::DB *)db;
++ (firebase::firestore::model::BatchId)loadNextBatchIDFromDB:(leveldb::DB *)db;
 
 @end