feat(firestore): add method clearPersistence (#446)

capawesome-team · Oct 6, 2023 · 5a42c3f · 5a42c3f
1 parent 1338d5f
commit 5a42c3f
Show file tree

Hide file tree

Showing 8 changed files with 84 additions and 1 deletion.
diff --git a/packages/authentication/README.md b/packages/authentication/README.md
@@ -1665,7 +1665,7 @@ Remove all listeners for this plugin.
 | Prop                    | Type                 | Description                                                                                                                                                   | Default            | Since |
 | ----------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
 | **`phoneNumber`**       | <code>string</code>  | The phone number to be verified in E.164 format.                                                                                                              |                    | 0.1.0 |
-| **`recaptchaVerifier`** | <code>unknown</code> | The reCAPTCHA verifier. Must be an instance of `firebase.auth.RecaptchaVerifier`. Only available for Web.                                                     |                    | 1.3.0 |
+| **`recaptchaVerifier`** | <code>unknown</code> | The reCAPTCHA verifier. Must be an instance of `firebase.auth.RecaptchaVerifier`. Only available for Web.                                                     |                    | 5.2.0 |
 | **`resendCode`**        | <code>boolean</code> | Resend the verification code to the specified phone number. `signInWithPhoneNumber` must be called once before using this option. Only available for Android. | <code>false</code> | 1.3.0 |
 
 

diff --git a/packages/firestore/README.md b/packages/firestore/README.md
@@ -192,6 +192,7 @@ const removeAllListeners = async () => {
 * [`deleteDocument(...)`](#deletedocument)
 * [`getCollection(...)`](#getcollection)
 * [`getCollectionGroup(...)`](#getcollectiongroup)
+* [`clearPersistence()`](#clearpersistence)
 * [`enableNetwork()`](#enablenetwork)
 * [`disableNetwork()`](#disablenetwork)
 * [`addDocumentSnapshotListener(...)`](#adddocumentsnapshotlistener)
@@ -332,6 +333,21 @@ Reads the collection group referenced by the specified reference.
 --------------------
 
 
+### clearPersistence()
+
+```typescript
+clearPersistence() => Promise<void>
+```
+
+Clears the persistent storage. This includes pending writes and cached documents.
+
+Must be called after the app is shutdown or when the app is first initialized.
+
+**Since:** 5.2.0
+
+--------------------
+
+
 ### enableNetwork()
 
 ```typescript

diff --git a/...src/main/java/io/capawesome/capacitorjs/plugins/firebase/firestore/FirebaseFirestore.java b/...src/main/java/io/capawesome/capacitorjs/plugins/firebase/firestore/FirebaseFirestore.java
@@ -159,6 +159,20 @@ public void getCollectionGroup(@NonNull GetCollectionGroupOptions options, @NonN
             .addOnFailureListener(exception -> callback.error(exception));
     }
 
+    public void clearPersistence(@NonNull EmptyResultCallback callback) {
+        this.firestoreInstance.clearPersistence()
+            .addOnSuccessListener(
+                unused -> {
+                    callback.success();
+                }
+            )
+            .addOnFailureListener(
+                exception -> {
+                    callback.error(exception);
+                }
+            );
+    }
+
     public void enableNetwork(@NonNull EmptyResultCallback callback) {
         this.firestoreInstance.enableNetwork()
             .addOnSuccessListener(

diff --git a/...in/java/io/capawesome/capacitorjs/plugins/firebase/firestore/FirebaseFirestorePlugin.java b/...in/java/io/capawesome/capacitorjs/plugins/firebase/firestore/FirebaseFirestorePlugin.java
@@ -272,6 +272,28 @@ public void error(Exception exception) {
         }
     }
 
+    @PluginMethod
+    public void clearPersistence(PluginCall call) {
+        try {
+            EmptyResultCallback callback = new EmptyResultCallback() {
+                @Override
+                public void success() {
+                    call.resolve();
+                }
+
+                @Override
+                public void error(Exception exception) {
+                    Logger.error(TAG, exception.getMessage(), exception);
+                    call.reject(exception.getMessage());
+                }
+            };
+            implementation.clearPersistence(callback);
+        } catch (Exception exception) {
+            Logger.error(TAG, exception.getMessage(), exception);
+            call.reject(exception.getMessage());
+        }
+    }
+
     @PluginMethod
     public void enableNetwork(PluginCall call) {
         try {

diff --git a/packages/firestore/ios/Plugin/FirebaseFirestore.swift b/packages/firestore/ios/Plugin/FirebaseFirestore.swift
@@ -139,6 +139,12 @@ import FirebaseFirestore
         }
     }
 
+    @objc public func clearPersistence(completion: @escaping (Error?) -> Void) {
+        Firestore.firestore().clearPersistence { error in
+            completion(error)
+        }
+    }
+
     @objc public func enableNetwork(completion: @escaping (Error?) -> Void) {
         Firestore.firestore().enableNetwork { error in
             completion(error)

diff --git a/packages/firestore/ios/Plugin/FirebaseFirestorePlugin.swift b/packages/firestore/ios/Plugin/FirebaseFirestorePlugin.swift
@@ -169,6 +169,17 @@ public class FirebaseFirestorePlugin: CAPPlugin {
         })
     }
 
+    @objc func clearPersistence(_ call: CAPPluginCall) {
+        implementation?.clearPersistence(completion: { error in
+            if let error = error {
+                CAPLog.print("[", self.tag, "] ", error)
+                call.reject(error.localizedDescription)
+                return
+            }
+            call.resolve()
+        })
+    }
+
     @objc func enableNetwork(_ call: CAPPluginCall) {
         implementation?.enableNetwork(completion: { error in
             if let error = error {

diff --git a/packages/firestore/src/definitions.ts b/packages/firestore/src/definitions.ts
@@ -46,6 +46,14 @@ export interface FirebaseFirestorePlugin {
   getCollectionGroup<T extends DocumentData = DocumentData>(
     options: GetCollectionGroupOptions,
   ): Promise<GetCollectionGroupResult<T>>;
+  /**
+   * Clears the persistent storage. This includes pending writes and cached documents.
+   *
+   * Must be called after the app is shutdown or when the app is first initialized.
+   *
+   * @since 5.2.0
+   */
+  clearPersistence(): Promise<void>;
   /**
    * Re-enables use of the network.
    *

diff --git a/packages/firestore/src/web.ts b/packages/firestore/src/web.ts
@@ -11,6 +11,7 @@ import type {
 import {
   addDoc,
   and,
+  clearIndexedDbPersistence,
   collection,
   deleteDoc,
   doc,
@@ -150,6 +151,11 @@ export class FirebaseFirestoreWeb
     };
   }
 
+  public async clearPersistence(): Promise<void> {
+    const firestore = getFirestore();
+    await clearIndexedDbPersistence(firestore);
+  }
+
   public async enableNetwork(): Promise<void> {
     throw this.unimplemented('Not implemented on web.');
   }