Skip to main content

rust_store_core/
error.rs

1//! core 错误类型:FFI 边界的结构化错误(评测报告 rust m-3)。
2//!
3//! core 内部约定错误为 `String`(各层 `?` 直通,消息即契约——绑定层错误文案
4//! 与 JS 参考实现逐字对齐)。本模块把「哨兵识别」从 Host 侧收口到 core:
5//!
6//! - **core 内唯一的哨兵前缀匹配点**是 [`CoreError::classify`]:内层 `String`
7//!   错误在 FFI 边界经 `From<String>` 归类为 [`CoreError`],绑定层 `match`
8//!   枚举构造原生异常(Node `Error` / Python `RuntimeError`),不再各自做
9//!   字符串匹配(对比 nodejs-store m-1 / py-store crud/exec.py 的历史方案)。
10//! - [`Display`] 输出**保留完整原始文案(含哨兵前缀)**:既有的「按前缀识别」
11//!   Host 逻辑(含 `ERR_PERMISSION:` 剥离)不受影响,宿主可渐进迁移。
12//!
13//! 分类依据只引用 [`crate::command`] 的哨兵常量本体,靠 [`tests`] 模块锁定
14//! 「常量前缀 ↔ 变体」关系,文案可自由调整而不破坏分类。
15
16use crate::command::{ERR_NO_CONTEXT, ERR_PERM_PREFIX};
17
18/// core 错误(FFI 边界可程序化穷举)。
19#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
20pub enum CoreError {
21    /// 权限拒绝:内层消息携带 `ERR_PERMISSION:` 稳定前缀
22    /// ([`ERR_PERMISSION`] / [`ERR_NO_WRITE`] / [`ERR_NO_DELETE`] /
23    /// [`ERR_NO_BATCH_WRITE`] 等,Host 据此映射 403 类错误)。
24    #[error("{0}")]
25    Permission(String),
26    /// `require_context` 开启且 ctx 缺失:调用方合约违反(`ERR_NO_CONTEXT:`
27    /// 前缀),Host 一般映射 500 配置/契约错误而非 403。
28    #[error("{0}")]
29    NoContext(String),
30    /// 其余语义错误(schema 校验 / 翻译层 / 参数校验 / 计算列……)
31    #[error("{0}")]
32    Other(String),
33}
34
35impl CoreError {
36    /// 稳定错误码(FFI 边界 `match` 枚举之外的第二选择:日志/指标用)。
37    pub fn code(&self) -> &'static str {
38        match self {
39            CoreError::Permission(_) => "permission",
40            CoreError::NoContext(_) => "no_context",
41            CoreError::Other(_) => "other",
42        }
43    }
44
45    /// 把内层 `String` 错误按哨兵前缀归类(core 内唯一的前缀匹配收口点)。
46    pub fn classify(msg: String) -> Self {
47        if msg.starts_with(ERR_PERM_PREFIX) {
48            CoreError::Permission(msg)
49        } else if msg.starts_with(ERR_NO_CONTEXT) {
50            CoreError::NoContext(msg)
51        } else {
52            CoreError::Other(msg)
53        }
54    }
55
56    /// 完整原始消息(含哨兵前缀;与 `Display` 一致,供宿主按前缀渐进迁移)
57    pub fn message(&self) -> &str {
58        match self {
59            CoreError::Permission(m) | CoreError::NoContext(m) | CoreError::Other(m) => m,
60        }
61    }
62}
63
64impl From<String> for CoreError {
65    fn from(msg: String) -> Self {
66        Self::classify(msg)
67    }
68}
69
70impl From<&str> for CoreError {
71    fn from(msg: &str) -> Self {
72        Self::classify(msg.to_string())
73    }
74}
75
76/// core 公开入口统一错误别名
77pub type CoreResult<T> = Result<T, CoreError>;
78
79#[cfg(test)]
80mod tests {
81    use super::CoreError;
82    use crate::command::{
83        ERR_NO_BATCH_WRITE, ERR_NO_CONTEXT, ERR_NO_DELETE, ERR_NO_WRITE, ERR_PERMISSION,
84    };
85
86    #[test]
87    fn classify_maps_sentinels_to_variants() {
88        // 权限族(四个哨兵全量穷举)→ Permission
89        for m in [
90            ERR_PERMISSION,
91            ERR_NO_WRITE,
92            ERR_NO_DELETE,
93            ERR_NO_BATCH_WRITE,
94        ] {
95            let e = CoreError::classify(m.to_string());
96            assert_eq!(e, CoreError::Permission(m.to_string()));
97            assert_eq!(e.code(), "permission");
98        }
99        // ctx 缺失 → NoContext
100        let e = CoreError::classify(ERR_NO_CONTEXT.to_string());
101        assert_eq!(e, CoreError::NoContext(ERR_NO_CONTEXT.to_string()));
102        assert_eq!(e.code(), "no_context");
103        // 其余 → Other
104        let e = CoreError::classify("translate: 未知命令".to_string());
105        assert_eq!(e, CoreError::Other("translate: 未知命令".to_string()));
106        assert_eq!(e.code(), "other");
107    }
108
109    #[test]
110    fn display_preserves_message_verbatim() {
111        // Display / message() 保留完整原文(含前缀)——宿主按前缀渐进迁移的兼容面
112        let e = CoreError::from(ERR_NO_WRITE);
113        assert_eq!(e.to_string(), ERR_NO_WRITE);
114        assert_eq!(e.message(), ERR_NO_WRITE);
115    }
116
117    #[test]
118    fn from_str_and_string_classify_identically() {
119        assert_eq!(
120            CoreError::from(ERR_PERMISSION),
121            CoreError::classify(ERR_PERMISSION.to_string())
122        );
123    }
124}