opendal/services/ipmfs/
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 http::Response;
19use http::StatusCode;
20use serde::Deserialize;
21use serde_json::de;
22
23use crate::raw::*;
24use crate::*;
25
26#[derive(Deserialize, Default, Debug)]
27#[serde(default)]
28struct IpfsError {
29    #[serde(rename = "Message")]
30    message: String,
31    #[serde(rename = "Code")]
32    code: usize,
33    #[serde(rename = "Type")]
34    ty: String,
35}
36
37/// Parse error response into io::Error.
38///
39/// > Status code 500 means that the function does exist, but IPFS was not
40/// > able to fulfil the request because of an error.
41/// > To know that reason, you have to look at the error message that is
42/// > usually returned with the body of the response
43/// > (if no error, check the daemon logs).
44///
45/// ref: https://docs.ipfs.tech/reference/kubo/rpc/#http-status-codes
46pub(super) fn parse_error(resp: Response<Buffer>) -> Error {
47    let (parts, body) = resp.into_parts();
48    let bs = body.to_bytes();
49
50    let ipfs_error = de::from_slice::<IpfsError>(&bs).ok();
51
52    let (kind, retryable) = match parts.status {
53        StatusCode::INTERNAL_SERVER_ERROR => {
54            if let Some(ie) = &ipfs_error {
55                match ie.message.as_str() {
56                    "file does not exist" => (ErrorKind::NotFound, false),
57                    _ => (ErrorKind::Unexpected, false),
58                }
59            } else {
60                (ErrorKind::Unexpected, false)
61            }
62        }
63        StatusCode::BAD_GATEWAY | StatusCode::SERVICE_UNAVAILABLE | StatusCode::GATEWAY_TIMEOUT => {
64            (ErrorKind::Unexpected, true)
65        }
66        _ => (ErrorKind::Unexpected, false),
67    };
68
69    let message = match ipfs_error {
70        Some(ipfs_error) => format!("{ipfs_error:?}"),
71        None => String::from_utf8_lossy(&bs).into_owned(),
72    };
73
74    let mut err = Error::new(kind, message);
75
76    err = with_error_response_context(err, parts);
77
78    if retryable {
79        err = err.set_temporary();
80    }
81
82    err
83}
opendal/services/ipmfs/error.rs

opendal/services/ipmfs/
error.rs
