Add an idle write timeout #718
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
gjcairo
force-pushed
the
write-timeout
branch
from
09ea501
to
c3f5630
Compare
dnadoba
reviewed
Dec 14, 2023
gjcairo
force-pushed
the
write-timeout
branch
from
c3f5630
to
e3155a0
Compare
dnadoba
reviewed
Dec 15, 2023
| assert(self.idleWriteTimeoutTimer == nil, "Expected there is no timeout timer so far.") | ||
|
|
||
| self.idleWriteTimeoutTimer = self.eventLoop.scheduleTask(in: timeAmount) { | ||
| guard self.idleWriteTimeoutTimer != nil else { return } |
There was a problem hiding this comment.
In HTTP1 we use a timer "ID" but here we are just setting the timer to nil. Is there a reason for these two different approaches?
There was a problem hiding this comment.
Yes, this is an inconsistency and should be changed because race conditions can happen with this current approach. It was actually fixed for HTTP1 in #455, but not in HTTP2. I just decided to keep things as they currently are in this PR (without using the timer ID) to avoid mixing multiple changes in a single PR, but I'll send a follow-up that adds a timer and changes these checks.
dnadoba
approved these changes
Dec 18, 2023
gjcairo
added
the
semver/minor
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.
Motivation
We currently provide an idle read timeout to fail requests that take more than a given amount of time to produce any response data. We were missing its counterpart: to provide a timeout for when no request data is being written either.
This could happen, for example, when uploading large files: if for whatever reason (e.g. back pressure from the server, etc) the client does not write any bytes, and there is no data being sent from the server either, the connection could be idle and unused, but remain open for longer than necessary. With an idle write timeout, we can avoid this.
Modifications
Added a new idle write timeout.
Result
Users can now configure an idle write timeout in addition to an idle read timeout.