-
Notifications
You must be signed in to change notification settings - Fork 1.1k
fix(client): add 10s connect timeout to prevent initial hangs #537
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
base: main
Are you sure you want to change the base?
Changes from all commits
88ca172
2b40280
c2a8e20
bd0879a
edfa364
e3e3a27
ac994ca
9bc1c4d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| ---\n"@googleworkspace/cli": patch\n---\n\nfix(client): add 10s connect timeout to prevent hangs on initial connection |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,11 @@ | ||
| use reqwest::header::{HeaderMap, HeaderValue}; | ||
|
|
||
| const MAX_RETRIES: u32 = 3; | ||
| /// Maximum seconds to sleep on a 429 Retry-After header. Prevents a hostile | ||
| /// or misconfigured server from hanging the process indefinitely. | ||
| const MAX_RETRY_DELAY_SECS: u64 = 60; | ||
| const CONNECT_TIMEOUT_SECS: u64 = 10; | ||
|
|
||
| pub fn build_client() -> Result<reqwest::Client, crate::error::GwsError> { | ||
| let mut headers = HeaderMap::new(); | ||
| let name = env!("CARGO_PKG_NAME"); | ||
|
|
@@ -13,17 +19,13 @@ pub fn build_client() -> Result<reqwest::Client, crate::error::GwsError> { | |
|
|
||
| reqwest::Client::builder() | ||
| .default_headers(headers) | ||
| .connect_timeout(std::time::Duration::from_secs(CONNECT_TIMEOUT_SECS)) | ||
| .build() | ||
|
Comment on lines
+22
to
23
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The pull request description mentions adding a 10-minute (600s) request timeout, but this seems to be missing from the implementation. Without a request timeout, operations could hang indefinitely, which this change is intended to prevent. Please add the request timeout to the client builder. It would be best to define the timeout value as a constant, similar to .connect_timeout(std::time::Duration::from_secs(CONNECT_TIMEOUT_SECS))
.timeout(std::time::Duration::from_secs(600))
.build() |
||
| .map_err(|e| { | ||
| crate::error::GwsError::Other(anyhow::anyhow!("Failed to build HTTP client: {e}")) | ||
| }) | ||
| } | ||
|
|
||
| const MAX_RETRIES: u32 = 3; | ||
| /// Maximum seconds to sleep on a 429 Retry-After header. Prevents a hostile | ||
| /// or misconfigured server from hanging the process indefinitely. | ||
| const MAX_RETRY_DELAY_SECS: u64 = 60; | ||
|
|
||
| /// Send an HTTP request with automatic retry on 429 (rate limit) responses. | ||
| /// Respects the `Retry-After` header; falls back to exponential backoff (1s, 2s, 4s). | ||
| pub async fn send_with_retry( | ||
|
|
||
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.
The pull request description mentions adding a 120-second request timeout, but this change is missing from the implementation. Adding a request timeout is crucial to prevent the client from hanging indefinitely when a stream stalls, which is one of the goals of this PR.
I've added the request timeout to the client builder. Please also define a
REQUEST_TIMEOUT_SECSconstant for the value120at the top of the file, similar to howCONNECT_TIMEOUT_SECSis defined.Once this is done, please also update the changeset message in
.changeset/http-timeouts.mdto reflect the full scope of the changes.