C++ migration: eliminate FSTRemoteStore

Firestore/Example/Tests/Integration/FSTDatastoreTests.mm

@@ -30,7 +30,6 @@
 #import "Firestore/Source/Model/FSTFieldValue.h"
 #import "Firestore/Source/Model/FSTMutation.h"
 #import "Firestore/Source/Model/FSTMutationBatch.h"
-#import "Firestore/Source/Remote/FSTRemoteStore.h"
 
 #import "Firestore/Example/Tests/Util/FSTIntegrationTestCase.h"
 
@@ -41,6 +40,7 @@
 #include "Firestore/core/src/firebase/firestore/model/precondition.h"
 #include "Firestore/core/src/firebase/firestore/remote/datastore.h"
 #include "Firestore/core/src/firebase/firestore/remote/remote_event.h"
+#include "Firestore/core/src/firebase/firestore/remote/remote_store.h"
 #include "Firestore/core/src/firebase/firestore/util/async_queue.h"
 #include "Firestore/core/src/firebase/firestore/util/executor_libdispatch.h"
 #include "Firestore/core/src/firebase/firestore/util/hard_assert.h"
@@ -60,15 +60,12 @@
 using firebase::firestore::remote::Datastore;
 using firebase::firestore::remote::GrpcConnection;
 using firebase::firestore::remote::RemoteEvent;
+using firebase::firestore::remote::RemoteStore;
 using firebase::firestore::util::AsyncQueue;
 using firebase::firestore::util::ExecutorLibdispatch;
 
 NS_ASSUME_NONNULL_BEGIN
 
-@interface FSTRemoteStore (Tests)
-- (void)addBatchToWritePipeline:(FSTMutationBatch *)batch;
-@end
-
 #pragma mark - FSTRemoteStoreEventCapture
 
 @interface FSTRemoteStoreEventCapture : NSObject <FSTRemoteSyncer>
