Compat Layer for Firestore

Author: schmidt-sebastian

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

@@ -44,15 +44,15 @@ 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
+  FirestoreDatabase
 } from '../../../src/api/database';
 import {
   indexedDbClearPersistence,
   indexedDbStoragePrefix
 } from '../../../src/local/indexeddb_persistence';
 import { PersistenceSettings } from '../../../exp-types';
+import { debugAssert } from '../../../src/util/assert';
+import { DatabaseInfo } from '../../../src/core/database_info';
 
 /** DOMException error code constants. */
 const DOM_EXCEPTION_INVALID_STATE = 11;
@@ -70,18 +70,18 @@ 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,
+    app: FirestoreDatabase | FirebaseApp,
     authProvider: Provider<FirebaseAuthInternalName>
   ) {
     super(app, authProvider);
-    this._persistenceKey = app.name;
+    this._persistenceKey = 'name' in app ? app.name : '[DEFAULT]';
   }
 
   _terminate(): Promise<void> {
@@ -94,6 +94,39 @@ export class FirebaseFirestore
   }
 }
 
+export function ensureFirestoreConfigured(
+  firestore: FirebaseFirestore
+): FirestoreClient {
+  if (!firestore._firestoreClient) {
+    configureFirestore(firestore);
+  }
+  firestore._firestoreClient!.verifyNotTerminated();
+  return firestore._firestoreClient as FirestoreClient;
+}
+
+export function configureFirestore(firestore: FirebaseFirestore): void {
+  const settings = firestore._getSettings();
+  debugAssert(!!settings.host, 'FirestoreSettings.host is not set');
+  debugAssert(
+    !firestore._firestoreClient,
+    'configureFirestore() called multiple times'
+  );
+
+  const databaseInfo = new DatabaseInfo(
+    firestore._databaseId,
+    firestore._persistenceKey,
+    settings.host,
+    settings.ssl,
+    settings.experimentalForceLongPolling,
+    settings.experimentalAutoDetectLongPolling
+  );
+  firestore._firestoreClient = new FirestoreClient(
+    firestore._credentials,
+    firestore._queue,
+    databaseInfo
+  );
+}
+
 /**
  * Initializes a new instance of Cloud Firestore with the provided settings.
  * Can only be called before any other function, including
@@ -129,6 +162,16 @@ export function initializeFirestore(
   return firestore;
 }
 
+export function initializeStandalone(
+  database: FirestoreDatabase,
+  authProvider: Provider<FirebaseAuthInternalName>,
+  settings: Settings
+): FirebaseFirestore {
+  const firestore = new FirebaseFirestore(database, authProvider);
+  firestore._setSettings(settings);
+  return firestore;
+}
+
 /**
  * Returns the existing instance of Firestore that is associated with the
  * provided {@link FirebaseApp}. If no instance exists, initializes a new
@@ -165,7 +208,7 @@ 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);
@@ -209,7 +252,7 @@ export function enableIndexedDbPersistence(
  * storage.
  */
 export function enableMultiTabIndexedDbPersistence(
-  firestore: FirestoreCompat
+  firestore: FirebaseFirestore
 ): Promise<void> {
   verifyNotInitialized(firestore);
 
@@ -322,7 +365,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 +463,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,

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

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-import { FirebaseFirestore } from './database';
+import { ensureFirestoreConfigured, FirebaseFirestore } from './database';
 import {
   _DocumentKeyReference,
   ParsedUpdateData,

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

@@ -19,7 +19,7 @@ import { Transaction as LiteTransaction } from '../../../lite/src/api/transactio
 import { DocumentSnapshot } from './snapshot';
 import { TransactionRunner } from '../../../src/core/transaction_runner';
 import { AsyncQueue } from '../../../src/util/async_queue';
-import { FirebaseFirestore } from './database';
+import { ensureFirestoreConfigured, FirebaseFirestore } from './database';
 import { Deferred } from '../../../src/util/promise';
 import {
   ensureFirestoreConfigured,

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

@@ -16,7 +16,7 @@
  */
 
 import { WriteBatch } from '../../../lite/src/api/write_batch';
-import { FirebaseFirestore } from './database';
+import { ensureFirestoreConfigured, FirebaseFirestore } from './database';
 import { executeWrite } from './reference';
 import { ensureFirestoreConfigured } from '../../../src/api/database';
 

packages/firestore/exp/test/shim.ts

@@ -70,6 +70,7 @@ import {
   validateSetOptions
 } from '../../src/util/input_validation';
 import { Compat } from '../../src/compat/compat';
+import { Firestore } from '../../src/api/database';
 
 export { GeoPoint, Timestamp } from '../index';
 export { FieldValue } from '../../src/compat/field_value';
@@ -93,92 +94,11 @@ export class FirebaseApp
   }
 }
 
-export class FirebaseFirestore
-  extends Compat<exp.FirebaseFirestore>
-  implements legacy.FirebaseFirestore {
-  app = new FirebaseApp(this._delegate.app);
-
-  settings(settings: legacy.Settings): void {
-    initializeFirestore(this.app._delegate, settings);
-  }
-
-  useEmulator(host: string, port: number): void {
-    this.settings({ host: `${host}:${port}`, ssl: false, merge: true });
-  }
-
-  enablePersistence(settings?: legacy.PersistenceSettings): Promise<void> {
-    return settings?.synchronizeTabs
-      ? enableMultiTabIndexedDbPersistence(this._delegate)
-      : enableIndexedDbPersistence(this._delegate);
-  }
-
-  collection(collectionPath: string): CollectionReference<legacy.DocumentData> {
-    return new CollectionReference(
-      this,
-      collection(this._delegate, collectionPath)
-    );
-  }
-
-  doc(documentPath: string): DocumentReference<legacy.DocumentData> {
-    return new DocumentReference(this, doc(this._delegate, documentPath));
-  }
-
-  collectionGroup(collectionId: string): Query<legacy.DocumentData> {
-    return new Query(this, collectionGroup(this._delegate, collectionId));
-  }
-
-  runTransaction<T>(
-    updateFunction: (transaction: legacy.Transaction) => Promise<T>
-  ): Promise<T> {
-    return runTransaction(this._delegate, t =>
-      updateFunction(new Transaction(this, t))
-    );
-  }
-
-  batch(): legacy.WriteBatch {
-    return new WriteBatch(writeBatch(this._delegate));
-  }
-
-  clearPersistence(): Promise<void> {
-    return clearIndexedDbPersistence(this._delegate);
-  }
-
-  enableNetwork(): Promise<void> {
-    return enableNetwork(this._delegate);
-  }
-
-  disableNetwork(): Promise<void> {
-    return disableNetwork(this._delegate);
-  }
-
-  waitForPendingWrites(): Promise<void> {
-    return waitForPendingWrites(this._delegate);
-  }
-
-  onSnapshotsInSync(observer: {
-    next?: (value: void) => void;
-    error?: (error: legacy.FirestoreError) => void;
-    complete?: () => void;
-  }): () => void;
-  onSnapshotsInSync(onSync: () => void): () => void;
-  onSnapshotsInSync(arg: any): () => void {
-    return onSnapshotsInSync(this._delegate, arg);
-  }
-
-  terminate(): Promise<void> {
-    return terminate(this._delegate);
-  }
-
-  INTERNAL = {
-    delete: () => terminate(this._delegate)
-  };
-}
-
 export class Transaction
   extends Compat<exp.Transaction>
   implements legacy.Transaction {
   constructor(
-    private readonly _firestore: FirebaseFirestore,
+    private readonly _firestore: Firestore,
     delegate: exp.Transaction
   ) {
     super(delegate);
@@ -301,7 +221,7 @@ export class DocumentReference<T = legacy.DocumentData>
   extends Compat<exp.DocumentReference<T>>
   implements legacy.DocumentReference<T> {
   constructor(
-    readonly firestore: FirebaseFirestore,
+    readonly firestore: Firestore,
     delegate: exp.DocumentReference<T>
   ) {
     super(delegate);
@@ -424,7 +344,7 @@ export class DocumentSnapshot<T = legacy.DocumentData>
   extends Compat<exp.DocumentSnapshot<T>>
   implements legacy.DocumentSnapshot<T> {
   constructor(
-    private readonly _firestore: FirebaseFirestore,
+    private readonly _firestore: Firestore,
     delegate: exp.DocumentSnapshot<T>
   ) {
     super(delegate);
@@ -455,7 +375,7 @@ export class QueryDocumentSnapshot<T = legacy.DocumentData>
   extends DocumentSnapshot<T>
   implements legacy.QueryDocumentSnapshot<T> {
   constructor(
-    firestore: FirebaseFirestore,
+    firestore: Firestore,
     readonly _delegate: exp.QueryDocumentSnapshot<T>
   ) {
     super(firestore, _delegate);
@@ -469,7 +389,7 @@ export class QueryDocumentSnapshot<T = legacy.DocumentData>
 export class Query<T = legacy.DocumentData>
   extends Compat<exp.Query<T>>
   implements legacy.Query<T> {
-  constructor(readonly firestore: FirebaseFirestore, delegate: exp.Query<T>) {
+  constructor(readonly firestore: Firestore, delegate: exp.Query<T>) {
     super(delegate);
   }
 
@@ -592,7 +512,7 @@ export class Query<T = legacy.DocumentData>
 export class QuerySnapshot<T = legacy.DocumentData>
   implements legacy.QuerySnapshot<T> {
   constructor(
-    readonly _firestore: FirebaseFirestore,
+    readonly _firestore: Firestore,
     readonly _delegate: exp.QuerySnapshot<T>
   ) {}
 
@@ -633,7 +553,7 @@ export class QuerySnapshot<T = legacy.DocumentData>
 export class DocumentChange<T = legacy.DocumentData>
   implements legacy.DocumentChange<T> {
   constructor(
-    private readonly _firestore: FirebaseFirestore,
+    private readonly _firestore: Firestore,
     private readonly _delegate: exp.DocumentChange<T>
   ) {}
   readonly type = this._delegate.type;
@@ -649,7 +569,7 @@ export class CollectionReference<T = legacy.DocumentData>
   extends Query<T>
   implements legacy.CollectionReference<T> {
   constructor(
-    firestore: FirebaseFirestore,
+    firestore: Firestore,
     readonly _delegate: exp.CollectionReference<T>
   ) {
     super(firestore, _delegate);
@@ -755,7 +675,7 @@ function wrap(value: any): any {
     // TODO(mrschmidt): Ideally, we should use an existing instance of
     // FirebaseFirestore here rather than instantiating a new instance
     return new DocumentReference(
-      new FirebaseFirestore(value.firestore as exp.FirebaseFirestore),
+      new Firestore(value.firestore as exp.FirebaseFirestore),
       value
     );
   } else if (isPlainObject(value)) {