C++ migration: make FIRFirestore implementation delegate to core API (#2492)

Author: var-const

Firestore/Example/Tests/API/FIRQuerySnapshotTests.mm

@@ -25,6 +25,7 @@
 #import "Firestore/Example/Tests/Util/FSTHelpers.h"
 #import "Firestore/Source/API/FIRDocumentChange+Internal.h"
 #import "Firestore/Source/API/FIRDocumentSnapshot+Internal.h"
+#import "Firestore/Source/API/FIRFirestore+Internal.h"
 #import "Firestore/Source/API/FIRQuerySnapshot+Internal.h"
 #import "Firestore/Source/API/FIRSnapshotMetadata+Internal.h"
 #import "Firestore/Source/Model/FSTDocument.h"
@@ -110,16 +111,18 @@ - (void)testIncludeMetadataChanges {
                                                               snapshot:std::move(viewSnapshot)
                                                               metadata:metadata];
 
-  FIRQueryDocumentSnapshot *doc1Snap = [FIRQueryDocumentSnapshot snapshotWithFirestore:firestore
-                                                                           documentKey:doc1New.key
-                                                                              document:doc1New
-                                                                             fromCache:NO
-                                                                      hasPendingWrites:NO];
-  FIRQueryDocumentSnapshot *doc2Snap = [FIRQueryDocumentSnapshot snapshotWithFirestore:firestore
-                                                                           documentKey:doc2New.key
-                                                                              document:doc2New
-                                                                             fromCache:NO
-                                                                      hasPendingWrites:NO];
+  FIRQueryDocumentSnapshot *doc1Snap =
+      [[FIRQueryDocumentSnapshot alloc] initWithFirestore:firestore.wrapped
+                                              documentKey:doc1New.key
+                                                 document:doc1New
+                                                fromCache:false
+                                         hasPendingWrites:false];
+  FIRQueryDocumentSnapshot *doc2Snap =
+      [[FIRQueryDocumentSnapshot alloc] initWithFirestore:firestore.wrapped
+                                              documentKey:doc2New.key
+                                                 document:doc2New
+                                                fromCache:false
+                                         hasPendingWrites:false];
 
   NSArray<FIRDocumentChange *> *changesWithoutMetadata = @[
     [[FIRDocumentChange alloc] initWithType:FIRDocumentChangeTypeModified

Firestore/Example/Tests/API/FSTAPIHelpers.mm

@@ -55,9 +55,9 @@
   dispatch_once(&onceToken, ^{
     sharedInstance = [[FIRFirestore alloc] initWithProjectID:"abc"
                                                     database:"abc"
-                                              persistenceKey:@"db123"
-                                         credentialsProvider:nil
-                                                 workerQueue:nil
+                                              persistenceKey:"db123"
+                                         credentialsProvider:nullptr
+                                                 workerQueue:nullptr
                                                  firebaseApp:nil];
   });
 #pragma clang diagnostic pop
@@ -73,11 +73,11 @@
       data ? FSTTestDoc(path, version, data,
                         hasMutations ? FSTDocumentStateLocalMutations : FSTDocumentStateSynced)
            : nil;
-  return [FIRDocumentSnapshot snapshotWithFirestore:FSTTestFirestore()
-                                        documentKey:testutil::Key(path)
-                                           document:doc
-                                          fromCache:fromCache
-                                   hasPendingWrites:hasMutations];
+  return [[FIRDocumentSnapshot alloc] initWithFirestore:FSTTestFirestore().wrapped
+                                            documentKey:testutil::Key(path)
+                                               document:doc
+                                              fromCache:fromCache
+                                       hasPendingWrites:hasMutations];
 }
 
 FIRCollectionReference *FSTTestCollectionRef(const absl::string_view path) {
@@ -86,8 +86,8 @@
 }
 
 FIRDocumentReference *FSTTestDocRef(const absl::string_view path) {
-  return [FIRDocumentReference referenceWithPath:testutil::Resource(path)
-                                       firestore:FSTTestFirestore()];
+  return [[FIRDocumentReference alloc] initWithPath:testutil::Resource(path)
+                                          firestore:FSTTestFirestore().wrapped];
 }
 
 /** A convenience method for creating a query snapshots for tests. */

Firestore/Example/Tests/Util/FSTIntegrationTestCase.mm

@@ -193,7 +193,7 @@ - (FIRFirestore *)firestoreWithProjectID:(NSString *)projectID {
 
   FIRFirestore *firestore = [[FIRFirestore alloc] initWithProjectID:util::MakeString(projectID)
                                                            database:DatabaseId::kDefault
-                                                     persistenceKey:persistenceKey
+                                                     persistenceKey:util::MakeString(persistenceKey)
                                                 credentialsProvider:std::move(credentials_provider)
                                                         workerQueue:std::move(workerQueue)
                                                         firebaseApp:app];

Firestore/Source/API/FIRCollectionReference.mm

@@ -15,11 +15,13 @@
  */
 
 #import "FIRCollectionReference.h"
-#import "FIRFirestore.h"
+
+#include <utility>
 
 #include "Firestore/core/src/firebase/firestore/util/autoid.h"
 
 #import "Firestore/Source/API/FIRDocumentReference+Internal.h"
+#import "Firestore/Source/API/FIRFirestore+Internal.h"
 #import "Firestore/Source/API/FIRQuery+Internal.h"
 #import "Firestore/Source/API/FIRQuery_Init.h"
 #import "Firestore/Source/Core/FSTQuery.h"
@@ -99,7 +101,8 @@ - (FIRDocumentReference *_Nullable)parent {
     return nil;
   } else {
     DocumentKey key{parentPath};
-    return [FIRDocumentReference referenceWithKey:key firestore:self.firestore];
+    return [[FIRDocumentReference alloc] initWithKey:std::move(key)
+                                           firestore:self.firestore.wrapped];
   }
 }
 
@@ -112,8 +115,9 @@ - (FIRDocumentReference *)documentWithPath:(NSString *)documentPath {
     FSTThrowInvalidArgument(@"Document path cannot be nil.");
   }
   const ResourcePath subPath = ResourcePath::FromString(util::MakeString(documentPath));
-  const ResourcePath path = self.query.path.Append(subPath);
-  return [FIRDocumentReference referenceWithPath:path firestore:self.firestore];
+  ResourcePath path = self.query.path.Append(subPath);
+  return [[FIRDocumentReference alloc] initWithPath:std::move(path)
+                                          firestore:self.firestore.wrapped];
 }
 
 - (FIRDocumentReference *)addDocumentWithData:(NSDictionary<NSString *, id> *)data {
@@ -129,8 +133,8 @@ - (FIRDocumentReference *)addDocumentWithData:(NSDictionary<NSString *, id> *)da
 }
 
 - (FIRDocumentReference *)documentWithAutoID {
-  const DocumentKey key{self.query.path.Append(CreateAutoId())};
-  return [FIRDocumentReference referenceWithKey:key firestore:self.firestore];
+  DocumentKey key{self.query.path.Append(CreateAutoId())};
+  return [[FIRDocumentReference alloc] initWithKey:std::move(key) firestore:self.firestore.wrapped];
 }
 
 @end

Firestore/Source/API/FIRDocumentChange+Internal.h

@@ -16,6 +16,7 @@
 
 #import "FIRDocumentChange.h"
 
+#include "Firestore/core/src/firebase/firestore/api/firestore.h"
 #include "Firestore/core/src/firebase/firestore/core/view_snapshot.h"
 
 @class FIRFirestore;
@@ -26,10 +27,10 @@ NS_ASSUME_NONNULL_BEGIN
 @interface FIRDocumentChange (Internal)
 
 /** Calculates the array of FIRDocumentChange's based on the given FSTViewSnapshot. */
-+ (NSArray<FIRDocumentChange *> *)documentChangesForSnapshot:
-                                      (const firebase::firestore::core::ViewSnapshot &)snapshot
-                                      includeMetadataChanges:(BOOL)includeMetadataChanges
-                                                   firestore:(FIRFirestore *)firestore;
++ (NSArray<FIRDocumentChange *> *)
+    documentChangesForSnapshot:(const firebase::firestore::core::ViewSnapshot &)snapshot
+        includeMetadataChanges:(bool)includeMetadataChanges
+                     firestore:(firebase::firestore::api::Firestore *)firestore;
 
 @end
 

Firestore/Source/API/FIRDocumentChange.mm

@@ -17,13 +17,15 @@
 #import "FIRDocumentChange.h"
 
 #import "Firestore/Source/API/FIRDocumentSnapshot+Internal.h"
+#import "Firestore/Source/API/FIRFirestore+Internal.h"
 #import "Firestore/Source/Core/FSTQuery.h"
 #import "Firestore/Source/Model/FSTDocument.h"
 #import "Firestore/Source/Model/FSTDocumentSet.h"
 
 #include "Firestore/core/src/firebase/firestore/core/view_snapshot.h"
 #include "Firestore/core/src/firebase/firestore/util/hard_assert.h"
 
+using firebase::firestore::api::Firestore;
 using firebase::firestore::core::DocumentViewChange;
 using firebase::firestore::core::ViewSnapshot;
 
@@ -55,21 +57,21 @@ + (FIRDocumentChangeType)documentChangeTypeForChange:(const DocumentViewChange &
 }
 
 + (NSArray<FIRDocumentChange *> *)documentChangesForSnapshot:(const ViewSnapshot &)snapshot
-                                      includeMetadataChanges:(BOOL)includeMetadataChanges
-                                                   firestore:(FIRFirestore *)firestore {
+                                      includeMetadataChanges:(bool)includeMetadataChanges
+                                                   firestore:(Firestore *)firestore {
   if (snapshot.old_documents().isEmpty) {
     // Special case the first snapshot because index calculation is easy and fast. Also all changes
     // on the first snapshot are adds so there are also no metadata-only changes to filter out.
     FSTDocument *_Nullable lastDocument = nil;
     NSUInteger index = 0;
     NSMutableArray<FIRDocumentChange *> *changes = [NSMutableArray array];
     for (const DocumentViewChange &change : snapshot.document_changes()) {
-      FIRQueryDocumentSnapshot *document = [FIRQueryDocumentSnapshot
-          snapshotWithFirestore:firestore
-                    documentKey:change.document().key
-                       document:change.document()
-                      fromCache:snapshot.from_cache()
-               hasPendingWrites:snapshot.mutated_keys().contains(change.document().key)];
+      FIRQueryDocumentSnapshot *document = [[FIRQueryDocumentSnapshot alloc]
+          initWithFirestore:firestore
+                documentKey:change.document().key
+                   document:change.document()
+                  fromCache:snapshot.from_cache()
+           hasPendingWrites:snapshot.mutated_keys().contains(change.document().key)];
       HARD_ASSERT(change.type() == DocumentViewChange::Type::kAdded,
                   "Invalid event type for first snapshot");
       HARD_ASSERT(!lastDocument || snapshot.query().comparator(lastDocument, change.document()) ==
@@ -91,12 +93,12 @@ + (FIRDocumentChangeType)documentChangeTypeForChange:(const DocumentViewChange &
         continue;
       }
 
-      FIRQueryDocumentSnapshot *document = [FIRQueryDocumentSnapshot
-          snapshotWithFirestore:firestore
-                    documentKey:change.document().key
-                       document:change.document()
-                      fromCache:snapshot.from_cache()
-               hasPendingWrites:snapshot.mutated_keys().contains(change.document().key)];
+      FIRQueryDocumentSnapshot *document = [[FIRQueryDocumentSnapshot alloc]
+          initWithFirestore:firestore
+                documentKey:change.document().key
+                   document:change.document()
+                  fromCache:snapshot.from_cache()
+           hasPendingWrites:snapshot.mutated_keys().contains(change.document().key)];
 
       NSUInteger oldIndex = NSNotFound;
       NSUInteger newIndex = NSNotFound;

Firestore/Source/API/FIRDocumentReference+Internal.h

@@ -16,19 +16,28 @@
 
 #import "FIRDocumentReference.h"
 
+#include "Firestore/core/src/firebase/firestore/api/document_reference.h"
 #include "Firestore/core/src/firebase/firestore/model/document_key.h"
 #include "Firestore/core/src/firebase/firestore/model/resource_path.h"
 
 NS_ASSUME_NONNULL_BEGIN
 
+@interface FIRDocumentReference (/* Init */)
+
+- (instancetype)initWithReference:(firebase::firestore::api::DocumentReference &&)reference
+    NS_DESIGNATED_INITIALIZER;
+
+- (instancetype)initWithPath:(firebase::firestore::model::ResourcePath)path
+                   firestore:(firebase::firestore::api::Firestore *)firestore;
+
+- (instancetype)initWithKey:(firebase::firestore::model::DocumentKey)key
+                  firestore:(firebase::firestore::api::Firestore *)firestore;
+
+@end
+
 /** Internal FIRDocumentReference API we don't want exposed in our public header files. */
 @interface FIRDocumentReference (Internal)
 
-+ (instancetype)referenceWithPath:(const firebase::firestore::model::ResourcePath &)path
-                        firestore:(FIRFirestore *)firestore;
-+ (instancetype)referenceWithKey:(firebase::firestore::model::DocumentKey)key
-                       firestore:(FIRFirestore *)firestore;
-
 - (const firebase::firestore::model::DocumentKey &)key;
 
 @end