Skip to content
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

feat(client): Add timeout and connect error to backoff transient error #1014

Merged
merged 6 commits into from
Apr 5, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions crates/rover-client/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ git2 = { version = "0.14", default-features = false, features = [
graphql_client = "0.10"
http = "0.2"
humantime = "2.1.0"
hyper = "0.14"
prettytable-rs = "0.8.0"
reqwest = { version = "0.11", default-features = false, features = [
"blocking",
Expand Down
101 changes: 88 additions & 13 deletions crates/rover-client/src/blocking/client.rs
Original file line number Diff line number Diff line change
Expand Up @@ -74,21 +74,52 @@ impl GraphQLClient {
.post(&self.graphql_endpoint)
.headers(header_map.clone())
.body(request_body.clone())
.send()
.map_err(BackoffError::Permanent)?;

if let Err(status_error) = response.error_for_status_ref() {
if let Some(response_status) = status_error.status() {
if response_status.is_server_error() {
Err(BackoffError::transient(status_error))
.send();

match response {
Err(client_error) => {
if client_error.is_timeout() || client_error.is_connect() {
Err(BackoffError::transient(client_error))
} else if client_error.is_body()
|| client_error.is_decode()
|| client_error.is_builder()
|| client_error.is_redirect()
{
Err(BackoffError::Permanent(client_error))
} else if client_error.is_request() {
if let Some(hyper_error) =
get_source_error_type::<hyper::Error>(&client_error)
{
if hyper_error.is_incomplete_message() {
Err(BackoffError::transient(client_error))
} else {
Err(BackoffError::Permanent(client_error))
}
} else {
Err(BackoffError::Permanent(client_error))
}
} else {
Err(BackoffError::Permanent(status_error))
Err(BackoffError::Permanent(client_error))
}
}
Ok(success) => {
if let Err(status_error) = success.error_for_status_ref() {
if let Some(response_status) = status_error.status() {
if response_status.is_server_error()
|| response_status.is_client_error()
|| response_status.is_redirection()
{
Err(BackoffError::transient(status_error))
} else {
Err(BackoffError::Permanent(status_error))
}
} else {
Err(BackoffError::Permanent(status_error))
}
} else {
Ok(success)
}
} else {
Err(BackoffError::Permanent(status_error))
}
} else {
Ok(response)
}
};

Expand Down Expand Up @@ -166,6 +197,22 @@ fn handle_graphql_body_errors(errors: Vec<GraphQLError>) -> Result<(), RoverClie
}
}

/// Downcasts the given err source into T.
fn get_source_error_type<T: std::error::Error + 'static>(
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this hack because waiting for hyperium/hyper#2711

err: &dyn std::error::Error,
) -> Option<&T> {
let mut source = err.source();

while let Some(err) = source {
if let Some(hyper_err) = err.downcast_ref::<T>() {
return Some(hyper_err);
}

source = err.source();
}
None
}

#[cfg(test)]
mod tests {
use super::*;
Expand Down Expand Up @@ -271,9 +318,37 @@ mod tests {

let mock_hits = not_found_mock.hits();

assert_eq!(mock_hits, 1);
assert!(mock_hits > 1);

let error = response.expect_err("Response didn't error");
assert!(error.to_string().contains("Not Found"));
}

#[test]
fn test_timeout_error() {
let server = MockServer::start();
let timeout_path = "/i-timeout-easily";
let timeout_mock = server.mock(|when, then| {
when.method(POST).path(timeout_path);
then.status(200)
.body("you've missed your bus")
.delay(Duration::from_secs(3));
});

let client = reqwest::blocking::ClientBuilder::new()
.timeout(Duration::from_secs(1))
.build()
.unwrap();
let graphql_client = GraphQLClient::new(&server.url(timeout_path), client).unwrap();

let response = graphql_client.execute("{}".to_string(), &HeaderMap::new());

let mock_hits = timeout_mock.hits();

assert!(mock_hits > 1);
assert!(response.is_err());

let error = response.expect_err("Response didn't error");
assert!(error.to_string().contains("operation timed out"));
}
}