Tomandersen/multi db (#6518)

Author: tom-andersen

.changeset/heavy-spiders-fry.md

@@ -0,0 +1,6 @@
+---
+'@firebase/firestore': minor
+'@firebase/firestore-compat': patch
+---
+
+Add named DB support

common/api-review/firestore-lite.api.md

@@ -176,13 +176,22 @@ export function getDoc<T>(reference: DocumentReference<T>): Promise<DocumentSnap
 export function getDocs<T>(query: Query<T>): Promise<QuerySnapshot<T>>;
 
 // @public
-export function getFirestore(app?: FirebaseApp): Firestore;
+export function getFirestore(): Firestore;
+
+// @public
+export function getFirestore(app: FirebaseApp): Firestore;
+
+// @public
+export function getFirestore(databaseId: string): Firestore;
+
+// @public
+export function getFirestore(app: FirebaseApp, databaseId: string): Firestore;
 
 // @public
 export function increment(n: number): FieldValue;
 
 // @public
-export function initializeFirestore(app: FirebaseApp, settings: Settings): Firestore;
+export function initializeFirestore(app: FirebaseApp, settings: Settings, databaseId?: string): Firestore;
 
 // @public
 export function limit(limit: number): QueryConstraint;

common/api-review/firestore.api.md

@@ -228,13 +228,22 @@ export function getDocsFromCache<T>(query: Query<T>): Promise<QuerySnapshot<T>>;
 export function getDocsFromServer<T>(query: Query<T>): Promise<QuerySnapshot<T>>;
 
 // @public
-export function getFirestore(app?: FirebaseApp): Firestore;
+export function getFirestore(): Firestore;
+
+// @public
+export function getFirestore(app: FirebaseApp): Firestore;
+
+// @public
+export function getFirestore(databaseId: string): Firestore;
+
+// @public
+export function getFirestore(app: FirebaseApp, databaseId: string): Firestore;
 
 // @public
 export function increment(n: number): FieldValue;
 
 // @public
-export function initializeFirestore(app: FirebaseApp, settings: FirestoreSettings): Firestore;
+export function initializeFirestore(app: FirebaseApp, settings: FirestoreSettings, databaseId?: string): Firestore;
 
 // @public
 export function limit(limit: number): QueryConstraint;

integration/firestore/firebase_export.ts

@@ -27,19 +27,25 @@ import {
 
 let appCount = 0;
 
+export function newTestApp(projectId: string, appName?: string): FirebaseApp {
+  if (appName === undefined) {
+    appName = 'test-app-' + appCount++;
+  }
+  return initializeApp(
+    {
+      apiKey: 'fake-api-key',
+      projectId
+    },
+    appName
+  );
+}
+
 export function newTestFirestore(
-  projectId: string,
-  nameOrApp?: string | FirebaseApp,
-  settings?: FirestoreSettings
+  app: FirebaseApp,
+  settings?: FirestoreSettings,
+  dbName?: string
 ): Firestore {
-  if (nameOrApp === undefined) {
-    nameOrApp = 'test-app-' + appCount++;
-  }
-  const app =
-    typeof nameOrApp === 'string'
-      ? initializeApp({ apiKey: 'fake-api-key', projectId }, nameOrApp)
-      : nameOrApp;
-  return initializeFirestore(app, settings || {});
+  return initializeFirestore(app, settings || {}, dbName);
 }
 
 export * from '@firebase/firestore';

packages/firestore-compat/src/index.console.ts

@@ -91,9 +91,9 @@ export class Firestore extends FirestoreCompat {
     super(
       databaseIdFromFirestoreDatabase(firestoreDatabase),
       new FirestoreExp(
-        databaseIdFromFirestoreDatabase(firestoreDatabase),
         new _EmptyAuthCredentialsProvider(),
-        new _EmptyAppCheckTokenProvider()
+        new _EmptyAppCheckTokenProvider(),
+        databaseIdFromFirestoreDatabase(firestoreDatabase)
       ),
       new MemoryPersistenceProvider()
     );

packages/firestore/lite/register.ts

@@ -27,9 +27,9 @@ import {
   LiteAppCheckTokenProvider,
   LiteAuthCredentialsProvider
 } from '../src/api/credentials';
+import { databaseIdFromApp } from '../src/core/database_info';
 import { setSDKVersion } from '../src/core/version';
 import { Firestore } from '../src/lite-api/database';
-import { FirestoreSettings } from '../src/lite-api/settings';
 
 declare module '@firebase/component' {
   interface NameServiceMapping {
@@ -42,24 +42,25 @@ export function registerFirestore(): void {
   _registerComponent(
     new Component(
       'firestore/lite',
-      (container, { options: settings }: { options?: FirestoreSettings }) => {
+      (container, { instanceIdentifier: databaseId, options: settings }) => {
         const app = container.getProvider('app').getImmediate()!;
         const firestoreInstance = new Firestore(
-          app,
           new LiteAuthCredentialsProvider(
             container.getProvider('auth-internal')
           ),
           new LiteAppCheckTokenProvider(
             container.getProvider('app-check-internal')
-          )
+          ),
+          databaseIdFromApp(app, databaseId),
+          app
         );
         if (settings) {
           firestoreInstance._setSettings(settings);
         }
         return firestoreInstance;
       },
       'PUBLIC' as ComponentType.PUBLIC
-    )
+    ).setMultipleInstances(true)
   );
   // RUNTIME_ENV and BUILD_TARGET are replaced by real values during the compilation
   registerVersion('firestore-lite', version, '__RUNTIME_ENV__');

packages/firestore/src/api/database.ts

@@ -31,7 +31,7 @@ import {
   OfflineComponentProvider,
   OnlineComponentProvider
 } from '../core/component_provider';
-import { DatabaseId } from '../core/database_info';
+import { DatabaseId, DEFAULT_DATABASE_NAME } from '../core/database_info';
 import {
   FirestoreClient,
   firestoreClientDisableNetwork,
@@ -103,17 +103,18 @@ export class Firestore extends LiteFirestore {
 
   /** @hideconstructor */
   constructor(
-    databaseIdOrApp: DatabaseId | FirebaseApp,
     authCredentialsProvider: CredentialsProvider<User>,
-    appCheckCredentialsProvider: CredentialsProvider<string>
+    appCheckCredentialsProvider: CredentialsProvider<string>,
+    databaseId: DatabaseId,
+    app?: FirebaseApp
   ) {
     super(
-      databaseIdOrApp,
       authCredentialsProvider,
-      appCheckCredentialsProvider
+      appCheckCredentialsProvider,
+      databaseId,
+      app
     );
-    this._persistenceKey =
-      'name' in databaseIdOrApp ? databaseIdOrApp.name : '[DEFAULT]';
+    this._persistenceKey = app?.name || '[DEFAULT]';
   }
 
   _terminate(): Promise<void> {
@@ -135,17 +136,26 @@ export class Firestore extends LiteFirestore {
  * @param app - The {@link @firebase/app#FirebaseApp} with which the {@link Firestore} instance will
  * be associated.
  * @param settings - A settings object to configure the {@link Firestore} instance.
+ * @param databaseId - The name of database.
  * @returns A newly initialized {@link Firestore} instance.
  */
 export function initializeFirestore(
   app: FirebaseApp,
-  settings: FirestoreSettings
+  settings: FirestoreSettings,
+  databaseId?: string
 ): Firestore {
+  if (!databaseId) {
+    databaseId = DEFAULT_DATABASE_NAME;
+  }
   const provider = _getProvider(app, 'firestore');
 
-  if (provider.isInitialized()) {
-    const existingInstance = provider.getImmediate();
-    const initialSettings = provider.getOptions() as FirestoreSettings;
+  if (provider.isInitialized(databaseId)) {
+    const existingInstance = provider.getImmediate({
+      identifier: databaseId
+    });
+    const initialSettings = provider.getOptions(
+      databaseId
+    ) as FirestoreSettings;
     if (deepEqual(initialSettings, settings)) {
       return existingInstance;
     } else {
@@ -170,20 +180,63 @@ export function initializeFirestore(
     );
   }
 
-  return provider.initialize({ options: settings });
+  return provider.initialize({
+    options: settings,
+    instanceIdentifier: databaseId
+  });
 }
 
+/**
+ * Returns the existing default {@link Firestore} instance that is associated with the
+ * default {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
+ * instance with default settings.
+ *
+ * @returns The {@link Firestore} instance of the provided app.
+ */
+export function getFirestore(): Firestore;
+/**
+ * Returns the existing default {@link Firestore} instance that is associated with the
+ * provided {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
+ * instance with default settings.
+ *
+ * @param app - The {@link @firebase/app#FirebaseApp} instance that the returned {@link Firestore}
+ * instance is associated with.
+ * @returns The {@link Firestore} instance of the provided app.
+ */
+export function getFirestore(app: FirebaseApp): Firestore;
+/**
+ * Returns the existing {@link Firestore} instance that is associated with the
+ * default {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
+ * instance with default settings.
+ *
+ * @param databaseId - The name of database.
+ * @returns The {@link Firestore} instance of the provided app.
+ */
+export function getFirestore(databaseId: string): Firestore;
 /**
  * Returns the existing {@link Firestore} instance that is associated with the
  * provided {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
  * instance with default settings.
  *
  * @param app - The {@link @firebase/app#FirebaseApp} instance that the returned {@link Firestore}
  * instance is associated with.
+ * @param databaseId - The name of database.
  * @returns The {@link Firestore} instance of the provided app.
  */
-export function getFirestore(app: FirebaseApp = getApp()): Firestore {
-  return _getProvider(app, 'firestore').getImmediate() as Firestore;
+export function getFirestore(app: FirebaseApp, databaseId: string): Firestore;
+export function getFirestore(
+  appOrDatabaseId?: FirebaseApp | string,
+  optionalDatabaseId?: string
+): Firestore {
+  const app: FirebaseApp =
+    typeof appOrDatabaseId === 'object' ? appOrDatabaseId : getApp();
+  const databaseId =
+    typeof appOrDatabaseId === 'string'
+      ? appOrDatabaseId
+      : optionalDatabaseId || DEFAULT_DATABASE_NAME;
+  return _getProvider(app, 'firestore').getImmediate({
+    identifier: databaseId
+  }) as Firestore;
 }
 
 /**
@@ -498,7 +551,11 @@ export function disableNetwork(firestore: Firestore): Promise<void> {
  * terminated.
  */
 export function terminate(firestore: Firestore): Promise<void> {
-  _removeServiceInstance(firestore.app, 'firestore');
+  _removeServiceInstance(
+    firestore.app,
+    'firestore',
+    firestore._databaseId.database
+  );
   return firestore._delete();
 }
 

packages/firestore/src/core/database_info.ts

@@ -1,3 +1,7 @@
+import { FirebaseApp } from '@firebase/app';
+
+import { Code, FirestoreError } from '../util/error';
+
 /**
  * @license
  * Copyright 2017 Google LLC
@@ -46,7 +50,7 @@ export class DatabaseInfo {
 }
 
 /** The default database name for a project. */
-const DEFAULT_DATABASE_NAME = '(default)';
+export const DEFAULT_DATABASE_NAME = '(default)';
 
 /**
  * Represents the database ID a Firestore client is associated with.
@@ -74,3 +78,17 @@ export class DatabaseId {
     );
   }
 }
+
+export function databaseIdFromApp(
+  app: FirebaseApp,
+  database?: string
+): DatabaseId {
+  if (!Object.prototype.hasOwnProperty.apply(app.options, ['projectId'])) {
+    throw new FirestoreError(
+      Code.INVALID_ARGUMENT,
+      '"projectId" not provided in firebase.initializeApp.'
+    );
+  }
+
+  return new DatabaseId(app.options.projectId!, database);
+}