@@ -163,7 +160,7 @@ @implementation FSTDatastoreTests {
 
   DatabaseInfo _databaseInfo;
   std::shared_ptr<Datastore> _datastore;
-  FSTRemoteStore *_remoteStore;
+  std::unique_ptr<RemoteStore> _remoteStore;
 }
 
 - (void)setUp {
@@ -185,18 +182,16 @@ - (void)setUp {
   _testWorkerQueue = absl::make_unique<AsyncQueue>(absl::make_unique<ExecutorLibdispatch>(queue));
   _datastore = std::make_shared<Datastore>(_databaseInfo, _testWorkerQueue.get(), &_credentials);
 
-  _remoteStore = [[FSTRemoteStore alloc] initWithLocalStore:_localStore
-                                                  datastore:_datastore
-                                                workerQueue:_testWorkerQueue.get()
-                                         onlineStateHandler:[](OnlineState) {}];
+  _remoteStore = absl::make_unique<RemoteStore>(_localStore, _datastore, _testWorkerQueue.get(),
+                                                [](OnlineState) {});
 
-  _testWorkerQueue->Enqueue([=] { [_remoteStore start]; });
+  _testWorkerQueue->Enqueue([=] { _remoteStore->Start(); });
 }
 
 - (void)tearDown {
   XCTestExpectation *completion = [self expectationWithDescription:@"shutdown"];
   _testWorkerQueue->Enqueue([=] {
-    [_remoteStore shutdown];
+    _remoteStore->Shutdown();
     [completion fulfill];
   });
   [self awaitExpectations];
@@ -219,17 +214,17 @@ - (void)testStreamingWrite {
   FSTRemoteStoreEventCapture *capture = [[FSTRemoteStoreEventCapture alloc] initWithTestCase:self];
   [capture expectWriteEventWithDescription:@"write mutations"];
 
-  [_remoteStore setSyncEngine:capture];
+  _remoteStore->set_sync_engine(capture);
 
   FSTSetMutation *mutation = [self setMutation];
   FSTMutationBatch *batch = [[FSTMutationBatch alloc] initWithBatchID:23
                                                        localWriteTime:[FIRTimestamp timestamp]
                                                             mutations:@[ mutation ]];
   _testWorkerQueue->Enqueue([=] {
-    [_remoteStore addBatchToWritePipeline:batch];
+    _remoteStore->AddToWritePipeline(batch);
     // The added batch won't be written immediately because write stream wasn't yet open --
     // trigger its opening.
-    [_remoteStore fillWritePipeline];
+    _remoteStore->FillWritePipeline();
   });
 
   [self awaitExpectations];

Firestore/Example/Tests/SpecTests/FSTSyncEngineTestDriver.h

@@ -20,8 +20,6 @@
 #include <unordered_map>
 #include <vector>
 
-#import "Firestore/Source/Remote/FSTRemoteStore.h"
-
 #include "Firestore/core/src/firebase/firestore/auth/user.h"
 #include "Firestore/core/src/firebase/firestore/model/document_key.h"
 #include "Firestore/core/src/firebase/firestore/model/document_key_set.h"
@@ -286,7 +284,7 @@ typedef std::unordered_map<firebase::firestore::auth::User,
  * outstanding persisted mutations.
  *
  * Note: The size of the list for the current user will generally be the same as
- * sentWritesCount, but not necessarily, since the FSTRemoteStore limits the number of
+ * sentWritesCount, but not necessarily, since the `RemoteStore` limits the number of
  * outstanding writes to the backend at a given time.
  */
 @property(nonatomic, assign, readonly) const FSTOutstandingWriteQueues &outstandingWrites;

Firestore/Example/Tests/SpecTests/FSTSyncEngineTestDriver.mm

@@ -39,6 +39,7 @@
 #include "Firestore/core/src/firebase/firestore/core/database_info.h"
 #include "Firestore/core/src/firebase/firestore/model/database_id.h"
 #include "Firestore/core/src/firebase/firestore/model/document_key.h"
+#include "Firestore/core/src/firebase/firestore/remote/remote_store.h"
 #include "Firestore/core/src/firebase/firestore/util/async_queue.h"
 #include "Firestore/core/src/firebase/firestore/util/executor_libdispatch.h"
 #include "Firestore/core/src/firebase/firestore/util/hard_assert.h"
@@ -58,6 +59,7 @@
 using firebase::firestore::model::SnapshotVersion;
 using firebase::firestore::model::TargetId;
 using firebase::firestore::remote::MockDatastore;
+using firebase::firestore::remote::RemoteStore;
 using firebase::firestore::remote::WatchChange;
 using firebase::firestore::util::AsyncQueue;
 using firebase::firestore::util::TimerId;
@@ -85,7 +87,6 @@ @interface FSTSyncEngineTestDriver ()
 #pragma mark - Parts of the Firestore system that the spec tests need to control.
 
 @property(nonatomic, strong, readonly) FSTEventManager *eventManager;
-@property(nonatomic, strong, readonly) FSTRemoteStore *remoteStore;
 @property(nonatomic, strong, readonly) FSTLocalStore *localStore;
 @property(nonatomic, strong, readonly) FSTSyncEngine *syncEngine;
 @property(nonatomic, strong, readonly) id<FSTPersistence> persistence;
@@ -112,6 +113,8 @@ @interface FSTSyncEngineTestDriver ()
 @implementation FSTSyncEngineTestDriver {
   std::unique_ptr<AsyncQueue> _workerQueue;
 
+  std::unique_ptr<RemoteStore> _remoteStore;
+
   std::unordered_map<TargetId, FSTQueryData *> _expectedActiveTargets;
 
   // ivar is declared as mutable.
@@ -153,19 +156,17 @@ - (instancetype)initWithPersistence:(id<FSTPersistence>)persistence
 
     _datastore =
         std::make_shared<MockDatastore>(_databaseInfo, _workerQueue.get(), &_credentialProvider);
-    _remoteStore =
-        [[FSTRemoteStore alloc] initWithLocalStore:_localStore
-                                         datastore:_datastore
-                                       workerQueue:_workerQueue.get()
-                                onlineStateHandler:[self](OnlineState onlineState) {
-                                  [self.syncEngine applyChangedOnlineState:onlineState];
-                                  [self.eventManager applyChangedOnlineState:onlineState];
-                                }];
+    _remoteStore = absl::make_unique<RemoteStore>(
+        _localStore, _datastore, _workerQueue.get(), [self](OnlineState onlineState) {
+          [self.syncEngine applyChangedOnlineState:onlineState];
+          [self.eventManager applyChangedOnlineState:onlineState];
+        });
+    ;
 
     _syncEngine = [[FSTSyncEngine alloc] initWithLocalStore:_localStore
-                                                remoteStore:_remoteStore
+                                                remoteStore:_remoteStore.get()
                                                 initialUser:initialUser];
-    [_remoteStore setSyncEngine:_syncEngine];
+    _remoteStore->set_sync_engine(_syncEngine);
     _eventManager = [FSTEventManager eventManagerWithSyncEngine:_syncEngine];
 
     // Set up internal event tracking for the spec tests.
@@ -209,7 +210,7 @@ - (void)drainQueue {
 - (void)start {
   _workerQueue->EnqueueBlocking([&] {
     [self.localStore start];
-    [self.remoteStore start];
+    _remoteStore->Start();
   });
 }
 
@@ -221,7 +222,7 @@ - (void)validateUsage {
 
 - (void)shutdown {
   _workerQueue->EnqueueBlocking([&] {
-    [self.remoteStore shutdown];
+    _remoteStore->Shutdown();
     [self.persistence shutdown];
   });
 }
@@ -253,13 +254,13 @@ - (void)disableNetwork {
   _workerQueue->EnqueueBlocking([&] {
     // Make sure to execute all writes that are currently queued. This allows us
     // to assert on the total number of requests sent before shutdown.
-    [self.remoteStore fillWritePipeline];
-    [self.remoteStore disableNetwork];
+    _remoteStore->FillWritePipeline();
+    _remoteStore->DisableNetwork();
   });
 }
 
 - (void)enableNetwork {
-  _workerQueue->EnqueueBlocking([&] { [self.remoteStore enableNetwork]; });
+  _workerQueue->EnqueueBlocking([&] { _remoteStore->EnableNetwork(); });
 }
 
 - (void)runTimer:(TimerId)timerID {

Firestore/Source/Core/FSTEventManager.h

@@ -17,7 +17,6 @@
 #import <Foundation/Foundation.h>
 
 #import "Firestore/Source/Core/FSTViewSnapshot.h"
-#import "Firestore/Source/Remote/FSTRemoteStore.h"
 
 #include "Firestore/core/src/firebase/firestore/model/types.h"
 

Firestore/Source/Core/FSTFirestoreClient.h

@@ -20,7 +20,6 @@
 
 #import "Firestore/Source/Core/FSTTypes.h"
 #import "Firestore/Source/Core/FSTViewSnapshot.h"
-#import "Firestore/Source/Remote/FSTRemoteStore.h"
 
 #include "Firestore/core/src/firebase/firestore/auth/credentials_provider.h"
 #include "Firestore/core/src/firebase/firestore/core/database_info.h"

Firestore/Source/Core/FSTFirestoreClient.mm

@@ -40,18 +40,19 @@
 #import "Firestore/Source/Local/FSTMemoryPersistence.h"
 #import "Firestore/Source/Model/FSTDocument.h"
 #import "Firestore/Source/Model/FSTDocumentSet.h"
-#import "Firestore/Source/Remote/FSTRemoteStore.h"
 #import "Firestore/Source/Remote/FSTSerializerBeta.h"
 #import "Firestore/Source/Util/FSTClasses.h"
 
 #include "Firestore/core/src/firebase/firestore/auth/credentials_provider.h"
 #include "Firestore/core/src/firebase/firestore/core/database_info.h"
 #include "Firestore/core/src/firebase/firestore/model/database_id.h"
 #include "Firestore/core/src/firebase/firestore/remote/datastore.h"
+#include "Firestore/core/src/firebase/firestore/remote/remote_store.h"
 #include "Firestore/core/src/firebase/firestore/util/async_queue.h"
 #include "Firestore/core/src/firebase/firestore/util/hard_assert.h"
 #include "Firestore/core/src/firebase/firestore/util/log.h"
 #include "Firestore/core/src/firebase/firestore/util/string_apple.h"
+#include "absl/memory/memory.h"
 
 namespace util = firebase::firestore::util;
 using firebase::firestore::auth::CredentialsProvider;
@@ -64,6 +65,7 @@
 using firebase::firestore::model::MaybeDocumentMap;
 using firebase::firestore::model::OnlineState;
 using firebase::firestore::remote::Datastore;
+using firebase::firestore::remote::RemoteStore;
 using firebase::firestore::util::Path;
 using firebase::firestore::util::Status;
 using firebase::firestore::util::AsyncQueue;
@@ -93,7 +95,6 @@ - (instancetype)initWithDatabaseInfo:(const DatabaseInfo &)databaseInfo
 @property(nonatomic, strong, readonly) FSTEventManager *eventManager;
 @property(nonatomic, strong, readonly) id<FSTPersistence> persistence;
 @property(nonatomic, strong, readonly) FSTSyncEngine *syncEngine;
-@property(nonatomic, strong, readonly) FSTRemoteStore *remoteStore;
 @property(nonatomic, strong, readonly) FSTLocalStore *localStore;
 
 // Does not own the CredentialsProvider instance.
@@ -110,6 +111,8 @@ @implementation FSTFirestoreClient {
    */
   std::unique_ptr<AsyncQueue> _workerQueue;
 
+  std::unique_ptr<RemoteStore> _remoteStore;
+
   std::unique_ptr<Executor> _userExecutor;
   std::chrono::milliseconds _initialGcDelay;
   std::chrono::milliseconds _regularGcDelay;
@@ -226,26 +229,23 @@ - (void)initializeWithUser:(const User &)user settings:(FIRFirestoreSettings *)s
   auto datastore =
       std::make_shared<Datastore>(*self.databaseInfo, _workerQueue.get(), _credentialsProvider);
 
-  _remoteStore = [[FSTRemoteStore alloc] initWithLocalStore:_localStore
-                                                  datastore:std::move(datastore)
-                                                workerQueue:_workerQueue.get()
-                                         onlineStateHandler:[self](OnlineState onlineState) {
-                                           [self.syncEngine applyChangedOnlineState:onlineState];
-                                         }];
+  _remoteStore = absl::make_unique<RemoteStore>(
+      _localStore, std::move(datastore), _workerQueue.get(),
+      [self](OnlineState onlineState) { [self.syncEngine applyChangedOnlineState:onlineState]; });
 
   _syncEngine = [[FSTSyncEngine alloc] initWithLocalStore:_localStore
-                                              remoteStore:_remoteStore
+                                              remoteStore:_remoteStore.get()
                                               initialUser:user];
 
   _eventManager = [FSTEventManager eventManagerWithSyncEngine:_syncEngine];
 
   // Setup wiring for remote store.
-  [_remoteStore setSyncEngine:_syncEngine];
+  _remoteStore->set_sync_engine(_syncEngine);
 
   // NOTE: RemoteStore depends on LocalStore (for persisting stream tokens, refilling mutation
   // queue, etc.) so must be started after LocalStore.
   [_localStore start];
-  [_remoteStore start];
+  _remoteStore->Start();
 }
 
 /**
@@ -270,7 +270,7 @@ - (void)credentialDidChangeWithUser:(const User &)user {
 
 - (void)disableNetworkWithCompletion:(nullable FSTVoidErrorBlock)completion {
   _workerQueue->Enqueue([self, completion] {
-    [self.remoteStore disableNetwork];
+    _remoteStore->DisableNetwork();
     if (completion) {
       self->_userExecutor->Execute([=] { completion(nil); });
     }
@@ -279,7 +279,7 @@ - (void)disableNetworkWithCompletion:(nullable FSTVoidErrorBlock)completion {
 
 - (void)enableNetworkWithCompletion:(nullable FSTVoidErrorBlock)completion {
   _workerQueue->Enqueue([self, completion] {
-    [self.remoteStore enableNetwork];
+    _remoteStore->EnableNetwork();
     if (completion) {
       self->_userExecutor->Execute([=] { completion(nil); });
     }
@@ -294,7 +294,7 @@ - (void)shutdownWithCompletion:(nullable FSTVoidErrorBlock)completion {
     if (self->_lruCallback) {
       self->_lruCallback.Cancel();
     }
-    [self.remoteStore shutdown];
+    _remoteStore->Shutdown();
     [self.persistence shutdown];
     if (completion) {
       self->_userExecutor->Execute([=] { completion(nil); });

Firestore/Source/Core/FSTSyncEngine.h

@@ -17,16 +17,15 @@
 #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"
 #include "Firestore/core/src/firebase/firestore/model/types.h"
+#include "Firestore/core/src/firebase/firestore/remote/remote_store.h"
 #include "Firestore/core/src/firebase/firestore/util/async_queue.h"
 
 @class FSTLocalStore;
 @class FSTMutation;
 @class FSTQuery;
-@class FSTRemoteStore;
 @class FSTViewSnapshot;
 
 using firebase::firestore::model::OnlineState;
@@ -63,7 +62,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 - (instancetype)init NS_UNAVAILABLE;
 - (instancetype)initWithLocalStore:(FSTLocalStore *)localStore
-                       remoteStore:(FSTRemoteStore *)remoteStore
+                       remoteStore:(firebase::firestore::remote::RemoteStore *)remoteStore
                        initialUser:(const firebase::firestore::auth::User &)user
     NS_DESIGNATED_INITIALIZER;
 
@@ -74,7 +73,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 /**
  * Initiates a new listen. The FSTLocalStore will be queried for initial data and the listen will
- * be sent to the FSTRemoteStore to get remote data. The registered FSTSyncEngineDelegate will be
+ * be sent to the `RemoteStore` to get remote data. The registered FSTSyncEngineDelegate will be
  * notified of resulting view snapshots and/or listen errors.
  *
  * @return the target ID assigned to the query.