heddle_object_model/
error.rs

1// SPDX-License-Identifier: Apache-2.0
2//! Shared error types across Heddle crates.
3
4use std::{error::Error, fmt, io, path::Path};
5
6use crate::object::{ContentHash, StateId, TreeError};
7
8/// Structured recovery details that can cross the embeddable facade boundary.
9#[derive(Debug, Clone, PartialEq)]
10pub struct RecoveryDetails {
11    pub kind: &'static str,
12    pub error: String,
13    pub hint: String,
14    pub unsafe_condition: String,
15    pub would_change: String,
16    pub preserved: String,
17    /// Explicit, path-specific recovery commands. When present these override
18    /// the `kind`-keyed fallback the CLI envelope would otherwise reconstruct
19    /// (the first entry is the primary command). `None` = use the generic
20    /// per-`kind` recovery mapping.
21    pub recovery_commands: Option<Vec<String>>,
22}
23
24impl RecoveryDetails {
25    pub fn safety_refusal(
26        kind: &'static str,
27        error: impl Into<String>,
28        hint: impl Into<String>,
29        unsafe_condition: impl Into<String>,
30        would_change: impl Into<String>,
31        already_preserved: impl Into<String>,
32    ) -> Self {
33        Self {
34            kind,
35            error: error.into(),
36            hint: hint.into(),
37            unsafe_condition: unsafe_condition.into(),
38            would_change: would_change.into(),
39            preserved: already_preserved.into(),
40            recovery_commands: None,
41        }
42    }
43
44    /// Attach explicit, path-specific recovery commands (the first entry is the
45    /// primary command). Used where the callsite has context — e.g. a source
46    /// checkout path — that the `kind`-keyed CLI fallback cannot reconstruct.
47    #[must_use]
48    pub fn with_recovery_commands(mut self, commands: Vec<String>) -> Self {
49        self.recovery_commands = Some(commands);
50        self
51    }
52
53    pub fn invalid_usage(
54        kind: &'static str,
55        error: impl Into<String>,
56        hint: impl Into<String>,
57    ) -> Self {
58        Self::safety_refusal(
59            kind,
60            error,
61            hint,
62            "the command arguments do not describe a valid operation",
63            "running with ambiguous or invalid arguments could target the wrong repository state or metadata",
64            "no repository objects, refs, metadata, or worktree files were changed",
65        )
66    }
67
68    pub fn feature_unavailable(command: &str, feature: &str) -> Self {
69        Self::safety_refusal(
70            "feature_unavailable",
71            format!("{command} requires building heddle with --features {feature}"),
72            format!(
73                "Use a binary built with the `{feature}` feature, or rerun without the feature-specific flag."
74            ),
75            format!("this heddle binary was built without the `{feature}` feature"),
76            format!("{command} cannot run because the requested analysis engine is unavailable"),
77            "repository state, refs, and worktree files were left unchanged",
78        )
79    }
80
81    pub fn serialization_error(detail: impl fmt::Display) -> Self {
82        Self::safety_refusal(
83            "state_corrupted",
84            "Repository state is corrupted or unreadable",
85            "Inspect repository integrity before attempting repair.",
86            format!("a stored repository object failed to decode: {detail}"),
87            "continuing would read or write through repository state Heddle cannot decode",
88            "the command stopped before mutating repository state; intact objects were left unchanged",
89        )
90    }
91
92    pub fn repository_integrity_error(error: impl Into<String>) -> Self {
93        Self::safety_refusal(
94            "repository_integrity_error",
95            error,
96            "Inspect repository integrity, then restore or repair the reported object/ref.",
97            "repository object or ref integrity did not pass validation",
98            "continuing could compound corruption or hide the missing object",
99            "the command stopped before applying the requested mutation",
100        )
101    }
102
103    pub fn repository_not_found(path: &Path) -> Self {
104        Self::safety_refusal(
105            "repository_not_found",
106            format!("repository not found at {}", path.display()),
107            "Initialize the requested repository before running repository commands.",
108            format!("no Heddle repository was found at '{}'", path.display()),
109            "the command cannot inspect or change repository state until initialization",
110            "no repository objects, refs, metadata, or worktree files were changed",
111        )
112    }
113
114    pub fn state_not_found(state_id: impl fmt::Display) -> Self {
115        Self::safety_refusal(
116            "state_not_found",
117            format!("State not found: {state_id}"),
118            "List recent states with `heddle log`, then choose an existing state id.",
119            "the requested state id does not exist in this repository",
120            "continuing with a guessed state could target the wrong history point",
121            "repository state, refs, metadata, and worktree files were left unchanged",
122        )
123    }
124}
125
126impl fmt::Display for RecoveryDetails {
127    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
128        write!(
129            f,
130            "{}. Unsafe: {}. Would change: {}. Preserved: {}.",
131            self.error, self.unsafe_condition, self.would_change, self.preserved
132        )?;
133        Ok(())
134    }
135}
136
137impl Error for RecoveryDetails {}
138
139/// Failure to acquire or access a repository lock.
140///
141/// The lock implementation lives in `heddle-objects`; this pure error value
142/// lives with [`HeddleError`] so the object-model crate does not depend on a
143/// storage backend.
144#[derive(Debug, thiserror::Error)]
145pub enum LockError {
146    #[error("failed to acquire lock: {0}")]
147    Acquire(#[source] io::Error),
148    #[error("lock file not accessible: {0}")]
149    Io(#[source] io::Error),
150}
151
152/// Error type for repository/storage-adjacent operations.
153#[derive(Debug, thiserror::Error)]
154pub enum HeddleError {
155    #[error("{0}")]
156    Recovery(Box<RecoveryDetails>),
157    #[error("object not found: {0}")]
158    NotFound(String),
159    #[error("No merge in progress")]
160    NoMergeInProgress,
161    #[error("no worktree changes to capture")]
162    NoChanges,
163    #[error("state not found: {0}")]
164    StateNotFound(StateId),
165    #[error("invalid object: {0}")]
166    InvalidObject(String),
167    #[error("repository not found at {0}")]
168    RepositoryNotFound(std::path::PathBuf),
169    #[error("repository already exists at {0}")]
170    RepositoryExists(std::path::PathBuf),
171    #[error("repository clone at {0} is incomplete and must be repaired from its origin")]
172    IncompleteClone(std::path::PathBuf),
173    #[error(
174        "repository config at {path} uses repository format {found} but this binary supports {supported}; upgrade heddle or run `heddle migrate`"
175    )]
176    RepositoryFormatTooNew {
177        path: std::path::PathBuf,
178        found: u32,
179        supported: u32,
180    },
181    #[error(
182        "repository at {path} predates format v{required} (found v{found}); recreate it or re-adopt its Git history with this Heddle version"
183    )]
184    RepositoryFormatMigrationRequired {
185        path: std::path::PathBuf,
186        found: u32,
187        required: u32,
188    },
189    #[error(
190        "{storage} uses format {found}, but this binary supports {supported}; upgrade Heddle before opening it"
191    )]
192    StorageFormatTooNew {
193        storage: String,
194        found: u32,
195        supported: u32,
196    },
197    #[error(
198        "{storage} predates required format {required} (found {found}); recreate the repository or re-adopt its Git history with this Heddle version"
199    )]
200    StorageFormatMigrationRequired {
201        storage: String,
202        found: u32,
203        required: u32,
204    },
205    #[error("io error: {0}")]
206    Io(#[from] std::io::Error),
207    #[error("repository lock unavailable: {0}")]
208    Lock(#[from] LockError),
209    #[error("serialization error: {0}")]
210    Serialization(String),
211    #[error("configuration error: {0}")]
212    Config(String),
213    #[error("configuration parse error at {path}: {source}")]
214    ConfigParse {
215        path: std::path::PathBuf,
216        // Keep the original `toml::de::Error` as the error source — not a
217        // flattened string — so `HeddleExitCode::from_error` can still
218        // downcast through the chain and classify config-parse failures as
219        // EX_DATAERR (65) rather than falling through to EX_IOERR (74).
220        #[source]
221        source: toml::de::Error,
222    },
223    #[error(
224        "invalid {key}: '{value}' — valid values are {} (in {path})",
225        valid_values.join(" or ")
226    )]
227    ConfigInvalidValue {
228        path: std::path::PathBuf,
229        key: String,
230        value: String,
231        valid_values: Vec<String>,
232    },
233    #[error("conflict: {0}")]
234    Conflict(String),
235    #[error("compression error: {0}")]
236    Compression(String),
237    #[error("invalid ref name: {0}")]
238    InvalidRefName(String),
239    #[error("file too large: {0} bytes")]
240    InvalidFileSize(u64),
241    #[error(
242        "symlink target escapes repository: {} -> {}",
243        path.display(),
244        target.display()
245    )]
246    InvalidSymlinkTarget {
247        path: std::path::PathBuf,
248        target: std::path::PathBuf,
249    },
250    #[error("object corruption: expected {expected}, found {found}")]
251    Corruption {
252        expected: ContentHash,
253        found: ContentHash,
254    },
255    #[error(
256        "missing {object_type} object: {id} (run `heddle maintenance fsck --full` to inspect store integrity)"
257    )]
258    MissingObject { object_type: String, id: String },
259    #[error("invalid tree entry: {0}")]
260    InvalidTreeEntry(#[from] TreeError),
261}
262
263impl HeddleError {
264    pub fn recovery(details: RecoveryDetails) -> Self {
265        HeddleError::Recovery(Box::new(details))
266    }
267}
268
269impl From<rmp_serde::encode::Error> for HeddleError {
270    fn from(e: rmp_serde::encode::Error) -> Self {
271        HeddleError::Serialization(e.to_string())
272    }
273}
274
275impl From<rmp_serde::decode::Error> for HeddleError {
276    fn from(e: rmp_serde::decode::Error) -> Self {
277        HeddleError::Serialization(e.to_string())
278    }
279}
280
281impl From<crate::object::SemanticIndexError> for HeddleError {
282    fn from(e: crate::object::SemanticIndexError) -> Self {
283        HeddleError::InvalidObject(e.to_string())
284    }
285}
286
287impl From<toml::de::Error> for HeddleError {
288    fn from(e: toml::de::Error) -> Self {
289        HeddleError::Config(e.to_string())
290    }
291}
292
293impl From<toml::ser::Error> for HeddleError {
294    fn from(e: toml::ser::Error) -> Self {
295        HeddleError::Config(e.to_string())
296    }
297}
298
299impl From<serde_json::Error> for HeddleError {
300    fn from(e: serde_json::Error) -> Self {
301        HeddleError::Serialization(e.to_string())
302    }
303}
304
305impl From<heddle_format::compression::CompressionError> for HeddleError {
306    fn from(e: heddle_format::compression::CompressionError) -> Self {
307        HeddleError::Compression(e.to_string())
308    }
309}
310
311/// Result type for repository/storage-adjacent operations.
312pub type Result<T> = std::result::Result<T, HeddleError>;
313
314#[cfg(test)]
315mod tests {
316    use super::{HeddleError, RecoveryDetails};
317
318    #[test]
319    fn safety_refusal_formats_domain_details() {
320        let details = RecoveryDetails::safety_refusal(
321            "example",
322            "error",
323            "hint",
324            "unsafe",
325            "would change",
326            "preserved",
327        );
328
329        assert_eq!(
330            details.to_string(),
331            "error. Unsafe: unsafe. Would change: would change. Preserved: preserved."
332        );
333    }
334
335    #[test]
336    fn recovery_error_displays_structured_error_copy() {
337        let err = HeddleError::recovery(RecoveryDetails::serialization_error("bad marker"));
338
339        assert!(err.to_string().contains("Repository state is corrupted"));
340        assert!(!err.to_string().contains("heddle maintenance fsck --full"));
341    }
342}
heddle_object_model/error.rs

heddle_object_model/
error.rs
