Expose Multi-DB, and add tests.

Author: tom-andersen

firebase-firestore/firebase-firestore.gradle

@@ -179,6 +179,9 @@ dependencies {
     androidTestImplementation 'androidx.test:runner:1.2.0'
     androidTestImplementation 'androidx.test:rules:1.2.0'
     androidTestImplementation 'androidx.test.ext:junit:1.1.1'
+
+    //testImplementation project(':firebase-firestore')
+    androidTestImplementation project(':firebase-firestore')
 }
 
 gradle.projectsEvaluated {

firebase-firestore/ktx/src/main/kotlin/com/google/firebase/firestore/ktx/Firestore.kt

@@ -43,6 +43,19 @@ val Firebase.firestore: FirebaseFirestore
 /** Returns the [FirebaseFirestore] instance of a given [FirebaseApp]. */
 fun Firebase.firestore(app: FirebaseApp): FirebaseFirestore = FirebaseFirestore.getInstance(app)
 
+/** Returns the [FirebaseFirestore] instance of a given [FirebaseApp] and database name. */
+fun Firebase.firestore(
+    app: FirebaseApp,
+    database: String
+): FirebaseFirestore = FirebaseFirestore.getInstance(app, database)
+
+/**
+ * Returns the [FirebaseFirestore] instance of the default [FirebaseApp], given the database name.
+ */
+fun Firebase.firestore(
+    database: String
+): FirebaseFirestore = FirebaseFirestore.getInstance(database)
+
 /**
  * Returns the contents of the document converted to a POJO or null if the document doesn't exist.
  *

firebase-firestore/ktx/src/test/kotlin/com/google/firebase/firestore/ktx/FirestoreTests.kt

@@ -78,12 +78,23 @@ class FirestoreTests : BaseTestCase() {
         assertThat(Firebase.firestore).isSameInstanceAs(FirebaseFirestore.getInstance())
     }
 
+    @Test
+    fun `Database#firestore should delegate to FirebaseFirestore#getInstance(Database)`() {
+        assertThat(Firebase.firestore("name")).isSameInstanceAs(FirebaseFirestore.getInstance("name"))
+    }
+
     @Test
     fun `FirebaseApp#firestore should delegate to FirebaseFirestore#getInstance(FirebaseApp)`() {
         val app = Firebase.app(EXISTING_APP)
         assertThat(Firebase.firestore(app)).isSameInstanceAs(FirebaseFirestore.getInstance(app))
     }
 
+    @Test
+    fun `FirebaseApp#Database#firestore should delegate to FirebaseFirestore#getInstance(FirebaseApp,Database)`() {
+        val app = Firebase.app(EXISTING_APP)
+        assertThat(Firebase.firestore(app, "name")).isSameInstanceAs(FirebaseFirestore.getInstance(app, "name"))
+    }
+
     @Test
     fun `FirebaseFirestoreSettings builder works`() {
         val host = "http://10.0.2.2:8080"

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

@@ -15,6 +15,7 @@
 package com.google.firebase.firestore;
 
 import static com.google.firebase.firestore.AccessHelper.getAsyncQueue;
+import static com.google.firebase.firestore.testutil.IntegrationTestUtil.isRunningAgainstEmulator;
 import static com.google.firebase.firestore.testutil.IntegrationTestUtil.newTestSettings;
 import static com.google.firebase.firestore.testutil.IntegrationTestUtil.provider;
 import static com.google.firebase.firestore.testutil.IntegrationTestUtil.testChangeUserTo;
@@ -46,6 +47,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.model.DatabaseId;
 import com.google.firebase.firestore.testutil.EventAccumulator;
 import com.google.firebase.firestore.testutil.IntegrationTestUtil;
 import com.google.firebase.firestore.util.AsyncQueue.TimerId;
@@ -57,7 +59,9 @@
 import java.util.List;
 import java.util.Map;
 import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.ExecutionException;
 import java.util.concurrent.Semaphore;
+import java.util.concurrent.TimeoutException;
 import org.junit.After;
 import org.junit.Test;
 import org.junit.runner.RunWith;
@@ -1131,6 +1135,87 @@ public void testAppDeleteLeadsToFirestoreTerminate() {
     assertTrue(instance.getClient().isTerminated());
   }
 
+  @Test
+  public void testDefaultNamedDbIsSame() {
+    FirebaseApp app = FirebaseApp.getInstance();
+    FirebaseFirestore db1 = FirebaseFirestore.getInstance();
+    FirebaseFirestore db2 = FirebaseFirestore.getInstance(app);
+    FirebaseFirestore db3 = FirebaseFirestore.getInstance(app, "(default)");
+    FirebaseFirestore db4 = FirebaseFirestore.getInstance("(default)");
+
+    assertSame(db1, db2);
+    assertSame(db1, db3);
+    assertSame(db1, db4);
+  }
+
+  @Test
+  public void testSameNamedDbIsSame() {
+    FirebaseApp app = FirebaseApp.getInstance();
+    FirebaseFirestore db1 = FirebaseFirestore.getInstance(app, "myDb");
+    FirebaseFirestore db2 = FirebaseFirestore.getInstance("myDb");
+
+    assertSame(db1, db2);
+  }
+
+  @Test
+  public void testDifferentDbNamesAreDifferent() {
+    FirebaseFirestore db1 = FirebaseFirestore.getInstance();
+    FirebaseFirestore db2 = FirebaseFirestore.getInstance("db1");
+    FirebaseFirestore db3 = FirebaseFirestore.getInstance("db2");
+
+    assertNotSame(db1, db2);
+    assertNotSame(db1, db3);
+    assertNotSame(db2, db3);
+  }
+
+  @Test
+  public void testNamedDbHaveDifferentPersistence()
+      throws ExecutionException, InterruptedException, TimeoutException {
+    // TODO: Have backend with named databases created beforehand.
+    // Emulator doesn't care if database was created beforehand.
+    if (!isRunningAgainstEmulator()) {
+      return;
+    }
+    // FirebaseFirestore db1 = FirebaseFirestore.getInstance();
+    String projectId = provider().projectId();
+    FirebaseFirestore db1 =
+        testFirestore(
+            DatabaseId.forDatabase(projectId, "db1"),
+            Level.DEBUG,
+            newTestSettings(),
+            "dbPersistenceKey");
+    FirebaseFirestore db2 =
+        testFirestore(
+            DatabaseId.forDatabase(projectId, "db2"),
+            Level.DEBUG,
+            newTestSettings(),
+            "dbPersistenceKey");
+
+    DocumentReference docRef = db1.collection("col1").document("doc1");
+    waitFor(docRef.set(Collections.singletonMap("foo", "bar")));
+    assertEquals(waitFor(docRef.get(Source.SERVER)).get("foo"), "bar");
+
+    String path = docRef.getPath();
+    DocumentReference docRef2 = db2.document(path);
+
+    {
+      Exception e = waitForException(docRef2.get(Source.CACHE));
+      assertEquals(Code.UNAVAILABLE, ((FirebaseFirestoreException) e).getCode());
+    }
+
+    {
+      Task<DocumentSnapshot> task = docRef2.get(Source.SERVER);
+      DocumentSnapshot result = waitFor(task);
+      assertNull(result.getDocument());
+    }
+
+    {
+      Task<DocumentSnapshot> task = docRef2.get(Source.DEFAULT);
+      DocumentSnapshot result = waitFor(task);
+      assertNull(result.getDocument());
+    }
+  }
+
   @Test
   public void testNewOperationThrowsAfterFirestoreTerminate() {
     FirebaseFirestore instance = testFirestore();

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

@@ -95,7 +95,15 @@ public void disableSslWithoutSettingHostFails() {
   @Test
   public void firestoreGetInstanceWithNullAppFails() {
     expectError(
-        () -> FirebaseFirestore.getInstance(null), "Provided FirebaseApp must not be null.");
+        () -> FirebaseFirestore.getInstance((FirebaseApp) null),
+        "Provided FirebaseApp must not be null.");
+  }
+
+  @Test
+  public void firestoreGetInstanceWithNullDbNamepFails() {
+    expectError(
+        () -> FirebaseFirestore.getInstance((String) null),
+        "Provided database name must not be null.");
   }
 
   @Test

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

@@ -251,11 +251,22 @@ public static FirebaseFirestore testFirestore(
       Logger.Level logLevel,
       FirebaseFirestoreSettings settings,
       String persistenceKey) {
+    return testFirestore(
+        DatabaseId.forDatabase(projectId, DatabaseId.DEFAULT_DATABASE_ID),
+        logLevel,
+        settings,
+        persistenceKey);
+  }
+
+  public static FirebaseFirestore testFirestore(
+      DatabaseId databaseId,
+      Logger.Level logLevel,
+      FirebaseFirestoreSettings settings,
+      String persistenceKey) {
     // This unfortunately is a global setting that affects existing Firestore clients.
     Logger.setLogLevel(logLevel);
 
     Context context = ApplicationProvider.getApplicationContext();
-    DatabaseId databaseId = DatabaseId.forDatabase(projectId, DatabaseId.DEFAULT_DATABASE_ID);
 
     ensureStrictMode();
 

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

@@ -104,22 +104,31 @@ public interface InstanceRegistry {
   private final GrpcMetadataProvider metadataProvider;
 
   @NonNull
-  public static FirebaseFirestore getInstance() {
+  private static FirebaseApp getDefaultFirebaseApp() {
     FirebaseApp app = FirebaseApp.getInstance();
     if (app == null) {
       throw new IllegalStateException("You must call FirebaseApp.initializeApp first.");
     }
-    return getInstance(app, DatabaseId.DEFAULT_DATABASE_ID);
+    return app;
+  }
+
+  @NonNull
+  public static FirebaseFirestore getInstance() {
+    return getInstance(getDefaultFirebaseApp(), DatabaseId.DEFAULT_DATABASE_ID);
   }
 
   @NonNull
   public static FirebaseFirestore getInstance(@NonNull FirebaseApp app) {
     return getInstance(app, DatabaseId.DEFAULT_DATABASE_ID);
   }
 
-  // TODO: make this public
   @NonNull
-  private static FirebaseFirestore getInstance(@NonNull FirebaseApp app, @NonNull String database) {
+  public static FirebaseFirestore getInstance(@NonNull String database) {
+    return getInstance(getDefaultFirebaseApp(), database);
+  }
+
+  @NonNull
+  public static FirebaseFirestore getInstance(@NonNull FirebaseApp app, @NonNull String database) {
     checkNotNull(app, "Provided FirebaseApp must not be null.");
     FirestoreMultiDbComponent component = app.get(FirestoreMultiDbComponent.class);
     checkNotNull(component, "Firestore component is not present.");