feat: setup android for onSnapshotInSync

Author: russellwheatley

packages/firestore/android/src/main/java/io/invertase/firebase/firestore/UniversalFirebaseFirestoreModule.java

@@ -22,10 +22,17 @@
 import static io.invertase.firebase.firestore.UniversalFirebaseFirestoreCommon.instanceCache;
 
 import android.content.Context;
+import android.util.SparseArray;
+
+import com.facebook.react.bridge.Arguments;
+import com.facebook.react.bridge.WritableMap;
 import com.google.android.gms.tasks.Task;
 import com.google.android.gms.tasks.Tasks;
 import com.google.firebase.firestore.FirebaseFirestore;
+import com.google.firebase.firestore.ListenerRegistration;
 import com.google.firebase.firestore.LoadBundleTask;
+
+import io.invertase.firebase.common.ReactNativeFirebaseEventEmitter;
 import io.invertase.firebase.common.UniversalFirebaseModule;
 import io.invertase.firebase.common.UniversalFirebasePreferences;
 import java.nio.charset.StandardCharsets;
@@ -34,13 +41,52 @@
 import java.util.Objects;
 
 public class UniversalFirebaseFirestoreModule extends UniversalFirebaseModule {
+  private static SparseArray<ListenerRegistration> onSnapshotInSyncListeners =
+    new SparseArray<>();
 
   private static HashMap<String, String> emulatorConfigs = new HashMap<>();
 
   UniversalFirebaseFirestoreModule(Context context, String serviceName) {
     super(context, serviceName);
   }
 
+  void addSnapshotsInSync(
+    String appName,
+    String databaseId,
+    int listenerId
+  ) {
+
+    FirebaseFirestore firebaseFirestore = getFirestoreForApp(appName, databaseId);
+    ListenerRegistration listenerRegistration = firebaseFirestore
+      .addSnapshotsInSyncListener(() -> {
+        ReactNativeFirebaseEventEmitter emitter =
+          ReactNativeFirebaseEventEmitter.getSharedInstance();
+        WritableMap body = Arguments.createMap();
+        emitter.sendEvent(
+          new ReactNativeFirebaseFirestoreEvent(
+            ReactNativeFirebaseFirestoreEvent.SNAPSHOT_IN_SYNC_EVENT_SYNC,
+            body,
+            appName,
+            databaseId,
+            listenerId));
+      });
+
+
+    onSnapshotInSyncListeners.put(listenerId, listenerRegistration);
+  }
+
+  void removeSnapshotsInSync(
+    String appName,
+    String databaseId,
+    int listenerId
+  ) {
+    ListenerRegistration listenerRegistration = onSnapshotInSyncListeners.get(listenerId);
+    if (listenerRegistration != null) {
+      listenerRegistration.remove();
+      onSnapshotInSyncListeners.remove(listenerId);
+    }
+  }
+
   Task<Void> disableNetwork(String appName, String databaseId) {
     return getFirestoreForApp(appName, databaseId).disableNetwork();
   }

packages/firestore/android/src/reactnative/java/io/invertase/firebase/firestore/ReactNativeFirebaseFirestoreEvent.java

@@ -26,6 +26,7 @@ public class ReactNativeFirebaseFirestoreEvent implements NativeEvent {
   static final String COLLECTION_EVENT_SYNC = "firestore_collection_sync_event";
   static final String DOCUMENT_EVENT_SYNC = "firestore_document_sync_event";
   static final String TRANSACTION_EVENT_SYNC = "firestore_transaction_event";
+  static final String SNAPSHOT_IN_SYNC_EVENT_SYNC = "firestore_snapshots_in_sync_event";
   private static final String KEY_ID = "listenerId";
   private static final String KEY_BODY = "body";
   private static final String KEY_APP_NAME = "appName";

packages/firestore/android/src/reactnative/java/io/invertase/firebase/firestore/ReactNativeFirebaseFirestoreModule.java

@@ -21,7 +21,6 @@
 import static io.invertase.firebase.firestore.ReactNativeFirebaseFirestoreCommon.rejectPromiseFirestoreException;
 import static io.invertase.firebase.firestore.UniversalFirebaseFirestoreCommon.createFirestoreKey;
 import static io.invertase.firebase.firestore.UniversalFirebaseFirestoreCommon.getFirestoreForApp;
-import static io.invertase.firebase.firestore.UniversalFirebaseFirestoreCommon.getQueryForFirestore;
 
 import com.facebook.react.bridge.Arguments;
 import com.facebook.react.bridge.Promise;
@@ -30,8 +29,10 @@
 import com.facebook.react.bridge.ReadableMap;
 import com.facebook.react.bridge.WritableMap;
 import com.google.firebase.firestore.FirebaseFirestore;
+import com.google.firebase.firestore.ListenerRegistration;
 import com.google.firebase.firestore.LoadBundleTaskProgress;
 import com.google.firebase.firestore.PersistentCacheIndexManager;
+
 import io.invertase.firebase.common.ReactNativeFirebaseModule;
 
 public class ReactNativeFirebaseFirestoreModule extends ReactNativeFirebaseModule {
@@ -195,62 +196,25 @@ public void persistenceCacheIndexManager(
   }
 
   @ReactMethod
-  public void snapshotsInSyncListener(
+  public void addSnapshotsInSync(
     String appName,
     String databaseId,
-    int listenerId
+    int listenerId,
+    Promise promise
     ) {
-    FirebaseFirestore firebaseFirestore = getFirestoreForApp(appName, databaseId);
-    ReactNativeFirebaseFirestoreQuery firestoreQuery =
-      new ReactNativeFirebaseFirestoreQuery(
-        appName,
-        databaseId,
-        getQueryForFirestore(firebaseFirestore)
-        );
-
-    handleSnapshotsInSync(appName, databaseId);
+    module.addSnapshotsInSync(appName, databaseId, listenerId);
+    promise.resolve(null);
   }
 
   @ReactMethod
-  public void onSnapshotsInSync(String appName, String databaseId, Promise promise) {
-    ListenerRegistration registration = FirebaseFirestore.getInstance()
-      .addSnapshotsInSyncListener(() -> {
-        WritableMap result = Arguments.createMap();
-        getReactApplicationContext()
-          .getJSModule(DeviceEventManagerModule.RCTDeviceEventEmitter.class)
-          .emit("firestore_onSnapshotsInSync", result);
-      });
-
+  public void removeSnapshotsInSync(String appName,
+                                    String databaseId,
+                                    int listenerId,
+                                    Promise promise){
+    module.removeSnapshotsInSync(appName, databaseId, listenerId);
     promise.resolve(null);
   }
 
-  private void handleSnapshotsInSync(
-    ReactNativeFirebaseFirestoreQuery firestoreQuery,
-    String appName,
-    String databaseId,
-    int listenerId
-    ) {
-
-    final EventListener<QuerySnapshot> listener =
-      (querySnapshot, exception) -> {
-        if (exception != null) {
-          ListenerRegistration listenerRegistration = collectionSnapshotListeners.get(listenerId);
-          if (listenerRegistration != null) {
-            listenerRegistration.remove();
-            collectionSnapshotListeners.remove(listenerId);
-          }
-          sendOnSnapshotError(appName, databaseId, listenerId, exception);
-        } else {
-          sendOnSnapshotEvent(appName, databaseId, listenerId, querySnapshot, metadataChanges);
-        }
-      };
-
-    ListenerRegistration listenerRegistration =
-      firestoreQuery.query.addSnapshotListener(metadataChanges, listener);
-
-    collectionSnapshotListeners.put(listenerId, listenerRegistration);
-  }
-
   private WritableMap taskProgressToWritableMap(LoadBundleTaskProgress progress) {
     WritableMap writableMap = Arguments.createMap();
     writableMap.putDouble("bytesLoaded", progress.getBytesLoaded());

packages/firestore/lib/index.js

@@ -190,17 +190,9 @@ class FirebaseFirestoreModule extends FirebaseModule {
     };
 
     this.firestore.native.snapshotsInSyncListener(listenerId);
-    
     return unsubscribe;
   }
 
-  async onSnapshotsInSync(firestore, callback) {
-    this.native.onSnapshotsInSync(firestore, callback, MODULAR_DEPRECATION_ARG);
-    return () => {
-      firestoreEmitter.removeListener('onSnapshotsInSync', callback);
-    };
-  }
-
   useEmulator(host, port) {
     if (!host || !isString(host) || !port || !isNumber(port)) {
       throw new Error('firebase.firestore().useEmulator() takes a non-empty host and port');

packages/firestore/lib/modular/index.js

@@ -89,6 +89,24 @@ export function collectionGroup(firestore, collectionId) {
   return firestore.collectionGroup.call(firestore, collectionId, MODULAR_DEPRECATION_ARG);
 }
 
+let _id_SnapshotInSync = 0;
+
+export function onSnapshotsInSync(firestore, callback) {
+  const listenerId = _id_SnapshotInSync++;
+  firestore.native.addSnapshotsInSync(listenerId);
+  const onSnapshotsInSyncSubscription = firestore.emitter.addListener(
+    firestore.eventNameForApp(`firestore_snapshots_in_sync_event:${listenerId}`),
+    () => {
+      callback();
+    },
+  );
+
+  return () => {
+    onSnapshotsInSyncSubscription.remove();
+    firestore.native.removeSnapshotsInSync(listenerId);
+  };
+}
+
 /**
  * @param {DocumentReference} reference
  * @param {import('.').PartialWithFieldValue} data

tests/test-app/examples/firestore/onSnapshotInSync.js

@@ -0,0 +1,48 @@
+import React, { useEffect } from 'react';
+import { AppRegistry, Button, Text, View } from 'react-native';
+
+import '@react-native-firebase/app';
+import firestore, { onSnapshotsInSync } from '@react-native-firebase/firestore';
+
+const fire = firestore();
+function App() {
+  let unsubscribe;
+  useEffect(() => {
+    unsubscribe = onSnapshotsInSync(fire, () => {
+      console.log('onSnapshotsInSync');
+    });
+  }, []);
+
+  async function addDocument() {
+    await firestore().collection('flutter-tests').doc('one').set({ foo: 'bar' });
+  }
+
+  return (
+    <View>
+      <Text>React Native Firebase</Text>
+      <Text>onSnapshotsInSync API</Text>
+      <Button
+        title="add document"
+        onPress={async () => {
+          try {
+            addDocument();
+          } catch (e) {
+            console.log('EEEE', e);
+          }
+        }}
+      />
+      <Button
+        title="unsubscribe to snapshot in sync"
+        onPress={async () => {
+          try {
+            unsubscribe();
+          } catch (e) {
+            console.log('EEEE', e);
+          }
+        }}
+      />
+    </View>
+  );
+}
+
+AppRegistry.registerComponent('testing', () => App);