Skip to main content

ironflow_store/
error.rs

1//! Storage error types.
2//!
3//! [`StoreError`] covers all failure modes for [`RunStore`](crate::store::RunStore)
4//! implementations, from missing records to invalid FSM transitions.
5
6use thiserror::Error;
7use uuid::Uuid;
8
9use crate::entities::RunStatus;
10
11/// Errors produced by [`RunStore`](crate::store::RunStore) operations.
12///
13/// # Examples
14///
15/// ```
16/// use ironflow_store::error::StoreError;
17/// use uuid::Uuid;
18///
19/// let err = StoreError::RunNotFound(Uuid::nil());
20/// assert!(err.to_string().contains("run not found"));
21/// ```
22#[derive(Debug, Error)]
23pub enum StoreError {
24    /// The requested run does not exist.
25    #[error("run not found: {0}")]
26    RunNotFound(Uuid),
27
28    /// The requested step does not exist.
29    #[error("step not found: {0}")]
30    StepNotFound(Uuid),
31
32    /// Attempted an illegal FSM transition.
33    #[error("invalid status transition: {from} -> {to}")]
34    InvalidTransition {
35        /// Current status.
36        from: RunStatus,
37        /// Attempted target status.
38        to: RunStatus,
39    },
40
41    /// Email is already taken by another user.
42    #[error("email already exists: {0}")]
43    DuplicateEmail(String),
44
45    /// Username is already taken by another user.
46    #[error("username already exists: {0}")]
47    DuplicateUsername(String),
48
49    /// The requested user does not exist.
50    #[error("user not found: {0}")]
51    UserNotFound(Uuid),
52
53    /// The worker no longer holds the lease on this run.
54    ///
55    /// Either another worker took it over after the lease expired, or the run
56    /// left the `Running` state (cancelled, failed, awaiting approval).
57    #[error("lease lost on run {run_id}")]
58    LeaseLost {
59        /// Run whose lease was lost.
60        run_id: Uuid,
61        /// Worker currently holding the lease, if any.
62        held_by: Option<String>,
63    },
64
65    /// The step already holds an artifact with this name.
66    #[error("artifact {name:?} already exists on step {step_id}")]
67    DuplicateArtifact {
68        /// Step that already owns the name.
69        step_id: Uuid,
70        /// The conflicting artifact name.
71        name: String,
72    },
73
74    /// Another non-terminal run already holds this concurrency key.
75    #[error("concurrency key {key:?} is held by active run {run_id}")]
76    ConcurrencyConflict {
77        /// The contested key.
78        key: String,
79        /// The run holding it.
80        run_id: Uuid,
81    },
82
83    /// The requested schedule does not exist.
84    #[error("schedule not found: {0}")]
85    ScheduleNotFound(Uuid),
86
87    /// The requested approval delegation does not exist.
88    #[error("approval delegation not found: {0}")]
89    DelegationNotFound(Uuid),
90
91    /// The requested provider account does not exist.
92    #[error("provider account not found: {0}")]
93    ProviderAccountNotFound(Uuid),
94
95    /// A provider account with this name already exists.
96    #[error("provider account already exists: {0}")]
97    DuplicateProviderAccount(String),
98
99    /// A database or I/O error from the backing store.
100    #[error("database error: {0}")]
101    Database(String),
102
103    /// JSON serialization or deserialization failed.
104    #[error("serialization error: {0}")]
105    Serialization(#[from] serde_json::Error),
106
107    /// A cryptographic operation failed (encryption or decryption).
108    #[error("crypto error: {0}")]
109    Crypto(String),
110}
111
112#[cfg(test)]
113mod tests {
114    use super::*;
115
116    #[test]
117    fn run_not_found_display() {
118        let id = Uuid::nil();
119        let err = StoreError::RunNotFound(id);
120        assert_eq!(err.to_string(), format!("run not found: {id}"));
121    }
122
123    #[test]
124    fn step_not_found_display() {
125        let id = Uuid::nil();
126        let err = StoreError::StepNotFound(id);
127        assert_eq!(err.to_string(), format!("step not found: {id}"));
128    }
129
130    #[test]
131    fn invalid_transition_display() {
132        let err = StoreError::InvalidTransition {
133            from: RunStatus::Pending,
134            to: RunStatus::Completed,
135        };
136        assert!(err.to_string().contains("Pending"));
137        assert!(err.to_string().contains("Completed"));
138    }
139
140    #[test]
141    fn concurrency_conflict_display() {
142        let run_id = Uuid::now_v7();
143        let err = StoreError::ConcurrencyConflict {
144            key: "issue:12".to_string(),
145            run_id,
146        };
147        let message = err.to_string();
148        assert!(message.contains("issue:12"));
149        assert!(message.contains(&run_id.to_string()));
150    }
151
152    #[test]
153    fn delegation_not_found_display() {
154        let id = Uuid::nil();
155        let err = StoreError::DelegationNotFound(id);
156        assert_eq!(
157            err.to_string(),
158            format!("approval delegation not found: {id}")
159        );
160    }
161
162    #[test]
163    fn database_error_display() {
164        let err = StoreError::Database("connection refused".to_string());
165        assert!(err.to_string().contains("connection refused"));
166    }
167
168    #[test]
169    fn serialization_error_from_serde() {
170        let serde_err = serde_json::from_str::<String>("not json").unwrap_err();
171        let err = StoreError::from(serde_err);
172        assert!(err.to_string().contains("serialization error"));
173    }
174}