Add IndexedDB action to error message (#3871)

* Add IndexedDB action to error message

* Create gentle-doors-play.md

* Feedback

* Fix big

Author: schmidt-sebastian

.changeset/gentle-doors-play.md

@@ -0,0 +1,5 @@
+---
+"@firebase/firestore": patch
+---
+
+The SDK now include more information in the error message for failed IndexedDB transactions.

packages/firestore/src/local/indexeddb_persistence.ts

@@ -684,6 +684,7 @@ export class IndexedDbPersistence implements Persistence {
     // Use `SimpleDb.runTransaction` directly to avoid failing if another tab
     // has obtained the primary lease.
     await this.simpleDb.runTransaction(
+      'shutdown',
       'readwrite',
       [DbPrimaryClient.store, DbClientMetadata.store],
       simpleDbTxn => {
@@ -794,7 +795,7 @@ export class IndexedDbPersistence implements Persistence {
     // Do all transactions as readwrite against all object stores, since we
     // are the only reader/writer.
     return this.simpleDb
-      .runTransaction(simpleDbMode, ALL_STORES, simpleDbTxn => {
+      .runTransaction(action, simpleDbMode, ALL_STORES, simpleDbTxn => {
         persistenceTransaction = new IndexedDbTransaction(
           simpleDbTxn,
           this.listenSequence

packages/firestore/src/local/indexeddb_schema.ts

@@ -88,7 +88,7 @@ export class SchemaConverter implements SimpleDbSchemaConverter {
       `Unexpected schema upgrade from v${fromVersion} to v${toVersion}.`
     );
 
-    const simpleDbTransaction = new SimpleDbTransaction(txn);
+    const simpleDbTransaction = new SimpleDbTransaction('createOrUpgrade', txn);
 
     if (fromVersion < 1 && toVersion >= 1) {
       createPrimaryClientStore(db);

packages/firestore/src/local/simple_db.ts

@@ -189,7 +189,7 @@ export class SimpleDb {
   /**
    * Opens the specified database, creating or upgrading it if necessary.
    */
-  async ensureDb(): Promise<IDBDatabase> {
+  async ensureDb(action: string): Promise<IDBDatabase> {
     if (!this.db) {
       logDebug(LOG_TAG, 'Opening database:', this.name);
       this.db = await new Promise<IDBDatabase>((resolve, reject) => {
@@ -208,6 +208,7 @@ export class SimpleDb {
         request.onblocked = () => {
           reject(
             new IndexedDbTransactionError(
+              action,
               'Cannot upgrade IndexedDB schema while another tab is open. ' +
                 'Close all tabs that access Firestore and reload this page to proceed.'
             )
@@ -228,7 +229,7 @@ export class SimpleDb {
               )
             );
           } else {
-            reject(new IndexedDbTransactionError(error));
+            reject(new IndexedDbTransactionError(action, error));
           }
         };
 
@@ -274,6 +275,7 @@ export class SimpleDb {
   }
 
   async runTransaction<T>(
+    action: string,
     mode: SimpleDbTransactionMode,
     objectStores: string[],
     transactionFn: (transaction: SimpleDbTransaction) => PersistencePromise<T>
@@ -285,10 +287,11 @@ export class SimpleDb {
       ++attemptNumber;
 
       try {
-        this.db = await this.ensureDb();
+        this.db = await this.ensureDb(action);
 
         const transaction = SimpleDbTransaction.open(
           this.db,
+          action,
           readonly ? 'readonly' : 'readwrite',
           objectStores
         );
@@ -424,8 +427,11 @@ export interface IterateOptions {
 export class IndexedDbTransactionError extends FirestoreError {
   name = 'IndexedDbTransactionError';
 
-  constructor(cause: Error | string) {
-    super(Code.UNAVAILABLE, 'IndexedDB transaction failed: ' + cause);
+  constructor(actionName: string, cause: Error | string) {
+    super(
+      Code.UNAVAILABLE,
+      `IndexedDB transaction '${actionName}' failed: ${cause}`
+    );
   }
 }
 
@@ -450,24 +456,31 @@ export class SimpleDbTransaction {
 
   static open(
     db: IDBDatabase,
+    action: string,
     mode: IDBTransactionMode,
     objectStoreNames: string[]
   ): SimpleDbTransaction {
     try {
-      return new SimpleDbTransaction(db.transaction(objectStoreNames, mode));
+      return new SimpleDbTransaction(
+        action,
+        db.transaction(objectStoreNames, mode)
+      );
     } catch (e) {
-      throw new IndexedDbTransactionError(e);
+      throw new IndexedDbTransactionError(action, e);
     }
   }
 
-  constructor(private readonly transaction: IDBTransaction) {
+  constructor(
+    private readonly action: string,
+    private readonly transaction: IDBTransaction
+  ) {
     this.transaction.oncomplete = () => {
       this.completionDeferred.resolve();
     };
     this.transaction.onabort = () => {
       if (transaction.error) {
         this.completionDeferred.reject(
-          new IndexedDbTransactionError(transaction.error)
+          new IndexedDbTransactionError(action, transaction.error)
         );
       } else {
         this.completionDeferred.resolve();
@@ -477,7 +490,9 @@ export class SimpleDbTransaction {
       const error = checkForAndReportiOSError(
         (event.target as IDBRequest).error!
       );
-      this.completionDeferred.reject(new IndexedDbTransactionError(error));
+      this.completionDeferred.reject(
+        new IndexedDbTransactionError(action, error)
+      );
     };
   }
 

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

@@ -195,7 +195,12 @@ function runTransaction<T>(
     transaction: SimpleDbTransaction
   ) => PersistencePromise<T>
 ): Promise<T> {
-  return db.runTransaction<T>('readwrite', ['test'], txn => {
-    return fn(txn.store<string, boolean>('test'), txn);
-  });
+  return db.runTransaction<T>(
+    'EncodedResourcePathTests',
+    'readwrite',
+    ['test'],
+    txn => {
+      return fn(txn.store<string, boolean>('test'), txn);
+    }
+  );
 }