fix: Unsubscribe dangling listeners (#6696)

## Summary

Unsubscribes listeners that were not removed correctly during the app
reload.

## Test plan

I tested it with a new project using Expo (SDK 52) and with Fabric
enabled. I reloaded the app several times and performed a heap dump to
verify that everything was removed correctly.

---------

Co-authored-by: Krzysztof Piaskowy <[email protected]>

Author: lukmccall

packages/react-native-reanimated/android/src/fabric/java/com/swmansion/reanimated/ReaCompatibility.java

@@ -21,6 +21,12 @@ public void registerFabricEventListener(NodesManager nodesManager) {
     }
   }
 
+  public void unregisterFabricEventListener(NodesManager nodesManager) {
+    if (fabricUIManager != null) {
+      fabricUIManager.getEventDispatcher().removeListener(nodesManager);
+    }
+  }
+
   public void synchronouslyUpdateUIProps(int viewTag, ReadableMap uiProps) {
     fabricUIManager.synchronouslyUpdateViewOnUIThread(viewTag, uiProps);
   }

packages/react-native-reanimated/android/src/main/java/com/swmansion/reanimated/NodesManager.java

@@ -30,6 +30,7 @@
 import com.facebook.react.uimanager.UIManagerReanimatedHelper;
 import com.facebook.react.uimanager.common.UIManagerType;
 import com.facebook.react.uimanager.events.Event;
+import com.facebook.react.uimanager.events.EventDispatcher;
 import com.facebook.react.uimanager.events.EventDispatcherListener;
 import com.facebook.react.uimanager.events.RCTEventEmitter;
 import com.swmansion.reanimated.layoutReanimation.AnimationsManager;
@@ -111,6 +112,7 @@ public interface OnAnimationFrame {
   public Set<String> uiProps = Collections.emptySet();
   public Set<String> nativeProps = Collections.emptySet();
   private ReaCompatibility compatibility;
+  private @Nullable Runnable mUnsubscribe = null;
 
   public NativeProxy getNativeProxy() {
     return mNativeProxy;
@@ -131,6 +133,15 @@ public void invalidate() {
       mNativeProxy.invalidate();
       mNativeProxy = null;
     }
+
+    if (compatibility != null) {
+      compatibility.unregisterFabricEventListener(this);
+    }
+
+    if (mUnsubscribe != null) {
+      mUnsubscribe.run();
+      mUnsubscribe = null;
+    }
   }
 
   public void initWithContext(ReactApplicationContext reactApplicationContext) {
@@ -184,8 +195,10 @@ protected void doFrameGuarded(long frameTimeNanos) {
     // Events are handled in the native modules thread in the `onEventDispatch()` method.
     // This method indirectly uses `mChoreographerCallback` which was created after event
     // registration, creating race condition
-    Objects.requireNonNull(UIManagerHelper.getEventDispatcher(context, uiManagerType))
-        .addListener(this);
+    EventDispatcher eventDispatcher =
+        Objects.requireNonNull(UIManagerHelper.getEventDispatcher(context, uiManagerType));
+    eventDispatcher.addListener(this);
+    mUnsubscribe = () -> eventDispatcher.removeListener(this);
 
     mAnimationManager = new AnimationsManager(mContext, mUIManager);
   }

packages/react-native-reanimated/android/src/main/java/com/swmansion/reanimated/Utils.java

@@ -46,4 +46,14 @@ public static float convertToFloat(Object value) {
     }
     return 0;
   }
+
+  public static Runnable combineRunnables(final Runnable... runnables) {
+    return new Runnable() {
+      public void run() {
+        for (Runnable r : runnables) {
+          r.run();
+        }
+      }
+    };
+  }
 }

packages/react-native-reanimated/android/src/paper/java/com/swmansion/reanimated/ReaCompatibility.java

@@ -8,5 +8,7 @@ public ReaCompatibility(ReactApplicationContext reactApplicationContext) {}
 
   public void registerFabricEventListener(NodesManager nodesManager) {}
 
