Skip to content

feat: Retry all HTTP requests #2523

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.

Sign up for GitHub

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

Merged
szokeasaurusrex merged 1 commit into from
May 27, 2025
Merged

feat: Retry all HTTP requests #2523

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
71 changes: 11 additions & 60 deletions src/api/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,13 @@ lazy_static! {
static ref API: Mutex<Option<Arc<Api>>> = Mutex::new(None);
}

const RETRY_STATUS_CODES: &[u32] = &[
http::HTTP_STATUS_502_BAD_GATEWAY,
http::HTTP_STATUS_503_SERVICE_UNAVAILABLE,
http::HTTP_STATUS_504_GATEWAY_TIMEOUT,
http::HTTP_STATUS_507_INSUFFICIENT_STORAGE,
];

/// Helper for the API access.
/// Implements the low-level API access methods, and provides high-level implementations for interacting
/// with portions of the API that do not require authentication via an auth token.
Expand Down Expand Up @@ -113,8 +120,6 @@ pub struct ApiRequest {
is_authenticated: bool,
body: Option<Vec<u8>>,
progress_bar_mode: ProgressBarMode,
max_retries: u32,
retry_on_statuses: &'static [u32],
}

/// Represents an API response.
Expand Down Expand Up @@ -395,14 +400,6 @@ impl Api {
let request = self
.request(Method::Post, url, None)?
.with_form_data(form)?
.with_retry(
self.config.max_retries(),
&[
http::HTTP_STATUS_502_BAD_GATEWAY,
http::HTTP_STATUS_503_SERVICE_UNAVAILABLE,
http::HTTP_STATUS_504_GATEWAY_TIMEOUT,
],
)
.progress_bar_mode(progress_bar_mode);

// The request is performed to an absolute URL. Thus, `Self::request()` will
Expand Down Expand Up @@ -967,14 +964,6 @@ impl<'a> AuthenticatedApi<'a> {

self.request(Method::Post, &url)?
.with_json_body(request)?
.with_retry(
self.api.config.max_retries(),
&[
http::HTTP_STATUS_502_BAD_GATEWAY,
http::HTTP_STATUS_503_SERVICE_UNAVAILABLE,
http::HTTP_STATUS_504_GATEWAY_TIMEOUT,
],
)
.send()?
.convert_rnf(ApiErrorKind::ProjectNotFound)
}
Expand All @@ -1000,14 +989,6 @@ impl<'a> AuthenticatedApi<'a> {
version: None,
dist: None,
})?
.with_retry(
self.api.config.max_retries(),
&[
http::HTTP_STATUS_502_BAD_GATEWAY,
http::HTTP_STATUS_503_SERVICE_UNAVAILABLE,
http::HTTP_STATUS_504_GATEWAY_TIMEOUT,
],
)
.send()?
.convert_rnf(ApiErrorKind::ReleaseNotFound)
}
Expand All @@ -1031,14 +1012,6 @@ impl<'a> AuthenticatedApi<'a> {
version,
dist,
})?
.with_retry(
self.api.config.max_retries(),
&[
http::HTTP_STATUS_502_BAD_GATEWAY,
http::HTTP_STATUS_503_SERVICE_UNAVAILABLE,
http::HTTP_STATUS_504_GATEWAY_TIMEOUT,
],
)
.send()?
.convert_rnf(ApiErrorKind::ReleaseNotFound)
}
Expand Down Expand Up @@ -1407,10 +1380,6 @@ impl RegionSpecificApi<'_> {
form.part("file").file(file).add()?;
self.request(Method::Post, &path)?
.with_form_data(form)?
.with_retry(
self.api.api.config.max_retries(),
&[http::HTTP_STATUS_507_INSUFFICIENT_STORAGE],
)
.progress_bar_mode(ProgressBarMode::Request)
.send()?
.convert()
Expand Down Expand Up @@ -1466,14 +1435,6 @@ impl RegionSpecificApi<'_> {
let resp = self
.request(Method::Post, &path)?
.with_form_data(form)?
.with_retry(
self.api.api.config.max_retries(),
&[
http::HTTP_STATUS_502_BAD_GATEWAY,
http::HTTP_STATUS_503_SERVICE_UNAVAILABLE,
http::HTTP_STATUS_504_GATEWAY_TIMEOUT,
],
)
.progress_bar_mode(progress_bar_mode)
.send()?;
if resp.status() == 409 {
Expand Down Expand Up @@ -1661,8 +1622,6 @@ impl ApiRequest {
is_authenticated: false,
body: None,
progress_bar_mode: ProgressBarMode::Disabled,
max_retries: 0,
retry_on_statuses: &[],
};

let request = match auth {
Expand Down Expand Up @@ -1736,13 +1695,6 @@ impl ApiRequest {
self
}

pub fn with_retry(mut self, max_retries: u32, retry_on_statuses: &'static [u32]) -> Self {
self.max_retries = max_retries;
self.retry_on_statuses = retry_on_statuses;

self
}

/// Get a copy of the header list
fn get_headers(&self) -> curl::easy::List {
let mut result = curl::easy::List::new();
Expand Down Expand Up @@ -1771,18 +1723,17 @@ impl ApiRequest {

/// Sends the request and reads the response body into the response object.
pub fn send(mut self) -> ApiResult<ApiResponse> {
let max_retries = Config::current().max_retries();

let mut backoff = get_default_backoff();
let mut retry_number = 0;

loop {
let mut out = vec![];
debug!(
"retry number {}, max retries: {}",
retry_number, self.max_retries,
);
debug!("retry number {retry_number}, max retries: {max_retries}",);

let mut rv = self.send_into(&mut out)?;
if retry_number >= self.max_retries || !self.retry_on_statuses.contains(&rv.status) {
if retry_number >= max_retries || !RETRY_STATUS_CODES.contains(&rv.status) {
rv.body = Some(out);
return Ok(rv);
}
Expand Down