use reqwest::StatusCode;
#[derive(thiserror::Error, Debug)]
#[non_exhaustive]
pub enum Error {
#[error("API key is required to call Braze")]
MissingApiKey,
#[error("API key contains characters that are not allowed in an HTTP header")]
InvalidApiKey,
#[error("invalid Braze REST endpoint")]
InvalidEndpoint {
#[source]
source: url::ParseError,
},
#[error("failed to read credentials file")]
CredentialsIo {
#[source]
source: std::io::Error,
},
#[error("failed to parse credentials file")]
CredentialsParse {
#[source]
source: serde_json::Error,
},
#[error("HTTP transport error")]
Http {
#[source]
source: reqwest::Error,
},
#[error("Braze API returned {status}: {body}")]
Api {
status: StatusCode,
body: String,
},
#[error("failed to deserialize Braze response")]
Deserialize {
#[source]
source: serde_json::Error,
},
#[error("invalid request header `{name}`")]
InvalidHeader {
name: String,
},
#[error("invalid path segment `{segment}`")]
InvalidPathSegment {
segment: String,
},
}
impl Error {
pub fn is_retryable(&self) -> bool {
match self {
Error::Http { source } => {
source.is_timeout() || source.is_connect() || source.is_request()
}
Error::Api { status, .. } => {
status.is_server_error()
|| matches!(
*status,
StatusCode::REQUEST_TIMEOUT
| StatusCode::TOO_EARLY
| StatusCode::TOO_MANY_REQUESTS
)
}
Error::MissingApiKey
| Error::InvalidApiKey
| Error::InvalidEndpoint { .. }
| Error::CredentialsIo { .. }
| Error::CredentialsParse { .. }
| Error::Deserialize { .. }
| Error::InvalidHeader { .. }
| Error::InvalidPathSegment { .. } => false,
}
}
}
pub type Result<T> = std::result::Result<T, Error>;
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn retryable_classification() {
let rate_limited = Error::Api {
status: StatusCode::TOO_MANY_REQUESTS,
body: String::new(),
};
assert!(rate_limited.is_retryable());
let server = Error::Api {
status: StatusCode::BAD_GATEWAY,
body: String::new(),
};
assert!(server.is_retryable());
let unauthorized = Error::Api {
status: StatusCode::UNAUTHORIZED,
body: String::new(),
};
assert!(!unauthorized.is_retryable());
assert!(!Error::MissingApiKey.is_retryable());
assert!(!Error::InvalidHeader {
name: String::new()
}
.is_retryable());
}
}