+  public void unregisterFabricEventListener(NodesManager nodesManager) {}
+
   public void synchronouslyUpdateUIProps(int viewTag, ReadableMap uiProps) {}
 }

packages/react-native-reanimated/android/src/reactNativeVersionPatch/ReanimatedUIManager/74/com/swmansion/reanimated/ReanimatedModule.java

@@ -63,6 +63,7 @@ private interface UIThreadOperation {
   private ArrayList<UIThreadOperation> mOperations = new ArrayList<>();
   private @Nullable NodesManager mNodesManager;
   private final WorkletsModule mWorkletsModule;
+  private Runnable mUnsubscribe = () -> {};
 
   public ReanimatedModule(ReactApplicationContext reactContext) {
     super(reactContext);
@@ -81,14 +82,22 @@ public void initialize() {
       UIManager uiManager = reactCtx.getFabricUIManager();
       if (uiManager instanceof FabricUIManager) {
         ((FabricUIManager) uiManager).addUIManagerEventListener(this);
+        mUnsubscribe =
+            Utils.combineRunnables(
+                mUnsubscribe,
+                () -> ((FabricUIManager) uiManager).removeUIManagerEventListener(this));
       } else {
         throw new RuntimeException("[Reanimated] Failed to obtain instance of FabricUIManager.");
       }
     } else {
       UIManagerModule uiManager = reactCtx.getNativeModule(UIManagerModule.class);
       uiManager.addUIManagerListener(this);
+      mUnsubscribe =
+          Utils.combineRunnables(mUnsubscribe, () -> uiManager.removeUIManagerListener(this));
     }
     reactCtx.addLifecycleEventListener(this);
+    mUnsubscribe =
+        Utils.combineRunnables(mUnsubscribe, () -> reactCtx.removeLifecycleEventListener(this));
   }
 
   @Override
@@ -176,5 +185,7 @@ public void invalidate() {
     if (mNodesManager != null) {
       mNodesManager.invalidate();
     }
+
+    mUnsubscribe.run();
   }
 }

packages/react-native-reanimated/android/src/reactNativeVersionPatch/ReanimatedUIManager/latest/com/swmansion/reanimated/ReanimatedModule.java

@@ -63,6 +63,7 @@ private interface UIThreadOperation {
   private ArrayList<UIThreadOperation> mOperations = new ArrayList<>();
   private @Nullable NodesManager mNodesManager;
   private final WorkletsModule mWorkletsModule;
+  private Runnable mUnsubscribe = () -> {};
 
   public ReanimatedModule(ReactApplicationContext reactContext) {
     super(reactContext);
@@ -81,15 +82,23 @@ public void initialize() {
       UIManager uiManager = reactCtx.getFabricUIManager();
       if (uiManager instanceof FabricUIManager) {
         ((FabricUIManager) uiManager).addUIManagerEventListener(this);
+        mUnsubscribe =
+            Utils.combineRunnables(
+                mUnsubscribe,
+                () -> ((FabricUIManager) uiManager).removeUIManagerEventListener(this));
       } else {
         throw new RuntimeException("[Reanimated] Failed to obtain instance of FabricUIManager.");
       }
     } else {
       UIManagerModule uiManager =
           Objects.requireNonNull(reactCtx.getNativeModule(UIManagerModule.class));
       uiManager.addUIManagerListener(this);
+      mUnsubscribe =
+          Utils.combineRunnables(mUnsubscribe, () -> uiManager.removeUIManagerListener(this));
     }
     reactCtx.addLifecycleEventListener(this);
+    mUnsubscribe =
+        Utils.combineRunnables(mUnsubscribe, () -> reactCtx.removeLifecycleEventListener(this));
   }
 
   @Override
@@ -174,5 +183,7 @@ public void invalidate() {
     if (mNodesManager != null) {
       mNodesManager.invalidate();
     }
+
+    mUnsubscribe.run();
   }
 }