Add FirestoreClientProvider

firebase-firestore/src/androidTest/java/com/google/firebase/firestore/AccessHelper.java

@@ -18,8 +18,10 @@
 import com.google.firebase.FirebaseApp;
 import com.google.firebase.firestore.auth.CredentialsProvider;
 import com.google.firebase.firestore.auth.User;
+import com.google.firebase.firestore.core.ComponentProvider;
 import com.google.firebase.firestore.model.DatabaseId;
 import com.google.firebase.firestore.util.AsyncQueue;
+import com.google.firebase.firestore.util.Function;
 
 /** Gives access to package private methods in integration tests. */
 public final class AccessHelper {
@@ -32,6 +34,7 @@ public static FirebaseFirestore newFirebaseFirestore(
       CredentialsProvider<User> authProvider,
       CredentialsProvider<String> appCheckProvider,
       AsyncQueue asyncQueue,
+      Function<FirebaseFirestoreSettings, ComponentProvider> componentProviderFactory,
       FirebaseApp firebaseApp,
       FirebaseFirestore.InstanceRegistry instanceRegistry) {
     return new FirebaseFirestore(
@@ -41,6 +44,7 @@ public static FirebaseFirestore newFirebaseFirestore(
         authProvider,
         appCheckProvider,
         asyncQueue,
+        componentProviderFactory,
         firebaseApp,
         instanceRegistry,
         null);

firebase-firestore/src/androidTest/java/com/google/firebase/firestore/FirestoreTest.java

@@ -49,6 +49,7 @@
 import com.google.firebase.firestore.FirebaseFirestoreException.Code;
 import com.google.firebase.firestore.Query.Direction;
 import com.google.firebase.firestore.auth.User;
+import com.google.firebase.firestore.core.FirestoreClient;
 import com.google.firebase.firestore.model.DatabaseId;
 import com.google.firebase.firestore.testutil.EventAccumulator;
 import com.google.firebase.firestore.testutil.IntegrationTestUtil;
@@ -1132,7 +1133,7 @@ public void testAppDeleteLeadsToFirestoreTerminate() {
 
     app.delete();
 
-    assertTrue(instance.getClient().isTerminated());
+    assertTrue(instance.callClient(FirestoreClient::isTerminated));
   }
 
   @Test

firebase-firestore/src/androidTest/java/com/google/firebase/firestore/QueryTest.java

@@ -536,12 +536,12 @@ public void testQueriesFireFromCacheWhenOffline() {
     assertFalse(querySnapshot.getMetadata().isFromCache());
 
     // offline event with fromCache=true
-    waitFor(collection.firestore.getClient().disableNetwork());
+    waitFor(collection.firestore.disableNetwork());
     querySnapshot = accum.await();
     assertTrue(querySnapshot.getMetadata().isFromCache());
 
     // back online event with fromCache=false
-    waitFor(collection.firestore.getClient().enableNetwork());
+    waitFor(collection.firestore.enableNetwork());
     querySnapshot = accum.await();
     assertFalse(querySnapshot.getMetadata().isFromCache());
 

firebase-firestore/src/androidTest/java/com/google/firebase/firestore/ServerTimestampTest.java

@@ -214,7 +214,7 @@ public void testServerTimestampsCanReturnPreviousValueOfDifferentType() {
   @Test
   public void testServerTimestampsCanRetainPreviousValueThroughConsecutiveUpdates() {
     writeInitialData();
-    waitFor(docRef.getFirestore().getClient().disableNetwork());
+    waitFor(docRef.getFirestore().disableNetwork());
     accumulator.awaitRemoteEvent();
 
     docRef.update("a", FieldValue.serverTimestamp());
@@ -226,7 +226,7 @@ public void testServerTimestampsCanRetainPreviousValueThroughConsecutiveUpdates(
     localSnapshot = accumulator.awaitLocalEvent();
     assertEquals(42L, localSnapshot.get("a", ServerTimestampBehavior.PREVIOUS));
 
-    waitFor(docRef.getFirestore().getClient().enableNetwork());
+    waitFor(docRef.getFirestore().enableNetwork());
 
     DocumentSnapshot remoteSnapshot = accumulator.awaitRemoteEvent();
     assertThat(remoteSnapshot.get("a")).isInstanceOf(Timestamp.class);
@@ -235,7 +235,7 @@ public void testServerTimestampsCanRetainPreviousValueThroughConsecutiveUpdates(
   @Test
   public void testServerTimestampsUsesPreviousValueFromLocalMutation() {
     writeInitialData();
-    waitFor(docRef.getFirestore().getClient().disableNetwork());
+    waitFor(docRef.getFirestore().disableNetwork());
     accumulator.awaitRemoteEvent();
 
     docRef.update("a", FieldValue.serverTimestamp());
@@ -249,7 +249,7 @@ public void testServerTimestampsUsesPreviousValueFromLocalMutation() {
     localSnapshot = accumulator.awaitLocalEvent();
     assertEquals(1337L, localSnapshot.get("a", ServerTimestampBehavior.PREVIOUS));
 
-    waitFor(docRef.getFirestore().getClient().enableNetwork());
+    waitFor(docRef.getFirestore().enableNetwork());
 
     DocumentSnapshot remoteSnapshot = accumulator.awaitRemoteEvent();
     assertThat(remoteSnapshot.get("a")).isInstanceOf(Timestamp.class);

firebase-firestore/src/androidTest/java/com/google/firebase/firestore/ValidationTest.java

@@ -453,7 +453,7 @@ public void queriesCannotBeSortedByAnUncommittedServerTimestamp() {
     CollectionReference collection = testCollection();
 
     // Ensure the server timestamp stays uncommitted for the first half of the test
-    waitFor(collection.firestore.getClient().disableNetwork());
+    waitFor(collection.firestore.disableNetwork());
 
     TaskCompletionSource<Void> offlineCallbackDone = new TaskCompletionSource<>();
     TaskCompletionSource<Void> onlineCallbackDone = new TaskCompletionSource<>();
@@ -497,7 +497,7 @@ public void queriesCannotBeSortedByAnUncommittedServerTimestamp() {
     document.set(map("timestamp", FieldValue.serverTimestamp()));
     waitFor(offlineCallbackDone.getTask());
 
-    waitFor(collection.firestore.getClient().enableNetwork());
+    waitFor(collection.firestore.enableNetwork());
     waitFor(onlineCallbackDone.getTask());
 
     listenerRegistration.remove();

firebase-firestore/src/androidTest/java/com/google/firebase/firestore/remote/RemoteStoreTest.java

@@ -20,6 +20,7 @@
 import androidx.test.ext.junit.runners.AndroidJUnit4;
 import com.google.firebase.database.collection.ImmutableSortedSet;
 import com.google.firebase.firestore.auth.User;
+import com.google.firebase.firestore.core.DatabaseInfo;
 import com.google.firebase.firestore.core.OnlineState;
 import com.google.firebase.firestore.local.LocalStore;
 import com.google.firebase.firestore.local.MemoryPersistence;
@@ -40,14 +41,8 @@ public class RemoteStoreTest {
   @Test
   public void testRemoteStoreStreamStopsWhenNetworkUnreachable() {
     AsyncQueue testQueue = new AsyncQueue();
-    Datastore datastore =
-        new Datastore(
-            IntegrationTestUtil.testEnvDatabaseInfo(),
-            testQueue,
-            null,
-            null,
-            ApplicationProvider.getApplicationContext(),
-            null);
+    RemoteSerializer serializer = new RemoteSerializer(IntegrationTestUtil.testEnvDatabaseId());
+    Datastore datastore = new Datastore(testQueue, serializer, null);
     Semaphore networkChangeSemaphore = new Semaphore(0);
     RemoteStore.RemoteStoreCallback callback =
         new RemoteStore.RemoteStoreCallback() {
@@ -75,12 +70,11 @@ public ImmutableSortedSet<DocumentKey> getRemoteKeysForTarget(int targetId) {
         };
 
     FakeConnectivityMonitor connectivityMonitor = new FakeConnectivityMonitor();
-    QueryEngine queryEngine = new QueryEngine();
     Persistence persistence = MemoryPersistence.createEagerGcMemoryPersistence();
     persistence.start();
-    LocalStore localStore = new LocalStore(persistence, queryEngine, User.UNAUTHENTICATED);
+    LocalStore localStore = new LocalStore(persistence, new QueryEngine(), User.UNAUTHENTICATED);
     RemoteStore remoteStore =
-        new RemoteStore(callback, localStore, datastore, testQueue, connectivityMonitor);
+        new RemoteStore(IntegrationTestUtil.testEnvDatabaseId(), callback, localStore, datastore, testQueue, connectivityMonitor);
 
     waitFor(testQueue.enqueue(remoteStore::forceEnableNetwork));
     drain(testQueue);

firebase-firestore/src/androidTest/java/com/google/firebase/firestore/remote/StreamTest.java

@@ -26,9 +26,11 @@
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
 
+import androidx.annotation.NonNull;
 import androidx.test.core.app.ApplicationProvider;
 import androidx.test.ext.junit.runners.AndroidJUnit4;
 import com.google.android.gms.tasks.Task;
+import com.google.firebase.firestore.core.DatabaseInfo;
 import com.google.firebase.firestore.model.SnapshotVersion;
 import com.google.firebase.firestore.model.mutation.Mutation;
 import com.google.firebase.firestore.model.mutation.MutationResult;
@@ -109,14 +111,7 @@ public void onWriteResponse(
   /** Creates a WriteStream and gets it in a state that accepts mutations. */
   private WriteStream createAndOpenWriteStream(
       AsyncQueue testQueue, StreamStatusCallback callback) {
-    Datastore datastore =
-        new Datastore(
-            IntegrationTestUtil.testEnvDatabaseInfo(),
-            testQueue,
-            new EmptyCredentialsProvider(),
-            new EmptyAppCheckTokenProvider(),
-            ApplicationProvider.getApplicationContext(),
-            null);
+    Datastore datastore = createTestDatastore(testQueue, null);
     final WriteStream writeStream = datastore.createWriteStream(callback);
     waitForWriteStreamOpen(testQueue, writeStream, callback);
     return writeStream;
@@ -131,18 +126,25 @@ private void waitForWriteStreamOpen(
     waitFor(callback.handshakeSemaphore);
   }
 
+  @NonNull
+  private static Datastore createTestDatastore(AsyncQueue testQueue, GrpcMetadataProvider metadataProvider) {
+    DatabaseInfo databaseInfo = IntegrationTestUtil.testEnvDatabaseInfo();
+    RemoteSerializer remoteSerializer = new RemoteSerializer(databaseInfo.getDatabaseId());
+    FirestoreChannel firestoreChannel = new FirestoreChannel(
+            testQueue,
+            ApplicationProvider.getApplicationContext(),
+            new EmptyCredentialsProvider(),
+            new EmptyAppCheckTokenProvider(),
+            databaseInfo,
+            metadataProvider);
+    return new Datastore(testQueue, remoteSerializer, firestoreChannel);
+  }
+
   @Test
   public void testWatchStreamStopBeforeHandshake() throws Exception {
     AsyncQueue testQueue = new AsyncQueue();
     GrpcMetadataProvider mockGrpcProvider = mock(GrpcMetadataProvider.class);
-    Datastore datastore =
-        new Datastore(
-            IntegrationTestUtil.testEnvDatabaseInfo(),
-            testQueue,
-            new EmptyCredentialsProvider(),
-            new EmptyAppCheckTokenProvider(),
-            ApplicationProvider.getApplicationContext(),
-            mockGrpcProvider);
+    Datastore datastore = createTestDatastore(testQueue, mockGrpcProvider);
     StreamStatusCallback streamCallback = new StreamStatusCallback() {};
     final WatchStream watchStream = datastore.createWatchStream(streamCallback);
 
@@ -158,14 +160,7 @@ public void testWatchStreamStopBeforeHandshake() throws Exception {
   @Test
   public void testWriteStreamStopAfterHandshake() throws Exception {
     AsyncQueue testQueue = new AsyncQueue();
-    Datastore datastore =
-        new Datastore(
-            IntegrationTestUtil.testEnvDatabaseInfo(),
-            testQueue,
-            new EmptyCredentialsProvider(),
-            new EmptyAppCheckTokenProvider(),
-            ApplicationProvider.getApplicationContext(),
-            null);
+    Datastore datastore = createTestDatastore(testQueue, null);
     final WriteStream[] writeStreamWrapper = new WriteStream[1];
     StreamStatusCallback streamCallback =
         new StreamStatusCallback() {
@@ -206,14 +201,7 @@ public void onWriteResponse(
   @Test
   public void testWriteStreamStopPartial() throws Exception {
     AsyncQueue testQueue = new AsyncQueue();
-    Datastore datastore =
-        new Datastore(
-            IntegrationTestUtil.testEnvDatabaseInfo(),
-            testQueue,
-            new EmptyCredentialsProvider(),
-            new EmptyAppCheckTokenProvider(),
-            ApplicationProvider.getApplicationContext(),
-            null);
+    Datastore datastore = createTestDatastore(testQueue, null);
     StreamStatusCallback streamCallback = new StreamStatusCallback() {};
     final WriteStream writeStream = datastore.createWriteStream(streamCallback);
 
@@ -287,14 +275,7 @@ public void testStreamStaysIdle() throws Exception {
   public void testStreamRefreshesTokenUponExpiration() throws Exception {
     AsyncQueue testQueue = new AsyncQueue();
     MockCredentialsProvider mockCredentialsProvider = new MockCredentialsProvider();
-    Datastore datastore =
-        new Datastore(
-            IntegrationTestUtil.testEnvDatabaseInfo(),
-            testQueue,
-            mockCredentialsProvider,
-            new EmptyAppCheckTokenProvider(),
-            ApplicationProvider.getApplicationContext(),
-            null);
+    Datastore datastore = createTestDatastore(testQueue, null);
     StreamStatusCallback callback = new StreamStatusCallback();
     WriteStream writeStream = datastore.createWriteStream(callback);
     waitForWriteStreamOpen(testQueue, writeStream, callback);
@@ -317,14 +298,7 @@ public void testStreamRefreshesTokenUponExpiration() throws Exception {
   public void testTokenIsNotInvalidatedOnceStreamIsHealthy() throws Exception {
     AsyncQueue testQueue = new AsyncQueue();
     MockCredentialsProvider mockCredentialsProvider = new MockCredentialsProvider();
-    Datastore datastore =
-        new Datastore(
-            IntegrationTestUtil.testEnvDatabaseInfo(),
-            testQueue,
-            mockCredentialsProvider,
-            new EmptyAppCheckTokenProvider(),
-            ApplicationProvider.getApplicationContext(),
-            null);
+    Datastore datastore = createTestDatastore(testQueue, null);
     StreamStatusCallback callback = new StreamStatusCallback();
     WriteStream writeStream = datastore.createWriteStream(callback);
     waitForWriteStreamOpen(testQueue, writeStream, callback);

firebase-firestore/src/androidTest/java/com/google/firebase/firestore/testutil/IntegrationTestUtil.java

@@ -22,6 +22,8 @@
 
 import android.content.Context;
 import android.os.StrictMode;
+
+import androidx.annotation.NonNull;
 import androidx.test.core.app.ApplicationProvider;
 import com.google.android.gms.tasks.Task;
 import com.google.android.gms.tasks.TaskCompletionSource;
@@ -42,6 +44,7 @@
 import com.google.firebase.firestore.Source;
 import com.google.firebase.firestore.WriteBatch;
 import com.google.firebase.firestore.auth.User;
+import com.google.firebase.firestore.core.ComponentProvider;
 import com.google.firebase.firestore.core.DatabaseInfo;
 import com.google.firebase.firestore.model.DatabaseId;
 import com.google.firebase.firestore.testutil.provider.FirestoreProvider;
@@ -170,14 +173,20 @@ public static TargetBackend getTargetBackend() {
     }
   }
 
+  @NonNull
   public static DatabaseInfo testEnvDatabaseInfo() {
     return new DatabaseInfo(
-        DatabaseId.forProject(provider.projectId()),
+        testEnvDatabaseId(),
         "test-persistenceKey",
         getFirestoreHost(),
         getSslEnabled());
   }
 
+  @NonNull
+  public static DatabaseId testEnvDatabaseId() {
+    return DatabaseId.forProject(provider.projectId());
+  }
+
   public static FirebaseFirestoreSettings newTestSettings() {
     Logger.debug("IntegrationTestUtil", "target backend is: %s", backend.name());
     FirebaseFirestoreSettings.Builder settings = new FirebaseFirestoreSettings.Builder();
@@ -315,6 +324,7 @@ public static FirebaseFirestore testFirestore(
             MockCredentialsProvider.instance(),
             new EmptyAppCheckTokenProvider(),
             asyncQueue,
+            ComponentProvider::defaultFactory,
             /*firebaseApp=*/ null,
             /*instanceRegistry=*/ (dbId) -> {});
     waitFor(firestore.clearPersistence());

firebase-firestore/src/main/java/com/google/firebase/firestore/AggregateQuery.java

@@ -64,10 +64,7 @@ public List<AggregateField> getAggregateFields() {
   public Task<AggregateQuerySnapshot> get(@NonNull AggregateSource source) {
     Preconditions.checkNotNull(source, "AggregateSource must not be null");
     TaskCompletionSource<AggregateQuerySnapshot> tcs = new TaskCompletionSource<>();
-    query
-        .firestore
-        .getClient()
-        .runAggregateQuery(query.query, aggregateFieldList)
+    query.firestore.callClient(client -> client.runAggregateQuery(query.query, aggregateFieldList))
         .continueWith(
             Executors.DIRECT_EXECUTOR,
             (task) -> {