Skip to content

Commit 40c4620

Browse files
authored
Use consistent revisions for ResizeObserver measurements
Summary: ## Context With commit branching enabled, a React commit updates the pending React revision before it is promoted to the main shadow-tree revision. Reading the main revision directly can make `ResizeObserver` report newly mounted targets as detached with zero sizes, or report stale sizes during callback-driven updates. ## Changes - Use the existing `ShadowTreeRevisionProvider` exposed by UIManager’s consistency manager, rather than choosing the main or React revision directly. - Obtain resize-observation snapshots through the same revision-selection and caching policy used by JavaScript layout reads. - Add public-behavior tests for subscriptions from ref callbacks and layout effects, comparing delivered sizes with layout reads during the callback. - Run the existing ResizeObserver suite with commit branching both enabled and disabled, including its callback-driven resize feedback case. Changelog: [General][Fixed] - Report consistent committed sizes from `ResizeObserver` when commit branching is enabled Differential Revision: D133269095 Pull Request resolved: #60159
1 parent 18cd3ae commit 40c4620

3 files changed

Lines changed: 66 additions & 11 deletions

File tree

‎packages/react-native/ReactCommon/react/renderer/observers/resize/ResizeObserverManager.cpp‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
#include <cxxreact/TraceSection.h>
1010
#include <glog/logging.h>
1111
#include <react/renderer/core/LayoutableShadowNode.h>
12+
#include <react/renderer/uimanager/consistency/ShadowTreeRevisionProvider.h>
1213
#include <react/utils/OnScopeExit.h>
1314
#include <algorithm>
1415
#include <unordered_set>
@@ -130,7 +131,7 @@ void ResizeObserverManager::connect(
130131

131132
runtimeScheduler.setResizeObserverDelegate(this);
132133
uiManager.registerCommitHook(*this);
133-
shadowTreeRegistry_ = &uiManager.getShadowTreeRegistry();
134+
shadowTreeRevisionProvider_ = uiManager.getShadowTreeRevisionProvider();
134135
commitHookRegistered_ = true;
135136
}
136137

