Implement mount hooks in UIManager (Android)

rubennorte · facebook-github-bot · commit 1e6f79d2a7ea · 2023-05-26T03:26:56.000-07:00
Differential Revision: D45866244

fbshipit-source-id: 90769b04f0e7dfede0e7df0482fe119c4601e4f0
diff --git a/packages/react-native/React/Fabric/RCTScheduler.h b/packages/react-native/React/Fabric/RCTScheduler.h
@@ -67,6 +67,8 @@ NS_ASSUME_NONNULL_BEGIN
 
 - (void)animationTick;
 
+- (void)reportMount:(facebook::react::SurfaceId)surfaceId;
+
 - (void)addEventListener:(std::shared_ptr<facebook::react::EventListener> const &)listener;
 
 - (void)removeEventListener:(std::shared_ptr<facebook::react::EventListener> const &)listener;
diff --git a/packages/react-native/React/Fabric/RCTScheduler.mm b/packages/react-native/React/Fabric/RCTScheduler.mm
@@ -132,6 +132,11 @@ - (void)animationTick
   _scheduler->animationTick();
 }
 
+- (void)reportMount:(facebook::react::SurfaceId)surfaceId
+{
+  _scheduler->reportMount(surfaceId);
+}
+
 - (void)dealloc
 {
   if (_animationDriver) {
diff --git a/packages/react-native/React/Fabric/RCTSurfacePresenter.mm b/packages/react-native/React/Fabric/RCTSurfacePresenter.mm
@@ -280,6 +280,10 @@ - (RCTScheduler *)_createScheduler
     CoreFeatures::enableGranularScrollViewStateUpdatesIOS = true;
   }
 
+  if (reactNativeConfig && reactNativeConfig->getBool("react_fabric:enable_mount_hooks_ios")) {
+    CoreFeatures::enableMountHooks = true;
+  }
+
   auto componentRegistryFactory =
       [factory = wrapManagedObject(_mountingManager.componentViewRegistry.componentViewFactory)](
           EventDispatcher::Weak const &eventDispatcher, ContextContainer::Shared const &contextContainer) {
@@ -442,6 +446,15 @@ - (void)mountingManager:(RCTMountingManager *)mountingManager didMountComponents
       [observer didMountComponentsWithRootTag:rootTag];
     }
   }
+
+  RCTScheduler *scheduler = [self scheduler];
+  if (scheduler) {
+    // Notify mount when the effects are visible and prevent mount hooks to
+    // delay paint.
+    dispatch_async(dispatch_get_main_queue(), ^{
+      [scheduler reportMount:rootTag];
+    });
+  }
 }
 
 - (NSArray<id<RCTSurfacePresenterObserver>> *)_getObservers
diff --git a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/config/ReactFeatureFlags.java b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/config/ReactFeatureFlags.java
@@ -156,4 +156,7 @@ public class ReactFeatureFlags {
    * HostObject pattern
    */
   public static boolean useNativeState = false;
+
+  /** Report mount operations from the host platform to notify mount hooks. */
+  public static boolean enableMountHooks = false;
 }
