[cloud_firestore] Clean up Android Firestore listeners (firebase#2733)

* Remove listeners when view is destroyed or when detached from engine.
angryCastor · Jun 19, 2020 · db92fc3 · db92fc3
1 parent 8ecdf43
commit db92fc3
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 2 deletions.
diff --git a/packages/cloud_firestore/cloud_firestore/CHANGELOG.md b/packages/cloud_firestore/cloud_firestore/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 0.13.7
+
+* Clean up snapshot listeners when Android Activity is destroyed.
+
 ## 0.13.6
 
 * Update lower bound of dart dependency to 2.0.0.

diff --git a/...ndroid/src/main/java/io/flutter/plugins/firebase/cloudfirestore/CloudFirestorePlugin.java b/...ndroid/src/main/java/io/flutter/plugins/firebase/cloudfirestore/CloudFirestorePlugin.java
@@ -49,6 +49,7 @@
 import io.flutter.plugin.common.PluginRegistry;
 import io.flutter.plugin.common.StandardMessageCodec;
 import io.flutter.plugin.common.StandardMethodCodec;
+import io.flutter.view.FlutterNativeView;
 import java.io.ByteArrayOutputStream;
 import java.nio.ByteBuffer;
 import java.nio.charset.Charset;
@@ -76,9 +77,17 @@ public class CloudFirestorePlugin implements MethodCallHandler, FlutterPlugin, A
   private final SparseArray<TaskCompletionSource> completionTasks = new SparseArray<>();
 
   public static void registerWith(PluginRegistry.Registrar registrar) {
-    CloudFirestorePlugin instance = new CloudFirestorePlugin();
+    final CloudFirestorePlugin instance = new CloudFirestorePlugin();
     instance.activity = registrar.activity();
     instance.initInstance(registrar.messenger());
+    registrar.addViewDestroyListener(
+        new PluginRegistry.ViewDestroyListener() {
+          @Override
+          public boolean onViewDestroy(FlutterNativeView view) {
+            instance.onDetachedFromEngine();
+            return false;
+          }
+        });
   }
 
   private void initInstance(BinaryMessenger messenger) {
@@ -476,6 +485,11 @@ public void onAttachedToEngine(@NonNull FlutterPluginBinding binding) {
 
   @Override
   public void onDetachedFromEngine(@NonNull FlutterPluginBinding binding) {
+    onDetachedFromEngine();
+  }
+
+  private void onDetachedFromEngine() {
+    removeSnapshotListeners();
     channel.setMethodCallHandler(null);
     channel = null;
   }
@@ -985,6 +999,13 @@ private static final class TransactionResult {
       this.exception = null;
     }
   }
+
+  private void removeSnapshotListeners() {
+    for (int i = 0; i < listenerRegistrations.size(); i++) {
+      listenerRegistrations.valueAt(i).remove();
+    }
+    listenerRegistrations.clear();
+  }
 }
 
 final class FirestoreMessageCodec extends StandardMessageCodec {

diff --git a/packages/cloud_firestore/cloud_firestore/pubspec.yaml b/packages/cloud_firestore/cloud_firestore/pubspec.yaml
@@ -3,7 +3,7 @@ description:
   Flutter plugin for Cloud Firestore, a cloud-hosted, noSQL database with
   live synchronization and offline support on Android and iOS.
 homepage: https://github.com/FirebaseExtended/flutterfire/tree/master/packages/cloud_firestore/cloud_firestore
-version: 0.13.6
+version: 0.13.7
 
 flutter:
   plugin: