feat(firestore): include metadata property on snapshot (#567)

packages/firestore/android/src/main/java/io/capawesome/capacitorjs/plugins/firebase/firestore/FirebaseFirestore.java

@@ -7,6 +7,7 @@
 import com.google.firebase.firestore.DocumentReference;
 import com.google.firebase.firestore.Filter;
 import com.google.firebase.firestore.ListenerRegistration;
+import com.google.firebase.firestore.MetadataChanges;
 import com.google.firebase.firestore.Query;
 import com.google.firebase.firestore.SetOptions;
 import com.google.firebase.firestore.WriteBatch;
@@ -244,6 +245,7 @@ public void addDocumentSnapshotListener(@NonNull AddDocumentSnapshotListenerOpti
         ListenerRegistration listenerRegistration = getFirebaseFirestoreInstance()
             .document(reference)
             .addSnapshotListener(
+                options.isIncludeMetadataChanges() ? MetadataChanges.INCLUDE : MetadataChanges.EXCLUDE,
                 (documentSnapshot, exception) -> {
                     if (exception != null) {
                         callback.error(exception);
@@ -277,6 +279,7 @@ public void addCollectionSnapshotListener(
         }
 
         ListenerRegistration listenerRegistration = query.addSnapshotListener(
+            options.isIncludeMetadataChanges() ? MetadataChanges.INCLUDE : MetadataChanges.EXCLUDE,
             (querySnapshot, exception) -> {
                 if (exception != null) {
                     callback.error(exception);
@@ -310,6 +313,7 @@ public void addCollectionGroupSnapshotListener(
         }
 
         ListenerRegistration listenerRegistration = query.addSnapshotListener(
+            options.isIncludeMetadataChanges() ? MetadataChanges.INCLUDE : MetadataChanges.EXCLUDE,
             (querySnapshot, exception) -> {
                 if (exception != null) {
                     callback.error(exception);

packages/firestore/android/src/main/java/io/capawesome/capacitorjs/plugins/firebase/firestore/FirebaseFirestoreHelper.java

@@ -4,6 +4,7 @@
 import androidx.annotation.Nullable;
 import com.getcapacitor.JSArray;
 import com.getcapacitor.JSObject;
+import com.google.firebase.firestore.DocumentSnapshot;
 import io.capawesome.capacitorjs.plugins.firebase.firestore.classes.constraints.QueryCompositeFilterConstraint;
 import io.capawesome.capacitorjs.plugins.firebase.firestore.classes.constraints.QueryEndAtConstraint;
 import io.capawesome.capacitorjs.plugins.firebase.firestore.classes.constraints.QueryLimitConstraint;
@@ -126,4 +127,11 @@ private static JSArray createJSArrayFromArrayList(ArrayList arrayList) {
         }
         return array;
     }
+
+    public static JSObject createSnapshotMetadataResult(DocumentSnapshot snapshot) {
+        final JSObject obj = new JSObject();
+        obj.put("fromCache", snapshot.getMetadata().isFromCache());
+        obj.put("hasPendingWrites", snapshot.getMetadata().hasPendingWrites());
+        return obj;
+    }
 }

packages/firestore/android/src/main/java/io/capawesome/capacitorjs/plugins/firebase/firestore/FirebaseFirestorePlugin.java

@@ -404,11 +404,16 @@ public void addDocumentSnapshotListener(PluginCall call) {
                 call.reject(ERROR_REFERENCE_MISSING);
                 return;
             }
+            Boolean includeMetadataChanges = call.getBoolean("includeMetadataChanges");
             String callbackId = call.getCallbackId();
 
             this.pluginCallMap.put(callbackId, call);
 
-            AddDocumentSnapshotListenerOptions options = new AddDocumentSnapshotListenerOptions(reference, callbackId);
+            AddDocumentSnapshotListenerOptions options = new AddDocumentSnapshotListenerOptions(
+                reference,
+                includeMetadataChanges,
+                callbackId
+            );
             NonEmptyResultCallback callback = new NonEmptyResultCallback() {
                 @Override
                 public void success(Result result) {
@@ -441,6 +446,7 @@ public void addCollectionSnapshotListener(PluginCall call) {
             }
             JSObject compositeFilter = call.getObject("compositeFilter");
             JSArray queryConstraints = call.getArray("queryConstraints");
+            Boolean includeMetadataChanges = call.getBoolean("includeMetadataChanges");
             String callbackId = call.getCallbackId();
 
             this.pluginCallMap.put(callbackId, call);
@@ -449,6 +455,7 @@ public void addCollectionSnapshotListener(PluginCall call) {
                 reference,
                 compositeFilter,
                 queryConstraints,
+                includeMetadataChanges,
                 callbackId
             );
             NonEmptyResultCallback callback = new NonEmptyResultCallback() {
@@ -483,6 +490,7 @@ public void addCollectionGroupSnapshotListener(PluginCall call) {
             }
             JSObject compositeFilter = call.getObject("compositeFilter");
             JSArray queryConstraints = call.getArray("queryConstraints");
+            Boolean includeMetadataChanges = call.getBoolean("includeMetadataChanges");
             String callbackId = call.getCallbackId();
 
             this.pluginCallMap.put(callbackId, call);
@@ -491,6 +499,7 @@ public void addCollectionGroupSnapshotListener(PluginCall call) {
                 reference,
                 compositeFilter,
                 queryConstraints,
+                includeMetadataChanges,
                 callbackId
             );
             NonEmptyResultCallback callback = new NonEmptyResultCallback() {

packages/firestore/android/src/main/java/io/capawesome/capacitorjs/plugins/firebase/firestore/classes/options/AddCollectionGroupSnapshotListenerOptions.java

@@ -22,15 +22,19 @@ public class AddCollectionGroupSnapshotListenerOptions {
 
     private String callbackId;
 
+    private boolean includeMetadataChanges;
+
     public AddCollectionGroupSnapshotListenerOptions(
         String reference,
         @Nullable JSObject compositeFilter,
         @Nullable JSArray queryConstraints,
+        @Nullable Boolean includeMetadataChanges,
         String callbackId
     ) throws JSONException {
         this.reference = reference;
         this.compositeFilter = FirebaseFirestoreHelper.createQueryCompositeFilterConstraintFromJSObject(compositeFilter);
         this.queryConstraints = FirebaseFirestoreHelper.createQueryNonFilterConstraintArrayFromJSArray(queryConstraints);
+        this.includeMetadataChanges = includeMetadataChanges == null ? false : includeMetadataChanges;
         this.callbackId = callbackId;
     }
 
@@ -48,6 +52,10 @@ public QueryNonFilterConstraint[] getQueryConstraints() {
         return queryConstraints;
     }
 
+    public boolean isIncludeMetadataChanges() {
+        return includeMetadataChanges;
+    }
+
     public String getCallbackId() {
         return callbackId;
     }

packages/firestore/android/src/main/java/io/capawesome/capacitorjs/plugins/firebase/firestore/classes/options/AddCollectionSnapshotListenerOptions.java

@@ -23,15 +23,19 @@ public class AddCollectionSnapshotListenerOptions {
 
     private String callbackId;
 
+    private final boolean includeMetadataChanges;
+
     public AddCollectionSnapshotListenerOptions(
         String reference,
         @Nullable JSObject compositeFilter,
         @Nullable JSArray queryConstraints,
+        @Nullable Boolean includeMetadataChanges,
         String callbackId
     ) throws JSONException {
         this.reference = reference;
         this.compositeFilter = FirebaseFirestoreHelper.createQueryCompositeFilterConstraintFromJSObject(compositeFilter);
         this.queryConstraints = FirebaseFirestoreHelper.createQueryNonFilterConstraintArrayFromJSArray(queryConstraints);
+        this.includeMetadataChanges = includeMetadataChanges == null ? false : includeMetadataChanges;
         this.callbackId = callbackId;
     }
 
@@ -49,6 +53,10 @@ public QueryNonFilterConstraint[] getQueryConstraints() {
         return queryConstraints;
     }
 
+    public boolean isIncludeMetadataChanges() {
+        return includeMetadataChanges;
+    }
+
     public String getCallbackId() {
         return callbackId;
     }

packages/firestore/android/src/main/java/io/capawesome/capacitorjs/plugins/firebase/firestore/classes/options/AddDocumentSnapshotListenerOptions.java

@@ -1,19 +1,27 @@
 package io.capawesome.capacitorjs.plugins.firebase.firestore.classes.options;
 
+import androidx.annotation.Nullable;
+
 public class AddDocumentSnapshotListenerOptions {
 
     private String reference;
+    private final boolean includeMetadataChanges;
     private String callbackId;
 
-    public AddDocumentSnapshotListenerOptions(String reference, String callbackId) {
+    public AddDocumentSnapshotListenerOptions(String reference, @Nullable Boolean includeMetadataChanges, String callbackId) {
         this.reference = reference;
+        this.includeMetadataChanges = includeMetadataChanges == null ? false : includeMetadataChanges;
         this.callbackId = callbackId;
     }
 
     public String getReference() {
         return reference;
     }
 
+    public boolean isIncludeMetadataChanges() {
+        return includeMetadataChanges;
+    }
+
     public String getCallbackId() {
         return callbackId;
     }

packages/firestore/android/src/main/java/io/capawesome/capacitorjs/plugins/firebase/firestore/classes/results/GetCollectionGroupResult.java

@@ -30,6 +30,7 @@ public JSObject toJSObject() {
             } else {
                 snapshotResult.put("data", snapshotDataResult);
             }
+            snapshotResult.put("metadata", FirebaseFirestoreHelper.createSnapshotMetadataResult(document));
             snapshotsResult.put(snapshotResult);
         }
 

packages/firestore/android/src/main/java/io/capawesome/capacitorjs/plugins/firebase/firestore/classes/results/GetCollectionResult.java

@@ -30,6 +30,7 @@ public JSObject toJSObject() {
             } else {
                 snapshotResult.put("data", snapshotDataResult);
             }
+            snapshotResult.put("metadata", FirebaseFirestoreHelper.createSnapshotMetadataResult(document));
             snapshotsResult.put(snapshotResult);
         }
 

packages/firestore/android/src/main/java/io/capawesome/capacitorjs/plugins/firebase/firestore/classes/results/GetDocumentResult.java

@@ -25,6 +25,7 @@ public JSObject toJSObject() {
         } else {
             snapshotResult.put("data", snapshotDataResult);
         }
+        snapshotResult.put("metadata", FirebaseFirestoreHelper.createSnapshotMetadataResult(documentSnapshot));
 
         JSObject result = new JSObject();
         result.put("snapshot", snapshotResult);

packages/firestore/ios/Plugin/Classes/Options/AddCollectionGroupSnapshotListenerOptions.swift

@@ -5,12 +5,14 @@ import Capacitor
     private var reference: String
     private var compositeFilter: QueryCompositeFilterConstraint?
     private var queryConstraints: [QueryNonFilterConstraint]
+    private var includeMetadataChanges: Bool
     private var callbackId: String
 
-    init(reference: String, compositeFilter: JSObject?, queryConstraints: [JSObject]?, callbackId: String) {
+    init(reference: String, compositeFilter: JSObject?, queryConstraints: [JSObject]?, includeMetadataChanges: Bool, callbackId: String) {
         self.reference = reference
         self.compositeFilter = FirebaseFirestoreHelper.createQueryCompositeFilterConstraintFromJSObject(compositeFilter)
         self.queryConstraints = FirebaseFirestoreHelper.createQueryNonFilterConstraintArrayFromJSArray(queryConstraints)
+        self.includeMetadataChanges = includeMetadataChanges
         self.callbackId = callbackId
     }
 
@@ -26,6 +28,10 @@ import Capacitor
         return queryConstraints
     }
 
+    func getIncludeMetadataChanges() -> Bool {
+        return includeMetadataChanges
+    }
+
     func getCallbackId() -> String {
         return callbackId
     }

packages/firestore/ios/Plugin/Classes/Options/AddCollectionSnapshotListenerOptions.swift

@@ -5,12 +5,14 @@ import Capacitor
     private var reference: String
     private var compositeFilter: QueryCompositeFilterConstraint?
     private var queryConstraints: [QueryNonFilterConstraint]
+    private var includeMetadataChanges: Bool
     private var callbackId: String
 
-    init(reference: String, compositeFilter: JSObject?, queryConstraints: [JSObject]?, callbackId: String) {
+    init(reference: String, compositeFilter: JSObject?, queryConstraints: [JSObject]?, includeMetadataChanges: Bool, callbackId: String) {
         self.reference = reference
         self.compositeFilter = FirebaseFirestoreHelper.createQueryCompositeFilterConstraintFromJSObject(compositeFilter)
         self.queryConstraints = FirebaseFirestoreHelper.createQueryNonFilterConstraintArrayFromJSArray(queryConstraints)
+        self.includeMetadataChanges = includeMetadataChanges
         self.callbackId = callbackId
     }
 
@@ -26,6 +28,10 @@ import Capacitor
         return queryConstraints
     }
 
+    func getIncludeMetadataChanges() -> Bool {
+        return includeMetadataChanges
+    }
+
     func getCallbackId() -> String {
         return callbackId
     }

packages/firestore/ios/Plugin/Classes/Options/AddDocumentSnapshotListenerOptions.swift

@@ -2,17 +2,23 @@ import Foundation
 
 @objc public class AddDocumentSnapshotListenerOptions: NSObject {
     private var reference: String
+    private var includeMetadataChanges: Bool
     private var callbackId: String
 
-    init(reference: String, callbackId: String) {
+    init(reference: String, includeMetadataChanges: Bool, callbackId: String) {
         self.reference = reference
+        self.includeMetadataChanges = includeMetadataChanges
         self.callbackId = callbackId
     }
 
     func getReference() -> String {
         return reference
     }
 
+    func getIncludeMetadataChanges() -> Bool {
+        return includeMetadataChanges
+    }
+
     func getCallbackId() -> String {
         return callbackId
     }

packages/firestore/ios/Plugin/Classes/Results/GetCollectionGroupResult.swift

@@ -22,6 +22,12 @@ import Capacitor
             } else {
                 snapshotResult["data"] = NSNull()
             }
+
+            var metadata = JSObject()
+            metadata["fromCache"] = documentSnapshot.metadata.isFromCache
+            metadata["hasPendingWrites"] = documentSnapshot.metadata.hasPendingWrites
+            snapshotResult["metadata"] = metadata
+
             snapshotsResult.append(snapshotResult)
         }
 

packages/firestore/ios/Plugin/Classes/Results/GetCollectionResult.swift

@@ -22,6 +22,12 @@ import Capacitor
             } else {
                 snapshotResult["data"] = NSNull()
             }
+
+            var metadata = JSObject()
+            metadata["fromCache"] = documentSnapshot.metadata.isFromCache
+            metadata["hasPendingWrites"] = documentSnapshot.metadata.hasPendingWrites
+            snapshotResult["metadata"] = metadata
+
             snapshotsResult.append(snapshotResult)
         }
 

packages/firestore/ios/Plugin/Classes/Results/GetDocumentResult.swift

@@ -21,6 +21,11 @@ import Capacitor
             snapshotResult["data"] = NSNull()
         }
 
+        var metadata = JSObject()
+        metadata["fromCache"] = documentSnapshot.metadata.isFromCache
+        metadata["hasPendingWrites"] = documentSnapshot.metadata.hasPendingWrites
+        snapshotResult["metadata"] = metadata
+
         var result = JSObject()
         result["snapshot"] = snapshotResult
         return result as AnyObject

packages/firestore/ios/Plugin/FirebaseFirestorePlugin.swift

@@ -240,14 +240,15 @@ public class FirebaseFirestorePlugin: CAPPlugin {
             call.reject(errorReferenceMissing)
             return
         }
+        let includeMetadataChanges = call.getBool("includeMetadataChanges", false)
         guard let callbackId = call.callbackId else {
             call.reject(errorCallbackIdMissing)
             return
         }
 
         self.pluginCallMap[callbackId] = call
 
-        let options = AddDocumentSnapshotListenerOptions(reference: reference, callbackId: callbackId)
+        let options = AddDocumentSnapshotListenerOptions(reference: reference, includeMetadataChanges: includeMetadataChanges, callbackId: callbackId)
 
         implementation?.addDocumentSnapshotListener(options, completion: { result, error in
             if let error = error {
@@ -270,14 +271,15 @@ public class FirebaseFirestorePlugin: CAPPlugin {
         }
         let compositeFilter = call.getObject("compositeFilter")
         let queryConstraints = call.getArray("queryConstraints", JSObject.self)
+        let includeMetadataChanges = call.getBool("includeMetadataChanges", false)
         guard let callbackId = call.callbackId else {
             call.reject(errorCallbackIdMissing)
             return
         }
 
         self.pluginCallMap[callbackId] = call
 
-        let options = AddCollectionSnapshotListenerOptions(reference: reference, compositeFilter: compositeFilter, queryConstraints: queryConstraints, callbackId: callbackId)
+        let options = AddCollectionSnapshotListenerOptions(reference: reference, compositeFilter: compositeFilter, queryConstraints: queryConstraints, includeMetadataChanges: includeMetadataChanges, callbackId: callbackId)
 
         do {
             implementation?.addCollectionSnapshotListener(options, completion: { result, error in
@@ -305,14 +307,15 @@ public class FirebaseFirestorePlugin: CAPPlugin {
         }
         let compositeFilter = call.getObject("compositeFilter")
         let queryConstraints = call.getArray("queryConstraints", JSObject.self)
+        let includeMetadataChanges = call.getBool("includeMetadataChanges", false)
         guard let callbackId = call.callbackId else {
             call.reject(errorCallbackIdMissing)
             return
         }
 
         self.pluginCallMap[callbackId] = call
 
-        let options = AddCollectionGroupSnapshotListenerOptions(reference: reference, compositeFilter: compositeFilter, queryConstraints: queryConstraints, callbackId: callbackId)
+        let options = AddCollectionGroupSnapshotListenerOptions(reference: reference, compositeFilter: compositeFilter, queryConstraints: queryConstraints, includeMetadataChanges: includeMetadataChanges, callbackId: callbackId)
 
         do {
             implementation?.addCollectionGroupSnapshotListener(options, completion: { result, error in

packages/firestore/src/definitions.ts

@@ -381,6 +381,8 @@ export interface SnapshotListenerOptions {
    * Set the source the query listens to.
    * The source `default` listens to both cache and server.
    *
+   * Only available for Web.
+   *
    * @since 6.2.0
    * @default "default"
    */