Add a batched scheduler delegate call for animated prop updates (#58773)

Summary:
Pull Request resolved: #58773

The animation backend hands its synchronous updates to the platform one view at a time. This adds `UIManager::synchronouslyUpdateAnimatedProps` and a matching `SchedulerDelegate` call that receive a whole frame's updates at once, continuing #56771. The backend uses it when `optimizedAnimatedPropUpdates` is on. The default `SchedulerDelegate` implementation forwards to the existing per-view update, so platforms that don't override it are unaffected. `UIManagerDelegate` gains a required method, implemented by `Scheduler`.

## Changelog:

[General] [Added] - Add a batched scheduler delegate call for animated prop updates behind `optimizedAnimatedPropUpdates`

Differential Revision: D122570617

Author: Bartlomiej Bloniarz

packages/react-native/ReactCommon/react/renderer/animationbackend/AnimationBackend.cpp

@@ -253,6 +253,12 @@ void AnimationBackend::commitUpdates(
 
 void AnimationBackend::synchronouslyUpdateProps(
     const std::unordered_map<Tag, AnimatedProps>& updates) {
+  if (ReactNativeFeatureFlags::optimizedAnimatedPropUpdates()) {
+    if (auto uiManager = uiManager_.lock()) {
+      uiManager->synchronouslyUpdateAnimatedProps(updates);
+    }
+    return;
+  }
   for (auto& [tag, animatedProps] : updates) {
     // TODO: We shouldn't repack it into dynamic, but for that a rewrite
     // of synchronouslyUpdateViewOnUIThread is needed

packages/react-native/ReactCommon/react/renderer/scheduler/Scheduler.cpp

@@ -378,6 +378,13 @@ void Scheduler::uiManagerShouldSynchronouslyUpdateViewOnUIThread(
   }
 }
 
+void Scheduler::uiManagerShouldSynchronouslyUpdateAnimatedProps(
+    const std::unordered_map<Tag, AnimatedProps>& updates) {
+  if (delegate_ != nullptr) {
+    delegate_->schedulerShouldSynchronouslyUpdateAnimatedProps(updates);
+  }
+}
+
 void Scheduler::uiManagerDidUpdateShadowTree(
     const std::unordered_map<Tag, folly::dynamic>& tagToProps) {
   if (delegate_ != nullptr) {

packages/react-native/ReactCommon/react/renderer/scheduler/Scheduler.h

@@ -97,6 +97,7 @@ class Scheduler final : public UIManagerDelegate {
       bool isJSResponder,
       bool blockNativeResponder) override;
   void uiManagerShouldSynchronouslyUpdateViewOnUIThread(Tag tag, const folly::dynamic &props) override;
+  void uiManagerShouldSynchronouslyUpdateAnimatedProps(const std::unordered_map<Tag, AnimatedProps> &updates) override;
   void uiManagerDidUpdateShadowTree(const std::unordered_map<Tag, folly::dynamic> &tagToProps) override;
   void uiManagerDidCaptureViewSnapshot(Tag tag, SurfaceId surfaceId) override;
   void uiManagerDidSetViewSnapshot(Tag sourceTag, Tag targetTag, SurfaceId surfaceId) override;

packages/react-native/ReactCommon/react/renderer/scheduler/SchedulerDelegate.cpp

@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#include "SchedulerDelegate.h"
+
+#include <react/renderer/animationbackend/AnimatedProps.h>
+#include <react/renderer/animationbackend/AnimatedPropsSerializer.h>
+
+namespace facebook::react {
+
+void SchedulerDelegate::schedulerShouldSynchronouslyUpdateAnimatedProps(
+    const std::unordered_map<Tag, AnimatedProps>& updates) {
+  for (const auto& [tag, props] : updates) {
+    schedulerShouldSynchronouslyUpdateViewOnUIThread(
+        tag, animationbackend::packAnimatedProps(props));
+  }
+}
+
+} // namespace facebook::react

packages/react-native/ReactCommon/react/renderer/scheduler/SchedulerDelegate.h

@@ -10,13 +10,16 @@
 #include <react/cxxstableapi/FrameworksGuard.h>
 
 #include <memory>
+#include <unordered_map>
 
 #include <React/RendererCore.h>
 #include <react/renderer/mounting/MountingCoordinator.h>
 #include <react/renderer/mounting/ShadowView.h>
 
 namespace facebook::react {
 
+struct AnimatedProps;
+
 /*
  * Abstract class for Scheduler's delegate.
  */
@@ -66,6 +69,12 @@ class SchedulerDelegate {
 
   virtual void schedulerShouldSynchronouslyUpdateViewOnUIThread(Tag tag, const folly::dynamic &props) = 0;
 
+  /*
+   * Synchronous update of animated props for many views at once. By default,
+   * forwards each view to `schedulerShouldSynchronouslyUpdateViewOnUIThread`.
+   */
+  virtual void schedulerShouldSynchronouslyUpdateAnimatedProps(const std::unordered_map<Tag, AnimatedProps> &updates);
+
   virtual void schedulerDidUpdateShadowTree(const std::unordered_map<Tag, folly::dynamic> &tagToProps) = 0;
 
   // View transition bitmap snapshot capture and application.

packages/react-native/ReactCommon/react/renderer/scheduler/tests/SchedulerDelegateInvalidationTest.cpp

@@ -34,6 +34,7 @@
 #include <ReactCommon/RuntimeExecutor.h>
 #include <react/featureflags/ReactNativeFeatureFlags.h>
 #include <react/featureflags/ReactNativeFeatureFlagsDefaults.h>
+#include <react/renderer/animationbackend/AnimatedPropsBuilder.h>
 #include <react/renderer/componentregistry/ComponentDescriptorProviderRegistry.h>
 #include <react/renderer/components/root/RootComponentDescriptor.h>
 #include <react/renderer/components/root/RootProps.h>
@@ -588,4 +589,36 @@ TEST_F(
   EXPECT_EQ(delegate_->shouldRenderTransactionsCount(), 1);
 }
 
+TEST(SchedulerDelegateTest, animatedPropsUseExistingViewUpdatesByDefault) {
+  class PropsDelegate : public RecordingDelegate {
+   public:
+    std::unordered_map<Tag, folly::dynamic> received;
+
+    void schedulerShouldSynchronouslyUpdateViewOnUIThread(
+        Tag tag,
+        const folly::dynamic& props) override {
+      received.emplace(tag, props);
+    }
+  } delegate;
+
+  std::unordered_map<Tag, AnimatedProps> updates;
+  updates.emplace(
+      10,
+      AnimatedProps{
+          {},
+          std::make_unique<RawProps>(folly::dynamic::object("opacity", 0.25))});
+  AnimatedPropsBuilder builder;
+  builder.setOpacity(0.75);
+  updates.emplace(20, builder.get());
+
+  delegate.schedulerShouldSynchronouslyUpdateAnimatedProps(updates);
+
+  ASSERT_EQ(delegate.received.size(), 2);
+  folly::dynamic expectedRaw = folly::dynamic::object("opacity", 0.25);
+  folly::dynamic expectedTyped = folly::dynamic::object("opacity", 0.75);
+  EXPECT_EQ(delegate.received.at(10), expectedRaw);
+  EXPECT_EQ(delegate.received.at(20), expectedTyped);
+  EXPECT_EQ(updates.at(10).rawProps->toDynamic(), delegate.received.at(10));
+}
+
 } // namespace facebook::react

packages/react-native/ReactCommon/react/renderer/uimanager/UIManager.cpp

@@ -769,6 +769,13 @@ void UIManager::synchronouslyUpdateViewOnUIThread(
   }
 }
 
+void UIManager::synchronouslyUpdateAnimatedProps(
+    const std::unordered_map<Tag, AnimatedProps>& updates) {
+  if (delegate_ != nullptr) {
+    delegate_->uiManagerShouldSynchronouslyUpdateAnimatedProps(updates);
+  }
+}
+
 #pragma mark ContextContainer
 
 std::shared_ptr<const ContextContainer> UIManager::getContextContainer() const {

packages/react-native/ReactCommon/react/renderer/uimanager/UIManager.h

@@ -89,6 +89,8 @@ class UIManager final : public ShadowTreeDelegate {
 
   void synchronouslyUpdateViewOnUIThread(Tag tag, const folly::dynamic &props);
 
+  void synchronouslyUpdateAnimatedProps(const std::unordered_map<Tag, AnimatedProps> &updates);
+
   /*
    * Provides access to a UIManagerBinding.
    * The `callback` methods will not be called if the internal pointer to

packages/react-native/ReactCommon/react/renderer/uimanager/UIManagerDelegate.h

@@ -21,6 +21,8 @@
 
 namespace facebook::react {
 
+struct AnimatedProps;
+
 /*
  * Abstract class for UIManager's delegate.
  */
@@ -71,6 +73,12 @@ class UIManagerDelegate {
    */
   virtual void uiManagerShouldSynchronouslyUpdateViewOnUIThread(Tag tag, const folly::dynamic &props) = 0;
 
+  /*
+   * Synchronous update of animated props for many views at once.
+   */
+  virtual void uiManagerShouldSynchronouslyUpdateAnimatedProps(
+      const std::unordered_map<Tag, AnimatedProps> &updates) = 0;
+
   /*
    * Called after updateShadowTree is invoked.
    */

scripts/cxx-api/api-snapshots/ReactAndroidDebugCxx.api

@@ -4617,6 +4617,7 @@ class facebook::react::Scheduler : public facebook::react::UIManagerDelegate {
   public virtual void uiManagerShouldAddEventListener(std::shared_ptr<const facebook::react::EventListener> listener) final;
   public virtual void uiManagerShouldAddOnSurfaceStartCallback(facebook::react::UIManagerDelegate::OnSurfaceStartCallback&& callback) override;
   public virtual void uiManagerShouldRemoveEventListener(const std::shared_ptr<const facebook::react::EventListener>& listener) final;
+  public virtual void uiManagerShouldSynchronouslyUpdateAnimatedProps(const std::unordered_map<facebook::react::Tag, facebook::react::AnimatedProps>& updates) override;
   public virtual void uiManagerShouldSynchronouslyUpdateViewOnUIThread(facebook::react::Tag tag, const folly::dynamic& props) override;
   public void addEventListener(std::shared_ptr<const facebook::react::EventListener> listener);
   public void animationTick() const;
@@ -4640,6 +4641,7 @@ class facebook::react::SchedulerDelegate {
   public virtual void schedulerDidUpdateShadowTree(const std::unordered_map<facebook::react::Tag, folly::dynamic>& tagToProps) = 0;
   public virtual void schedulerShouldMergeReactRevision(facebook::react::SurfaceId surfaceId) = 0;
   public virtual void schedulerShouldRenderTransactions(const std::shared_ptr<const facebook::react::MountingCoordinator>& mountingCoordinator) = 0;
+  public virtual void schedulerShouldSynchronouslyUpdateAnimatedProps(const std::unordered_map<facebook::react::Tag, facebook::react::AnimatedProps>& updates);
   public virtual void schedulerShouldSynchronouslyUpdateViewOnUIThread(facebook::react::Tag tag, const folly::dynamic& props) = 0;
   public virtual ~SchedulerDelegate() noexcept = default;
 }
@@ -5371,6 +5373,7 @@ class facebook::react::UIManager : public facebook::react::ShadowTreeDelegate {
   public void startEmptySurface(facebook::react::ShadowTree::Unique&& shadowTree) const noexcept;
   public void startSurface(facebook::react::ShadowTree::Unique&& shadowTree, std::string moduleName, folly::dynamic props, facebook::react::DisplayMode displayMode) const noexcept;
   public void stopSurfaceForAnimationDelegate(facebook::react::SurfaceId surfaceId) const;
+  public void synchronouslyUpdateAnimatedProps(const std::unordered_map<facebook::react::Tag, facebook::react::AnimatedProps>& updates);
   public void synchronouslyUpdateViewOnUIThread(facebook::react::Tag tag, const folly::dynamic& props);
   public void unregisterCommitHook(facebook::react::UIManagerCommitHook& commitHook);
   public void unregisterMountHook(facebook::react::UIManagerMountHook& mountHook);
@@ -5438,6 +5441,7 @@ class facebook::react::UIManagerDelegate {
   public virtual void uiManagerShouldAddEventListener(std::shared_ptr<const facebook::react::EventListener> listener) = 0;
   public virtual void uiManagerShouldAddOnSurfaceStartCallback(facebook::react::UIManagerDelegate::OnSurfaceStartCallback&& callback) = 0;
   public virtual void uiManagerShouldRemoveEventListener(const std::shared_ptr<const facebook::react::EventListener>& listener) = 0;
+  public virtual void uiManagerShouldSynchronouslyUpdateAnimatedProps(const std::unordered_map<facebook::react::Tag, facebook::react::AnimatedProps>& updates) = 0;
   public virtual void uiManagerShouldSynchronouslyUpdateViewOnUIThread(facebook::react::Tag tag, const folly::dynamic& props) = 0;
   public virtual ~UIManagerDelegate() noexcept = default;
 }