fix(android): rn74 forward-port onCatalystInstanceDestroy -> invalidate

onCatalystInstanceDestroy is no longer calld as of rn74, so our teardown
methods were not being called so we were orphaning listeners on rn 74+

this forward ports to the new invalidate API for rn74+ but leaves in place
the old hook as an override for people on rn73- and just delegates to the new
implementation

Author: mikehardy

packages/app-check/android/src/main/java/io/invertase/firebase/appcheck/ReactNativeFirebaseAppCheckModule.java

@@ -100,8 +100,8 @@ private boolean isAppDebuggable() throws Exception {
   }
 
   @Override
-  public void onCatalystInstanceDestroy() {
-    super.onCatalystInstanceDestroy();
+  public void invalidate() {
+    super.invalidate();
     Log.d(TAG, "instance-destroyed");
 
     Iterator appCheckListenerIterator = mAppCheckListeners.entrySet().iterator();

packages/app/android/src/reactnative/java/io/invertase/firebase/common/ReactNativeFirebaseModule.java

@@ -92,9 +92,26 @@ public final ExecutorService getTransactionalExecutor(String identifier) {
     return executorService.getTransactionalExecutor(identifier);
   }
 
-  @Override
-  @CallSuper
+
+  // This is no longer called as of react-native 0.74 and is only here for
+  // compatibility with older versions. It delegates to thew new `invalidate`
+  // method, which all modules should implement now
+  // Remove this method when minimum supported react-native is 0.74
+  /** @noinspection removal*/
+  @SuppressWarnings({"deprecation", "removal"})
+  @Deprecated
   public void onCatalystInstanceDestroy() {
+    // This should call the child class invalidate, which will then call super.invalidate,
+    // and everything will work correctly up and down the inheritance hierarchy to shut down
+    invalidate();
+  }
+
+  // This should have an @Override annotation but we cannot do
+  // that until our minimum supported react-native version is 0.74, since the
+  // method did not exist before then
+  @CallSuper
+  public void invalidate() {
+    super.invalidate();
     executorService.shutdown();
   }
 

packages/auth/android/src/main/java/io/invertase/firebase/auth/ReactNativeFirebaseAuthModule.java

@@ -123,8 +123,8 @@ public void initialize() {
   }
 
   @Override
-  public void onCatalystInstanceDestroy() {
-    super.onCatalystInstanceDestroy();
+  public void invalidate() {
+    super.invalidate();
     Log.d(TAG, "instance-destroyed");
 
     Iterator authListenerIterator = mAuthListeners.entrySet().iterator();

packages/database/android/src/reactnative/java/io/invertase/firebase/database/ReactNativeFirebaseDatabaseQueryModule.java

@@ -42,8 +42,8 @@ public class ReactNativeFirebaseDatabaseQueryModule extends ReactNativeFirebaseM
   }
 
   @Override
-  public void onCatalystInstanceDestroy() {
-    super.onCatalystInstanceDestroy();
+  public void invalidate() {
+    super.invalidate();
 
     Iterator refIterator = queryMap.entrySet().iterator();
     while (refIterator.hasNext()) {

packages/dynamic-links/android/src/main/java/io/invertase/firebase/dynamiclinks/ReactNativeFirebaseDynamicLinksModule.java

@@ -71,10 +71,10 @@ public class ReactNativeFirebaseDynamicLinksModule extends ReactNativeFirebaseMo
   }
 
   @Override
-  public void onCatalystInstanceDestroy() {
+  public void invalidate() {
     getReactApplicationContext().removeActivityEventListener(this);
     getReactApplicationContext().addLifecycleEventListener(this);
-    super.onCatalystInstanceDestroy();
+    super.invalidate();
   }
 
   @ReactMethod

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

@@ -42,8 +42,8 @@ public class ReactNativeFirebaseFirestoreCollectionModule extends ReactNativeFir
   }
 
   @Override
-  public void onCatalystInstanceDestroy() {
-    super.onCatalystInstanceDestroy();
+  public void invalidate() {
+    super.invalidate();
 
     for (int i = 0, size = collectionSnapshotListeners.size(); i < size; i++) {
       int key = collectionSnapshotListeners.keyAt(i);

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

@@ -43,8 +43,8 @@ public class ReactNativeFirebaseFirestoreDocumentModule extends ReactNativeFireb
   }
 
   @Override
-  public void onCatalystInstanceDestroy() {
-    super.onCatalystInstanceDestroy();
+  public void invalidate() {
+    super.invalidate();
 
     for (int i = 0, size = documentSnapshotListeners.size(); i < size; i++) {
       int key = documentSnapshotListeners.keyAt(i);

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

@@ -45,7 +45,7 @@ public class ReactNativeFirebaseFirestoreTransactionModule extends ReactNativeFi
   }
 
   @Override
-  public void onCatalystInstanceDestroy() {
+  public void invalidate() {
     for (int i = 0, size = transactionHandlers.size(); i < size; i++) {
       int key = transactionHandlers.keyAt(i);
       ReactNativeFirebaseFirestoreTransactionHandler transactionHandler =
@@ -57,7 +57,7 @@ public void onCatalystInstanceDestroy() {
     }
 
     transactionHandlers.clear();
-    super.onCatalystInstanceDestroy();
+    super.invalidate();
   }
 
   @ReactMethod

packages/perf/android/src/reactnative/java/io/invertase/firebase/perf/ReactNativeFirebasePerfModule.java

@@ -36,8 +36,8 @@ public class ReactNativeFirebasePerfModule extends ReactNativeFirebaseModule {
   }
 
   @Override
-  public void onCatalystInstanceDestroy() {
-    super.onCatalystInstanceDestroy();
+  public void invalidate() {
+    super.invalidate();
     module.onTearDown();
   }
 

packages/remote-config/android/src/reactnative/java/io/invertase/firebase/config/ReactNativeFirebaseConfigModule.java

@@ -45,8 +45,8 @@ public class ReactNativeFirebaseConfigModule extends ReactNativeFirebaseModule {
   }
 
   @Override
-  public void onCatalystInstanceDestroy() {
-    super.onCatalystInstanceDestroy();
+  public void invalidate() {
+    super.invalidate();
 
     Iterator<Map.Entry<String, ConfigUpdateListenerRegistration>> configRegistrationsIterator =
         mConfigUpdateRegistrations.entrySet().iterator();