-
Notifications
You must be signed in to change notification settings - Fork 161
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Timeout on body #303
Merged
Merged
Timeout on body #303
Changes from all commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
9b422a6
Timeout on body
99b4f2d
Poll sleep before returning data
c06d70e
Fix comments
ffa590b
Fix comments
f9466ed
Use .into() instead of as for casting errors
83cacf9
Address comments
969c3cb
Make sleep future lazy for body poll
d3e5df7
Style
7753978
Update BoxError reference
aa7b313
Use two sleep futures temporarily
82marbag 992827a
Rename unused variable
82marbag 3182815
Improve documentation
82marbag ae0cd93
Refactor modules
82marbag f476dca
Fix doc style
82marbag 28dea10
Merge imports
82marbag b6a0b31
Update style of imports
82marbag File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
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,219 @@ | ||
//! Middleware that applies a timeout to request and response bodies. | ||
//! | ||
//! Bodies must produce data at most within the specified timeout. | ||
//! If the body does not produce a requested data frame within the timeout period, it will return an error. | ||
//! | ||
//! # Differences from [`crate::timeout::Timeout`] | ||
//! | ||
//! [`crate::timeout::Timeout`] applies a timeout to the request future, not body. | ||
//! That timeout is not reset when bytes are handled, whether the request is active or not. | ||
//! Bodies are handled asynchronously outside of the tower stack's future and thus needs an additional timeout. | ||
//! | ||
//! This middleware will return a [`TimeoutError`]. | ||
//! | ||
//! # Example | ||
//! | ||
//! ``` | ||
//! use http::{Request, Response}; | ||
//! use hyper::Body; | ||
//! use std::time::Duration; | ||
//! use tower::ServiceBuilder; | ||
//! use tower_http::timeout::RequestBodyTimeoutLayer; | ||
//! | ||
//! async fn handle(_: Request<Body>) -> Result<Response<Body>, std::convert::Infallible> { | ||
//! // ... | ||
//! # todo!() | ||
//! } | ||
//! | ||
//! # #[tokio::main] | ||
//! # async fn main() -> Result<(), Box<dyn std::error::Error>> { | ||
//! let svc = ServiceBuilder::new() | ||
//! // Timeout bodies after 30 seconds of inactivity | ||
//! .layer(RequestBodyTimeoutLayer::new(Duration::from_secs(30))) | ||
//! .service_fn(handle); | ||
//! # Ok(()) | ||
//! # } | ||
//! ``` | ||
|
||
use crate::BoxError; | ||
use futures_core::{ready, Future}; | ||
use http_body::Body; | ||
use pin_project_lite::pin_project; | ||
use std::{ | ||
pin::Pin, | ||
task::{Context, Poll}, | ||
time::Duration, | ||
}; | ||
use tokio::time::{sleep, Sleep}; | ||
|
||
pin_project! { | ||
/// Wrapper around a [`http_body::Body`] to time out if data is not ready within the specified duration. | ||
pub struct TimeoutBody<B> { | ||
timeout: Duration, | ||
// In http-body 1.0, `poll_*` will be merged into `poll_frame`. | ||
// Merge the two `sleep_data` and `sleep_trailers` into one `sleep`. | ||
// See: https://github.com/tower-rs/tower-http/pull/303#discussion_r1004834958 | ||
#[pin] | ||
sleep_data: Option<Sleep>, | ||
#[pin] | ||
sleep_trailers: Option<Sleep>, | ||
#[pin] | ||
body: B, | ||
} | ||
} | ||
|
||
impl<B> TimeoutBody<B> { | ||
/// Creates a new [`TimeoutBody`]. | ||
pub fn new(timeout: Duration, body: B) -> Self { | ||
TimeoutBody { | ||
timeout, | ||
sleep_data: None, | ||
sleep_trailers: None, | ||
body, | ||
} | ||
} | ||
} | ||
|
||
impl<B> Body for TimeoutBody<B> | ||
where | ||
B: Body, | ||
B::Error: Into<BoxError>, | ||
{ | ||
type Data = B::Data; | ||
type Error = Box<dyn std::error::Error + Send + Sync>; | ||
|
||
fn poll_data( | ||
self: Pin<&mut Self>, | ||
cx: &mut Context<'_>, | ||
) -> Poll<Option<Result<Self::Data, Self::Error>>> { | ||
let mut this = self.project(); | ||
|
||
// Start the `Sleep` if not active. | ||
let sleep_pinned = if let Some(some) = this.sleep_data.as_mut().as_pin_mut() { | ||
some | ||
} else { | ||
this.sleep_data.set(Some(sleep(*this.timeout))); | ||
this.sleep_data.as_mut().as_pin_mut().unwrap() | ||
}; | ||
|
||
// Error if the timeout has expired. | ||
if let Poll::Ready(()) = sleep_pinned.poll(cx) { | ||
return Poll::Ready(Some(Err(Box::new(TimeoutError(()))))); | ||
} | ||
|
||
// Check for body data. | ||
let data = ready!(this.body.poll_data(cx)); | ||
// Some data is ready. Reset the `Sleep`... | ||
this.sleep_data.set(None); | ||
|
||
Poll::Ready(data.transpose().map_err(Into::into).transpose()) | ||
} | ||
|
||
fn poll_trailers( | ||
LucioFranco marked this conversation as resolved.
Show resolved
Hide resolved
|
||
self: Pin<&mut Self>, | ||
cx: &mut Context<'_>, | ||
) -> Poll<Result<Option<http::HeaderMap>, Self::Error>> { | ||
let mut this = self.project(); | ||
|
||
// In http-body 1.0, `poll_*` will be merged into `poll_frame`. | ||
// Merge the two `sleep_data` and `sleep_trailers` into one `sleep`. | ||
// See: https://github.com/tower-rs/tower-http/pull/303#discussion_r1004834958 | ||
|
||
let sleep_pinned = if let Some(some) = this.sleep_trailers.as_mut().as_pin_mut() { | ||
some | ||
} else { | ||
this.sleep_trailers.set(Some(sleep(*this.timeout))); | ||
this.sleep_trailers.as_mut().as_pin_mut().unwrap() | ||
}; | ||
|
||
// Error if the timeout has expired. | ||
if let Poll::Ready(()) = sleep_pinned.poll(cx) { | ||
return Poll::Ready(Err(Box::new(TimeoutError(())))); | ||
} | ||
|
||
this.body.poll_trailers(cx).map_err(Into::into) | ||
} | ||
} | ||
|
||
/// Error for [`TimeoutBody`]. | ||
#[derive(Debug)] | ||
pub struct TimeoutError(()); | ||
|
||
impl std::error::Error for TimeoutError {} | ||
|
||
impl std::fmt::Display for TimeoutError { | ||
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { | ||
write!(f, "data was not received within the designated timeout") | ||
} | ||
} | ||
#[cfg(test)] | ||
mod tests { | ||
use super::*; | ||
|
||
use bytes::Bytes; | ||
use pin_project_lite::pin_project; | ||
use std::{error::Error, fmt::Display}; | ||
|
||
#[derive(Debug)] | ||
struct MockError; | ||
|
||
impl Error for MockError {} | ||
impl Display for MockError { | ||
fn fmt(&self, _f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { | ||
todo!() | ||
} | ||
} | ||
|
||
pin_project! { | ||
struct MockBody { | ||
#[pin] | ||
sleep: Sleep | ||
} | ||
} | ||
|
||
impl Body for MockBody { | ||
type Data = Bytes; | ||
type Error = MockError; | ||
|
||
fn poll_data( | ||
self: Pin<&mut Self>, | ||
cx: &mut Context<'_>, | ||
) -> Poll<Option<Result<Self::Data, Self::Error>>> { | ||
let this = self.project(); | ||
this.sleep.poll(cx).map(|_| Some(Ok(vec![].into()))) | ||
} | ||
|
||
fn poll_trailers( | ||
self: Pin<&mut Self>, | ||
_cx: &mut Context<'_>, | ||
) -> Poll<Result<Option<http::HeaderMap>, Self::Error>> { | ||
todo!() | ||
} | ||
} | ||
|
||
#[tokio::test] | ||
async fn test_body_available_within_timeout() { | ||
let mock_sleep = Duration::from_secs(1); | ||
let timeout_sleep = Duration::from_secs(2); | ||
|
||
let mock_body = MockBody { | ||
sleep: sleep(mock_sleep), | ||
}; | ||
let timeout_body = TimeoutBody::new(timeout_sleep, mock_body); | ||
|
||
assert!(timeout_body.boxed().data().await.unwrap().is_ok()); | ||
} | ||
|
||
#[tokio::test] | ||
async fn test_body_unavailable_within_timeout_error() { | ||
let mock_sleep = Duration::from_secs(2); | ||
let timeout_sleep = Duration::from_secs(1); | ||
|
||
let mock_body = MockBody { | ||
sleep: sleep(mock_sleep), | ||
}; | ||
let timeout_body = TimeoutBody::new(timeout_sleep, mock_body); | ||
|
||
assert!(timeout_body.boxed().data().await.unwrap().is_err()); | ||
} | ||
} |
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,10 @@ | ||
//! Middleware for setting timeouts on requests and responses. | ||
|
||
mod body; | ||
mod service; | ||
|
||
pub use body::{TimeoutBody, TimeoutError}; | ||
pub use service::{ | ||
RequestBodyTimeout, RequestBodyTimeoutLayer, ResponseBodyTimeout, ResponseBodyTimeoutLayer, | ||
Timeout, TimeoutLayer, | ||
}; |
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.
Taking a big step back, this could live in
http_body
crate if there was a standard interface for sleep futures.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.
Yeah, I think we do want to add a timeout body in http-body-utils, that said we can start with that code in here. I think this is the path I am going with for the retry stuff as well.