[incubator-opendal] branch main updated: feat: add override_cache_control (#1804)

[xu...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

xuanwo pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-opendal.git


The following commit(s) were added to refs/heads/main by this push:
     new 74887442 feat: add override_cache_control (#1804)
74887442 is described below

commit 748874424b7a3dff2bff29a01343cdc105bc29eb
Author: Bas Zalmstra <ba...@prefix.dev>
AuthorDate: Thu Mar 30 13:48:32 2023 +0200

    feat: add override_cache_control (#1804)
    
    * feat: add override_cache_control
    
    * fix: dont use generics in non-critical path
---
 core/src/services/s3/backend.rs | 31 ++++++++++++++++++++++++-------
 core/src/types/ops.rs           | 17 +++++++++++++----
 2 files changed, 37 insertions(+), 11 deletions(-)

diff --git a/core/src/services/s3/backend.rs b/core/src/services/s3/backend.rs
index e4a935e5..dcb8819e 100644
--- a/core/src/services/s3/backend.rs
+++ b/core/src/services/s3/backend.rs
@@ -78,6 +78,7 @@ mod constants {
     pub const X_AMZ_BUCKET_REGION: &str = "x-amz-bucket-region";
 
     pub const RESPONSE_CONTENT_DISPOSITION: &str = "response-content-disposition";
+    pub const RESPONSE_CACHE_CONTROL: &str = "response-cache-control";
 }
 
 /// Aws S3 and compatible services (including minio, digitalocean space and so on) support
@@ -1241,9 +1242,12 @@ impl Accessor for S3Backend {
         // We will not send this request out, just for signing.
         let mut req = match args.operation() {
             PresignOperation::Stat(_) => self.s3_head_object_request(path)?,
-            PresignOperation::Read(v) => {
-                self.s3_get_object_request(path, v.range(), v.override_content_disposition())?
-            }
+            PresignOperation::Read(v) => self.s3_get_object_request(
+                path,
+                v.range(),
+                v.override_content_disposition(),
+                v.override_cache_control(),
+            )?,
             PresignOperation::Write(_) => {
                 self.s3_put_object_request(path, None, None, None, AsyncBody::Empty)?
             }
@@ -1334,18 +1338,31 @@ impl S3Backend {
         path: &str,
         range: BytesRange,
         override_content_disposition: Option<&str>,
+        override_cache_control: Option<&str>,
     ) -> Result<Request<AsyncBody>> {
         let p = build_abs_path(&self.root, path);
 
         // Construct headers to add to the request
         let mut url = format!("{}/{}", self.endpoint, percent_encode_path(&p));
 
+        // Add query arguments to the URL based on response overrides
+        let mut query_args = Vec::new();
         if let Some(override_content_disposition) = override_content_disposition {
-            url.push_str(&format!(
-                "?{}={}",
+            query_args.push(format!(
+                "{}={}",
                 constants::RESPONSE_CONTENT_DISPOSITION,
                 percent_encode_path(override_content_disposition)
-            ));
+            ))
+        }
+        if let Some(override_cache_control) = override_cache_control {
+            query_args.push(format!(
+                "{}={}",
+                constants::RESPONSE_CACHE_CONTROL,
+                percent_encode_path(override_cache_control)
+            ))
+        }
+        if !query_args.is_empty() {
+            url.push_str(&format!("?{}", query_args.join("&")));
         }
 
         let mut req = Request::get(&url);
@@ -1370,7 +1387,7 @@ impl S3Backend {
         path: &str,
         range: BytesRange,
     ) -> Result<Response<IncomingAsyncBody>> {
-        let mut req = self.s3_get_object_request(path, range, None)?;
+        let mut req = self.s3_get_object_request(path, range, None, None)?;
 
         self.signer.sign(&mut req).map_err(new_request_sign_error)?;
 
diff --git a/core/src/types/ops.rs b/core/src/types/ops.rs
index 2478036f..4e698a36 100644
--- a/core/src/types/ops.rs
+++ b/core/src/types/ops.rs
@@ -231,6 +231,7 @@ impl BatchOperations {
 pub struct OpRead {
     br: BytesRange,
     override_content_disposition: Option<String>,
+    override_cache_control: Option<String>,
 }
 
 impl OpRead {
@@ -251,10 +252,7 @@ impl OpRead {
     }
 
     /// Sets the content-disposition header that should be send back by the remote read operation.
-    pub fn with_override_content_disposition(
-        mut self,
-        content_disposition: impl Into<String>,
-    ) -> Self {
+    pub fn with_override_content_disposition(mut self, content_disposition: &str) -> Self {
         self.override_content_disposition = Some(content_disposition.into());
         self
     }
@@ -264,6 +262,17 @@ impl OpRead {
     pub fn override_content_disposition(&self) -> Option<&str> {
         self.override_content_disposition.as_deref()
     }
+
+    /// Sets the cache-control header that should be send back by the remote read operation.
+    pub fn with_override_cache_control(mut self, cache_control: &str) -> Self {
+        self.override_cache_control = Some(cache_control.into());
+        self
+    }
+
+    /// Returns the cache-control header that should be send back by the remote read operation.
+    pub fn override_cache_control(&self) -> Option<&str> {
+        self.override_cache_control.as_deref()
+    }
 }
 
 /// Args for `stat` operation.