Add fix for refresh control state's race condition. #21763

rostislav-simonik · 2018-10-12T19:46:17Z

Test Plan:

assign refreshing to true, which initiates beginRefreshingProgrammatically
before beginRefreshingProgrammatically animation ends, change refreshing state by assigning refreshing to false.
animation ends and overrides real state (refreshing: false) into previous state (refreshing: true)

Release Notes:

[BUGFIX][iOS][RefreshControl] Fix race condition that would overwrite state changes

facebook-github-bot · 2018-10-12T19:46:24Z

Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. In order for us to review and merge your code, please sign up at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need the corporate CLA signed.

If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks!

facebook-github-bot · 2018-10-12T19:59:00Z

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

pull-bot · 2018-10-12T20:02:34Z

	Messages
📖	📋 Missing Summary - Can you add a Summary? To do so, add a "## Summary" section to your PR description. This is a good place to explain the motivation for making this change.
📖	📋 Missing Test Plan - Can you add a Test Plan? To do so, add a "## Test Plan" section to your PR description. A Test Plan lets us know how these changes were tested.
📖	📋 Changelog Format - Did you include a Changelog? A changelog entry has the following format: `[CATEGORY] [TYPE] - Message`.

Generated by 🚫 dangerJS against 786c7fc

matthargett · 2018-11-10T01:06:50Z

can you add an e2e test? also release notes like [BUGFIX][iOS][RefreshControl] Fix race condition that would overwrite state changes should suffice.

rostislav-simonik · 2018-11-10T05:36:54Z

can you add an e2e test? also release notes like [BUGFIX][iOS][RefreshControl] Fix race condition that would overwrite state changes should suffice.

Release notes changed.
e2e test - Could you please give me an example, maybe another pull request. I've never done e2e test for this platform, but it's not problem to do it. Just need some directions.

cpojer · 2019-01-22T14:26:03Z

Ping @matthargett: could you provide a quick guide for writing an e2e test for this PR?

matthargett

I see in the originating issues that this doesn’t repro in a simulator, only on a real device. As such, never mind the e2e test ask.

cpojer

Alright, I'll land it. One thing to keep in mind here is because it is using local client time, changing the device time could break this behavior, no?

facebook-github-bot

@cpojer is landing this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

cpojer · 2019-02-13T12:48:47Z

Fails internally with:

