Fabric: Test for State Reconciliation mechanism

Summary: It's not immediately obvious from the UI/UX when/if this mechanism breaks, so it's good to have a test. Changelog: [Internal] Fabric-specific internal change. Reviewed By: JoshuaGross Differential Revision: D21184718 fbshipit-source-id: 25432a1398cff3ce61f62cf433e3cb73d7a7a93f
2025-11-01 09:14:26 +00:00 · 2020-04-24 21:39:08 -07:00
parent fef8bc33df
commit aad99607de
2 changed files with 180 additions and 0 deletions
@@ -81,5 +81,9 @@ fb_xplat_cxx_test(
        ":mounting",
        "//xplat/folly:molly",
        "//xplat/third-party/gmock:gtest",
+        react_native_xplat_target("fabric/element:element"),
+        react_native_xplat_target("fabric/components/root:root"),
+        react_native_xplat_target("fabric/components/view:view"),
+        react_native_xplat_target("fabric/components/scrollview:scrollview"),
    ],
 )
@@ -0,0 +1,176 @@
+/*
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#include <memory>
+
+#include <gtest/gtest.h>
+
+#include <react/componentregistry/ComponentDescriptorProviderRegistry.h>
+#include <react/components/root/RootComponentDescriptor.h>
+#include <react/components/view/ViewComponentDescriptor.h>
+#include <react/element/ComponentBuilder.h>
+#include <react/element/Element.h>
+#include <react/element/testUtils.h>
+
+#include <react/mounting/MountingCoordinator.h>
+#include <react/mounting/ShadowTree.h>
+#include <react/mounting/ShadowTreeDelegate.h>
+
+using namespace facebook::react;
+
+class DummyShadowTreeDelegate : public ShadowTreeDelegate {
+ public:
+  virtual void shadowTreeDidFinishTransaction(
+      ShadowTree const &shadowTree,
+      MountingCoordinator::Shared const &mountingCoordinator) const override{};
+};
+
+inline ShadowNode const *findDescendantNode(
+    ShadowNode const &shadowNode,
+    ShadowNodeFamily const &family) {
+  auto result = (ShadowNode const *){nullptr};
+  shadowNode.cloneTree(family, [&](ShadowNode const &oldShadowNode) {
+    result = &oldShadowNode;
+    return oldShadowNode.clone({});
+  });
+  return result;
+}
+
+inline ShadowNode const *findDescendantNode(
+    ShadowTree const &shadowTree,
+    ShadowNodeFamily const &family) {
+  auto result = (ShadowNode const *){nullptr};
+
+  shadowTree.tryCommit(
+      [&](RootShadowNode::Shared const &oldRootShadowNode) {
+        result = findDescendantNode(*oldRootShadowNode, family);
+        return nullptr;
+      },
+      false);
+
+  return result;
+}
+
+TEST(StateReconciliationTest, testStateReconciliation) {
+  auto builder = simpleComponentBuilder();
+
+  auto shadowNodeA = std::shared_ptr<RootShadowNode>{};
+  auto shadowNodeAA = std::shared_ptr<ViewShadowNode>{};
+  auto shadowNodeAB = std::shared_ptr<ScrollViewShadowNode>{};
+  auto shadowNodeABA = std::shared_ptr<ViewShadowNode>{};
+  auto shadowNodeABB = std::shared_ptr<ViewShadowNode>{};
+  auto shadowNodeABC = std::shared_ptr<ViewShadowNode>{};
+
+  // clang-format off
+  auto element =
+      Element<RootShadowNode>()
+        .reference(shadowNodeA)
+        .finalize([](RootShadowNode &shadowNode){
+          shadowNode.sealRecursive();
+        })
+        .children({
+          Element<ViewShadowNode>()
+            .reference(shadowNodeAA),
+          Element<ScrollViewShadowNode>()
+            .reference(shadowNodeAB)
+            .children({
+              Element<ViewShadowNode>()
+                .reference(shadowNodeABA),
+              Element<ViewShadowNode>()
+                .reference(shadowNodeABB),
+              Element<ViewShadowNode>()
+                .reference(shadowNodeABC)
+            })
+        });
+  // clang-format on
+
+  auto shadowNode = builder.build(element);
+
+  auto rootShadowNodeState1 = shadowNode->ShadowNode::clone({});
+
+  auto &scrollViewComponentDescriptor = shadowNodeAB->getComponentDescriptor();
+  auto &family = shadowNodeAB->getFamily();
+  auto state1 = shadowNodeAB->getState();
+  auto shadowTreeDelegate = DummyShadowTreeDelegate{};
+  auto eventDispatcher = EventDispatcher::Shared{};
+  auto rootComponentDescriptor =
+      ComponentDescriptorParameters{eventDispatcher, nullptr, nullptr};
+  ShadowTree shadowTree{SurfaceId{11},
+                        LayoutConstraints{},
+                        LayoutContext{},
+                        rootComponentDescriptor,
+                        shadowTreeDelegate};
+
+  shadowTree.commit(
+      [&](RootShadowNode::Shared const &oldRootShadowNode) {
+        return std::static_pointer_cast<RootShadowNode>(rootShadowNodeState1);
+      },
+      true);
+
+  EXPECT_EQ(state1->getMostRecentState(), state1);
+
+  EXPECT_EQ(
+      findDescendantNode(*rootShadowNodeState1, family)->getState(), state1);
+
+  auto state2 = scrollViewComponentDescriptor.createState(
+      family, std::make_shared<ScrollViewState const>());
+
+  auto rootShadowNodeState2 =
+      shadowNode->cloneTree(family, [&](ShadowNode const &oldShadowNode) {
+        return oldShadowNode.clone({ShadowNodeFragment::propsPlaceholder(),
+                                    ShadowNodeFragment::childrenPlaceholder(),
+                                    state2});
+      });
+
+  EXPECT_EQ(
+      findDescendantNode(*rootShadowNodeState2, family)->getState(), state2);
+
+  shadowTree.commit(
+      [&](RootShadowNode::Shared const &oldRootShadowNode) {
+        return std::static_pointer_cast<RootShadowNode>(rootShadowNodeState2);
+      },
+      true);
+
+  EXPECT_EQ(state1->getMostRecentState(), state2);
+  EXPECT_EQ(state2->getMostRecentState(), state2);
+
+  auto state3 = scrollViewComponentDescriptor.createState(
+      family, std::make_shared<ScrollViewState const>());
+
+  auto rootShadowNodeState3 = rootShadowNodeState2->cloneTree(
+      family, [&](ShadowNode const &oldShadowNode) {
+        return oldShadowNode.clone({ShadowNodeFragment::propsPlaceholder(),
+                                    ShadowNodeFragment::childrenPlaceholder(),
+                                    state3});
+      });
+
+  EXPECT_EQ(
+      findDescendantNode(*rootShadowNodeState3, family)->getState(), state3);
+
+  shadowTree.commit(
+      [&](RootShadowNode::Shared const &oldRootShadowNode) {
+        return std::static_pointer_cast<RootShadowNode>(rootShadowNodeState3);
+      },
+      true);
+
+  EXPECT_EQ(findDescendantNode(shadowTree, family)->getState(), state3);
+
+  EXPECT_EQ(state1->getMostRecentState(), state3);
+  EXPECT_EQ(state2->getMostRecentState(), state3);
+  EXPECT_EQ(state3->getMostRecentState(), state3);
+
+  // This is the core part of the whole test.
+  // Here we commit the old tree but we expect that the state associated with
+  // the node will stay the same (newer that the old tree has).
+  shadowTree.commit(
+      [&](RootShadowNode::Shared const &oldRootShadowNode) {
+        return std::static_pointer_cast<RootShadowNode>(rootShadowNodeState2);
+      },
+      true);
+
+  EXPECT_EQ(findDescendantNode(shadowTree, family)->getState(), state3);
+}