Improve Wear OS error handling on home, check websocket connection state #2261
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
- Switch the job used for monitoring whether a connection has been established to use Deferred, which will allow us to get the exception that caused the job to be cancelled (and also makes the code a little easier)
- Add a variable to the websocket repository to monitor the state of the connection. This will allow the app to respond to handled exceptions.
- If multiple outgoing messages are pending before the connection is opened, if we receive an invalid auth message or onFailure callback this will be processed last. The connected job is still 'completed', so it shouldn't return true but return if it was successful. This will ensure that any messages after the first one that triggered the failure, will be ignored until the job is reset. - Set the connection state to authenticating before sending the message, to make sure that we don't accidentally override a very quick response
- Add a state for the loading progress to the view model in order to be able to update the home view with errors if necessary - If loading the main data failed because of authentication, reset the session like in the phone app and send the user back to onboarding - Fix the app getting stuck on a loading screen, even if everything loaded correctly, if there are no supported entity domains in the response
JBassett
reviewed
Feb 17, 2022
# Conflicts: # common/src/main/res/values/strings.xml # wear/src/main/java/io/homeassistant/companion/android/home/MainViewModel.kt
JBassett
approved these changes
Feb 19, 2022
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.
Summary
This PR improves the Wear OS' app error handling on the home screen, by showing errors and/or redirecting to onboarding instead of crashing the app on errors. More specifically:
For more on specific changes, view the comments in individual commits.
Screenshots
General error:
If the user has favorites, the error will be shown below the favorites (in place of the loading text/chip) and favorites are still accessible:
No supported domains message if loading completed but the lists are still emtpy:
Settings remains accessible in all cases to allow changing tile settings, logging out, etc.
If you need to login again because authentication failed, the app will immediately send you to onboarding like the phone app.
Link to pull request in Documentation repository
I don't think this is needed, "Check the documentation" in the no supported domains error refers to the general documentation for Wear OS which lists supported domains.
Any other notes
If you're going to test this, be aware that because the websocket doesn't immediately throw an error if something fails once the connection is established, the app might send multiple requests before stopping which can trigger maximum number of failed login -> IP ban protections.