Add test for getHighestListenSequenceNumber() recovery

Author: schmidt-sebastian

packages/firestore/src/local/indexeddb_persistence.ts

@@ -45,7 +45,6 @@ import {
   DbPrimaryClient,
   DbPrimaryClientKey,
   DbTargetDocument,
-  DbTargetGlobal,
   SCHEMA_VERSION,
   SchemaConverter
 } from './indexeddb_schema';
@@ -306,10 +305,13 @@ export class IndexedDbPersistence implements Persistence {
 
         this.scheduleClientMetadataAndPrimaryLeaseRefreshes();
 
-        return this.simpleDb.runTransaction(
+        return this.runTransaction(
+          'getHighestListenSequenceNumber',
           'readonly',
-          [DbTargetGlobal.store],
-          txn => getHighestListenSequenceNumber(txn)
+          txn =>
+            getHighestListenSequenceNumber(
+              (txn as IndexedDbTransaction).simpleDbTransaction
+            )
         );
       })
       .then(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(
@@ -1158,13 +1162,32 @@ describe('IndexedDb: allowTabSynchronization', () => {
       'clientA',
       /* multiClient= */ true,
       async db => {
-        db.injectFailures = { updateClientMetadataAndTryBecomePrimary: true };
+        db.injectFailures = {
+          updateClientMetadataAndTryBecomePrimary: true,
+          getHighestListenSequenceNumber: false
+        };
         await db.start();
         await db.shutdown();
       }
     );
   });
 
+  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.rejectedWith(
+          '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<