mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Kacper Kafara
f402ed17fa
Summary: Related PR in `react-native-screens`: * https://github.com/software-mansion/react-native-screens/pull/2495 Additional context: * [my detailed explanation of **one of the issues**](https://github.com/software-mansion/react-native-screens/pull/2495#issuecomment-2478915818) * [Android Developer: ViewGroup.startViewTransition docs](https://developer.android.com/reference/android/view/ViewGroup#startViewTransition(android.view.View)) ### Background On Android view groups can be marked as "transitioning" with a `ViewGroup.startViewTransition` call. This effectively ensures, that in case a view group is marked with this call and its children are removed, they will be still drawn until `endViewTransition` is not called. This mechanism is implemented in Android by [keeping track of "transitioning" children in auxiliary `mTransitioningViews` array](https://android.googlesource.com/platform/frameworks/base/+/master/core/java/android/view/ViewGroup.java#7178). Then when such "transitioning" child is removed, [it is removed from children array](https://android.googlesource.com/platform/frameworks/base/+/master/core/java/android/view/ViewGroup.java#5595) but it's [parent-child relationship is not cleared](https://android.googlesource.com/platform/frameworks/base/+/master/core/java/android/view/ViewGroup.java#5397) and it is still retained in the auxiliary array. Having that established we can proceed with problem description. ### Problem https://github.com/user-attachments/assets/d0356bf5-2f17-4b06-ba53-bfca659a1071 <details> <summary>Full code</summary> ```javascript import { NavigationContainer } from 'react-navigation/native'; import React from 'react'; import { createNativeStackNavigator } from 'react-navigation/native-stack'; import { enableScreens } from 'react-native-screens'; import { StyleSheet, Text, View, FlatList, Button, ViewProps, Image, FlatListProps, findNodeHandle, } from 'react-native'; enableScreens(true); function Item({ children, ...props }: ViewProps) { return ( <View style={styles.item} {...props}> <Image source={require('../assets/trees.jpg')} style={styles.image} /> <Text style={styles.text}>{children}</Text> </View> ); } function Home({ navigation }: any) { return ( <View style={styles.container}> <Button title="Go to List" onPress={() => navigation.navigate('List')} /> </View> ); } function ListScreenSimplified({secondVisible}: {secondVisible?: (visible: boolean) => void}) { const containerRef = React.useRef<View>(null); const innerViewRef = React.useRef<View>(null); const childViewRef = React.useRef<View>(null); React.useEffect(() => { if (containerRef.current != null) { const tag = findNodeHandle(containerRef.current); console.log(`Container has tag [${tag}]`); } if (innerViewRef.current != null) { const tag = findNodeHandle(innerViewRef.current); console.log(`InnerView has tag [${tag}]`); } if (childViewRef.current != null) { const tag = findNodeHandle(childViewRef.current); console.log(`ChildView has tag [${tag}]`); } }, [containerRef.current, innerViewRef.current, childViewRef.current]); return ( <View ref={containerRef} style={{ flex: 1, backgroundColor: 'slateblue', overflow: 'hidden' }} removeClippedSubviews={false}> <View ref={innerViewRef} removeClippedSubviews style={{ height: '100%' }}> <View ref={childViewRef} style={{ backgroundColor: 'pink', width: '100%', height: 50 }} removeClippedSubviews={false}> {secondVisible && (<Button title='Hide second' onPress={() => secondVisible(false)} />)} </View> </View> </View> ); } function ParentFlatlist(props: Partial<FlatListProps<number>>) { return ( <FlatList data={Array.from({ length: 30 }).fill(0) as number[]} renderItem={({ index }) => { if (index === 10) { return <NestedFlatlist key={index} />; } else if (index === 15) { return <ExtraNestedFlatlist key={index} />; } else if (index === 20) { return <NestedFlatlist key={index} horizontal />; } else if (index === 25) { return <ExtraNestedFlatlist key={index} horizontal />; } else { return <Item key={index}>List item {index + 1}</Item>; } }} {...props} /> ); } function NestedFlatlist(props: Partial<FlatListProps<number>>) { return ( <FlatList style={[styles.nestedList, props.style]} data={Array.from({ length: 10 }).fill(0) as number[]} renderItem={({ index }) => ( <Item key={'nested' + index}>Nested list item {index + 1}</Item> )} {...props} /> ); } function ExtraNestedFlatlist(props: Partial<FlatListProps<number>>) { return ( <FlatList style={styles.nestedList} data={Array.from({ length: 10 }).fill(0) as number[]} renderItem={({ index }) => index === 4 ? ( <NestedFlatlist key={index} style={{ backgroundColor: '#d24729' }} /> ) : ( <Item key={'nested' + index}>Nested list item {index + 1}</Item> ) } {...props} /> ); } const Stack = createNativeStackNavigator(); export default function App(): React.JSX.Element { return ( <NavigationContainer> <Stack.Navigator screenOptions={{ animation: 'slide_from_right' }}> <Stack.Screen name="Home" component={Home} /> <Stack.Screen name="List" component={ListScreenSimplified}/> </Stack.Navigator> </NavigationContainer> ); } export function AppSimple(): React.JSX.Element { const [secondVisible, setSecondVisible] = React.useState(false); return ( <View style={{ flex: 1, backgroundColor: 'lightsalmon' }}> {!secondVisible && ( <View style={{ flex: 1, backgroundColor: 'lightblue' }} > <Button title='Show second' onPress={() => setSecondVisible(true)} /> </View> )} {secondVisible && ( <ListScreenSimplified secondVisible={setSecondVisible} /> )} </View> ); } const styles = StyleSheet.create({ container: { flex: 1, alignItems: 'center', justifyContent: 'center', }, nestedList: { backgroundColor: '#FFA07A', }, item: { flexDirection: 'row', alignItems: 'center', padding: 10, gap: 10, }, text: { fontSize: 24, fontWeight: 'bold', color: 'black', }, image: { width: 50, height: 50, }, }); ``` </details> Explanation (copied from [here](https://github.com/software-mansion/react-native-screens/pull/2495#issuecomment-2478915818)): I've debugged this for a while now & I have good understanding of what's going on. This bug is caused by our usage of `startViewTransition` and its implications. We use it well, however React does not account for case that some view might be in transition. Error mechanism is as follows: 1. Let's have initially simple stack with two screens: "A, B". This is component rendered under "B": ```javascript <View //<-- ContainerView (CV) removeClippedSubviews={false} style={{ flex: 1, backgroundColor: 'slateblue', overflow: 'hidden' }}> <View removeClippedSubviews style={{ height: '100%' }}> // <--- IntermediateView (IV) <View removeClippedSubviews={false} style={{ backgroundColor: 'pink', width: '100%', height: 50 }} /> // <--- ChildView (ChV) </View> </View> ``` 2. We press the back button. 3. We're on Fabric, therefore subtree of B gets destroyed before B itself is unmounted -> in our commit hook we detect that the screen B will be unmounted & we mark every node under B as transitioning by calling `startViewTransition`. 4. React Mounting stage starts, view hierarchy is disassembled in bottom-up fashion (leafs first). 5. ReactViewGroupManager receives MountItem to detach ChV from IV. 6. A call to [`IV.removeView(ChV)` is made](https://github.com/facebook/react-native/blob/9c11d7ca68c5c62ab7bab9919161d8417e96b28b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/views/view/ReactClippingViewManager.kt#L58-L73), which effectively removes ChV from `IV.children`, ***HOWEVER*** it does not clear `ChV.parent`, meaning that after the call, `ChV.parent == IV`. This happens, due to view being marked as in-transition by our call to `startViewTransition`. If the view is not marked as in-transition this parent-child relationship is removed. 7. IV has `removeClippedSubviews` enabled, therefore a [call to `IV.removeViewWithSubviewsClippingEnabled(ChV)` is made](https://github.com/facebook/react-native/blob/9c11d7ca68c5c62ab7bab9919161d8417e96b28b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/views/view/ReactClippingViewManager.kt#L68). [This function](https://github.com/facebook/react-native/blob/9c11d7ca68c5c62ab7bab9919161d8417e96b28b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/views/view/ReactViewGroup.java#L726-L744) does effectively two things: 1. if the ChV has parent (interpretation: it has not yet been detached from parent), we compute it's index in `IV.children` (Android.ViewGroup's state) and remove it from the array, 2. remove the ChV from `mAllChildren` array (this is state maintained by ReactViewGroup for purposes of implementing the "subview clipping" mechanism". The crash happens in 7.1, because ChV has been removed from `IV.children` in step 6, but the parent-child relationship has not been broken up there. Under usual circumstances (this is my hypothesis now, yet unconfirmed) 7.1 does not execute, because `ChV.parent` is nulled in step no. 6. ### Rationale for `startViewTransition` usage Transitions. On Fabric, when some subtree is unmounted, views in the subtree are unmounted in bottom-up order. This leads to uncomfortable situation, where our components (react-native-screens), who want to drive & manage transitions are notified that their children will be removed after the subtrees mounted in screen subviews are already disassembled. **If we start animation in this very moment we will have staggering effect of white flash** [(issue)](https://github.com/software-mansion/react-native-screens/issues/1685) (we animate just the screen with white background without it's children). This was not a problem on Paper, because the order of subtree disassembling was opposite - top-down. While we've managed to workaround this issue on Fabric using `MountingTransactionObserving` protocol on iOS and a commit hook on Android (we can inspect mutations in incoming transaction before it starts being applied) we still need to prevent view hierarchy from being disassembled in the middle of transition (on Paper this has also been less of an issue) - and this is where `startViewTransition` comes in. It allows us to draw views throughout transition after React Native removes them from HostTree model. On iOS we exchange subtree for its snapshot for transition time, however this approach isn't feasible on Android, because [snapshots do not capture shadows](https://stackoverflow.com/questions/42212600/android-screenshot-of-view-with-shadow). ### Possible solutions [Android does not expose a method to verify whether a view is in transition](https://android.googlesource.com/platform/frameworks/base/+/master/core/java/android/view/ViewGroup.java#7162) (it has `package` visibility), therefore we need to retrieve this information with some workaround. I see two posibilities: * first approach would be to override `startViewTransition` & `endViewTransition` in ReactViewGroup and keep the state on whether the view is transitioning there, * second possible approach would be as follows: we can check for "transitioning" view by checking whether a view has parent but is not it's parent child (this **should** be reliable), Having information on whether the view is in transition or not, we can prevent multiple removals of the same view in every call site (currently only in `removeViewAt` if `parent.removeClippingSubviews == true`). Another option would be to do just as this PR does: having in mind this "transitioning" state we can pass a flag to `removeViewWithSubviewClippingEnabled` and prevent duplicated removal from parent if we already know that this has been requested. I can also add override of this method: ```java /*package*/ void removeViewWithSubviewClippingEnabled(View view) { this.removeViewWithSubviewClippingEnabled(view, false); } ``` to make this parameter optional. ## Changelog: [ANDROID] [FIXED] - Handle removal of in-transition views. Pull Request resolved: https://github.com/facebook/react-native/pull/47634 Test Plan: WIP WIP Reviewed By: javache Differential Revision: D66539065 Pulled By: tdn120 fbshipit-source-id: cf1add67000ebd1b5dfdb2048461a55deac10b16
React Native
Learn once, write anywhere:
Build mobile apps with React.
Getting Started · Learn the Basics · Showcase · Contribute · Community · Support
React Native brings React's declarative UI framework to iOS and Android. With React Native, you use native UI controls and have full access to the native platform.
- Declarative. React makes it painless to create interactive UIs. Declarative views make your code more predictable and easier to debug.
- Component-Based. Build encapsulated components that manage their state, then compose them to make complex UIs.
- Developer Velocity. See local changes in seconds. Changes to JavaScript code can be live reloaded without rebuilding the native app.
- Portability. Reuse code across iOS, Android, and other platforms.
React Native is developed and supported by many companies and individual core contributors. Find out more in our ecosystem overview.
Contents
- Requirements
- Building your first React Native app
- Documentation
- Upgrading
- How to Contribute
- Code of Conduct
- License
📋 Requirements
React Native apps may target iOS 15.1 and Android 7.0 (API 24) or newer. You may use Windows, macOS, or Linux as your development operating system, though building and running iOS apps is limited to macOS. Tools like Expo can be used to work around this.
🎉 Building your first React Native app
Follow the Getting Started guide. The recommended way to install React Native depends on your project. Here you can find short guides for the most common scenarios:
📖 Documentation
The full documentation for React Native can be found on our website.
The React Native documentation discusses components, APIs, and topics that are specific to React Native. For further documentation on the React API that is shared between React Native and React DOM, refer to the React documentation.
The source for the React Native documentation and website is hosted on a separate repository, @facebook/react-native-website.
🚀 Upgrading
Upgrading to new versions of React Native may give you access to more APIs, views, developer tools, and other goodies. See the Upgrading Guide for instructions.
React Native releases are discussed in this discussion repo.
👏 How to Contribute
The main purpose of this repository is to continue evolving React Native core. We want to make contributing to this project as easy and transparent as possible, and we are grateful to the community for contributing bug fixes and improvements. Read below to learn how you can take part in improving React Native.
Code of Conduct
Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.
Contributing Guide
Read our Contributing Guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to React Native.
Open Source Roadmap
You can learn more about our vision for React Native in the Roadmap.
Good First Issues
We have a list of good first issues that contain bugs which have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with our contribution process.
Discussions
Larger discussions and proposals are discussed in @react-native-community/discussions-and-proposals.
📄 License
React Native is MIT licensed, as found in the LICENSE file.
React Native documentation is Creative Commons licensed, as found in the LICENSE-docs file.