Fail enablePersistence() if getHighestListenSequenceNumber fails

Author: schmidt-sebastian

packages/firestore/src/local/indexeddb_persistence.ts

@@ -306,9 +306,9 @@ export class IndexedDbPersistence implements Persistence {
 
         this.scheduleClientMetadataAndPrimaryLeaseRefreshes();
 
-        return this.simpleDb.runTransaction(
+        return this.runTransaction(
+          'getHighestListenSequenceNumber',
           'readonly',
-          [DbTargetGlobal.store],
           txn => getHighestListenSequenceNumber(txn)
         );
       })

packages/firestore/src/local/indexeddb_schema.ts

@@ -231,16 +231,19 @@ export class SchemaConverter implements SimpleDbSchemaConverter {
     const documentsStore = txn.store<DbRemoteDocumentKey, DbRemoteDocument>(
       DbRemoteDocument.store
     );
+    const globalTargetStore = txn.store<DbTargetGlobalKey, DbTargetGlobal>(
+      DbTargetGlobal.store
+    );
 
-    return getHighestListenSequenceNumber(txn).next(currentSequenceNumber => {
+    return globalTargetStore.get(DbTargetGlobal.key).next(metadata => {
       const writeSentinelKey = (
         path: ResourcePath
       ): PersistencePromise<void> => {
         return documentTargetStore.put(
           new DbTargetDocument(
             0,
             encodeResourcePath(path),
-            currentSequenceNumber
+            metadata!.highestListenSequenceNumber!
           )
         );
       };

packages/firestore/src/local/indexeddb_target_cache.ts

@@ -90,9 +90,7 @@ export class IndexedDbTargetCache implements TargetCache {
   getHighestSequenceNumber(
     transaction: PersistenceTransaction
   ): PersistencePromise<ListenSequenceNumber> {
-    return getHighestListenSequenceNumber(
-      (transaction as IndexedDbTransaction).simpleDbTransaction
-    );
+    return getHighestListenSequenceNumber(transaction);
   }
 
   setTargetsMetadata(
@@ -192,9 +190,7 @@ export class IndexedDbTargetCache implements TargetCache {
   private retrieveMetadata(
     transaction: PersistenceTransaction
   ): PersistencePromise<DbTargetGlobal> {
-    return retrieveMetadata(
-      (transaction as IndexedDbTransaction).simpleDbTransaction
-    );
+    return retrieveMetadata(transaction);
   }
 
   private saveMetadata(
@@ -423,20 +419,17 @@ function globalTargetStore(
 }
 
 function retrieveMetadata(
-  txn: SimpleDbTransaction
+  txn: PersistenceTransaction
 ): PersistencePromise<DbTargetGlobal> {
-  const globalStore = SimpleDb.getStore<DbTargetGlobalKey, DbTargetGlobal>(
-    txn,
-    DbTargetGlobal.store
-  );
+  const globalStore = globalTargetStore(txn);
   return globalStore.get(DbTargetGlobal.key).next(metadata => {
     hardAssert(metadata !== null, 'Missing metadata row.');
     return metadata;
   });
 }
 
 export function getHighestListenSequenceNumber(
-  txn: SimpleDbTransaction
+  txn: PersistenceTransaction
 ): PersistencePromise<ListenSequenceNumber> {
   return retrieveMetadata(txn).next(
     targetGlobal => targetGlobal.highestListenSequenceNumber

packages/firestore/test/unit/local/indexeddb_persistence.test.ts

@@ -15,7 +15,9 @@
  * limitations under the License.
  */
 
-import { expect } from 'chai';
+import * as chaiAsPromised from 'chai-as-promised';
+
+import { expect, use } from 'chai';
 import { Query } from '../../../src/core/query';
 import { SnapshotVersion } from '../../../src/core/snapshot_version';
 import {
@@ -74,6 +76,8 @@ import {
   TEST_SERIALIZER
 } from './persistence_test_helpers';
 
+use(chaiAsPromised);
+
 /* eslint-disable no-restricted-globals */
 
 function withDb(
@@ -1165,6 +1169,22 @@ describe('IndexedDb: allowTabSynchronization', () => {
     );
   });
 
+  it('blocks start() when getHighestListenSequenceNumber() fails', async () => {
+    await withUnstartedCustomPersistence(
+      'clientA',
+      /* multiClient= */ false,
+      async db1 => {
+        db1.injectFailures = {
+          updateClientMetadataAndTryBecomePrimary: false,
+          getHighestListenSequenceNumber: true
+        };
+        await expect(db1.start()).to.eventually.be.rejected(
+          'IndexedDB transaction failed'
+        );
+      }
+    );
+  });
+
   it('ignores intermittent IndexedDbTransactionError during lease refresh', async () => {
     await withPersistence('clientA', async (db, _, queue) => {
       db.injectFailures = { updateClientMetadataAndTryBecomePrimary: true };

packages/firestore/test/unit/specs/spec_test_runner.ts

@@ -1215,7 +1215,8 @@ export type PersistenceAction =
   | 'Get target data'
   | 'Get new document changes'
   | 'Synchronize last document change read time'
-  | 'updateClientMetadataAndTryBecomePrimary';
+  | 'updateClientMetadataAndTryBecomePrimary'
+  | 'getHighestListenSequenceNumber';
 
 /** Specifies failure or success for a list of database actions. */
 export type SpecDatabaseFailures = Partial<