areev_core/
error.rs

1use std::fmt;
2
3/// Content-addressed SHA-256 hash (32 bytes, displayed as lowercase hex).
4#[derive(Clone, Copy, PartialEq, Eq, Hash)]
5pub struct Hash([u8; 32]);
6
7impl Hash {
8    /// Create a hash from a fixed-size 32-byte array (compile-time safe).
9    pub fn from_bytes(bytes: &[u8; 32]) -> Self {
10        Hash(*bytes)
11    }
12
13    /// Create a hash from a variable-length byte slice (fallible).
14    pub fn try_from_bytes(bytes: &[u8]) -> Result<Self> {
15        if bytes.len() < 32 {
16            return Err(AreevError::Format(format!(
17                "hash requires 32 bytes, got {}",
18                bytes.len()
19            )));
20        }
21        let mut arr = [0u8; 32];
22        arr.copy_from_slice(&bytes[..32]);
23        Ok(Hash(arr))
24    }
25
26    pub fn from_hex(hex_str: &str) -> Result<Self> {
27        let bytes = hex::decode(hex_str)
28            .map_err(|e| AreevError::Format(format!("invalid hex hash: {}", e)))?;
29        if bytes.len() != 32 {
30            return Err(AreevError::Format(format!(
31                "hash must be 32 bytes, got {}",
32                bytes.len()
33            )));
34        }
35        Ok(Self::from_bytes(&bytes.try_into().unwrap()))
36    }
37
38    pub fn as_bytes(&self) -> &[u8; 32] {
39        &self.0
40    }
41
42    pub fn to_hex(&self) -> String {
43        hex::encode(self.0)
44    }
45}
46
47impl fmt::Debug for Hash {
48    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
49        write!(f, "Hash({})", &self.to_hex()[..16])
50    }
51}
52
53impl fmt::Display for Hash {
54    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
55        write!(f, "{}", self.to_hex())
56    }
57}
58
59impl serde::Serialize for Hash {
60    fn serialize<S: serde::Serializer>(
61        &self,
62        serializer: S,
63    ) -> std::result::Result<S::Ok, S::Error> {
64        serializer.serialize_str(&self.to_hex())
65    }
66}
67
68impl<'de> serde::Deserialize<'de> for Hash {
69    fn deserialize<D: serde::Deserializer<'de>>(
70        deserializer: D,
71    ) -> std::result::Result<Self, D::Error> {
72        let s = String::deserialize(deserializer)?;
73        Hash::from_hex(&s).map_err(serde::de::Error::custom)
74    }
75}
76
77/// All errors in areev-core.
78#[derive(Debug)]
79pub enum AreevError {
80    NotFound(Hash),
81    Format(String),
82    Validation(String),
83    Serialization(String),
84    ToolRenderUnsupported(String),
85    Storage(String),
86    /// Another writer holds this memory (single-writer-per-memory is
87    /// enforced, not advisory, on backends that can arbitrate it).
88    StoreBusy(String),
89    /// The connection to a backing store asks for transport encryption this
90    /// build cannot provide. Its own code because the alternative — reporting
91    /// a generic validation failure — reads as a typo in the DSN, when what
92    /// actually happened is that a *refusal to downgrade to plaintext* saved
93    /// the operator from an unencrypted connection they did not ask for.
94    TlsUnavailable(String),
95    /// A write was attempted through a handle opened with `read_only: true`
96    /// (`AreevOptions::read_only`). Refused at the store layer on BOTH
97    /// backends — on postgres this is what stands between a least-privilege
98    /// SELECT-only role and a raw `42501 permission denied`; on the embedded
99    /// backend there is no privilege system to fail against, so the store
100    /// enforces the same contract itself, which is what lets one conformance
101    /// case cover both.
102    ReadOnly(String),
103    /// A read-only open could not verify the schema/tables it expected to
104    /// find (postgres only — the embedded backend bootstraps its own file
105    /// regardless of `read_only`). Distinct from [`Storage`](Self::Storage)
106    /// because the fix differs: "schema absent" needs someone to create and
107    /// migrate it; "schema present but not initialized" needs the owning
108    /// role to open it read-write once to finish bootstrap. A read-only role
109    /// can do neither itself — that is the whole point of the least-privilege
110    /// grant — so the message says which one it is rather than surfacing the
111    /// raw permission-denied Postgres gives for `CREATE SCHEMA`/DDL.
112    ReadOnlyOpenFailed(String),
113    /// A postgres open found the schema absent or stamped at an older schema
114    /// version, and the DSN said `provision=never` — so no advisory lock and
115    /// no DDL were attempted, not even `CREATE SCHEMA`. Distinct from
116    /// [`ReadOnlyOpenFailed`](Self::ReadOnlyOpenFailed): that one is a
117    /// read-only handle discovering it has nothing to read; this is a
118    /// read-WRITE handle that was told never to bootstrap on the request path,
119    /// which is how a deployment guarantees its runtime role holds no `CREATE`
120    /// and its schema changes go through a migration step. Like its sibling,
121    /// the message names WHICH of the two operator actions is needed —
122    /// create the memory, or migrate it forward — because they are different
123    /// jobs.
124    SchemaNotProvisioned(String),
125    SupersessionConflict(Hash),
126    /// A supersession-chain walk (`Areev::supersession_chain`) did not reach
127    /// a root within the bounded hop count. Real edit histories terminate in
128    /// a handful of hops; exceeding the bound means the `supersedes` links
129    /// are corrupt (e.g. cyclic) rather than merely long, so the walk fails
130    /// loudly instead of looping the process forever.
131    SupersessionChainTooDeep(Hash),
132    /// An approximate-nearest-neighbour index was asked for on a backend that
133    /// has none. Vector recall is an exact scan on the embedded engine — there
134    /// is no ANN structure to build there, and silently doing nothing would
135    /// leave a caller believing its corpus was indexed when its latency is
136    /// still linear. Only the Postgres tier (pgvector HNSW) answers this.
137    AnnIndexUnsupported(String),
138    CryptoError(String),
139    AccumulateRetryExhausted,
140    AccumulateInternal(String),
141    AccumulateBackpressureRejected,
142    Internal(String),
143    /// A verb the session's grants don't cover (`authz::AuthzSet::check`).
144    AuthzDenied(String),
145    /// A principal name no credential authenticates.
146    AuthzUnknownPrincipal(String),
147    /// The credential map failed to load or validate (fail closed).
148    AuthzConfigInvalid(String),
149    /// A presented bearer token matched no credential. Deliberately carries
150    /// no payload: a refused secret must never reach a log line.
151    AuthzTokenUnrecognized,
152}
153
154impl AreevError {
155    /// Stable machine-readable error code in `DOMAIN-Ennn` form (see the
156    /// repo-root `ERROR_CODES.md` registry). Every `Display` string begins
157    /// with this code, so a user who reports the leading token points us at
158    /// the exact variant and subsystem. **Codes are append-only debugging
159    /// handles — never renumber or reuse an existing one.**
160    pub fn code(&self) -> &'static str {
161        match self {
162            Self::NotFound(_) => "MEM-E001",
163            Self::SupersessionConflict(_) => "MEM-E002",
164            Self::SupersessionChainTooDeep(_) => "STO-E006",
165            Self::AnnIndexUnsupported(_) => "STO-E007",
166            Self::ToolRenderUnsupported(_) => "MEM-E110",
167            Self::Format(_) => "FMT-E001",
168            Self::Serialization(_) => "FMT-E002",
169            Self::Validation(_) => "VAL-E001",
170            Self::Storage(_) => "STO-E001",
171            Self::StoreBusy(_) => "STO-E002",
172            Self::TlsUnavailable(_) => "STO-E003",
173            Self::ReadOnly(_) => "STO-E004",
174            Self::ReadOnlyOpenFailed(_) => "STO-E005",
175            Self::SchemaNotProvisioned(_) => "STO-E008",
176            Self::CryptoError(_) => "CRY-E001",
177            // These originate in CAL ACCUMULATE semantics and bubble up
178            // through the store, so they keep their CAL-domain codes.
179            Self::AccumulateRetryExhausted => "CAL-E083",
180            Self::AccumulateInternal(_) => "CAL-E084",
181            Self::AccumulateBackpressureRejected => "CAL-E085",
182            Self::Internal(_) => "SYS-E001",
183            Self::AuthzDenied(_) => "AUT-E001",
184            Self::AuthzUnknownPrincipal(_) => "AUT-E002",
185            Self::AuthzConfigInvalid(_) => "AUT-E003",
186            Self::AuthzTokenUnrecognized => "AUT-E004",
187        }
188    }
189}
190
191impl std::fmt::Display for AreevError {
192    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
193        // Invariant: every arm's message starts with `self.code()` — pinned by
194        // `code_prefixes_every_display` in the tests below.
195        match self {
196            Self::NotFound(h) => write!(f, "MEM-E001: grain not found: {h}"),
197            Self::SupersessionConflict(h) => write!(f, "MEM-E002: already superseded: {h}"),
198            Self::SupersessionChainTooDeep(h) => write!(
199                f,
200                "STO-E006: supersession chain from {h} did not terminate within the bounded walk — the supersedes links may be cyclic or corrupt"
201            ),
202            Self::AnnIndexUnsupported(m) => write!(
203                f,
204                "STO-E007: no approximate vector index on this backend: {m}"
205            ),
206            Self::ToolRenderUnsupported(m) => write!(f, "MEM-E110: tool render unsupported: {m}"),
207            Self::Format(m) => write!(f, "FMT-E001: format error: {m}"),
208            Self::Serialization(m) => write!(f, "FMT-E002: serialization error: {m}"),
209            Self::Validation(m) => write!(f, "VAL-E001: validation error: {m}"),
210            Self::Storage(m) => write!(f, "STO-E001: storage error: {m}"),
211            Self::StoreBusy(m) => write!(f, "STO-E002: store busy: {m}"),
212            Self::TlsUnavailable(m) => write!(f, "STO-E003: {m}"),
213            Self::ReadOnly(m) => write!(f, "STO-E004: refusing write on a read-only memory: {m}"),
214            Self::ReadOnlyOpenFailed(m) => write!(f, "STO-E005: {m}"),
215            Self::SchemaNotProvisioned(m) => write!(f, "STO-E008: {m}"),
216            Self::CryptoError(m) => write!(f, "CRY-E001: crypto error: {m}"),
217            Self::AccumulateRetryExhausted => write!(f, "CAL-E083: ACCUMULATE retry budget exhausted"),
218            Self::AccumulateInternal(m) => write!(f, "CAL-E084: ACCUMULATE internal failure: {m}"),
219            Self::AccumulateBackpressureRejected => write!(f, "CAL-E085: ACCUMULATE backpressure: inflight cap exceeded"),
220            Self::Internal(m) => write!(f, "SYS-E001: internal error: {m}"),
221            Self::AuthzDenied(m) => write!(f, "AUT-E001: authorization denied: {m}"),
222            Self::AuthzUnknownPrincipal(p) => write!(f, "AUT-E002: unknown principal: {p}"),
223            Self::AuthzConfigInvalid(m) => write!(f, "AUT-E003: {m}"),
224            Self::AuthzTokenUnrecognized => write!(f, "AUT-E004: token not recognized"),
225        }
226    }
227}
228
229impl std::error::Error for AreevError {}
230
231pub type Result<T> = std::result::Result<T, AreevError>;
232
233#[cfg(test)]
234mod error_code_tests {
235    use super::*;
236
237    /// One representative instance of every variant — extend when adding one.
238    fn all_variants() -> Vec<AreevError> {
239        let h = Hash::from_bytes(&[0u8; 32]);
240        vec![
241            AreevError::NotFound(h),
242            AreevError::SupersessionConflict(h),
243            AreevError::SupersessionChainTooDeep(h),
244            AreevError::AnnIndexUnsupported("x".into()),
245            AreevError::ToolRenderUnsupported("x".into()),
246            AreevError::Format("x".into()),
247            AreevError::Serialization("x".into()),
248            AreevError::Validation("x".into()),
249            AreevError::Storage("x".into()),
250            AreevError::StoreBusy("x".into()),
251            AreevError::TlsUnavailable("x".into()),
252            AreevError::ReadOnly("x".into()),
253            AreevError::ReadOnlyOpenFailed("x".into()),
254            AreevError::SchemaNotProvisioned("x".into()),
255            AreevError::CryptoError("x".into()),
256            AreevError::AccumulateRetryExhausted,
257            AreevError::AccumulateInternal("x".into()),
258            AreevError::AccumulateBackpressureRejected,
259            AreevError::Internal("x".into()),
260            AreevError::AuthzDenied("x".into()),
261            AreevError::AuthzUnknownPrincipal("x".into()),
262            AreevError::AuthzConfigInvalid("x".into()),
263            AreevError::AuthzTokenUnrecognized,
264        ]
265    }
266
267    /// The reported code must be the leading token of the message, so a user
268    /// pasting either gives us the same handle.
269    #[test]
270    fn code_prefixes_every_display() {
271        for e in all_variants() {
272            let msg = e.to_string();
273            let code = e.code();
274            assert!(
275                msg.starts_with(&format!("{code}: ")),
276                "`{msg}` must start with its code `{code}`"
277            );
278        }
279    }
280
281    /// Every code matches the `DOMAIN-Ennn` standard (see ERROR_CODES.md):
282    /// a 3-letter uppercase domain, `-E`, then digits.
283    #[test]
284    fn codes_follow_the_repo_standard() {
285        for e in all_variants() {
286            let c = e.code();
287            let (domain, num) = c.split_once("-E").unwrap_or_else(|| panic!("bad code: {c}"));
288            assert_eq!(domain.len(), 3, "{c}: domain must be 3 letters");
289            assert!(domain.chars().all(|ch| ch.is_ascii_uppercase()), "{c}: domain uppercase");
290            assert!(!num.is_empty() && num.chars().all(|ch| ch.is_ascii_digit()), "{c}: numeric suffix");
291        }
292    }
293}
areev_core/error.rs

areev_core/
error.rs
