opendal/services/oss/
error.rs

1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements.  See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership.  The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License.  You may obtain a copy of the License at
8//
9//   http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied.  See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18use bytes::Buf;
19use http::Response;
20use http::StatusCode;
21use quick_xml::de;
22use serde::Deserialize;
23
24use crate::raw::*;
25use crate::*;
26
27/// OssError is the error returned by oss service.
28#[derive(Default, Debug, Deserialize)]
29#[serde(default, rename_all = "PascalCase")]
30struct OssError {
31    code: String,
32    message: String,
33    request_id: String,
34    host_id: String,
35}
36
37/// Parse error response into Error.
38pub(super) fn parse_error(resp: Response<Buffer>) -> Error {
39    let (parts, body) = resp.into_parts();
40    let bs = body.to_bytes();
41
42    let (kind, retryable) = match parts.status {
43        StatusCode::NOT_FOUND => (ErrorKind::NotFound, false),
44        StatusCode::FORBIDDEN => (ErrorKind::PermissionDenied, false),
45        StatusCode::PRECONDITION_FAILED | StatusCode::NOT_MODIFIED | StatusCode::CONFLICT => {
46            (ErrorKind::ConditionNotMatch, false)
47        }
48        StatusCode::INTERNAL_SERVER_ERROR
49        | StatusCode::BAD_GATEWAY
50        | StatusCode::SERVICE_UNAVAILABLE
51        | StatusCode::GATEWAY_TIMEOUT => (ErrorKind::Unexpected, true),
52        _ => (ErrorKind::Unexpected, false),
53    };
54
55    let message = match de::from_reader::<_, OssError>(bs.clone().reader()) {
56        Ok(oss_err) => format!("{oss_err:?}"),
57        Err(_) => String::from_utf8_lossy(&bs).into_owned(),
58    };
59
60    let mut err = Error::new(kind, message);
61
62    err = with_error_response_context(err, parts);
63
64    if retryable {
65        err = err.set_temporary();
66    }
67
68    err
69}
70
71#[cfg(test)]
72mod tests {
73    use super::*;
74
75    /// Error response example is from https://www.alibabacloud.com/help/en/object-storage-service/latest/error-responses
76    #[test]
77    fn test_parse_error() {
78        let bs = bytes::Bytes::from(
79            r#"
80<?xml version="1.0" ?>
81<Error xmlns="http://doc.oss-cn-hangzhou.aliyuncs.com">
82    <Code>
83        AccessDenied
84    </Code>
85    <Message>
86        Query-string authentication requires the Signature, Expires and OSSAccessKeyId parameters
87    </Message>
88    <RequestId>
89        1D842BC54255****
90    </RequestId>
91    <HostId>
92        oss-cn-hangzhou.aliyuncs.com
93    </HostId>
94</Error>
95"#,
96        );
97
98        let out: OssError = de::from_reader(bs.reader()).expect("must success");
99        println!("{out:?}");
100
101        assert_eq!(out.code, "AccessDenied");
102        assert_eq!(out.message, "Query-string authentication requires the Signature, Expires and OSSAccessKeyId parameters");
103        assert_eq!(out.request_id, "1D842BC54255****");
104        assert_eq!(out.host_id, "oss-cn-hangzhou.aliyuncs.com");
105    }
106}
opendal/services/oss/error.rs

opendal/services/oss/
error.rs
