opendal/services/s3/
error.rs1use bytes::Buf;
19use http::response::Parts;
20use http::Response;
21use quick_xml::de;
22use serde::Deserialize;
23
24use crate::raw::*;
25use crate::*;
26
27#[derive(Default, Debug, Deserialize, PartialEq, Eq)]
29#[serde(default, rename_all = "PascalCase")]
30pub(crate) struct S3Error {
31 pub code: String,
32 pub message: String,
33 pub resource: String,
34 pub request_id: String,
35}
36
37pub(super) fn parse_error(resp: Response<Buffer>) -> Error {
39 let (parts, body) = resp.into_parts();
40 let bs = body.to_bytes();
41
42 let (mut kind, mut retryable) = match parts.status.as_u16() {
43 403 => (ErrorKind::PermissionDenied, false),
44 404 => (ErrorKind::NotFound, false),
45 304 | 412 => (ErrorKind::ConditionNotMatch, false),
46 499 => (ErrorKind::Unexpected, true),
49 500 | 502 | 503 | 504 => (ErrorKind::Unexpected, true),
50 429 => (ErrorKind::RateLimited, true),
51 _ => (ErrorKind::Unexpected, false),
52 };
53
54 let body_content = bs.chunk();
55 let (message, s3_err) = de::from_reader::<_, S3Error>(body_content.reader())
56 .map(|s3_err| (format!("{s3_err:?}"), Some(s3_err)))
57 .unwrap_or_else(|_| (String::from_utf8_lossy(&bs).into_owned(), None));
58
59 if let Some(s3_err) = s3_err {
60 (kind, retryable) = parse_s3_error_code(s3_err.code.as_str()).unwrap_or((kind, retryable));
61 }
62
63 let mut err = Error::new(kind, message);
64
65 err = with_error_response_context(err, parts);
66
67 if retryable {
68 err = err.set_temporary();
69 }
70
71 err
72}
73
74pub(crate) fn from_s3_error(s3_error: S3Error, parts: Parts) -> Error {
76 let (kind, retryable) =
77 parse_s3_error_code(s3_error.code.as_str()).unwrap_or((ErrorKind::Unexpected, false));
78 let mut err = Error::new(kind, format!("{s3_error:?}"));
79
80 err = with_error_response_context(err, parts);
81
82 if retryable {
83 err = err.set_temporary();
84 }
85
86 err
87}
88
89pub fn parse_s3_error_code(code: &str) -> Option<(ErrorKind, bool)> {
92 match code {
93 "NoSuchBucket" => Some((ErrorKind::ConfigInvalid, false)),
98 "RequestTimeout" => Some((ErrorKind::Unexpected, true)),
103 "InternalError" => Some((ErrorKind::Unexpected, true)),
105 "OperationAborted" => Some((ErrorKind::Unexpected, true)),
108 "SlowDown" => Some((ErrorKind::RateLimited, true)),
112 "ServiceUnavailable" => Some((ErrorKind::Unexpected, true)),
118 "TooManyRequests" => Some((ErrorKind::RateLimited, true)),
122 _ => None,
123 }
124}
125
126#[cfg(test)]
127mod tests {
128 use super::*;
129
130 #[test]
132 fn test_parse_error() {
133 let bs = bytes::Bytes::from(
134 r#"
135<?xml version="1.0" encoding="UTF-8"?>
136<Error>
137 <Code>NoSuchKey</Code>
138 <Message>The resource you requested does not exist</Message>
139 <Resource>/mybucket/myfoto.jpg</Resource>
140 <RequestId>4442587FB7D0A2F9</RequestId>
141</Error>
142"#,
143 );
144
145 let out: S3Error = de::from_reader(bs.reader()).expect("must success");
146 println!("{out:?}");
147
148 assert_eq!(out.code, "NoSuchKey");
149 assert_eq!(out.message, "The resource you requested does not exist");
150 assert_eq!(out.resource, "/mybucket/myfoto.jpg");
151 assert_eq!(out.request_id, "4442587FB7D0A2F9");
152 }
153
154 #[test]
155 fn test_parse_error_from_unrelated_input() {
156 let bs = bytes::Bytes::from(
157 r#"
158<?xml version="1.0" encoding="UTF-8"?>
159<CompleteMultipartUploadResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
160 <Location>http://Example-Bucket.s3.ap-southeast-1.amazonaws.com/Example-Object</Location>
161 <Bucket>Example-Bucket</Bucket>
162 <Key>Example-Object</Key>
163 <ETag>"3858f62230ac3c915f300c664312c11f-9"</ETag>
164</CompleteMultipartUploadResult>
165"#,
166 );
167
168 let out: S3Error = de::from_reader(bs.reader()).expect("must success");
169 assert_eq!(out, S3Error::default());
170 }
171}