TM iOS: Added backward-compatible ObjC invalidation logic

Summary:
Some ObjC NativeModules conform to `RCTInvalidating` protocol and implements `invalidate` method. This is typically used to clean things up during bridge teardown or reload. In TurboModule system the invalidate method can be replaced by pure destructors, but for backward compatibility, we call existing invalidate method on each module during teardown.

This also cleans up all existing LongLivedObject's.

Reviewed By: mdvacca, RSNara

Differential Revision: D15365655

fbshipit-source-id: 802844b39b5b7adb54970ea541f4d744bbf9e480

Author: fkgozali

React/Base/RCTBridge.h

@@ -85,6 +85,12 @@ RCT_EXTERN NSString *const RCTBridgeWillDownloadScriptNotification;
  */
 RCT_EXTERN NSString *const RCTBridgeDidDownloadScriptNotification;
 
+/**
+ * This notification fires right after the bridge finishes invalidating NativeModule
+ * instances during teardown. Handle this notification to perform additional invalidation.
+ */
+RCT_EXTERN NSString *const RCTBridgeDidInvalidateModulesNotification;
+
 /**
  * Key for the RCTSource object in the RCTBridgeDidDownloadScriptNotification
  * userInfo dictionary.

React/Base/RCTBridge.m

@@ -33,6 +33,7 @@
 NSString *const RCTBridgeWillReloadNotification = @"RCTBridgeWillReloadNotification";
 NSString *const RCTBridgeWillDownloadScriptNotification = @"RCTBridgeWillDownloadScriptNotification";
 NSString *const RCTBridgeDidDownloadScriptNotification = @"RCTBridgeDidDownloadScriptNotification";
+NSString *const RCTBridgeDidInvalidateModulesNotification = @"RCTBridgeDidInvalidateModulesNotification";
 NSString *const RCTBridgeDidDownloadScriptNotificationSourceKey = @"source";
 NSString *const RCTBridgeDidDownloadScriptNotificationBridgeDescriptionKey = @"bridgeDescription";
 

React/CxxBridge/RCTCxxBridge.mm

@@ -1100,6 +1100,10 @@ - (void)invalidate
       [moduleData invalidate];
     }
 
+    [[NSNotificationCenter defaultCenter] postNotificationName:RCTBridgeDidInvalidateModulesNotification
+                                                        object:self->_parentBridge
+                                                      userInfo:@{@"bridge": self}];
+
     if (dispatch_group_wait(moduleInvalidation, dispatch_time(DISPATCH_TIME_NOW, 10 * NSEC_PER_SEC))) {
       RCTLogError(@"Timed out waiting for modules to be invalidated");
     }

ReactCommon/turbomodule/core/TurboModuleBinding.cpp

@@ -10,6 +10,7 @@
 #include <string>
 
 #include <cxxreact/SystraceSection.h>
+#include <jsireact/LongLivedObject.h>
 
 using namespace facebook;
 
@@ -38,7 +39,7 @@ void TurboModuleBinding::install(
 }
 
 void TurboModuleBinding::invalidate() const {
-  // Nothing for now.
+  LongLivedObjectCollection::get().clear();
 }
 
 std::shared_ptr<TurboModule> TurboModuleBinding::getModule(const std::string &name) {

ReactCommon/turbomodule/core/platform/ios/RCTTurboModuleManager.mm

@@ -10,10 +10,10 @@
 #import <cassert>
 
 #import <React/RCTBridge+Private.h>
-#import <React/RCTPerformanceLogger.h>
 #import <React/RCTBridgeModule.h>
 #import <React/RCTCxxModule.h>
 #import <React/RCTLog.h>
+#import <React/RCTPerformanceLogger.h>
 #import <jsireact/BridgeJSCallInvoker.h>
 #import <jsireact/TurboCxxModule.h>
 #import <jsireact/TurboModuleBinding.h>
@@ -22,16 +22,16 @@
 
 // Fallback lookup since RCT class prefix is sometimes stripped in the existing NativeModule system.
 // This will be removed in the future.
-static Class getFallbackClassFromName(const char *name) {
+static Class getFallbackClassFromName(const char *name)
+{
   Class moduleClass = NSClassFromString([NSString stringWithUTF8String:name]);
   if (!moduleClass) {
     moduleClass = NSClassFromString([NSString stringWithFormat:@"RCT%s", name]);
   }
   return moduleClass;
 }
 
-@implementation RCTTurboModuleManager
-{
+@implementation RCTTurboModuleManager {
   jsi::Runtime *_runtime;
   std::shared_ptr<facebook::react::JSCallInvoker> _jsInvoker;
   std::shared_ptr<react::TurboModuleBinding> _binding;
@@ -57,6 +57,11 @@ - (instancetype)initWithBridge:(RCTBridge *)bridge delegate:(id<RCTTurboModuleMa
     // Necessary to allow NativeModules to lookup TurboModules
     [bridge setRCTTurboModuleLookupDelegate:self];
 
+    [[NSNotificationCenter defaultCenter] addObserver:self
+                                             selector:@selector(bridgeDidInvalidateModules:)
+                                                 name:RCTBridgeDidInvalidateModulesNotification
+                                               object:_bridge.parentBridge];
+
     __weak __typeof(self) weakSelf = self;
 
     auto moduleProvider = [weakSelf](const std::string &name) -> std::shared_ptr<react::TurboModule> {
@@ -92,17 +97,23 @@ - (instancetype)initWithBridge:(RCTBridge *)bridge delegate:(id<RCTTurboModuleMa
   return self;
 }
 
-- (void)notifyAboutTurboModuleSetup:(const char*)name {
-    NSString *moduleName = [[NSString alloc] initWithUTF8String:name];
-    if (moduleName) {
-      int64_t setupTime = [self->_bridge.performanceLogger durationForTag:RCTPLTurboModuleSetup];
-      [[NSNotificationCenter defaultCenter] postNotificationName:RCTDidSetupModuleNotification
-                                                          object:nil
-                                                        userInfo:@{
-                                                                  RCTDidSetupModuleNotificationModuleNameKey: moduleName,
-                                                                  RCTDidSetupModuleNotificationSetupTimeKey: @(setupTime)
-                                                                  }];
-    }
+- (void)dealloc
+{
+  [[NSNotificationCenter defaultCenter] removeObserver:self];
+}
+
+- (void)notifyAboutTurboModuleSetup:(const char *)name
+{
+  NSString *moduleName = [[NSString alloc] initWithUTF8String:name];
+  if (moduleName) {
+    int64_t setupTime = [self->_bridge.performanceLogger durationForTag:RCTPLTurboModuleSetup];
+    [[NSNotificationCenter defaultCenter] postNotificationName:RCTDidSetupModuleNotification
+                                                        object:nil
+                                                      userInfo:@{
+                                                        RCTDidSetupModuleNotificationModuleNameKey : moduleName,
+                                                        RCTDidSetupModuleNotificationSetupTimeKey : @(setupTime)
+                                                      }];
+  }
 }
 
 /**
@@ -114,7 +125,7 @@ - (void)notifyAboutTurboModuleSetup:(const char*)name {
  * (for now).
  */
 
