public inbox for pbs-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Christian Ebner <c.ebner@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox 1/3] s3-client: allow setting custom timeout when sending requests
Date: Wed, 20 Aug 2025 11:58:03 +0200	[thread overview]
Message-ID: <20250820095807.172722-2-c.ebner@proxmox.com> (raw)
In-Reply-To: <20250820095807.172722-1-c.ebner@proxmox.com>

Currently, all types of requests to the S3 API have the same default
timeout of 60 seconds, which was determined empirically.
Different types of requests to the S3 API will however take quite
different time, especially the uploading of objects via a put call
depends on the payload size and bandwidth available.

Therefore, in preparation for being able to set this on a per-request
basis, allow to optionally set the timeout when sending the request.
This now also allows to send the request without timeout.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
---
 proxmox-s3-client/src/client.rs | 34 ++++++++++++++++++++-------------
 1 file changed, 21 insertions(+), 13 deletions(-)

diff --git a/proxmox-s3-client/src/client.rs b/proxmox-s3-client/src/client.rs
index 3bc2a672..2a48240e 100644
--- a/proxmox-s3-client/src/client.rs
+++ b/proxmox-s3-client/src/client.rs
@@ -283,7 +283,11 @@ impl S3Client {
     }
 
     /// Send API request to the configured endpoint using the inner https client.
-    async fn send(&self, request: Request<Body>) -> Result<Response<Incoming>, Error> {
+    async fn send(
+        &self,
+        request: Request<Body>,
+        timeout: Option<Duration>,
+    ) -> Result<Response<Incoming>, Error> {
         let request = self.prepare(request).await?;
         if request.method() == Method::PUT {
             if let Some(limiter) = &self.put_rate_limiter {
@@ -294,9 +298,13 @@ impl S3Client {
                 tokio::time::sleep(sleep).await;
             }
         }
-        let response = tokio::time::timeout(S3_HTTP_REQUEST_TIMEOUT, self.client.request(request))
-            .await
-            .context("request timeout")??;
+        let response = if let Some(timeout) = timeout {
+            tokio::time::timeout(timeout, self.client.request(request))
+                .await
+                .context("request timeout")??
+        } else {
+            self.client.request(request).await?
+        };
         Ok(response)
     }
 
@@ -307,7 +315,7 @@ impl S3Client {
             .method(Method::HEAD)
             .uri(self.build_uri("/", &[])?)
             .body(Body::empty())?;
-        let response = self.send(request).await?;
+        let response = self.send(request, Some(S3_HTTP_REQUEST_TIMEOUT)).await?;
         let (parts, _body) = response.into_parts();
 
         match parts.status {
@@ -328,7 +336,7 @@ impl S3Client {
             .method(Method::GET)
             .uri(self.build_uri("/", &[])?)
             .body(Body::empty())?;
-        let response = self.send(request).await?;
+        let response = self.send(request, Some(S3_HTTP_REQUEST_TIMEOUT)).await?;
         let response_reader = ResponseReader::new(response);
         response_reader.list_buckets_response().await
     }
@@ -344,7 +352,7 @@ impl S3Client {
             .method(Method::HEAD)
             .uri(self.build_uri(&object_key, &[])?)
             .body(Body::empty())?;
-        let response = self.send(request).await?;
+        let response = self.send(request, Some(S3_HTTP_REQUEST_TIMEOUT)).await?;
         let response_reader = ResponseReader::new(response);
         response_reader.head_object_response().await
     }
@@ -361,7 +369,7 @@ impl S3Client {
             .uri(self.build_uri(&object_key, &[])?)
             .body(Body::empty())?;
 
-        let response = self.send(request).await?;
+        let response = self.send(request, Some(S3_HTTP_REQUEST_TIMEOUT)).await?;
         let response_reader = ResponseReader::new(response);
         response_reader.get_object_response().await
     }
@@ -391,7 +399,7 @@ impl S3Client {
             .uri(self.build_uri("/", &query)?)
             .body(Body::empty())?;
 
-        let response = self.send(request).await?;
+        let response = self.send(request, Some(S3_HTTP_REQUEST_TIMEOUT)).await?;
         let response_reader = ResponseReader::new(response);
         response_reader.list_objects_v2_response().await
     }
@@ -427,7 +435,7 @@ impl S3Client {
 
         let request = request.body(object_data)?;
 
-        let response = self.send(request).await?;
+        let response = self.send(request, Some(S3_HTTP_REQUEST_TIMEOUT)).await?;
         let response_reader = ResponseReader::new(response);
         response_reader.put_object_response().await
     }
@@ -441,7 +449,7 @@ impl S3Client {
             .uri(self.build_uri(&object_key, &[])?)
             .body(Body::empty())?;
 
-        let response = self.send(request).await?;
+        let response = self.send(request, None).await?;
         let response_reader = ResponseReader::new(response);
         response_reader.delete_object_response().await
     }
@@ -468,7 +476,7 @@ impl S3Client {
             .uri(self.build_uri("/", &[("delete", "")])?)
             .body(Body::from(body))?;
 
-        let response = self.send(request).await?;
+        let response = self.send(request, Some(S3_HTTP_REQUEST_TIMEOUT)).await?;
         let response_reader = ResponseReader::new(response);
         response_reader.delete_objects_response().await
     }
@@ -499,7 +507,7 @@ impl S3Client {
             )
             .body(Body::empty())?;
 
-        let response = self.send(request).await?;
+        let response = self.send(request, Some(S3_HTTP_REQUEST_TIMEOUT)).await?;
         let response_reader = ResponseReader::new(response);
         response_reader.copy_object_response().await
     }
-- 
2.47.2



_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel


  reply	other threads:[~2025-08-20  9:56 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-08-20  9:58 [pbs-devel] [PATCH proxmox{, -backup} 0/5] dynamically calculate request timeout for put object calls Christian Ebner
2025-08-20  9:58 ` Christian Ebner [this message]
2025-08-20  9:58 ` [pbs-devel] [PATCH proxmox 2/3] s3-client: dynamically calculate put request timeout based on payload Christian Ebner
2025-08-20  9:58 ` [pbs-devel] [PATCH proxmox 3/3] s3-client: expose default timeout for s3 api requests Christian Ebner
2025-08-20  9:58 ` [pbs-devel] [PATCH proxmox-backup 1/2] s3: pass now optional default request timeout for s3 api calls Christian Ebner
2025-08-20  9:58 ` [pbs-devel] [PATCH proxmox-backup 2/2] api: format error to show full context for failed chunk uploads Christian Ebner
2025-08-25  9:35 ` [pbs-devel] applied-series: [PATCH proxmox{, -backup} 0/5] dynamically calculate request timeout for put object calls Wolfgang Bumiller

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250820095807.172722-2-c.ebner@proxmox.com \
    --to=c.ebner@proxmox.com \
    --cc=pbs-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal