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: Add if_none_match for write #5129

Merged
merged 2 commits into from
Oct 8, 2024
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
12 changes: 12 additions & 0 deletions core/src/raw/ops.rs
Original file line number Diff line number Diff line change
Expand Up @@ -600,6 +600,7 @@ pub struct OpWrite {
content_disposition: Option<String>,
cache_control: Option<String>,
executor: Option<Executor>,
if_none_match: Option<String>,
user_metadata: Option<HashMap<String, String>>,
}

Expand Down Expand Up @@ -685,6 +686,17 @@ impl OpWrite {
self
}

/// Set the If-None-Match of the option
pub fn with_if_none_match(mut self, s: &str) -> Self {
self.if_none_match = Some(s.to_string());
self
}

/// Get If-None-Match from option
pub fn if_none_match(&self) -> Option<&str> {
self.if_none_match.as_deref()
}

/// Merge given executor into option.
///
/// If executor has already been set, this will do nothing.
Expand Down
1 change: 1 addition & 0 deletions core/src/services/s3/backend.rs
Original file line number Diff line number Diff line change
Expand Up @@ -917,6 +917,7 @@ impl Access for S3Backend {
write_can_multi: true,
write_with_cache_control: true,
write_with_content_type: true,
write_with_if_none_match: true,
write_with_user_metadata: true,

// The min multipart size of S3 is 5 MiB.
Expand Down
4 changes: 4 additions & 0 deletions core/src/services/s3/core.rs
Original file line number Diff line number Diff line change
Expand Up @@ -475,6 +475,10 @@ impl S3Core {
req = self.insert_checksum_header(req, &checksum);
}

if let Some(if_none_match) = args.if_none_match() {
req = req.header(IF_NONE_MATCH, if_none_match);
}

// Set body
let req = req.body(body).map_err(new_request_build_error)?;

Expand Down
2 changes: 2 additions & 0 deletions core/src/types/capability.rs
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@ pub struct Capability {
pub write_with_content_disposition: bool,
/// If operator supports write with cache control.
pub write_with_cache_control: bool,
/// If operator supports write with if none match.
pub write_with_if_none_match: bool,
/// If operator supports write with user defined metadata
pub write_with_user_metadata: bool,
/// write_multi_max_size is the max size that services support in write_multi.
Expand Down
23 changes: 23 additions & 0 deletions core/src/types/operator/operator.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1201,6 +1201,29 @@ impl Operator {
/// # }
/// ```
///
/// ## `if_none_match`
///
/// Set `if_none_match` for this `write` request.
///
/// This feature can be used to check if the file already exists.
/// This prevents overwriting of existing objects with identical key names.
/// Users can use *(asterisk) to verify if a file already exists by matching with any ETag.
/// Note: S3 only support use *(asterisk).
///
/// If file exists, an error with kind [`ErrorKind::ConditionNotMatch`] will be returned.
Copy link
Member

Choose a reason for hiding this comment

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

Perhaps we can also provide an example to demonstrate how to handle this error.

///
/// ```no_run
/// # use opendal::{ErrorKind, Result};
/// use opendal::Operator;
/// # async fn test(op: Operator, etag: &str) -> Result<()> {
/// let bs = b"hello, world!".to_vec();
/// let res = op.write_with("path/to/file", bs).if_none_match("*").await;
/// assert!(res.is_err());
/// assert_eq!(res.unwrap_err().kind(), ErrorKind::ConditionNotMatch);
/// # Ok(())
/// # }
/// ```
///
/// # Examples
///
/// ```
Expand Down
5 changes: 5 additions & 0 deletions core/src/types/operator/operator_futures.rs
Original file line number Diff line number Diff line change
Expand Up @@ -324,6 +324,11 @@ impl<F: Future<Output = Result<()>>> FutureWrite<F> {
self.map(|(args, options, bs)| (args.with_executor(executor), options, bs))
}

/// Set the If-None-Match for this operation.
pub fn if_none_match(self, s: &str) -> Self {
self.map(|(args, options, bs)| (args.with_if_none_match(s), options, bs))
}

/// Set the user defined metadata of the op
///
/// ## Notes
Expand Down
22 changes: 22 additions & 0 deletions core/tests/behavior/async_write.rs
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ pub fn tests(op: &Operator, tests: &mut Vec<Trial>) {
test_write_with_cache_control,
test_write_with_content_type,
test_write_with_content_disposition,
test_write_with_if_none_match,
test_write_with_user_metadata,
test_writer_write,
test_writer_write_with_overwrite,
Expand Down Expand Up @@ -624,3 +625,24 @@ pub async fn test_writer_write_with_overwrite(op: Operator) -> Result<()> {
op.delete(&path).await.expect("delete must succeed");
Ok(())
}

/// Write an exists file with if_none_match should match, else get a ConditionNotMatch error.
pub async fn test_write_with_if_none_match(op: Operator) -> Result<()> {
if !op.info().full_capability().write_with_if_none_match {
return Ok(());
}

let (path, content, _) = TEST_FIXTURE.new_file(op.clone());

op.write(&path, content.clone())
.await
.expect("write must succeed");
let res = op
.write_with(&path, content.clone())
.if_none_match("*")
.await;
assert!(res.is_err());
assert_eq!(res.unwrap_err().kind(), ErrorKind::ConditionNotMatch);

Ok(())
}
Loading