Add timeout enforcement to ProtocolClient #276
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| // Copyright 2022-2023 The Connect Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package com.connectrpc.http | ||
|
|
||
| import kotlinx.coroutines.delay | ||
| import java.util.Timer | ||
| import java.util.concurrent.atomic.AtomicBoolean | ||
| import kotlin.concurrent.timerTask | ||
| import kotlin.time.Duration | ||
|
|
||
| /** | ||
| * Represents the timeout state for an RPC. | ||
| */ | ||
| class Timeout private constructor( | ||
| private val timeoutAction: Cancelable, | ||
| ) { | ||
| private val done = AtomicBoolean(false) | ||
|
|
||
| @Volatile private var triggered: Boolean = false | ||
| private var onCancel: Cancelable? = null | ||
|
|
||
| /** Returns true if this timeout has lapsed and the associated RPC canceled. */ | ||
| val timedOut: Boolean | ||
| get() = triggered | ||
|
|
||
| /** | ||
| * Cancels the timeout. Should only be called when the RPC completes before the | ||
| * timeout elapses. Returns true if the timeout was canceled or false if either | ||
| * it was already previously canceled or has already timed out. The `timedOut` | ||
| * property can be queried to distinguish between these two possibilities. | ||
| */ | ||
| fun cancel(): Boolean { | ||
| if (done.compareAndSet(false, true)) { | ||
| onCancel?.invoke() | ||
| return true | ||
| } | ||
| return false | ||
| } | ||
|
|
||
| private fun trigger() { | ||
| if (done.compareAndSet(false, true)) { | ||
| triggered = true | ||
| timeoutAction() | ||
| } | ||
| } | ||
|
|
||
| /** Schedules timeouts for RPCs. */ | ||
| interface Scheduler { | ||
| /** | ||
| * Schedules a timeout that should invoke the given action to cancel | ||
| * an RPC after the given delay. | ||
| */ | ||
|
|
||
| fun scheduleTimeout(delay: Duration, action: Cancelable): Timeout | ||
| } | ||
|
|
||
| companion object { | ||
| /** | ||
| * A default implementation that a Timer backed by a single daemon thread. | ||
| * The thread isn't started until the first cancelation is scheduled. | ||
| */ | ||
| val DEFAULT_SCHEDULER = object : Scheduler { | ||
| override fun scheduleTimeout(delay: Duration, action: Cancelable): Timeout { | ||
| val timeout = Timeout(action) | ||
| val task = timerTask { timeout.trigger() } | ||
|
There was a problem hiding this comment. This works but we might consider tradeoffs vs. ScheduledThreadPoolExecutor. Probably not a big deal for timeout scheduling. There was a problem hiding this comment. I can change it. When I was searching, trying to figure out the idiomatic way to do this in Kotlin and Android apps, this was cited more than use of a For this, there's not really much of a tradeoff -- both solutions are roughly equivalent. Both approaches require creation of a heavyweight thread. Both implementations are similar, using a thread that polls a priority queue and then executes the tasks. The only potentially meaningful difference is that But it's super easy to switch if you think that's more appropriate. |
||
| timer.value.schedule(task, delay.inWholeMilliseconds) | ||
| timeout.onCancel = { task.cancel() } | ||
| return timeout | ||
| } | ||
| } | ||
|
|
||
| private val timer = lazy { Timer(Scheduler::class.qualifiedName, true) } | ||
| } | ||
| } | ||
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added this to account for removal of the timeouts in the configuration helper below. So if users use
ConnectOkHttpClient.configureClientand forget to set timeouts in this config, they get the same default behavior as theOkHttpClientwas providing (except that this default applies to bidirectional streams, whereas theOkHttpClienttimeouts do not).