Compat Layer for Firestore (#4003)

Author: schmidt-sebastian

.github/workflows/test-changed-firestore-integration.yml

@@ -28,6 +28,6 @@ jobs:
         cp config/ci.config.json config/project.json
         yarn
     - name: build
-      run: yarn build:changed firestore-integration --buildAppExp
+      run: yarn build:changed firestore-integration --buildAppExp --buildAppCompat
     - name: Run tests if firestore or its dependencies has changed
       run: yarn test:changed firestore-integration

.github/workflows/test-changed-firestore.yml

@@ -28,6 +28,6 @@ jobs:
         cp config/ci.config.json config/project.json
         yarn
     - name: build
-      run: yarn build:changed firestore --buildAppExp
+      run: yarn build:changed firestore --buildAppExp --buildAppCompat
     - name: Run tests if firestore or its dependencies has changed
       run: yarn test:changed firestore

packages/firestore/exp/src/api/database.ts

@@ -39,14 +39,14 @@ import {
   FirebaseFirestore as LiteFirestore,
   Settings as LiteSettings
 } from '../../../lite/src/api/database';
+import { DatabaseId } from '../../../src/core/database_info';
 import { Code, FirestoreError } from '../../../src/util/error';
 import { Deferred } from '../../../src/util/promise';
 import { LRU_MINIMUM_CACHE_SIZE_BYTES } from '../../../src/local/lru_garbage_collector';
 import {
   CACHE_SIZE_UNLIMITED,
   configureFirestore,
-  ensureFirestoreConfigured,
-  FirestoreCompat
+  ensureFirestoreConfigured
 } from '../../../src/api/database';
 import {
   indexedDbClearPersistence,
@@ -70,18 +70,19 @@ export interface Settings extends LiteSettings {
  */
 export class FirebaseFirestore
   extends LiteFirestore
-  implements _FirebaseService, FirestoreCompat {
+  implements _FirebaseService {
   readonly _queue = new AsyncQueue();
   readonly _persistenceKey: string;
 
   _firestoreClient: FirestoreClient | undefined;
 
   constructor(
-    app: FirebaseApp,
+    databaseIdOrApp: DatabaseId | FirebaseApp,
     authProvider: Provider<FirebaseAuthInternalName>
   ) {
-    super(app, authProvider);
-    this._persistenceKey = app.name;
+    super(databaseIdOrApp, authProvider);
+    this._persistenceKey =
+      'name' in databaseIdOrApp ? databaseIdOrApp.name : '[DEFAULT]';
   }
 
   _terminate(): Promise<void> {
@@ -165,13 +166,13 @@ export function getFirestore(app: FirebaseApp): FirebaseFirestore {
  * @return A promise that represents successfully enabling persistent storage.
  */
 export function enableIndexedDbPersistence(
-  firestore: FirestoreCompat,
+  firestore: FirebaseFirestore,
   persistenceSettings?: PersistenceSettings
 ): Promise<void> {
   verifyNotInitialized(firestore);
 
   const client = ensureFirestoreConfigured(firestore);
-  const settings = firestore._getSettings();
+  const settings = firestore._freezeSettings();
 
   const onlineComponentProvider = new OnlineComponentProvider();
   const offlineComponentProvider = new IndexedDbOfflineComponentProvider(
@@ -209,12 +210,12 @@ export function enableIndexedDbPersistence(
  * storage.
  */
 export function enableMultiTabIndexedDbPersistence(
-  firestore: FirestoreCompat
+  firestore: FirebaseFirestore
 ): Promise<void> {
   verifyNotInitialized(firestore);
 
   const client = ensureFirestoreConfigured(firestore);
-  const settings = firestore._getSettings();
+  const settings = firestore._freezeSettings();
 
   const onlineComponentProvider = new OnlineComponentProvider();
   const offlineComponentProvider = new MultiTabOfflineComponentProvider(
@@ -322,7 +323,7 @@ function canFallbackFromIndexedDbError(
  * cleared. Otherwise, the promise is rejected with an error.
  */
 export function clearIndexedDbPersistence(
-  firestore: FirestoreCompat
+  firestore: FirebaseFirestore
 ): Promise<void> {
   if (firestore._initialized && !firestore._terminated) {
     throw new FirestoreError(
@@ -420,7 +421,7 @@ export function terminate(firestore: FirebaseFirestore): Promise<void> {
   return firestore._delete();
 }
 
-function verifyNotInitialized(firestore: FirestoreCompat): void {
+function verifyNotInitialized(firestore: FirebaseFirestore): void {
   if (firestore._initialized || firestore._terminated) {
     throw new FirestoreError(
       Code.FAILED_PRECONDITION,