-- (std::shared_ptr<react::TurboModule>)provideTurboModule:(const char*)moduleName
+- (std::shared_ptr<react::TurboModule>)provideTurboModule:(const char *)moduleName
 {
   auto turboModuleLookup = _turboModuleCache.find(moduleName);
   if (turboModuleLookup != _turboModuleCache.end()) {
@@ -185,7 +196,7 @@ - (void)notifyAboutTurboModuleSetup:(const char*)name {
  * Note: All TurboModule instances are cached, which means they're all long-lived
  * (for now).
  */
-- (id<RCTTurboModule>)provideRCTTurboModule:(const char*)moduleName
+- (id<RCTTurboModule>)provideRCTTurboModule:(const char *)moduleName
 {
   auto rctTurboModuleCacheLookup = _rctTurboModuleCache.find(moduleName);
   if (rctTurboModuleCacheLookup != _rctTurboModuleCache.end()) {
@@ -245,11 +256,12 @@ - (void)notifyAboutTurboModuleSetup:(const char*)name {
        * the bridge property of these NativeModules.
        */
       [(id)module setValue:_bridge forKey:@"bridge"];
-    }
-    @catch (NSException *exception) {
-      RCTLogError(@"%@ has no setter or ivar for its bridge, which is not "
-                  "permitted. You must either @synthesize the bridge property, "
-                  "or provide your own setter method.", RCTBridgeModuleNameForClass(module));
+    } @catch (NSException *exception) {
+      RCTLogError(
+          @"%@ has no setter or ivar for its bridge, which is not "
+           "permitted. You must either @synthesize the bridge property, "
+           "or provide your own setter method.",
+          RCTBridgeModuleNameForClass(module));
     }
   }
 
@@ -265,9 +277,10 @@ - (void)notifyAboutTurboModuleSetup:(const char*)name {
    * TODO(T41180176): Investigate whether we can get rid of this after all
    * TurboModules are rolled out
    */
-  [[NSNotificationCenter defaultCenter] postNotificationName:RCTDidInitializeModuleNotification
-                                                      object:_bridge
-                                                    userInfo:@{@"module": module, @"bridge": RCTNullIfNil(_bridge.parentBridge)}];
+  [[NSNotificationCenter defaultCenter]
+      postNotificationName:RCTDidInitializeModuleNotification
+                    object:_bridge
+                  userInfo:@{@"module" : module, @"bridge" : RCTNullIfNil(_bridge.parentBridge)}];
   return module;
 }
 
@@ -311,4 +324,28 @@ - (BOOL)moduleIsInitialized:(const char *)moduleName
   return _rctTurboModuleCache.find(std::string(moduleName)) != _rctTurboModuleCache.end();
 }
 
+#pragma mark Invalidation logic
+
+- (void)bridgeDidInvalidateModules:(NSNotification *)notification
+{
+  // Rely on this notification to invalidate all known TurboModule ObjC instances, synchronously.
+  RCTBridge *bridge = notification.userInfo[@"bridge"];
+  if (bridge != _bridge) {
+    return;
+  }
+
+  // Backward-compatibility: RCTInvalidating handling.
+  for (const auto &p : _rctTurboModuleCache) {
+    id<RCTTurboModule> module = p.second;
+    if ([module respondsToSelector:@selector(invalidate)]) {
+      [((id<RCTInvalidating>)module) invalidate];
+    }
+  }
+
+  _rctTurboModuleCache.clear();
+  _turboModuleCache.clear();
+
+  _binding->invalidate();
+}
+
 @end

ReactCommon/turbomodule/samples/platform/ios/RCTSampleTurboModule.mm

@@ -44,6 +44,13 @@ - (dispatch_queue_t)methodQueue
 
 #endif
 
+// Backward compatible invalidation
+- (void)invalidate
+{
+  // Actually do nothing here.
+  NSLog(@"Invalidating RCTSampleTurboModule...");
+}
+
 - (NSDictionary *)getConstants
 {
   UIScreen *mainScreen = UIScreen.mainScreen;