Remove exception throwing from clearPersistence() (#1793)

Author: Brian Chen

packages/firestore/src/api/database.ts

@@ -309,16 +309,13 @@ export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
   // are already set to synchronize on the async queue.
   private _firestoreClient: FirestoreClient | undefined;
 
-  private clientRunning: boolean;
-
   // Public for use in tests.
   // TODO(mikelehen): Use modularized initialization instead.
   readonly _queue = new AsyncQueue();
 
   _dataConverter: UserDataConverter;
 
   constructor(databaseIdOrApp: FirestoreDatabase | FirebaseApp) {
-    this.clientRunning = false;
     const config = new FirestoreConfig();
     if (typeof (databaseIdOrApp as FirebaseApp).options === 'object') {
       // This is very likely a Firebase app object
@@ -428,18 +425,21 @@ export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
   }
 
   _clearPersistence(): Promise<void> {
-    if (this.clientRunning) {
-      throw new FirestoreError(
-        Code.FAILED_PRECONDITION,
-        'Persistence cannot be cleared while the client is running'
-      );
-    }
     const persistenceKey = IndexedDbPersistence.buildStoragePrefix(
       this.makeDatabaseInfo()
     );
     const deferred = new Deferred<void>();
     this._queue.enqueueAndForget(async () => {
       try {
+        if (
+          this._firestoreClient !== undefined &&
+          !this._firestoreClient.clientShutdown
+        ) {
+          throw new FirestoreError(
+            Code.FAILED_PRECONDITION,
+            'Persistence cannot be cleared while this firestore instance is running.'
+          );
+        }
         await IndexedDbPersistence.clearPersistence(persistenceKey);
         deferred.resolve();
       } catch (e) {
@@ -478,7 +478,6 @@ export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
 
     assert(!this._firestoreClient, 'configureClient() called multiple times');
 
-    this.clientRunning = true;
     const databaseInfo = this.makeDatabaseInfo();
 
     const preConverter = (value: unknown) => {
@@ -546,7 +545,6 @@ export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
       // throws an exception.
       this.ensureClientConfigured();
       await this._firestoreClient!.shutdown();
-      this.clientRunning = false;
     }
   };
 

packages/firestore/src/core/firestore_client.ts

@@ -108,7 +108,7 @@ export class FirestoreClient {
   private lruScheduler?: LruScheduler;
 
   private readonly clientId = AutoId.newId();
-  private isShutdown = false;
+  private _clientShutdown = false;
 
   // PORTING NOTE: SharedClientState is only used for multi-tab web.
   private sharedClientState: SharedClientState;
@@ -305,7 +305,7 @@ export class FirestoreClient {
    * this class cannot be called after the client is shutdown.
    */
   private verifyNotShutdown(): void {
-    if (this.isShutdown) {
+    if (this._clientShutdown) {
       throw new FirestoreError(
         Code.FAILED_PRECONDITION,
         'The client has already been shutdown.'
@@ -496,7 +496,7 @@ export class FirestoreClient {
 
   shutdown(): Promise<void> {
     return this.asyncQueue.enqueue(async () => {
-      if (!this.isShutdown) {
+      if (!this._clientShutdown) {
         // PORTING NOTE: LocalStore does not need an explicit shutdown on web.
         if (this.lruScheduler) {
           this.lruScheduler.stop();
@@ -509,7 +509,7 @@ export class FirestoreClient {
         // RemoteStore as it will prevent the RemoteStore from retrieving
         // auth tokens.
         this.credentials.removeChangeListener();
-        this.isShutdown = true;
+        this._clientShutdown = true;
       }
     });
   }
@@ -590,6 +590,10 @@ export class FirestoreClient {
     return this.databaseInfo.databaseId;
   }
 
+  get clientShutdown(): boolean {
+    return this._clientShutdown;
+  }
+
   transaction<T>(
     updateFunction: (transaction: Transaction) => Promise<T>
   ): Promise<T> {

packages/firestore/test/integration/api/database.test.ts

@@ -997,7 +997,7 @@ apiDescribe('Database', persistence => {
     await withTestDoc(persistence, async docRef => {
       const firestore = docRef.firestore;
       await expect(clearPersistence(firestore)).to.eventually.be.rejectedWith(
-        'Persistence cannot be cleared while the client is running'
+        'Persistence cannot be cleared while this firestore instance is running.'
       );
     });
   });