1use thiserror::Error;
4
5#[derive(Error, Debug)]
6pub enum StorageError {
7 #[error("sqlx error: {0}")]
8 Sqlx(#[from] sqlx::Error),
9
10 #[error("migration error: {0}")]
11 Migration(#[from] sqlx::migrate::MigrateError),
12
13 #[error("serialization error: {0}")]
14 Serde(#[from] serde_json::Error),
15
16 #[error("io error: {0}")]
17 Io(#[from] std::io::Error),
18
19 #[error("not found: {0}")]
20 NotFound(String),
21
22 #[error("invalid input: {0}")]
23 Invalid(String),
24}
25
26pub type StorageResult<T> = std::result::Result<T, StorageError>;
27
28#[cfg(test)]
29mod tests {
30 use super::*;
31
32 #[test]
33 fn debug_format_for_io_error() {
34 let io_err = std::io::Error::new(std::io::ErrorKind::NotFound, "missing");
35 let err: StorageError = io_err.into();
36 let dbg = format!("{:?}", err);
37 assert!(dbg.contains("Io"), "Debug should contain variant name: {dbg}");
38 assert!(dbg.contains("missing"), "Debug should contain inner message: {dbg}");
39 }
40
41 #[test]
42 fn display_for_io_error_includes_source_message() {
43 let io_err = std::io::Error::new(std::io::ErrorKind::PermissionDenied, "denied");
44 let err: StorageError = io_err.into();
45 let display = err.to_string();
46 assert!(
47 display.contains("io error"),
48 "Display prefix should be present: {display}"
49 );
50 assert!(
51 display.contains("denied"),
52 "Display should include inner io error: {display}"
53 );
54 }
55
56 #[test]
57 fn not_found_display_contains_payload() {
58 let err = StorageError::NotFound("run-42".to_string());
59 let display = err.to_string();
60 assert!(display.contains("not found"), "prefix: {display}");
61 assert!(display.contains("run-42"), "payload: {display}");
62 }
63
64 #[test]
65 fn invalid_display_contains_payload() {
66 let err = StorageError::Invalid("bad json".to_string());
67 let display = err.to_string();
68 assert!(display.contains("invalid input"), "prefix: {display}");
69 assert!(display.contains("bad json"), "payload: {display}");
70 }
71
72 #[test]
73 fn from_serde_json_error() {
74 let serde_err: serde_json::Error =
75 serde_json::from_str::<i32>("not a number").unwrap_err();
76 let err: StorageError = serde_err.into();
77 matches!(err, StorageError::Serde(_));
78 let display = err.to_string();
79 assert!(
80 display.contains("serialization error"),
81 "Display should include prefix: {display}"
82 );
83 }
84
85 #[test]
86 fn from_io_error_yields_io_variant() {
87 let io_err = std::io::Error::other("boom");
88 let err: StorageError = io_err.into();
89 assert!(matches!(err, StorageError::Io(_)));
90 }
91
92 #[test]
93 fn storage_result_ok_and_err_shortcuts() {
94 let ok: StorageResult<i32> = Ok(7);
95 assert_eq!(ok.unwrap(), 7);
96
97 let err: StorageResult<i32> = Err(StorageError::Invalid("x".into()));
98 assert!(err.is_err());
99 }
100
101 #[test]
102 fn sqlx_error_conversion_via_question_mark() {
103 fn propagate() -> StorageResult<()> {
104 let io_err = std::io::Error::other("inner");
105 let _x: StorageError = StorageError::Io(io_err);
106 Ok(())
107 }
108 assert!(propagate().is_ok());
109 }
110
111 #[test]
112 fn variants_are_distinct_patterns() {
113 let io_err = std::io::Error::other("io");
114 let err: StorageError = StorageError::Io(io_err);
115 match err {
116 StorageError::Sqlx(_) => panic!("should not be Sqlx"),
117 StorageError::Migration(_) => panic!("should not be Migration"),
118 StorageError::Serde(_) => panic!("should not be Serde"),
119 StorageError::Io(_) => {}
120 StorageError::NotFound(_) => panic!("should not be NotFound"),
121 StorageError::Invalid(_) => panic!("should not be Invalid"),
122 }
123 }
124}