Bugfix - Network Reachability #2688
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Prior to this change, the reachability listener was notified at launch if the device was not in airplane mode. When in airplane mode, the reachability flags were 0, which is what we were defaulting the previous flags to. Because of this, the notifyListener function would early out since the flags had not changed. The core issue here was that the default value of previousFlags was poorly chosen. It should instead default to a value that represents and unknown status. One way to do this would be to make previousFlags an optional. However, this change would not be backwards compatible, so it was abandoned. The best backwards compatible way to make this change was to set previousFlags to a rawValue that is not currently used. That way, we can guarantee that the originally computed flags will be different than the default previous flags. This change results in the listener being called at launch even when in airplane mode. Please refer to issue #2677 for more details.
cnoon
force-pushed
the
bugfix/network-reachability
branch
from
164c738
to
b050cc6
Compare
cnoon
force-pushed
the
bugfix/network-reachability
branch
from
b050cc6
to
6f01350
Compare
1 task
cnoon
commented
Jan 15, 2019
| </tableViewCell> | ||
| </cells> | ||
| </tableViewSection> | ||
| <tableViewSection headerTitle="Reachability" id="7nc-cQ-nUY"> |
There was a problem hiding this comment.
Added a new Reachability section with a Reachability Status cell that prints out the reachability status when you tap it. All of the other changes are just Xcode feeling the need to rebuild the entire storyboard.
|
Wow good timing! I was actually looking into this yesterday because I was encountering the same issue, I'll take a look and see if your patch fixes it for us. |
|
Great! Thanks for the quick turnaround, @cnoon! |
|
👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue Link 🔗
This PR resolves Issue #2677.
Goals ⚽
The goals of this PR are to resolve the issue reported where the reachability listener closure is not being called when launching an app in airplane mode.
Implementation Details 🚧
Prior to this change, the reachability listener was notified at launch if the device was not in airplane mode. When in airplane mode, the reachability flags were 0, which is what we were defaulting the previous flags to. Because of this, the
notifyListenerfunction would early out since the flags had not changed.The core issue here was that the default value of
previousFlagswas poorly chosen. It should instead default to a value that represents and unknown status. One way to do this would be to makepreviousFlagsan optional. However, this change would not be backwards compatible, so it was abandoned.The best backwards compatible way to make this change was to set
previousFlagsto arawValuethat is not currently used. That way, we can guarantee that the originally computed flags will be different than the default previous flags. This change results in the listener being called at launch even when in airplane mode.Testing Details 🔍
All the original reachability tests are still passing as expected. Given the nature of this particular change, there's no way to test this specific change unless we would redesign the
NetworkReachabilityManagerto decouple the actual Reachability API calls and inject them. This type of change is out-of-scope for AF 4.x release train.