diff --git a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/fabric/Binding.java b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/fabric/Binding.java
@@ -52,6 +52,8 @@ public void setConstraints(
 
   public void driveCxxAnimations();
 
+  public void reportMount(int surfaceId);
+
   public ReadableNativeMap getInspectorDataForInstance(EventEmitterWrapper eventEmitterWrapper);
 
   public void register(
diff --git a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/fabric/BindingImpl.java b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/fabric/BindingImpl.java
@@ -86,6 +86,8 @@ public native void setConstraints(
 
   public native void driveCxxAnimations();
 
+  public native void reportMount(int surfaceId);
+
   public native ReadableNativeMap getInspectorDataForInstance(
       EventEmitterWrapper eventEmitterWrapper);
 
diff --git a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/fabric/FabricUIManager.java b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/fabric/FabricUIManager.java
@@ -22,6 +22,8 @@
 import android.annotation.SuppressLint;
 import android.content.Context;
 import android.graphics.Point;
+import android.os.Handler;
+import android.os.Looper;
 import android.os.SystemClock;
 import android.view.View;
 import android.view.accessibility.AccessibilityEvent;
@@ -81,10 +83,13 @@
 import com.facebook.react.uimanager.events.RCTEventEmitter;
 import com.facebook.react.views.text.TextLayoutManager;
 import com.facebook.react.views.text.TextLayoutManagerMapBuffer;
+import java.util.ArrayList;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 import java.util.Queue;
 import java.util.concurrent.CopyOnWriteArrayList;
+import java.util.concurrent.atomic.AtomicBoolean;
 
 /**
  * We instruct ProGuard not to strip out any fields or methods, because many of these methods are
@@ -166,6 +171,9 @@ public class FabricUIManager implements UIManager, LifecycleEventListener {
   @NonNull
   private final CopyOnWriteArrayList<UIManagerListener> mListeners = new CopyOnWriteArrayList<>();
 
+  @NonNull private final AtomicBoolean mMountNotificationScheduled = new AtomicBoolean(false);
+  @NonNull private final Handler mMainThreadHandler = new Handler(Looper.getMainLooper());
+
   @ThreadConfined(UI)
   @NonNull
   private final DispatchUIFrameCallback mDispatchUIFrameCallback;
@@ -1179,17 +1187,50 @@ public Map<String, Long> getPerformanceCounters() {
 
   private class MountItemDispatchListener implements MountItemDispatcher.ItemDispatchListener {
     @Override
-    public void willMountItems() {
+    public void willMountItems(@Nullable List<MountItem> mountItems) {
       for (UIManagerListener listener : mListeners) {
         listener.willMountItems(FabricUIManager.this);
       }
     }
 
     @Override
-    public void didMountItems() {
+    public void didMountItems(@Nullable List<MountItem> mountItems) {
       for (UIManagerListener listener : mListeners) {
         listener.didMountItems(FabricUIManager.this);
       }
+
+      if (!ReactFeatureFlags.enableMountHooks) {
+        return;
+      }
+
+      boolean mountNotificationScheduled = mMountNotificationScheduled.getAndSet(true);
+      if (!mountNotificationScheduled) {
+        // Notify mount when the effects are visible and prevent mount hooks to
+        // delay paint.
+        mMainThreadHandler.postAtFrontOfQueue(
+            new Runnable() {
+              @Override
+              public void run() {
+                mMountNotificationScheduled.set(false);
+
+                if (mountItems == null) {
+                  return;
+                }
+
+                // Collect surface IDs for all the mount items
+                List<Integer> surfaceIds = new ArrayList();
+                for (MountItem mountItem : mountItems) {
+                  if (!surfaceIds.contains(mountItem.getSurfaceId())) {
+                    surfaceIds.add(mountItem.getSurfaceId());
+                  }
+                }
+
+                for (int surfaceId : surfaceIds) {
+                  mBinding.reportMount(surfaceId);
+                }
+              }
+            });
+      }
     }
 
     @Override
diff --git a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/fabric/mounting/MountItemDispatcher.java b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/fabric/mounting/MountItemDispatcher.java
@@ -192,7 +192,7 @@ private boolean dispatchMountItems() {
       return false;
     }
 
-    mItemDispatchListener.willMountItems();
+    mItemDispatchListener.willMountItems(mountItemsToDispatch);
 
     // As an optimization, execute all ViewCommands first
     // This should be:
@@ -301,7 +301,7 @@ private boolean dispatchMountItems() {
       mBatchedExecutionTime += SystemClock.uptimeMillis() - batchedExecutionStartTime;
     }
 
-    mItemDispatchListener.didMountItems();
+    mItemDispatchListener.didMountItems(mountItemsToDispatch);
 
     Systrace.endSection(Systrace.TRACE_TAG_REACT_JAVA_BRIDGE);
 
@@ -419,9 +419,9 @@ private static void printMountItem(MountItem mountItem, String prefix) {
   }
 
   public interface ItemDispatchListener {
-    void willMountItems();
+    void willMountItems(List<MountItem> mountItems);
 
-    void didMountItems();
+    void didMountItems(List<MountItem> mountItems);
 
     void didDispatchMountItems();
   }
diff --git a/packages/react-native/ReactAndroid/src/main/jni/react/fabric/Binding.cpp b/packages/react-native/ReactAndroid/src/main/jni/react/fabric/Binding.cpp
@@ -95,6 +95,15 @@ void Binding::driveCxxAnimations() {
   scheduler_->animationTick();
 }
 
+void Binding::reportMount(SurfaceId surfaceId) {
+  const auto &scheduler = getScheduler();
+  if (!scheduler) {
+    LOG(ERROR) << "Binding::reportMount: scheduler disappeared";
+    return;
+  }
+  scheduler->reportMount(surfaceId);
+}
+
 #pragma mark - Surface management
 
 void Binding::startSurface(
@@ -565,6 +574,7 @@ void Binding::registerNatives() {
       makeNativeMethod("setConstraints", Binding::setConstraints),
       makeNativeMethod("setPixelDensity", Binding::setPixelDensity),
       makeNativeMethod("driveCxxAnimations", Binding::driveCxxAnimations),
+      makeNativeMethod("reportMount", Binding::reportMount),
       makeNativeMethod(
           "uninstallFabricUIManager", Binding::uninstallFabricUIManager),
       makeNativeMethod("registerSurface", Binding::registerSurface),
diff --git a/packages/react-native/ReactAndroid/src/main/jni/react/fabric/Binding.h b/packages/react-native/ReactAndroid/src/main/jni/react/fabric/Binding.h
@@ -119,6 +119,7 @@ class Binding : public jni::HybridClass<Binding>,
   void setPixelDensity(float pointScaleFactor);
 
   void driveCxxAnimations();
+  void reportMount(SurfaceId surfaceId);
 
   void uninstallFabricUIManager();
 
diff --git a/packages/react-native/ReactCommon/React-Fabric.podspec b/packages/react-native/ReactCommon/React-Fabric.podspec
@@ -54,6 +54,7 @@ Pod::Spec.new do |s|
   s.dependency "React-debug"
   s.dependency "React-utils"
   s.dependency "React-runtimescheduler"
+  s.dependency "React-cxxreact"
 
   if ENV["USE_HERMES"] == nil || ENV["USE_HERMES"] == "1"
     s.dependency "hermes-engine"
diff --git a/packages/react-native/ReactCommon/react/renderer/core/CoreFeatures.cpp b/packages/react-native/ReactCommon/react/renderer/core/CoreFeatures.cpp
@@ -17,5 +17,6 @@ bool CoreFeatures::cacheLastTextMeasurement = false;
 bool CoreFeatures::cancelImageDownloadsOnRecycle = false;
 bool CoreFeatures::disableTransactionCommit = false;
 bool CoreFeatures::enableGranularScrollViewStateUpdatesIOS = false;
+bool CoreFeatures::enableMountHooks = false;
 
 } // namespace facebook::react
diff --git a/packages/react-native/ReactCommon/react/renderer/core/CoreFeatures.h b/packages/react-native/ReactCommon/react/renderer/core/CoreFeatures.h
@@ -52,6 +52,9 @@ class CoreFeatures {
   // When enabled, RCTScrollViewComponentView will trigger ShadowTree state
   // updates for all changes in scroll position.
   static bool enableGranularScrollViewStateUpdatesIOS;
+
+  // Report mount operations from the host platform to notify mount hooks.
+  static bool enableMountHooks;
 };
 
 } // namespace facebook::react
diff --git a/packages/react-native/ReactCommon/react/renderer/mounting/MountingCoordinator.cpp b/packages/react-native/ReactCommon/react/renderer/mounting/MountingCoordinator.cpp
@@ -179,6 +179,10 @@ TelemetryController const &MountingCoordinator::getTelemetryController() const {
   return telemetryController_;
 }
 
+ShadowTreeRevision const &MountingCoordinator::getBaseRevision() const {
+  return baseRevision_;
+}
+
 void MountingCoordinator::setMountingOverrideDelegate(
     std::weak_ptr<MountingOverrideDelegate const> delegate) const {
   std::lock_guard<std::mutex> lock(mutex_);
diff --git a/packages/react-native/ReactCommon/react/renderer/mounting/MountingCoordinator.h b/packages/react-native/ReactCommon/react/renderer/mounting/MountingCoordinator.h
@@ -71,6 +71,8 @@ class MountingCoordinator final {
 
   TelemetryController const &getTelemetryController() const;
 
+  ShadowTreeRevision const &getBaseRevision() const;
+
   /*
    * Methods from this section are meant to be used by
    * `MountingOverrideDelegate` only.
diff --git a/packages/react-native/ReactCommon/react/renderer/scheduler/Scheduler.cpp b/packages/react-native/ReactCommon/react/renderer/scheduler/Scheduler.cpp
@@ -377,6 +377,10 @@ void Scheduler::uiManagerDidSetIsJSResponder(
   }
 }
 
+void Scheduler::reportMount(SurfaceId surfaceId) const {
+  uiManager_->reportMount(surfaceId);
+}
+
 ContextContainer::Shared Scheduler::getContextContainer() const {
   return contextContainer_;
 }
diff --git a/packages/react-native/ReactCommon/react/renderer/scheduler/Scheduler.h b/packages/react-native/ReactCommon/react/renderer/scheduler/Scheduler.h
@@ -108,6 +108,8 @@ class Scheduler final : public UIManagerDelegate {
 #pragma mark - UIManager
   std::shared_ptr<UIManager> getUIManager() const;
 
+  void reportMount(SurfaceId surfaceId) const;
+
 #pragma mark - Event listeners
   void addEventListener(const std::shared_ptr<EventListener const> &listener);
   void removeEventListener(
diff --git a/packages/react-native/ReactCommon/react/renderer/uimanager/CMakeLists.txt b/packages/react-native/ReactCommon/react/renderer/uimanager/CMakeLists.txt
@@ -33,6 +33,7 @@ target_link_libraries(react_render_uimanager
         react_render_runtimescheduler
         react_render_mounting
         react_config
+        reactnative
         rrc_root
         rrc_view
         runtimeexecutor
diff --git a/packages/react-native/ReactCommon/react/renderer/uimanager/UIManager.cpp b/packages/react-native/ReactCommon/react/renderer/uimanager/UIManager.cpp
@@ -7,6 +7,7 @@
 
 #include "UIManager.h"
 
+#include <cxxreact/JSExecutor.h>
 #include <react/debug/react_native_assert.h>
 #include <react/renderer/core/DynamicPropsUtilities.h>
 #include <react/renderer/core/PropsParserContext.h>
@@ -16,6 +17,7 @@
 #include <react/renderer/uimanager/SurfaceRegistryBinding.h>
 #include <react/renderer/uimanager/UIManagerBinding.h>
 #include <react/renderer/uimanager/UIManagerCommitHook.h>
+#include <react/renderer/uimanager/UIManagerMountHook.h>
 
 #include <glog/logging.h>
 
@@ -612,6 +614,21 @@ void UIManager::unregisterCommitHook(
   commitHook.commitHookWasUnregistered(*this);
 }
 
+void UIManager::registerMountHook(UIManagerMountHook &mountHook) {
+  std::unique_lock lock(mountHookMutex_);
+  react_native_assert(
+      std::find(mountHooks_.begin(), mountHooks_.end(), &mountHook) ==
+      mountHooks_.end());
+  mountHooks_.push_back(&mountHook);
+}
+
+void UIManager::unregisterMountHook(UIManagerMountHook &mountHook) {
+  std::unique_lock lock(mountHookMutex_);
+  auto iterator = std::find(mountHooks_.begin(), mountHooks_.end(), &mountHook);
+  react_native_assert(iterator != mountHooks_.end());
+  mountHooks_.erase(iterator);
+}
+
 #pragma mark - ShadowTreeDelegate
 
 RootShadowNode::Unshared UIManager::shadowTreeWillCommit(
@@ -640,6 +657,28 @@ void UIManager::shadowTreeDidFinishTransaction(
   }
 }
 
+void UIManager::reportMount(SurfaceId surfaceId) const {
+  auto time = JSExecutor::performanceNow();
+
+  auto rootShadowNode = RootShadowNode::Shared{};
+  shadowTreeRegistry_.visit(surfaceId, [&](ShadowTree const &shadowTree) {
+    rootShadowNode =
+        shadowTree.getMountingCoordinator()->getBaseRevision().rootShadowNode;
+  });
+
+  if (!rootShadowNode) {
+    return;
+  }
+
+  {
+    std::shared_lock lock(mountHookMutex_);
+
+    for (auto *mountHook : mountHooks_) {
+      mountHook->shadowTreeDidMount(rootShadowNode, time);
+    }
+  }
+}
+
 #pragma mark - UIManagerAnimationDelegate
 
 void UIManager::setAnimationDelegate(UIManagerAnimationDelegate *delegate) {
diff --git a/packages/react-native/ReactCommon/react/renderer/uimanager/UIManager.h b/packages/react-native/ReactCommon/react/renderer/uimanager/UIManager.h
diff --git a/packages/react-native/ReactCommon/react/renderer/uimanager/UIManagerMountHook.h b/packages/react-native/ReactCommon/react/renderer/uimanager/UIManagerMountHook.h

Original file line number	Diff line number	Diff line change
`@@ -132,6 +132,11 @@ - (void)animationTick`
`132`	`132`	`_scheduler->animationTick();`
`133`	`133`	`}`
`134`	`134`
	`135`	`+- (void)reportMount:(facebook::react::SurfaceId)surfaceId`
	`136`	`+{`
	`137`	`+ _scheduler->reportMount(surfaceId);`
	`138`	`+}`
	`139`	`+`
`135`	`140`	`- (void)dealloc`
`136`	`141`	`{`
`137`	`142`	`if (_animationDriver) {`
Original file line number	Diff line number	Diff line change
`@@ -280,6 +280,10 @@ - (RCTScheduler *)_createScheduler`
`280`	`280`	`CoreFeatures::enableGranularScrollViewStateUpdatesIOS = true;`
`281`	`281`	`}`
`282`	`282`
	`283`	`+ if (reactNativeConfig && reactNativeConfig->getBool("react_fabric:enable_mount_hooks_ios")) {`
	`284`	`+ CoreFeatures::enableMountHooks = true;`
	`285`	`+ }`
	`286`	`+`
`283`	`287`	`auto componentRegistryFactory =`
`284`	`288`	`[factory = wrapManagedObject(_mountingManager.componentViewRegistry.componentViewFactory)](`
`285`	`289`	`EventDispatcher::Weak const &eventDispatcher, ContextContainer::Shared const &contextContainer) {`
`@@ -442,6 +446,15 @@ - (void)mountingManager:(RCTMountingManager *)mountingManager didMountComponents`
`442`	`446`	`[observer didMountComponentsWithRootTag:rootTag];`
`443`	`447`	`}`
`444`	`448`	`}`
	`449`	`+`
	`450`	`+ RCTScheduler *scheduler = [self scheduler];`
	`451`	`+ if (scheduler) {`
	`452`	`+ // Notify mount when the effects are visible and prevent mount hooks to`
	`453`	`+ // delay paint.`
	`454`	`+ dispatch_async(dispatch_get_main_queue(), ^{`
	`455`	`+ [scheduler reportMount:rootTag];`
	`456`	`+ });`
	`457`	`+ }`
`445`	`458`	`}`
`446`	`459`
`447`	`460`	`- (NSArray<id<RCTSurfacePresenterObserver>> *)_getObservers`
Original file line number	Diff line number	Diff line change
`@@ -156,4 +156,7 @@ public class ReactFeatureFlags {`
`156`	`156`	`* HostObject pattern`
`157`	`157`	`*/`
`158`	`158`	`public static boolean useNativeState = false;`
	`159`	`+`
	`160`	`+ /** Report mount operations from the host platform to notify mount hooks. */`
	`161`	`+ public static boolean enableMountHooks = false;`
`159`	`162`	`}`
Original file line number	Diff line number	Diff line change
`@@ -192,7 +192,7 @@ private boolean dispatchMountItems() {`
`192`	`192`	`return false;`
`193`	`193`	`}`
`194`	`194`
`195`		`- mItemDispatchListener.willMountItems();`
	`195`	`+ mItemDispatchListener.willMountItems(mountItemsToDispatch);`
`196`	`196`
`197`	`197`	`// As an optimization, execute all ViewCommands first`
`198`	`198`	`// This should be:`
`@@ -301,7 +301,7 @@ private boolean dispatchMountItems() {`
`301`	`301`	`mBatchedExecutionTime += SystemClock.uptimeMillis() - batchedExecutionStartTime;`
`302`	`302`	`}`
`303`	`303`
`304`		`- mItemDispatchListener.didMountItems();`
	`304`	`+ mItemDispatchListener.didMountItems(mountItemsToDispatch);`
`305`	`305`
`306`	`306`	`Systrace.endSection(Systrace.TRACE_TAG_REACT_JAVA_BRIDGE);`
`307`	`307`
`@@ -419,9 +419,9 @@ private static void printMountItem(MountItem mountItem, String prefix) {`
`419`	`419`	`}`
`420`	`420`
`421`	`421`	`public interface ItemDispatchListener {`
`422`		`- void willMountItems();`
	`422`	`+ void willMountItems(List<MountItem> mountItems);`
`423`	`423`
`424`		`- void didMountItems();`
	`424`	`+ void didMountItems(List<MountItem> mountItems);`
`425`	`425`
`426`	`426`	`void didDispatchMountItems();`
`427`	`427`	`}`