mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
David Biedenbach
df9abf7983
Summary: This PR addresses issue https://github.com/facebook/react-native/issues/23870 (`View.getGlobalVisibleRect()` is broken in some use cases) The issue affects the following Android APIs: - ViewGroup.getChildVisibleRect() - View.getGlobalVisibleRect() (Which calls into ViewGroup.getChildVisibleRect) - View.getLocalVisibleRect() (Which calls into View.getGlobalVisibleRect()) According to Android documentation, View.getGlobalVisibleRect() should provide a rect for a given view that has been clipped by the bounds of all of its parent views up the view hierarchy. It does so through the use of the recursive function ViewGroup.getChildVisibleRect(). Since React Native has a separate clipping mechanism that does not rely on Android UI's clipping implementation, ViewGroup.getChildVisibleRect() is unable to determine that a rect should be clipped if the clipping view is a ReactClippingViewGroup. This resultantly breaks some important use cases for things like testing with Detox, which relies on this functionality to tell when a component is on-screen, as explained in the above referenced issue. The rationale of the fix is essentially to implement logic analogous to [ViewGroup.getChildVisibleRect()](https://android.googlesource.com/platform/frameworks/base/+/master/core/java/android/view/ViewGroup.java#6176), discarding irrelevant Android clipping modes, and instead testing against the 'overflow' property, restoring the originally intended functionality. This is implemented as an override to ViewGroup.getChildVisibleRect() in the following classes: - ReactViewGroup - ReactScrollView - ReactHorizontalScrollView Unfortunately, since the public ViewGroup.getChildVisibleRect() API recurses into a `hide` annotated API which cannot be overridden, it was necessary to provide this override in each of the above React Native classes to ensure the superclass implementation would not be called, which would break the recursion. ## Changelog [Android] [Fixed] - View.getGlobalVisibleRect() clips result rect properly when overflow is 'hidden' Pull Request resolved: https://github.com/facebook/react-native/pull/26334 Test Plan: The functionality in question is neither used internally nor exposed by React Native, and thus only affects Android native modules that use the above referenced APIs. As such, I have primarily performed testing with a forked example project that had been submitted with issue https://github.com/facebook/react-native/issues/23870, originally by d4vidi. The example project can be found here: - [Configured to build against RN Master](https://github.com/davidbiedenbach/RNClipVisibilityBugDemo/tree/rn-master) - [Configured to build against PR branch](https://github.com/davidbiedenbach/RNClipVisibilityBugDemo/tree/fix-23870) (Original project here: https://github.com/d4vidi/RNClipVisibilityBugDemo) ### Bug in effect: When built against RN master, it can be observed that fully clipped views are reported as visible, as in the below screenshots. #### Views inside a ReactViewGroup do not report as clipped  #### Views inside a ReactScrollView do not report as clipped  #### Views inside a ReactHorizontalScrollView do not report clipping properly  ### Bug fixed When built against the PR branch, fully-clipped views no longer report visible. #### Views inside a ReactViewGroup report clipping properly  #### Views inside a ReactScrollView report clipping properly  #### Views inside a ReactHorizontalScrollView report clipping properly  Reviewed By: mdvacca Differential Revision: D17782658 Pulled By: yungsters fbshipit-source-id: 0cd0d385898579a7a8a3e453f6ba681679ebe496
Building React Native for Android
See the docs on the website.
Running tests
When you submit a pull request CircleCI will automatically run all tests. To run tests locally, see Testing.