Introduce DatabaseDeletedListenerError to fix infinite retries

Author: dconeybe

packages/firestore/src/core/firestore_client.ts

@@ -33,7 +33,10 @@ import {
   localStoreReadDocument,
   localStoreSetIndexAutoCreationEnabled
 } from '../local/local_store_impl';
-import { Persistence } from '../local/persistence';
+import {
+  DatabaseDeletedListenerError,
+  Persistence
+} from '../local/persistence';
 import { Document } from '../model/document';
 import { DocumentKey } from '../model/document_key';
 import { FieldIndex } from '../model/field_index';
@@ -253,12 +256,11 @@ export async function setOfflineComponentProvider(
       });
 
     if (event.type === 'ClearSiteDataDatabaseDeletedEvent') {
-      throw new Error(
-        `aborting refusing to open IndexedDB database due to potential ` +
-          `corruption of the IndexedDB database data; this corruption could ` +
-          `be caused by clicking the "clear site data" button in a web ` +
-          `browser; try reloading the web page to re-initialize the ` +
-          `IndexedDB database (` +
+      throw new DatabaseDeletedListenerError(
+        `Aborting due to potential IndexedDB database corruption. ` +
+          `This situation could be caused by clicking the "Clear Site Data" ` +
+          `button in a web browser. Try reloading the web page to ` +
+          `re-initialize the IndexedDB database. (` +
           `lastClosedVersion=${event.data.lastClosedVersion}, ` +
           `eventOldVersion${event.data.eventOldVersion}, ` +
           `eventNewVersion${event.data.eventNewVersion}, ` +

packages/firestore/src/local/persistence.ts

@@ -152,6 +152,22 @@ export class ClearSiteDataDatabaseDeletedEvent {
   ) {}
 }
 
+/**
+ * An exception that should be thrown from a {@link DatabaseDeletedListener}
+ * to indicate that the caller should immediately abort their work.
+ */
+export class DatabaseDeletedListenerError extends Error {
+  readonly name = 'DatabaseDeletedListenerError' as const;
+
+  constructor(message: string) {
+    super(message);
+
+    // Ensure that instanceof semantics behave as expected.
+    // See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error#custom_error_types
+    Object.setPrototypeOf(this, DatabaseDeletedListenerError.prototype);
+  }
+}
+
 /**
  * The type of the "event" parameter of {@link DatabaseDeletedListener}.
  */

packages/firestore/src/local/simple_db.ts

@@ -19,7 +19,7 @@ import { getGlobal, getUA, isIndexedDBAvailable } from '@firebase/util';
 
 import { debugAssert } from '../util/assert';
 import { Code, FirestoreError } from '../util/error';
-import { logDebug, logError, logWarn } from '../util/log';
+import { logDebug, logError } from '../util/log';
 import { Deferred } from '../util/promise';
 
 import {
@@ -341,6 +341,8 @@ export class SimpleDb {
                   error
               )
             );
+          } else if (error.name === 'DatabaseDeletedListenerError') {
+            reject(new FirestoreError(Code.FAILED_PRECONDITION, error.message));
           } else {
             reject(new IndexedDbTransactionError(action, error));
           }
@@ -400,10 +402,6 @@ export class SimpleDb {
         // Notify the listener if another tab attempted to delete the IndexedDb
         // database, such as by calling clearIndexedDbPersistence().
         if (event.newVersion === null) {
-          logWarn(
-            `Received "versionchange" event with newVersion===null; ` +
-              'notifying the registered DatabaseDeletedListener, if any'
-          );
           this.databaseDeletedListener?.(
             new VersionChangeDatabaseDeletedEvent({
               eventNewVersion: event.newVersion