systemprompt_ai/
error.rs

1//! Typed error hierarchy for the [`systemprompt-ai`](crate) crate.
2//!
3//! Two error families live here:
4//!
5//! - [`AiError`] — the top-level public error returned by [`crate::services`].
6//!   It composes repository-level failures ([`RepositoryError`]) via `#[from]`,
7//!   plus common transport / parsing errors ([`reqwest::Error`],
8//!   [`serde_json::Error`], [`sqlx::Error`]).
9//! - [`RepositoryError`] — the persistence-layer error returned by every
10//!   `*Repository` type in [`crate::repository`].
11//!
12//! All public service signatures use [`Result<T>`] (i.e. `Result<T, AiError>`).
13//! The dyn `AiProvider` seam returns
14//! [`AiInferenceError`](systemprompt_models::errors::AiInferenceError); the
15//! `From<AiError>` impl below is the single mapping onto it.
16//!
17//! Copyright (c) systemprompt.io — Business Source License 1.1.
18//! See <https://systemprompt.io> for licensing details.
19
20use std::time::Duration;
21
22use thiserror::Error;
23use uuid::Uuid;
24
25use systemprompt_database::resilience::Outcome;
26use systemprompt_identifiers::{AiRequestId, McpServerId};
27
28#[derive(Debug, Error)]
29pub enum AiError {
30    #[error("Model not specified and no default available for provider {provider}")]
31    ModelNotSpecified { provider: String },
32
33    #[error("Request metadata missing required field: {field}")]
34    MissingMetadata { field: String },
35
36    #[error("User context required for billing and audit trails")]
37    MissingUserContext,
38
39    #[error("Provider {provider} returned empty response")]
40    EmptyProviderResponse { provider: String },
41
42    #[error("Tool call schema validation failed: {reason}")]
43    InvalidToolSchema { reason: String },
44
45    #[error("Authentication required for service {service_id}")]
46    AuthenticationRequired { service_id: McpServerId },
47
48    #[error("Structured output validation failed after {retries} attempts: {details}")]
49    StructuredOutputFailed { retries: usize, details: String },
50
51    #[error("Provider {provider} error: {message}")]
52    ProviderError { provider: String, message: String },
53
54    #[error("No configured provider supports model {model}")]
55    NoProviderForModel { model: String },
56
57    #[error("Serialization failed: {0}")]
58    SerializationError(#[from] serde_json::Error),
59
60    #[error("HTTP request failed: {0}")]
61    Http(#[from] reqwest::Error),
62
63    #[error("I/O error: {0}")]
64    Io(#[from] std::io::Error),
65
66    #[error("Message history cannot be serialized to JSON")]
67    MessageSerializationFailed,
68
69    #[error("Tool {tool_name} missing required field: {field}")]
70    MissingToolField { tool_name: String, field: String },
71
72    #[error("Tool description cannot be empty for tool: {tool_name}")]
73    EmptyToolDescription { tool_name: String },
74
75    #[error("No tool calls found in provider response")]
76    NoToolCalls,
77
78    #[error("Rate limit exceeded for provider {provider}: {details}")]
79    RateLimit { provider: String, details: String },
80
81    #[error("Provider {provider} returned HTTP {status}: {body}")]
82    HttpStatus {
83        provider: String,
84        status: u16,
85        retry_after: Option<Duration>,
86        body: String,
87    },
88
89    #[error("Provider {provider} request timed out after {after_ms}ms")]
90    Timeout { provider: String, after_ms: u64 },
91
92    #[error("Circuit breaker open for provider {provider}; failing fast")]
93    CircuitOpen { provider: String },
94
95    #[error("Provider {provider} unavailable: concurrency limit reached")]
96    DependencyUnavailable { provider: String },
97
98    #[error("Invalid API credentials for provider {provider}")]
99    AuthenticationFailed { provider: String },
100
101    #[error("Configuration error: {message}")]
102    ConfigurationError { message: String },
103
104    #[error("Database operation failed: {message}")]
105    DatabaseError { message: String },
106
107    #[error("MCP service {service_id} not found or not configured")]
108    McpServiceNotFound { service_id: McpServerId },
109
110    #[error("MCP service {service_id} requires OAuth authentication but no token available")]
111    McpAuthenticationMissing { service_id: McpServerId },
112
113    #[error("Failed to determine service authentication requirements: {details}")]
114    ServiceAuthCheckFailed { details: String },
115
116    #[error("Storage operation failed: {message}")]
117    StorageError { message: String },
118
119    #[error("Invalid input: {0}")]
120    InvalidInput(String),
121
122    #[error("Regex error: {0}")]
123    Regex(#[from] regex::Error),
124
125    #[error(transparent)]
126    ToolProvider(#[from] systemprompt_traits::ToolProviderError),
127
128    #[error("tool discovery incomplete: {0}")]
129    ToolDiscovery(String),
130
131    #[error("provider {provider} has no pricing for model {model}; refusing to bill it")]
132    UnknownModel { provider: String, model: String },
133
134    #[error(transparent)]
135    Secrets(#[from] systemprompt_config::SecretsBootstrapError),
136
137    #[error(transparent)]
138    WireParse(#[from] systemprompt_models::wire::error::WireParseError),
139
140    #[error("internal: {0}")]
141    Internal(String),
142}
143
144impl From<AiError> for systemprompt_models::errors::AiInferenceError {
145    fn from(err: AiError) -> Self {
146        match err {
147            AiError::ModelNotSpecified { ref provider }
148            | AiError::EmptyProviderResponse { ref provider } => Self::Provider {
149                provider: provider.clone(),
150                message: err.to_string(),
151            },
152            AiError::ProviderError { provider, message } => Self::Provider { provider, message },
153            AiError::NoProviderForModel { model } => Self::NoProviderForModel { model },
154            AiError::RateLimit { provider, details } => Self::RateLimited { provider, details },
155            AiError::AuthenticationFailed { provider } => Self::AuthenticationFailed { provider },
156            AiError::HttpStatus { ref provider, .. }
157            | AiError::Timeout { ref provider, .. }
158            | AiError::CircuitOpen { ref provider }
159            | AiError::DependencyUnavailable { ref provider } => Self::Unavailable {
160                provider: provider.clone(),
161                message: err.to_string(),
162            },
163            AiError::MissingMetadata { .. }
164            | AiError::MissingUserContext
165            | AiError::InvalidToolSchema { .. }
166            | AiError::StructuredOutputFailed { .. }
167            | AiError::MessageSerializationFailed
168            | AiError::MissingToolField { .. }
169            | AiError::EmptyToolDescription { .. }
170            | AiError::InvalidInput(_)
171            | AiError::WireParse(_) => Self::InvalidRequest(err.to_string()),
172            AiError::NoToolCalls
173            | AiError::McpServiceNotFound { .. }
174            | AiError::McpAuthenticationMissing { .. }
175            | AiError::ServiceAuthCheckFailed { .. }
176            | AiError::ToolDiscovery(_)
177            | AiError::ToolProvider(_) => Self::Tool(err.to_string()),
178            AiError::UnknownModel { .. }
179            | AiError::AuthenticationRequired { .. }
180            | AiError::ConfigurationError { .. }
181            | AiError::Secrets(_) => Self::Configuration(err.to_string()),
182            AiError::DatabaseError { .. } | AiError::StorageError { .. } => {
183                Self::Storage(err.to_string())
184            },
185            AiError::SerializationError(_)
186            | AiError::Http(_)
187            | AiError::Io(_)
188            | AiError::Regex(_)
189            | AiError::Internal(_) => Self::Internal(err.to_string()),
190        }
191    }
192}
193
194#[derive(Debug, Error)]
195pub enum RepositoryError {
196    #[error("AI request not found: {0}")]
197    NotFound(Uuid),
198
199    #[error("Database error: {0}")]
200    Database(#[from] sqlx::Error),
201
202    #[error("Invalid data: {field} - {reason}")]
203    InvalidData { field: String, reason: String },
204
205    #[error("Database pool initialization failed: {0}")]
206    PoolInitialization(String),
207
208    #[error("Settlement of AI request {request_id} rejected: {reason}")]
209    SettlementConflict {
210        request_id: AiRequestId,
211        reason: String,
212    },
213
214    #[error("AI request {0} already exists")]
215    AlreadyExists(AiRequestId),
216}
217
218impl AiError {
219    pub async fn from_error_response(provider: &str, response: reqwest::Response) -> Self {
220        let status = response.status().as_u16();
221        let retry_after = parse_retry_after(response.headers());
222        let body = response
223            .text()
224            .await
225            .unwrap_or_else(|e| format!("<unreadable body: {e}>"));
226        Self::HttpStatus {
227            provider: provider.to_owned(),
228            status,
229            retry_after,
230            body,
231        }
232    }
233
234    #[must_use]
235    pub fn classify(&self) -> Outcome {
236        match self {
237            Self::HttpStatus {
238                status,
239                retry_after,
240                ..
241            } => {
242                if matches!(*status, 408 | 425 | 429 | 500 | 502 | 503 | 504) {
243                    Outcome::Transient {
244                        retry_after: *retry_after,
245                    }
246                } else {
247                    Outcome::Permanent
248                }
249            },
250            Self::RateLimit { .. } | Self::Timeout { .. } => {
251                Outcome::Transient { retry_after: None }
252            },
253            Self::Http(err) if err.is_timeout() || err.is_connect() => {
254                Outcome::Transient { retry_after: None }
255            },
256            _ => Outcome::Permanent,
257        }
258    }
259}
260
261fn parse_retry_after(headers: &reqwest::header::HeaderMap) -> Option<Duration> {
262    headers
263        .get(reqwest::header::RETRY_AFTER)?
264        .to_str()
265        .ok()?
266        .trim()
267        .parse::<u64>()
268        .ok()
269        .map(Duration::from_secs)
270}
271
272pub type Result<T> = std::result::Result<T, AiError>;
273
274impl From<RepositoryError> for AiError {
275    fn from(error: RepositoryError) -> Self {
276        Self::DatabaseError {
277            message: error.to_string(),
278        }
279    }
280}
systemprompt_ai/error.rs

systemprompt_ai/
error.rs
