1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
use std::any;
use std::error::Error;
use thiserror::Error;
use crate::api::{PaginationError, UrlBase};
/// Errors which may occur when creating form data.
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum BodyError {
/// Body data could not be serialized from form parameters.
#[error("failed to URL encode form parameters: {}", source)]
UrlEncoded {
/// The source of the error.
#[from]
source: serde_urlencoded::ser::Error,
},
/// Body data could not be serialized to JSON from form parameters.
#[error("failed to JSON encode form parameters: {}", source)]
JsonEncoded {
/// The source of the error.
#[from]
source: serde_json::Error,
},
}
/// Errors which may occur when using API endpoints.
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum ApiError<E>
where
E: Error + Send + Sync + 'static,
{
/// The client encountered an error.
#[error("client error: {}", source)]
Client {
/// The client error.
source: E,
},
/// Authentication failed.
#[error("failed to authenticate: {}", source)]
Auth {
/// The source of the error.
#[from]
source: crate::AuthError,
},
/// The URL failed to parse.
#[error("failed to parse url: {}", source)]
UrlParse {
/// The source of the error.
#[from]
source: url::ParseError,
},
/// Body data could not be created.
#[error("failed to create form data: {}", source)]
Body {
/// The source of the error.
#[from]
source: BodyError,
},
/// JSON deserialization from GitLab failed.
#[error("could not parse JSON response: {}", source)]
Json {
/// The source of the error.
#[from]
source: serde_json::Error,
},
/// The resource has been moved permanently.
#[error("moved permanently to: {}", location.as_ref().map(AsRef::as_ref).unwrap_or("<UNKNOWN>"))]
MovedPermanently {
/// The new location for the resource.
location: Option<String>,
},
/// GitLab returned an error message.
#[error("gitlab server error: {}", msg)]
Gitlab {
/// The error message from GitLab.
msg: String,
},
/// GitLab returned an error without JSON information.
#[error("gitlab internal server error {}", status)]
GitlabService {
/// The status code for the return.
status: http::StatusCode,
/// The error data from GitLab.
data: Vec<u8>,
},
/// GitLab returned an error object.
#[error("gitlab server error: {:?}", obj)]
GitlabObject {
/// The error object from GitLab.
obj: serde_json::Value,
},
/// GitLab returned an HTTP error with JSON we did not recognize.
#[error("gitlab server error: {:?}", obj)]
GitlabUnrecognized {
/// The full object from GitLab.
obj: serde_json::Value,
},
/// Failed to parse an expected data type from JSON.
#[error("could not parse {} data from JSON: {}", typename, source)]
DataType {
/// The source of the error.
source: serde_json::Error,
/// The name of the type that could not be deserialized.
typename: &'static str,
},
/// An error with pagination occurred.
#[error("failed to handle for pagination: {}", source)]
Pagination {
/// The source of the error.
#[from]
source: PaginationError,
},
/// The client does not understand how to use an endpoint for the given URL base.
#[error("unsupported URL base: {:?}", url_base)]
UnsupportedUrlBase {
/// The URL base that is not supported.
url_base: UrlBase,
},
}
impl<E> ApiError<E>
where
E: Error + Send + Sync + 'static,
{
/// Create an API error in a client error.
pub fn client(source: E) -> Self {
ApiError::Client {
source,
}
}
/// Wrap a client error in another wrapper.
pub fn map_client<F, W>(self, f: F) -> ApiError<W>
where
F: FnOnce(E) -> W,
W: Error + Send + Sync + 'static,
{
match self {
Self::Client {
source,
} => ApiError::client(f(source)),
Self::UrlParse {
source,
} => {
ApiError::UrlParse {
source,
}
},
Self::Auth {
source,
} => {
ApiError::Auth {
source,
}
},
Self::Body {
source,
} => {
ApiError::Body {
source,
}
},
Self::Json {
source,
} => {
ApiError::Json {
source,
}
},
Self::MovedPermanently {
location,
} => {
ApiError::MovedPermanently {
location,
}
},
Self::Gitlab {
msg,
} => {
ApiError::Gitlab {
msg,
}
},
Self::GitlabService {
status,
data,
} => {
ApiError::GitlabService {
status,
data,
}
},
Self::GitlabObject {
obj,
} => {
ApiError::GitlabObject {
obj,
}
},
Self::GitlabUnrecognized {
obj,
} => {
ApiError::GitlabUnrecognized {
obj,
}
},
Self::DataType {
source,
typename,
} => {
ApiError::DataType {
source,
typename,
}
},
Self::Pagination {
source,
} => {
ApiError::Pagination {
source,
}
},
Self::UnsupportedUrlBase {
url_base,
} => {
ApiError::UnsupportedUrlBase {
url_base,
}
},
}
}
pub(crate) fn moved_permanently(raw_location: Option<&http::HeaderValue>) -> Self {
let location = raw_location.map(|v| String::from_utf8_lossy(v.as_bytes()).into());
Self::MovedPermanently {
location,
}
}
pub(crate) fn server_error(status: http::StatusCode, body: &bytes::Bytes) -> Self {
Self::GitlabService {
status,
data: body.into_iter().copied().collect(),
}
}
pub(crate) fn from_gitlab(value: serde_json::Value) -> Self {
let error_value = value
.pointer("/message")
.or_else(|| value.pointer("/error"));
if let Some(error_value) = error_value {
if let Some(msg) = error_value.as_str() {
ApiError::Gitlab {
msg: msg.into(),
}
} else {
ApiError::GitlabObject {
obj: error_value.clone(),
}
}
} else {
ApiError::GitlabUnrecognized {
obj: value,
}
}
}
pub(crate) fn data_type<T>(source: serde_json::Error) -> Self {
ApiError::DataType {
source,
typename: any::type_name::<T>(),
}
}
pub(crate) fn unsupported_url_base(url_base: UrlBase) -> Self {
Self::UnsupportedUrlBase {
url_base,
}
}
}
#[cfg(test)]
mod tests {
use serde_json::json;
use thiserror::Error;
use crate::api::ApiError;
#[derive(Debug, Error)]
#[error("my error")]
enum MyError {}
#[test]
fn gitlab_error_error() {
let obj = json!({
"error": "error contents",
});
let err: ApiError<MyError> = ApiError::from_gitlab(obj);
if let ApiError::Gitlab {
msg,
} = err
{
assert_eq!(msg, "error contents");
} else {
panic!("unexpected error: {}", err);
}
}
#[test]
fn gitlab_error_message_string() {
let obj = json!({
"message": "error contents",
});
let err: ApiError<MyError> = ApiError::from_gitlab(obj);
if let ApiError::Gitlab {
msg,
} = err
{
assert_eq!(msg, "error contents");
} else {
panic!("unexpected error: {}", err);
}
}
#[test]
fn gitlab_error_message_object() {
let err_obj = json!({
"blah": "foo",
});
let obj = json!({
"message": err_obj,
});
let err: ApiError<MyError> = ApiError::from_gitlab(obj);
if let ApiError::GitlabObject {
obj,
} = err
{
assert_eq!(obj, err_obj);
} else {
panic!("unexpected error: {}", err);
}
}
#[test]
fn gitlab_error_message_unrecognized() {
let err_obj = json!({
"some_weird_key": "an even weirder value",
});
let err: ApiError<MyError> = ApiError::from_gitlab(err_obj.clone());
if let ApiError::GitlabUnrecognized {
obj,
} = err
{
assert_eq!(obj, err_obj);
} else {
panic!("unexpected error: {}", err);
}
}
}