mirror of
https://github.com/facebook/react-native.git
synced 2026-11-18 20:19:07 +00:00
Fix native animated mount flash (#57391)
Summary: The C++ native animated backend (`cxxNativeAnimatedEnabled`) prevents the `useNativeDriver` first-frame flash by having `AnimatedMountingOverrideDelegate` re-merge a view's live animated props (`getManagedProps`) onto mount `Update` mutations, so a stale JS re-render can't reach the screen. There is a residual at connect time: `connectAnimatedNodeToView` registers the view (the override starts overriding it) but never runs the props node, so `getManagedProps()` returns an empty object until the next animation frame. If a Fabric mount transaction is pulled in that window the override has nothing to merge and the un-driven default value flashes for one frame, most visibly when a brand-new view is connected to an already mid-flight shared `Animated.Value`. This seeds the props node with `node->update()` at the end of `connectAnimatedNodeToView` so `getManagedProps()` is live the instant the view becomes managed. No manager mutex is held at that point and `update()` takes only the node-local props mutex, so it is lock-safe; it is idempotent with the per-frame update and adds no extra Fabric commit because it only stages. It closes the connect-while-`Update`-in-flight case and mitigates the brand-new-view (`Insert`) first-paint case; the override only rewrites `Update`/`Delete` mutations today, so fully closing `Insert` is a follow-up. It also adds the missing unit coverage for the `getManagedProps` / `hasManagedProps` seam the override depends on. ## Changelog: [INTERNAL] [FIXED] - Seed managed props when a view connects to the native animated backend so they are live before the first frame, shrinking the useNativeDriver mount flash Pull Request resolved: https://github.com/react/react-native/pull/57391 Test Plan: Adds `ManagedPropsMountingOverrideTests.cpp` to the ReactCommon animated unit tests. `getManagedPropsReflectsLiveValueAcrossFrames`, `getManagedPropsNullForUnconnectedView`, `hasManagedPropsTracksConnectAndDisconnect` and `getManagedPropsIsolatedPerView` pin the seam and pass regardless of the change. `getManagedPropsLiveImmediatelyOnConnect` and `getManagedPropsLiveOnConnectWhileValueMidFlight` are the regression cases: they fail without the seed (empty props at connect) and pass with it. Run via the animated C++ unit test target. On-device verification (iOS and Android with `cxxNativeAnimatedEnabled` on, frame-stepped capture of a popover/menu open) is still recommended for the user-visible flash. Reviewed By: sammy-SC Differential Revision: D110323404 Pulled By: zeyap fbshipit-source-id: 485e31e1c874548da1ee7339481164faa763b2d9
This commit is contained in:
1 parent
34ccf4f331
commit
d1c5ee0388
13 files changed
+246
-10
No files matched your search
+3
@@ -229,6 +229,9 @@ void NativeAnimatedNodesManager::connectAnimatedNodeToView(
|
||||
connectedAnimatedNodes_.insert({viewTag, propsNodeTag});
|
||||
}
|
||||
updatedNodeTags_.insert(node->tag());
|
||||
// Seed props_ so getManagedProps() is live at mount, without staging a
|
||||
// commit.
|
||||
node->collectProps();
|
||||
} else {
|
||||
LOG(WARNING)
|
||||
<< "Cannot ConnectAnimatedNodeToView, animated node has to be props type";
|
||||
|
||||
+23
-10
@@ -97,18 +97,9 @@ void PropsAnimatedNode::restoreDefaultValues() {
|
||||
}
|
||||
}
|
||||
|
||||
void PropsAnimatedNode::update() {
|
||||
return update(false);
|
||||
}
|
||||
|
||||
void PropsAnimatedNode::update(bool forceFabricCommit) {
|
||||
if (connectedViewTag_ == animated::undefinedAnimatedNodeIdentifier) {
|
||||
return;
|
||||
}
|
||||
|
||||
void PropsAnimatedNode::collectPropsLocked() {
|
||||
// TODO: T190192206 consolidate shared update logic between
|
||||
// Props/StyleAnimatedNode
|
||||
std::lock_guard<std::mutex> lock(propsMutex_);
|
||||
const auto& configProps = getConfig()["props"];
|
||||
for (const auto& entry : configProps.items()) {
|
||||
auto propName = entry.first.asString();
|
||||
@@ -164,6 +155,28 @@ void PropsAnimatedNode::update(bool forceFabricCommit) {
|
||||
}
|
||||
|
||||
layoutStyleUpdated_ = isLayoutStyleUpdated(getConfig()["props"], *manager_);
|
||||
}
|
||||
|
||||
void PropsAnimatedNode::collectProps() {
|
||||
if (connectedViewTag_ == animated::undefinedAnimatedNodeIdentifier) {
|
||||
return;
|
||||
}
|
||||
|
||||
std::lock_guard<std::mutex> lock(propsMutex_);
|
||||
collectPropsLocked();
|
||||
}
|
||||
|
||||
void PropsAnimatedNode::update() {
|
||||
return update(false);
|
||||
}
|
||||
|
||||
void PropsAnimatedNode::update(bool forceFabricCommit) {
|
||||
if (connectedViewTag_ == animated::undefinedAnimatedNodeIdentifier) {
|
||||
return;
|
||||
}
|
||||
|
||||
std::lock_guard<std::mutex> lock(propsMutex_);
|
||||
collectPropsLocked();
|
||||
|
||||
if (manager_->useSharedAnimatedBackend()) {
|
||||
manager_->schedulePropsCommit(
|
||||
|
||||
@@ -46,11 +46,18 @@ class PropsAnimatedNode final : public AnimatedNode {
|
||||
return props_;
|
||||
}
|
||||
|
||||
// Recompute props_ from the connected nodes WITHOUT scheduling a view
|
||||
// commit, so getManagedProps() is live at connect with no commit side effect.
|
||||
void collectProps();
|
||||
|
||||
void update() override;
|
||||
|
||||
void update(bool forceFabricCommit);
|
||||
|
||||
private:
|
||||
// Caller must hold propsMutex_.
|
||||
void collectPropsLocked();
|
||||
|
||||
std::mutex propsMutex_;
|
||||
folly::dynamic props_;
|
||||
bool layoutStyleUpdated_{false};
|
||||
|
||||
+204
@@ -0,0 +1,204 @@
|
||||
/*
|
||||
* 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 "AnimationTestsBase.h"
|
||||
|
||||
#include <react/renderer/animated/drivers/AnimationDriverUtils.h>
|
||||
#include <react/renderer/core/ReactRootViewTagGenerator.h>
|
||||
|
||||
namespace facebook::react {
|
||||
|
||||
// Pins the getManagedProps / hasManagedProps seam re-merged by
|
||||
// AnimatedMountingOverrideDelegate to prevent the useNativeDriver mount flash.
|
||||
class ManagedPropsMountingOverrideTests : public AnimationTestsBase {
|
||||
protected:
|
||||
struct OpacityGraph {
|
||||
Tag opacityTag;
|
||||
Tag styleTag;
|
||||
Tag propsTag;
|
||||
Tag viewTag;
|
||||
};
|
||||
|
||||
// value -> style -> props graph for an animated opacity; view left
|
||||
// unconnected.
|
||||
OpacityGraph buildOpacityGraph(float initialOpacity) {
|
||||
const auto opacityTag = ++rootTag_;
|
||||
nodesManager_->createAnimatedNode(
|
||||
opacityTag,
|
||||
folly::dynamic::object("type", "value")("value", initialOpacity)(
|
||||
"offset", 0));
|
||||
|
||||
const auto styleTag = ++rootTag_;
|
||||
nodesManager_->createAnimatedNode(
|
||||
styleTag,
|
||||
folly::dynamic::object("type", "style")(
|
||||
"style", folly::dynamic::object("opacity", opacityTag)));
|
||||
nodesManager_->connectAnimatedNodes(opacityTag, styleTag);
|
||||
|
||||
const auto propsTag = ++rootTag_;
|
||||
nodesManager_->createAnimatedNode(
|
||||
propsTag,
|
||||
folly::dynamic::object("type", "props")(
|
||||
"props", folly::dynamic::object("style", styleTag)));
|
||||
nodesManager_->connectAnimatedNodes(styleTag, propsTag);
|
||||
|
||||
const auto viewTag = ++rootTag_;
|
||||
return OpacityGraph{
|
||||
.opacityTag = opacityTag,
|
||||
.styleTag = styleTag,
|
||||
.propsTag = propsTag,
|
||||
.viewTag = viewTag};
|
||||
}
|
||||
|
||||
Tag rootTag_{getNextRootViewTag()};
|
||||
};
|
||||
|
||||
TEST_F(
|
||||
ManagedPropsMountingOverrideTests,
|
||||
getManagedPropsNullForUnconnectedView) {
|
||||
initNodesManager();
|
||||
|
||||
const auto unknownTag = ++rootTag_;
|
||||
EXPECT_TRUE(nodesManager_->getManagedProps(unknownTag).isNull());
|
||||
EXPECT_FALSE(nodesManager_->hasManagedProps());
|
||||
}
|
||||
|
||||
// Managed props mirror the live committed value every frame, never the frozen
|
||||
// start value nor the 1.0 default.
|
||||
TEST_F(
|
||||
ManagedPropsMountingOverrideTests,
|
||||
getManagedPropsReflectsLiveValueAcrossFrames) {
|
||||
initNodesManager();
|
||||
|
||||
auto g = buildOpacityGraph(/*initialOpacity=*/0.0f);
|
||||
nodesManager_->connectAnimatedNodeToView(g.propsTag, g.viewTag);
|
||||
|
||||
const auto frames = folly::dynamic::array(0.0f, 0.25f, 0.5f, 0.75f, 1.0f);
|
||||
nodesManager_->startAnimatingNode(
|
||||
/*animationId=*/1,
|
||||
g.opacityTag,
|
||||
folly::dynamic::object("type", "frames")("frames", frames)(
|
||||
"toValue", 1.0f),
|
||||
std::nullopt);
|
||||
|
||||
const double startTimeInTick = 1000;
|
||||
for (int frame = 0; frame <= 4; ++frame) {
|
||||
runAnimationFrame(startTimeInTick + frame * SingleFrameIntervalMs);
|
||||
|
||||
auto props = nodesManager_->getManagedProps(g.viewTag);
|
||||
ASSERT_FALSE(props.isNull());
|
||||
ASSERT_TRUE(props.isObject());
|
||||
ASSERT_EQ(props.count("opacity"), 1u);
|
||||
|
||||
const double live = nodesManager_->getValue(g.opacityTag).value();
|
||||
EXPECT_DOUBLE_EQ(props["opacity"].asDouble(), live);
|
||||
|
||||
if (frame == 0) {
|
||||
EXPECT_DOUBLE_EQ(live, 0.0);
|
||||
}
|
||||
}
|
||||
|
||||
EXPECT_DOUBLE_EQ(nodesManager_->getValue(g.opacityTag).value(), 1.0);
|
||||
auto finalProps = nodesManager_->getManagedProps(g.viewTag);
|
||||
ASSERT_EQ(finalProps.count("opacity"), 1u);
|
||||
EXPECT_DOUBLE_EQ(finalProps["opacity"].asDouble(), 1.0);
|
||||
}
|
||||
|
||||
// Without the connect-time seed props_ is empty at connect, so the override has
|
||||
// nothing to merge: the opacity assertion fails pre-hardening, passes post.
|
||||
TEST_F(
|
||||
ManagedPropsMountingOverrideTests,
|
||||
getManagedPropsLiveImmediatelyOnConnect) {
|
||||
initNodesManager();
|
||||
|
||||
auto g = buildOpacityGraph(/*initialOpacity=*/0.8f);
|
||||
nodesManager_->connectAnimatedNodeToView(g.propsTag, g.viewTag);
|
||||
// No runAnimationFrame: the value must be live the instant the view is
|
||||
// managed.
|
||||
|
||||
auto props = nodesManager_->getManagedProps(g.viewTag);
|
||||
EXPECT_FALSE(props.isNull());
|
||||
ASSERT_TRUE(props.isObject());
|
||||
ASSERT_EQ(props.count("opacity"), 1u);
|
||||
EXPECT_DOUBLE_EQ(props["opacity"].asDouble(), static_cast<double>(0.8f));
|
||||
}
|
||||
|
||||
// A brand-new view connected to an already mid-flight shared value, with no
|
||||
// frame in between: fails pre-hardening, passes post.
|
||||
TEST_F(
|
||||
ManagedPropsMountingOverrideTests,
|
||||
getManagedPropsLiveOnConnectWhileValueMidFlight) {
|
||||
initNodesManager();
|
||||
|
||||
auto g = buildOpacityGraph(/*initialOpacity=*/0.0f);
|
||||
nodesManager_->connectAnimatedNodeToView(g.propsTag, g.viewTag);
|
||||
|
||||
const auto frames = folly::dynamic::array(0.0f, 0.25f, 0.5f, 0.75f, 1.0f);
|
||||
nodesManager_->startAnimatingNode(
|
||||
/*animationId=*/1,
|
||||
g.opacityTag,
|
||||
folly::dynamic::object("type", "frames")("frames", frames)(
|
||||
"toValue", 1.0f),
|
||||
std::nullopt);
|
||||
runAnimationFrame(1000);
|
||||
runAnimationFrame(1000 + 2 * SingleFrameIntervalMs);
|
||||
|
||||
const double live = nodesManager_->getValue(g.opacityTag).value();
|
||||
ASSERT_GT(live, 0.0);
|
||||
ASSERT_LT(live, 1.0);
|
||||
|
||||
const auto styleTag2 = ++rootTag_;
|
||||
nodesManager_->createAnimatedNode(
|
||||
styleTag2,
|
||||
folly::dynamic::object("type", "style")(
|
||||
"style", folly::dynamic::object("opacity", g.opacityTag)));
|
||||
nodesManager_->connectAnimatedNodes(g.opacityTag, styleTag2);
|
||||
const auto propsTag2 = ++rootTag_;
|
||||
nodesManager_->createAnimatedNode(
|
||||
propsTag2,
|
||||
folly::dynamic::object("type", "props")(
|
||||
"props", folly::dynamic::object("style", styleTag2)));
|
||||
nodesManager_->connectAnimatedNodes(styleTag2, propsTag2);
|
||||
const auto viewTag2 = ++rootTag_;
|
||||
nodesManager_->connectAnimatedNodeToView(propsTag2, viewTag2);
|
||||
|
||||
auto props = nodesManager_->getManagedProps(viewTag2);
|
||||
EXPECT_FALSE(props.isNull());
|
||||
ASSERT_EQ(props.count("opacity"), 1u);
|
||||
EXPECT_DOUBLE_EQ(props["opacity"].asDouble(), live);
|
||||
}
|
||||
|
||||
TEST_F(
|
||||
ManagedPropsMountingOverrideTests,
|
||||
hasManagedPropsTracksConnectAndDisconnect) {
|
||||
initNodesManager();
|
||||
|
||||
auto g = buildOpacityGraph(/*initialOpacity=*/0.5f);
|
||||
|
||||
EXPECT_FALSE(nodesManager_->hasManagedProps());
|
||||
EXPECT_TRUE(nodesManager_->getManagedProps(g.viewTag).isNull());
|
||||
|
||||
nodesManager_->connectAnimatedNodeToView(g.propsTag, g.viewTag);
|
||||
EXPECT_TRUE(nodesManager_->hasManagedProps());
|
||||
EXPECT_FALSE(nodesManager_->getManagedProps(g.viewTag).isNull());
|
||||
|
||||
nodesManager_->disconnectAnimatedNodeFromView(g.propsTag, g.viewTag);
|
||||
EXPECT_FALSE(nodesManager_->hasManagedProps());
|
||||
EXPECT_TRUE(nodesManager_->getManagedProps(g.viewTag).isNull());
|
||||
}
|
||||
|
||||
TEST_F(ManagedPropsMountingOverrideTests, getManagedPropsIsolatedPerView) {
|
||||
initNodesManager();
|
||||
|
||||
auto g = buildOpacityGraph(/*initialOpacity=*/0.3f);
|
||||
nodesManager_->connectAnimatedNodeToView(g.propsTag, g.viewTag);
|
||||
|
||||
EXPECT_FALSE(nodesManager_->getManagedProps(g.viewTag).isNull());
|
||||
EXPECT_TRUE(nodesManager_->getManagedProps(g.viewTag + 1000).isNull());
|
||||
}
|
||||
|
||||
} // namespace facebook::react
|
||||
@@ -4146,6 +4146,7 @@ class facebook::react::PropsAnimatedNode : public facebook::react::AnimatedNode
|
||||
public facebook::react::Tag connectedViewTag() const;
|
||||
public folly::dynamic props();
|
||||
public virtual void update() override;
|
||||
public void collectProps();
|
||||
public void connectToShadowNodeFamily(facebook::react::ShadowNodeFamily::Weak shadowNodeFamily);
|
||||
public void connectToView(facebook::react::Tag viewTag);
|
||||
public void disconnectFromShadowNodeFamily();
|
||||
|
||||
@@ -4000,6 +4000,7 @@ class facebook::react::PropsAnimatedNode : public facebook::react::AnimatedNode
|
||||
public facebook::react::Tag connectedViewTag() const;
|
||||
public folly::dynamic props();
|
||||
public virtual void update() override;
|
||||
public void collectProps();
|
||||
public void connectToShadowNodeFamily(facebook::react::ShadowNodeFamily::Weak shadowNodeFamily);
|
||||
public void connectToView(facebook::react::Tag viewTag);
|
||||
public void disconnectFromShadowNodeFamily();
|
||||
|
||||
@@ -4143,6 +4143,7 @@ class facebook::react::PropsAnimatedNode : public facebook::react::AnimatedNode
|
||||
public facebook::react::Tag connectedViewTag() const;
|
||||
public folly::dynamic props();
|
||||
public virtual void update() override;
|
||||
public void collectProps();
|
||||
public void connectToShadowNodeFamily(facebook::react::ShadowNodeFamily::Weak shadowNodeFamily);
|
||||
public void connectToView(facebook::react::Tag viewTag);
|
||||
public void disconnectFromShadowNodeFamily();
|
||||
|
||||
@@ -6329,6 +6329,7 @@ class facebook::react::PropsAnimatedNode : public facebook::react::AnimatedNode
|
||||
public facebook::react::Tag connectedViewTag() const;
|
||||
public folly::dynamic props();
|
||||
public virtual void update() override;
|
||||
public void collectProps();
|
||||
public void connectToShadowNodeFamily(facebook::react::ShadowNodeFamily::Weak shadowNodeFamily);
|
||||
public void connectToView(facebook::react::Tag viewTag);
|
||||
public void disconnectFromShadowNodeFamily();
|
||||
|
||||
@@ -6211,6 +6211,7 @@ class facebook::react::PropsAnimatedNode : public facebook::react::AnimatedNode
|
||||
public facebook::react::Tag connectedViewTag() const;
|
||||
public folly::dynamic props();
|
||||
public virtual void update() override;
|
||||
public void collectProps();
|
||||
public void connectToShadowNodeFamily(facebook::react::ShadowNodeFamily::Weak shadowNodeFamily);
|
||||
public void connectToView(facebook::react::Tag viewTag);
|
||||
public void disconnectFromShadowNodeFamily();
|
||||
|
||||
@@ -6326,6 +6326,7 @@ class facebook::react::PropsAnimatedNode : public facebook::react::AnimatedNode
|
||||
public facebook::react::Tag connectedViewTag() const;
|
||||
public folly::dynamic props();
|
||||
public virtual void update() override;
|
||||
public void collectProps();
|
||||
public void connectToShadowNodeFamily(facebook::react::ShadowNodeFamily::Weak shadowNodeFamily);
|
||||
public void connectToView(facebook::react::Tag viewTag);
|
||||
public void disconnectFromShadowNodeFamily();
|
||||
|
||||
@@ -2748,6 +2748,7 @@ class facebook::react::PropsAnimatedNode : public facebook::react::AnimatedNode
|
||||
public facebook::react::Tag connectedViewTag() const;
|
||||
public folly::dynamic props();
|
||||
public virtual void update() override;
|
||||
public void collectProps();
|
||||
public void connectToShadowNodeFamily(facebook::react::ShadowNodeFamily::Weak shadowNodeFamily);
|
||||
public void connectToView(facebook::react::Tag viewTag);
|
||||
public void disconnectFromShadowNodeFamily();
|
||||
|
||||
@@ -2642,6 +2642,7 @@ class facebook::react::PropsAnimatedNode : public facebook::react::AnimatedNode
|
||||
public facebook::react::Tag connectedViewTag() const;
|
||||
public folly::dynamic props();
|
||||
public virtual void update() override;
|
||||
public void collectProps();
|
||||
public void connectToShadowNodeFamily(facebook::react::ShadowNodeFamily::Weak shadowNodeFamily);
|
||||
public void connectToView(facebook::react::Tag viewTag);
|
||||
public void disconnectFromShadowNodeFamily();
|
||||
|
||||
@@ -2745,6 +2745,7 @@ class facebook::react::PropsAnimatedNode : public facebook::react::AnimatedNode
|
||||
public facebook::react::Tag connectedViewTag() const;
|
||||
public folly::dynamic props();
|
||||
public virtual void update() override;
|
||||
public void collectProps();
|
||||
public void connectToShadowNodeFamily(facebook::react::ShadowNodeFamily::Weak shadowNodeFamily);
|
||||
public void connectToView(facebook::react::Tag viewTag);
|
||||
public void disconnectFromShadowNodeFamily();
|
||||
|
||||
Reference in new issue
Block a user