Using Compat-Layer for IndexedDB persistence

Author: schmidt-sebastian

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

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-import { FirebaseFirestore } from './database';
+import { FirebaseFirestore, FirestoreCompat } from './database';
 import {
   MemoryOfflineComponentProvider,
   OfflineComponentProvider,
@@ -44,28 +44,27 @@ const LOG_TAG = 'ComponentProvider';
 // Instance maps that ensure that only one component provider exists per
 // Firestore instance.
 const offlineComponentProviders = new Map<
-  FirebaseFirestore,
+  FirestoreCompat,
   OfflineComponentProvider
 >();
 const onlineComponentProviders = new Map<
-  FirebaseFirestore,
+  FirestoreCompat,
   OnlineComponentProvider
 >();
 
 export async function setOfflineComponentProvider(
-  firestore: FirebaseFirestore,
+  firestore: FirestoreCompat,
   offlineComponentProvider: OfflineComponentProvider
 ): Promise<void> {
+  firestore._queue.verifyOperationInProgress();
+
   logDebug(LOG_TAG, 'Initializing OfflineComponentProvider');
   const configuration = await firestore._getConfiguration();
   await offlineComponentProvider.initialize(configuration);
   firestore._setCredentialChangeListener(user =>
-    // TODO(firestorexp): This should be a retryable IndexedDB operation
-    firestore._queue.enqueueAndForget(() =>
-      // TODO(firestorexp): Make sure handleUserChange is a no-op if user
-      // didn't change
-      handleUserChange(offlineComponentProvider.localStore, user)
-    )
+    firestore._queue.enqueueRetryable(async () => {
+      await handleUserChange(offlineComponentProvider.localStore, user);
+    })
   );
   // When a user calls clearPersistence() in one client, all other clients
   // need to be terminated to allow the delete to succeed.
@@ -77,24 +76,23 @@ export async function setOfflineComponentProvider(
 }
 
 export async function setOnlineComponentProvider(
-  firestore: FirebaseFirestore,
+  firestore: FirestoreCompat,
   onlineComponentProvider: OnlineComponentProvider
 ): Promise<void> {
   firestore._queue.verifyOperationInProgress();
 
-  const configuration = await firestore._getConfiguration();
   const offlineComponentProvider = await getOfflineComponentProvider(firestore);
 
   logDebug(LOG_TAG, 'Initializing OnlineComponentProvider');
+  const configuration = await firestore._getConfiguration();
   await onlineComponentProvider.initialize(
     offlineComponentProvider,
     configuration
   );
   // The CredentialChangeListener of the online component provider takes
   // precedence over the offline component provider.
   firestore._setCredentialChangeListener(user =>
-    // TODO(firestoreexp): This should be enqueueRetryable.
-    firestore._queue.enqueueAndForget(() =>
+    firestore._queue.enqueueRetryable(() =>
       remoteStoreHandleCredentialChange(
         onlineComponentProvider.remoteStore,
         user
@@ -105,8 +103,9 @@ export async function setOnlineComponentProvider(
   onlineComponentProviders.set(firestore, onlineComponentProvider);
 }
 
-async function getOfflineComponentProvider(
-  firestore: FirebaseFirestore
+// TODO(firestore-compat): Remove `export` once compat migration is complete.
+export async function getOfflineComponentProvider(
+  firestore: FirestoreCompat
 ): Promise<OfflineComponentProvider> {
   firestore._queue.verifyOperationInProgress();
 
@@ -121,8 +120,9 @@ async function getOfflineComponentProvider(
   return offlineComponentProviders.get(firestore)!;
 }
 
-async function getOnlineComponentProvider(
-  firestore: FirebaseFirestore
+// TODO(firestore-compat): Remove `export` once compat migration is complete.
+export async function getOnlineComponentProvider(
+  firestore: FirestoreCompat
 ): Promise<OnlineComponentProvider> {
   firestore._queue.verifyOperationInProgress();
 
@@ -183,7 +183,7 @@ export async function getLocalStore(
  * when the Firestore instance is terminated.
  */
 export async function removeComponents(
-  firestore: FirebaseFirestore
+  firestore: FirestoreCompat
 ): Promise<void> {
   const onlineComponentProviderPromise = onlineComponentProviders.get(
     firestore

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

@@ -53,7 +53,7 @@ import {
   setOnlineComponentProvider
 } from './components';
 import { DEFAULT_HOST, DEFAULT_SSL } from '../../../lite/src/api/components';
-import { DatabaseInfo } from '../../../src/core/database_info';
+import { DatabaseId, DatabaseInfo } from '../../../src/core/database_info';
 import { AutoId } from '../../../src/util/misc';
 import { User } from '../../../src/auth/user';
 import { CredentialChangeListener } from '../../../src/api/credentials';
@@ -76,14 +76,29 @@ export interface Settings extends LiteSettings {
   cacheSizeBytes?: number;
 }
 
+// TODO(firestore-compat): This interface exposes internal APIs that the Compat
+// layer implements to interact with the firestore-exp SDL. We can remove this
+// class once we have an actual compat class for FirebaseFirestore.
+export interface FirestoreCompat {
+  readonly _initialized: boolean;
+  readonly _terminated: boolean;
+  readonly _databaseId: DatabaseId;
+  readonly _persistenceKey: string;
+  readonly _queue: AsyncQueue;
+  _getSettings(): Settings;
+  _getConfiguration(): Promise<ComponentConfiguration>;
+  _delete(): Promise<void>;
+  _setCredentialChangeListener(listener: (user: User) => void): void;
+}
+
 /**
  * The Cloud Firestore service interface.
  *
  * Do not call this constructor directly. Instead, use {@link getFirestore()}.
  */
 export class FirebaseFirestore
   extends LiteFirestore
-  implements _FirebaseService {
+  implements _FirebaseService, FirestoreCompat {
   readonly _queue = new AsyncQueue();
   readonly _persistenceKey: string;
   readonly _clientId = AutoId.newId();
@@ -103,7 +118,10 @@ export class FirebaseFirestore
     super(app, authProvider);
     this._persistenceKey = app.name;
     this._credentials.setChangeListener(user => {
-      this._user = user;
+      if (!this._user.isEqual(user)) {
+        this._user = user;
+        this._credentialListener(user);
+      }
       this._receivedInitialUser.resolve();
     });
   }
@@ -250,7 +268,7 @@ export function getFirestore(app: FirebaseApp): FirebaseFirestore {
  * @return A promise that represents successfully enabling persistent storage.
  */
 export function enableIndexedDbPersistence(
-  firestore: FirebaseFirestore,
+  firestore: FirestoreCompat,
   persistenceSettings?: PersistenceSettings
 ): Promise<void> {
   verifyNotInitialized(firestore);
@@ -297,7 +315,7 @@ export function enableIndexedDbPersistence(
  * storage.
  */
 export function enableMultiTabIndexedDbPersistence(
-  firestore: FirebaseFirestore
+  firestore: FirestoreCompat
 ): Promise<void> {
   verifyNotInitialized(firestore);
 
@@ -326,7 +344,7 @@ export function enableMultiTabIndexedDbPersistence(
  * but the client remains usable.
  */
 function setPersistenceProviders(
-  firestore: FirebaseFirestore,
+  firestore: FirestoreCompat,
   onlineComponentProvider: OnlineComponentProvider,
   offlineComponentProvider: OfflineComponentProvider
 ): Promise<void> {
@@ -415,7 +433,7 @@ export function canFallbackFromIndexedDbError(
  * cleared. Otherwise, the promise is rejected with an error.
  */
 export function clearIndexedDbPersistence(
-  firestore: FirebaseFirestore
+  firestore: FirestoreCompat
 ): Promise<void> {
   if (firestore._initialized && !firestore._terminated) {
     throw new FirestoreError(
@@ -531,7 +549,7 @@ export function terminate(firestore: FirebaseFirestore): Promise<void> {
   return firestore._delete();
 }
 
-function verifyNotInitialized(firestore: FirebaseFirestore): void {
+function verifyNotInitialized(firestore: FirestoreCompat): void {
   if (firestore._initialized || firestore._terminated) {
     throw new FirestoreError(
       Code.FAILED_PRECONDITION,