error: unable to find developer root
react-native/React/Views/RCTRefreshControl.m:68:55: error: block implicitly retains 'self'; explicitly mention 'self' to indicate this is intended behavior [-Werror,-Wimplicit-retain-self]
                       if(beginRefreshingTimestamp == _currentRefreshingStateTimestamp) {
                                                      ^
react-native/React/Views/RCTRefreshControl.m:89:53: error: block implicitly retains 'self'; explicitly mention 'self' to indicate this is intended behavior [-Werror,-Wimplicit-retain-self]
                       if(endRefreshingTimestamp == _currentRefreshingStateTimestamp) {
                                                    ^
stderr: react-native/React/Views/RCTRefreshControl.m:68:55: error: block implicitly retains 'self'; explicitly mention 'self' to indicate this is intended behavior [-Werror,-Wimplicit-retain-self]
                       if(beginRefreshingTimestamp == _currentRefreshingStateTimestamp) {
                                                      ^
react-native/React/Views/RCTRefreshControl.m:89:53: error: block implicitly retains 'self'; explicitly mention 'self' to indicate this is intended behavior [-Werror,-Wimplicit-retain-self]
                       if(endRefreshingTimestamp == _currentRefreshingStateTimestamp) {
                                                    ^

Could you fix this up?

@matthargett do you know if there is a way to enable the same error on React Native GitHub? This seems to come up frequently.

rostislav-simonik · 2019-02-13T12:58:38Z

Alright, I'll land it. One thing to keep in mind here is because it is using local client time, changing the device time could break this behavior, no?

Yes, I've got idea later that could be done by logical clock instead.

rostislav-simonik · 2019-02-13T13:38:47Z

Fails internally with:

error: unable to find developer root
react-native/React/Views/RCTRefreshControl.m:68:55: error: block implicitly retains 'self'; explicitly mention 'self' to indicate this is intended behavior [-Werror,-Wimplicit-retain-self]
                       if(beginRefreshingTimestamp == _currentRefreshingStateTimestamp) {
                                                      ^
react-native/React/Views/RCTRefreshControl.m:89:53: error: block implicitly retains 'self'; explicitly mention 'self' to indicate this is intended behavior [-Werror,-Wimplicit-retain-self]
                       if(endRefreshingTimestamp == _currentRefreshingStateTimestamp) {
                                                    ^
stderr: react-native/React/Views/RCTRefreshControl.m:68:55: error: block implicitly retains 'self'; explicitly mention 'self' to indicate this is intended behavior [-Werror,-Wimplicit-retain-self]
                       if(beginRefreshingTimestamp == _currentRefreshingStateTimestamp) {
                                                      ^
react-native/React/Views/RCTRefreshControl.m:89:53: error: block implicitly retains 'self'; explicitly mention 'self' to indicate this is intended behavior [-Werror,-Wimplicit-retain-self]
                       if(endRefreshingTimestamp == _currentRefreshingStateTimestamp) {
                                                    ^

Could you fix this up?

Done.

cpojer · 2019-02-13T13:58:09Z

Thank you so much for the changes!

@matthargett could you do a second review of this given that it is now using a slightly different approach? Thank you.

facebook-github-bot · 2019-02-14T00:49:00Z

I tried to merge this pull request into the Facebook internal repo but some checks failed. To unblock yourself please check the following: Does this pull request pass all open source tests on GitHub? If not please fix those. Does the code still apply cleanly on top of GitHub master? If not can please rebase. In all other cases this means some internal test failed, for example a part of a fb app won't work with this pull request. I've added the Import Failed label to this pull request so it is easy for someone at fb to find the pull request and check what failed. If you don't see anyone comment in a few days feel free to comment mentioning one of the core contributors to the project so they get a notification.

…k warning.

matthargett · 2019-02-14T17:26:55Z

React/Views/RCTRefreshControl.m

+- (void)setCurrentRefreshingState:(BOOL)refreshing
+{
+  _currentRefreshingState = refreshing;
+  _currentRefreshingStateTimestamp = _currentRefreshingStateClock++;


currentRefreshingStateClock is never decremented. Was this meant to track/prevent other potential races where it could go above 1 or 2?

@matthargett no, it shouldn't because I used logical clock. Every time refreshSetCurrentRefreshingState is called i need unique timestamp. This time stamp is used in animation window which starts on
https://github.com/facebook/react-native/pull/21763/files#diff-cfafa8d7e42ab87ab863f917e187a4aeR56
and ends on
https://github.com/facebook/react-native/pull/21763/files#diff-cfafa8d7e42ab87ab863f917e187a4aeR70
and if timestamp is still the same, then state can be safely set, otherwise it should be thrown away due something else changed state and increased clock timestamp.

I've just changed that due i used local date time before, and as @cpojer has noted changing os date time can have impact on that logic. But in real life it wouldn't harm logic at all because chance that somebody changes os date time, and in that moment will trigger race condition described above, is astronomically low. But to prevent confusion, I've rid of that logic and replaced local date time with logical clock.

facebook-github-bot

@cpojer is landing this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

react-native-bot · 2019-02-15T10:55:04Z

@rostislav-simonik merged commit 95d399b into facebook:master.

Summary: Fixes #21762 Pull Request resolved: #21763 Differential Revision: D14064621 Pulled By: cpojer fbshipit-source-id: 63010248a46cb49ed17ed89d7c55945aa7b22973

rostislav-simonik requested a review from shergin as a code owner October 12, 2018 19:46

facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Oct 12, 2018

react-native-bot added the ✅Release Notes label Oct 12, 2018

matthargett approved these changes Feb 13, 2019

View reviewed changes

cpojer approved these changes Feb 13, 2019

View reviewed changes

facebook-github-bot added the Import Started This pull request has been imported. This does not imply the PR has been approved. label Feb 13, 2019

facebook-github-bot approved these changes Feb 13, 2019

View reviewed changes

facebook-github-bot added Import Failed and removed Import Started This pull request has been imported. This does not imply the PR has been approved. labels Feb 14, 2019

rostislav-simonik and others added 3 commits February 14, 2019 13:30

Add fix for refresh control state's race condition.

935c598

Replace local date time with logical clock. Fix implicit self in bloc…

09d241f

…k warning.

Update RCTRefreshControl.m

786c7fc

rostislav-simonik force-pushed the fix/refresh-control-race-condition branch from f76b815 to 786c7fc Compare February 14, 2019 12:31

matthargett reviewed Feb 14, 2019

View reviewed changes

facebook-github-bot added the Import Started This pull request has been imported. This does not imply the PR has been approved. label Feb 15, 2019

facebook-github-bot approved these changes Feb 15, 2019

View reviewed changes

facebook-github-bot closed this in 95d399b Feb 15, 2019

facebook locked as resolved and limited conversation to collaborators Feb 15, 2019

react-native-bot added the Merged This PR has been merged. label Feb 15, 2019

hramos removed Import Failed Import Started This pull request has been imported. This does not imply the PR has been approved. labels Feb 23, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add fix for refresh control state's race condition. #21763

Add fix for refresh control state's race condition. #21763

rostislav-simonik commented Oct 12, 2018 •

edited

Loading

facebook-github-bot commented Oct 12, 2018

facebook-github-bot commented Oct 12, 2018

pull-bot commented Oct 12, 2018 •

edited

Loading

matthargett commented Nov 10, 2018

rostislav-simonik commented Nov 10, 2018

cpojer commented Jan 22, 2019

matthargett left a comment

cpojer left a comment

facebook-github-bot left a comment

cpojer commented Feb 13, 2019

rostislav-simonik commented Feb 13, 2019

rostislav-simonik commented Feb 13, 2019 •

edited

Loading

cpojer commented Feb 13, 2019

facebook-github-bot commented Feb 14, 2019

matthargett Feb 14, 2019

rostislav-simonik Feb 14, 2019 •

edited

Loading

rostislav-simonik Feb 14, 2019

facebook-github-bot left a comment

react-native-bot commented Feb 15, 2019

Add fix for refresh control state's race condition. #21763

Add fix for refresh control state's race condition. #21763

Conversation

rostislav-simonik commented Oct 12, 2018 • edited Loading

Test Plan:

Release Notes:

facebook-github-bot commented Oct 12, 2018

facebook-github-bot commented Oct 12, 2018

pull-bot commented Oct 12, 2018 • edited Loading

matthargett commented Nov 10, 2018

rostislav-simonik commented Nov 10, 2018

cpojer commented Jan 22, 2019

matthargett left a comment

Choose a reason for hiding this comment

cpojer left a comment

Choose a reason for hiding this comment

facebook-github-bot left a comment

Choose a reason for hiding this comment

cpojer commented Feb 13, 2019

rostislav-simonik commented Feb 13, 2019

rostislav-simonik commented Feb 13, 2019 • edited Loading

cpojer commented Feb 13, 2019

facebook-github-bot commented Feb 14, 2019

matthargett Feb 14, 2019

Choose a reason for hiding this comment

rostislav-simonik Feb 14, 2019 • edited Loading

Choose a reason for hiding this comment

rostislav-simonik Feb 14, 2019

Choose a reason for hiding this comment

facebook-github-bot left a comment

Choose a reason for hiding this comment

react-native-bot commented Feb 15, 2019

rostislav-simonik commented Oct 12, 2018 •

edited

Loading

pull-bot commented Oct 12, 2018 •

edited

Loading

rostislav-simonik commented Feb 13, 2019 •

edited

Loading

rostislav-simonik Feb 14, 2019 •

edited

Loading