status-im/react-native
2
0
Fork 0
mirror of https://github.com/status-im/react-native.git synced 2025-01-28 10:14:49 +00:00
Code Issues Projects Releases Wiki Activity

Fix a bug with ListView with sticky headers + RefreshControl

Browse Source 
Summary:The bug is caused by a weird race condition. What happens is that when calling `UIRefreshControl#endRefreshing` the `UIScrollView` delegate `scrollViewDidScroll` function is called synchronously and then `dockClosestSectionHeader` crashes because the sticky header indexes are updated but not the contentView children.

I fixed it by adding an updating property on `RCTRefreshControl` and setting it before calling `endRefreshing` so we can know not to call `dockClosestSectionHeader` at that moment.

Tested with both `RefreshControl` and `onRefreshStart` prop.

I reproduced the bug by replacing ListViewExample.js in UIExplorer with https://gist.github.com/janicduplessis/05fc58e852f3e80e51b9

Fixes #5440

cc nicklockwood
Closes https://github.com/facebook/react-native/pull/5445

Differential Revision: D2953984

Pulled By: nicklockwood

fb-gh-sync-id: c17a6a75ab31ef54d478706ed17a8115a11d734e
shipit-source-id: c17a6a75ab31ef54d478706ed17a8115a11d734e
This commit is contained in:
Janic Duplessis 2016-02-19 05:54:46 -08:00 committed by facebook-github-bot-6
parent 183d6a088c
commit 671b975d92
2 changed files with 20 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
React/Views/RCTRefreshControl.m
View File

@ -30,7 +30,7 @@ RCT_NOT_IMPLEMENTED(- (instancetype)initWithCoder:(NSCoder *)aDecoder)
- (void)layoutSubviews - (void)layoutSubviews
{ {
[super layoutSubviews]; [super layoutSubviews];
// If the control is refreshing when mounted we need to call // If the control is refreshing when mounted we need to call
// beginRefreshing in layoutSubview or it doesn't work. // beginRefreshing in layoutSubview or it doesn't work.
if (_isInitialRender && _initialRefreshingState) { if (_isInitialRender && _initialRefreshingState) {
@ -46,9 +46,7 @@ RCT_NOT_IMPLEMENTED(- (instancetype)initWithCoder:(NSCoder *)aDecoder)
CGPoint offset = {scrollView.contentOffset.x, scrollView.contentOffset.y - self.frame.size.height}; CGPoint offset = {scrollView.contentOffset.x, scrollView.contentOffset.y - self.frame.size.height};
// Don't animate when the prop is set initialy. // Don't animate when the prop is set initialy.
if (_isInitialRender) { if (_isInitialRender) {
// Must use `[scrollView setContentOffset:offset animated:NO]` instead of just setting scrollView.contentOffset = offset;
// `scrollview.contentOffset` or it doesn't work, don't ask me why!
[scrollView setContentOffset:offset animated:NO];
[super beginRefreshing]; [super beginRefreshing];
} else { } else {
// `beginRefreshing` must be called after the animation is done. This is why it is impossible // `beginRefreshing` must be called after the animation is done. This is why it is impossible

23
React/Views/RCTScrollView.m
View File

@ -145,7 +145,7 @@ RCT_NOT_IMPLEMENTED(- (instancetype)init)
@property (nonatomic, copy) NSIndexSet *stickyHeaderIndices; @property (nonatomic, copy) NSIndexSet *stickyHeaderIndices;
@property (nonatomic, assign) BOOL centerContent; @property (nonatomic, assign) BOOL centerContent;
@property (nonatomic, strong) UIRefreshControl *refreshControl; @property (nonatomic, strong) RCTRefreshControl *refreshControl;
@end @end
@ -287,10 +287,12 @@ RCT_NOT_IMPLEMENTED(- (instancetype)init)
__block UIView *nextHeader = nil; __block UIView *nextHeader = nil;
NSUInteger subviewCount = contentView.reactSubviews.count; NSUInteger subviewCount = contentView.reactSubviews.count;
[_stickyHeaderIndices enumerateIndexesWithOptions:0 usingBlock: [_stickyHeaderIndices enumerateIndexesWithOptions:0 usingBlock:
^(NSUInteger idx, __unused BOOL *stop) { ^(NSUInteger idx, BOOL *stop) {
// If the subviews are out of sync with the sticky header indices don't
// do anything.
if (idx >= subviewCount) { if (idx >= subviewCount) {
RCTLogError(@"Sticky header index %zd was outside the range {0, %zd}", idx, subviewCount); *stop = YES;
return; return;
} }
@ -365,7 +367,7 @@ RCT_NOT_IMPLEMENTED(- (instancetype)init)
return hitView ?: [super hitTest:point withEvent:event]; return hitView ?: [super hitTest:point withEvent:event];
} }
- (void)setRefreshControl:(UIRefreshControl *)refreshControl - (void)setRefreshControl:(RCTRefreshControl *)refreshControl
{ {
if (_refreshControl) { if (_refreshControl) {
[_refreshControl removeFromSuperview]; [_refreshControl removeFromSuperview];
@ -826,6 +828,17 @@ RCT_SCROLL_EVENT_HANDLER(scrollViewDidZoom, RCTScrollEventTypeMove)
_scrollView.contentSize = contentSize; _scrollView.contentSize = contentSize;
_scrollView.contentOffset = newOffset; _scrollView.contentOffset = newOffset;
} }
if (RCT_DEBUG) {
// Validate that sticky headers are not out of range.
NSUInteger subviewCount = _scrollView.contentView.reactSubviews.count;
NSUInteger lastIndex = _scrollView.stickyHeaderIndices.lastIndex;
if (lastIndex != NSNotFound && lastIndex >= subviewCount) {
RCTLogWarn(@"Sticky header index %zd was outside the range {0, %zd}",
lastIndex, subviewCount);
}
}
[_scrollView dockClosestSectionHeader]; [_scrollView dockClosestSectionHeader];
} }
@ -888,7 +901,7 @@ RCT_SET_AND_PRESERVE_OFFSET(setScrollIndicatorInsets, UIEdgeInsets);
_onRefreshStart = [onRefreshStart copy]; _onRefreshStart = [onRefreshStart copy];
if (!_scrollView.refreshControl) { if (!_scrollView.refreshControl) {
UIRefreshControl *refreshControl = [[UIRefreshControl alloc] init]; RCTRefreshControl *refreshControl = [[RCTRefreshControl alloc] init];
[refreshControl addTarget:self action:@selector(refreshControlValueChanged) forControlEvents:UIControlEventValueChanged]; [refreshControl addTarget:self action:@selector(refreshControlValueChanged) forControlEvents:UIControlEventValueChanged];
_scrollView.refreshControl = refreshControl; _scrollView.refreshControl = refreshControl;
} }