Add timeout to SSE #8565
Open
Add timeout to SSE #8565
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
yschimke
reviewed
Nov 11, 2024
| /** | ||
| * Seconds elapsed between 2 events until connection failed. Doesn't timeout if null | ||
| */ | ||
| open var timeout: Long? = null |
There was a problem hiding this comment.
From Call, I think there is a convention on timeout names. Such as readTimeoutMillis. So perhaps receiveTimeoutMillis?
I wonder if we should prefer Kotlin Duration here also?
There was a problem hiding this comment.
Internally we use callTimeout in RealEventSource to track establishment, and it's obviously an existing top level think in OkHttp which extends to the end of a request.
read feel to I/O socket focused.
yschimke
reviewed
Nov 15, 2024
| @@ -40,6 +44,18 @@ internal class RealEventSource( | |||
| } | |||
| } | |||
|
|
|||
| private fun updateTimeout(call: Call?, duration: Duration) { | |||
| if (call?.timeout() is AsyncTimeout) { | |||
There was a problem hiding this comment.
I'm a bit nervous about reusing call.timeout() here. I guess two reasons
- it isn't clear we are the owner of it, perhaps some other component or an interceptor is using it.
- the casting seems unsafe, but if we create it, we know the type and can set the duration ourselves.
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.
This PR adds the possibility to timeout the SSE connection. It is now possible to fail as soon as an event-free timeout is not reached, making it easier to detect a lost connection.
For a real world example: I've an app connected to a server. It sends a ping at a keepalive interval. I've a job checking from time to time that everything works as expected (using a worker, so the period is 15min, the minimum). It happens that the connection is lost at the beginning of this interval, therefore the users are disconnected for several minutes.
With this PR we can directly catch a lost connection: https://codeberg.org/NextPush/nextpush-android/commit/f6edb178ddee8255e9de6e548ea75f5d3eb6b32a
PS: I've also added some comments, but I can remove this commit from the branch