Skip to content

Commit

Permalink
Provide an adequate error message when if-none-match-* can be replace…
Browse files Browse the repository at this point in the history
…d with if-none-exists
  • Loading branch information
gruuya committed Jan 3, 2025
1 parent 291404e commit 44e62cc
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 14 deletions.
57 changes: 44 additions & 13 deletions core/src/layers/correctness_check.rs
Original file line number Diff line number Diff line change
Expand Up @@ -123,14 +123,14 @@ impl<A: Access> LayeredAccess for CorrectnessAccessor<A> {
));
}
if let Some(if_none_match) = args.if_none_match() {
// AWS S3 supports only wildcard (every resource) matching
let is_s3_wildcard_match = self.info.scheme() == Scheme::S3 && if_none_match == "*";
if !is_s3_wildcard_match || !capability.write_with_if_none_match {
return Err(new_unsupported_error(
self.info.as_ref(),
Operation::Write,
"if_none_match",
));
if !capability.write_with_if_none_match {
let mut err =
new_unsupported_error(self.info.as_ref(), Operation::Write, "if_none_match");
if if_none_match == "*" && capability.write_with_if_not_exists {
err = err.with_context("hint", "use if_not_exists instead");
}

return Err(err);
}
}

Expand Down Expand Up @@ -308,7 +308,7 @@ mod tests {
}

async fn write(&self, _: &str, _: OpWrite) -> Result<(RpWrite, Self::Writer)> {
Ok((RpWrite::new(), Box::new(())))
Ok((RpWrite::new(), Box::new(MockWriter)))
}

async fn list(&self, _: &str, _: OpList) -> Result<(RpList, Self::Lister)> {
Expand All @@ -320,6 +320,22 @@ mod tests {
}
}

struct MockWriter;

impl oio::Write for MockWriter {
async fn write(&mut self, _: Buffer) -> Result<()> {
Ok(())
}

async fn close(&mut self) -> Result<()> {
Ok(())
}

async fn abort(&mut self) -> Result<()> {
Ok(())
}
}

struct MockDeleter;

impl oio::Delete for MockDeleter {
Expand Down Expand Up @@ -380,6 +396,7 @@ mod tests {
async fn test_write_with() {
let op = new_test_operator(Capability {
write: true,
write_with_if_not_exists: true,
..Default::default()
});
let res = op.write_with("path", "".as_bytes()).append(true).await;
Expand All @@ -388,17 +405,31 @@ mod tests {

let res = op
.write_with("path", "".as_bytes())
.if_not_exists(true)
.if_none_match("etag")
.await;
assert!(res.is_err());
assert_eq!(res.unwrap_err().kind(), ErrorKind::Unsupported);
assert_eq!(
res.unwrap_err().to_string(),
"Unsupported (permanent) at write => service memory doesn't support operation write with args if_none_match"
);

// Now try a wildcard if-none-match
let res = op
.write_with("path", "".as_bytes())
.if_none_match("etag")
.if_none_match("*")
.await;
assert!(res.is_err());
assert_eq!(res.unwrap_err().kind(), ErrorKind::Unsupported);
assert_eq!(
res.unwrap_err().to_string(),
"Unsupported (permanent) at write, context: { hint: use if_not_exists instead } => \
service memory doesn't support operation write with args if_none_match"
);

let res = op
.write_with("path", "".as_bytes())
.if_not_exists(true)
.await;
assert!(res.is_ok());

let op = new_test_operator(Capability {
write: true,
Expand Down
2 changes: 1 addition & 1 deletion core/src/services/s3/core.rs
Original file line number Diff line number Diff line change
Expand Up @@ -465,7 +465,7 @@ impl S3Core {
req = req.header(IF_MATCH, if_match);
}

if args.if_not_exists() || args.if_none_match() == Some("*") {
if args.if_not_exists() {
req = req.header(IF_NONE_MATCH, "*");
}

Expand Down

0 comments on commit 44e62cc

Please sign in to comment.