Prevent socket response continuation being called multiple times (#3338) #4616
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
![home-assistant[bot]](https://avatars.githubusercontent.com/in/97978?s=60&v=4){kind=small}
There was a problem hiding this comment.
It seems you haven't yet signed a CLA. Please do so here.
Once you do that we will be able to review and accept this pull request.
Thanks!
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
home-assistant
bot
added
cla-recheck
cla-signed
and removed
cla-recheck
cla-needed
labels
ShaunPlummer
changed the title
Isn't that the stack trace we already have as a crash? |
|
Yes, with these changes, it won't be logged out any more so it will be less obvious when the problem occurs. A better idea would probably be to log a warning when the second invocation is attempted. |
jpelgrom
requested changes
Sep 10, 2024
...n/src/main/java/io/homeassistant/companion/android/common/data/websocket/WebSocketRequest.kt
Outdated
Show resolved
Hide resolved
ShaunPlummer
force-pushed
the
3338-prevent-multiple-continuation-execution
branch
from
5727eda to
24378db
Compare
Coroutines continuations can only be invoke once, see CancellableContinuation. Use atomic boolean to ensure the continuation is called only once in a thread safe way.
Log a warning message so that it's more visible if a websocket response is invoked multiple times
The default value must be false as the continuation property is mutable. The value is always assigned after the object is created.
ShaunPlummer
force-pushed
the
3338-prevent-multiple-continuation-execution
branch
from
24378db to
7500421
Compare
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
Prevent the crash outlined in #3338. Coroutines continuations can only be invoke once, see CancellableContinuation. Use atomic boolean to ensure the continuation is called only once in a thread safe way. While this does not fix the underlying cause it will prevent any more crashes.
Any other notes
We could log the stack trace whenever the continuation is invoked a second time in order to help identify where the second call comes from.