@@ -146,7 +147,7 @@ void ResizeObserverManager::disconnect(
146147

147148
runtimeScheduler.setResizeObserverDelegate(nullptr);
148149
uiManager.unregisterCommitHook(*this);
149-
shadowTreeRegistry_ = nullptr;
150+
shadowTreeRevisionProvider_ = nullptr;
150151

151152
// May run from inside `broadcastActiveResizeObservations` (a callback can
152153
// disconnect the last observer), which copies the callable before invoking
@@ -316,15 +317,13 @@ ResizeObserverManager::gatherActiveResizeObservations(size_t depth) {
316317
GatherResult gatherResult;
317318

318319
// Null once `disconnect` ran; nothing left to observe against.
319-
if (candidateSurfaceIds.empty() || shadowTreeRegistry_ == nullptr) {
320+
if (candidateSurfaceIds.empty() || shadowTreeRevisionProvider_ == nullptr) {
320321
return gatherResult;
321322
}
322323

323324
for (auto surfaceId : candidateSurfaceIds) {
324-
auto rootShadowNode = std::shared_ptr<const RootShadowNode>();
325-
shadowTreeRegistry_->visit(surfaceId, [&](const auto& shadowTree) {
326-
rootShadowNode = shadowTree.getCurrentRevision().rootShadowNode;
327-
});
325+
auto rootShadowNode =
326+
shadowTreeRevisionProvider_->getCurrentRevision(surfaceId);
328327

329328
if (rootShadowNode == nullptr) {
330329
// The surface was stopped, so its families are dead and can never report

‎packages/react-native/ReactCommon/react/renderer/observers/resize/ResizeObserverManager.h‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212
#include <jsi/jsi.h>
1313
#include <react/renderer/core/ShadowNodeFamily.h>
1414
#include <react/renderer/mounting/ShadowTree.h>
15-
#include <react/renderer/mounting/ShadowTreeRegistry.h>
1615
#include <react/renderer/runtimescheduler/RuntimeScheduler.h>
1716
#include <react/renderer/runtimescheduler/RuntimeSchedulerResizeObserverDelegate.h>
1817
#include <react/renderer/uimanager/UIManager.h>
@@ -29,6 +28,8 @@
2928

3029
namespace facebook::react {
3130

31+
class ShadowTreeRevisionProvider;
32+
3233
class ResizeObserverManager final : public UIManagerCommitHook, public RuntimeSchedulerResizeObserverDelegate {
3334
public:
3435
ResizeObserverManager();
@@ -123,7 +124,7 @@ class ResizeObserverManager final : public UIManagerCommitHook, public RuntimeSc
123124
// tick, so it is safe to retain it as a raw pointer.
124125
// We need to retain it here because the RuntimeScheduler does not provide
125126
// it when calling `runResizeObservations`.
126-
const ShadowTreeRegistry *shadowTreeRegistry_{nullptr};
127+
ShadowTreeRevisionProvider *shadowTreeRevisionProvider_{nullptr};
127128

128129
mutable std::vector<ResizeObserverEntry> pendingEntries_;
129130
mutable std::mutex pendingEntriesMutex_;

‎packages/react-native/src/private/webapis/resizeobserver/__tests__/ResizeObserver-itest.js‎

Lines changed: 57 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
* This source code is licensed under the MIT license found in the
55
* LICENSE file in the root directory of this source tree.
66
*
7-
* @fantom_flags enableResizeObserverByDefault:true
7+
* @fantom_flags enableResizeObserverByDefault:true enableFabricCommitBranching:*
88
* @flow strict-local
99
* @format
1010
*/
@@ -20,7 +20,7 @@ import {createShadowNodeReferenceCountingRef} from '../../../__tests__/utilities
2020
import * as Fantom from '@react-native/fantom';
2121
import nullthrows from 'nullthrows';
2222
import * as React from 'react';
23-
import {createRef} from 'react';
23+
import {createRef, useLayoutEffect} from 'react';
2424
import {View} from 'react-native';
2525

2626
declare const ResizeObserver: Class<ResizeObserverType>;
@@ -1562,6 +1562,61 @@ describe('ResizeObserver', () => {
15621562
});
15631563

15641564
describe('delivery timing', () => {
1565+
it('should report the committed size when observing from a ref callback', () => {
1566+
const root = Fantom.createRoot();
1567+
const sizes: Array<[number, number]> = [];
1568+
Fantom.runTask(() => {
1569+
observer = new ResizeObserver(entries => {
1570+
const entry = entries[0];
1571+
sizes.push([
1572+
entry.contentRect.width,
1573+
entry.target.getBoundingClientRect().width,
1574+
]);
1575+
});
1576+
root.render(
1577+
<View
1578+
style={{width: 100, height: 50}}
1579+
ref={node => {
1580+
if (node != null) {
1581+
observer.observe(node);
1582+
}
1583+
}}
1584+
/>,
1585+
);
1586+
});
1587+
expect(sizes).toEqual([[100, 100]]);
1588+
});
1589+
1590+
it('should report the committed size when observing from a layout effect', () => {
1591+
const root = Fantom.createRoot();
1592+
const nodeRef = createRef<HostInstance>();
1593+
const sizes: Array<[number, number]> = [];
1594+
component Box(width: number) {
1595+
useLayoutEffect(() => {
1596+
const node = nullthrows(nodeRef.current);
1597+
observer.observe(node);
1598+
return () => observer.unobserve(node);
1599+
}, []);
1600+
return <View ref={nodeRef} style={{width, height: 50}} />;
1601+
}
1602+
Fantom.runTask(() => {
1603+
observer = new ResizeObserver(entries => {
1604+
const entry = entries[0];
1605+
sizes.push([
1606+
entry.contentRect.width,
1607+
entry.target.getBoundingClientRect().width,
1608+
]);
1609+
});
1610+
root.render(<Box width={100} />);
1611+
});
1612+
expect(sizes).toEqual([[100, 100]]);
1613+
Fantom.runTask(() => root.render(<Box width={200} />));
1614+
expect(sizes).toEqual([
1615+
[100, 100],
1616+
[200, 200],
1617+
]);
1618+
});
1619+
15651620
it('should deliver observations before a task scheduled from the same tick', () => {
15661621
const nodeRef = createRef<HostInstance>();
15671622
const root = Fantom.createRoot();

0 commit comments

Comments
 (0)