Highlight the uncancelable behavior in Timeout middleware scaladoc
#6407
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
armanbilge
reviewed
May 23, 2022
server/shared/src/main/scala/org/http4s/server/middleware/Timeout.scala
Outdated
Show resolved
Hide resolved
armanbilge
reviewed
May 23, 2022
server/shared/src/main/scala/org/http4s/server/middleware/Timeout.scala
Outdated
Show resolved
Hide resolved
armanbilge
reviewed
May 23, 2022
server/shared/src/main/scala/org/http4s/server/middleware/Timeout.scala
Outdated
Show resolved
Hide resolved
armanbilge
reviewed
May 23, 2022
server/shared/src/main/scala/org/http4s/server/middleware/Timeout.scala
Outdated
Show resolved
Hide resolved
|
Thanks, sorry for the nitpicks. I think this is a really important topic to cover. |
armanbilge
reviewed
May 23, 2022
Comment on lines
+84
to
+94
| test( | ||
| "return a 503 error if the result takes too long and execute underlying uncancelable effect" | ||
| ) { | ||
| testMiddleware(5.milliseconds) { app => | ||
| for { | ||
| _ <- app(uncancelableReq).map(_.status).assertEquals(Status.ServiceUnavailable) | ||
| _ <- checkStatus(app(uncancelableReq), Status.ServiceUnavailable) | ||
| .intercept[TimeoutException] | ||
| } yield () | ||
| } | ||
| } |
There was a problem hiding this comment.
Sorry, I'm a little confused what this test is demonstrating?
There was a problem hiding this comment.
- it shows that uncancelable effects complete fully without any cancelation (from middleware) in a case when a timeout has exceeded (test at the 90 line)
- it shows that
Timeoutmiddleware will respond with the timeout response anyway (test at the 89 line)
There was a problem hiding this comment.
Ah, thank you for explaining, I think I finally understood. The test for (1) is the .intercept[TimeoutException] because 1.seconds < IO.sleep(1100.milliseconds) IIUC.
There was a problem hiding this comment.
Yeah, it so, you're correct.
Co-authored-by: Arman Bilge <armanbilge@gmail.com>
armanbilge
approved these changes
May 23, 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.
I think the uncancelable behavior is noteworthy because it could lead to some surprising effects on the user site. It's indisputable that it's the user's responsibility to check how their services produce effects. But still, I'm sure it's better to highlight that behavior.
Also, I've added the test that proves my point about
Timeoutmiddleware behavior when dealing with uncancelable effects.