orion_error/traits/

conversion.rs

use crate::{core::convert_error, core::DomainReason, StructError};

/// Convert a `Result<T, StructError<R1>>` into `Result<T, StructError<R2>>`.
///
/// Requires `R2: From<R1>`. Preserves all detail, position, context, and source state.
///
/// # Example
///
/// ```rust,ignore
/// // This example requires the `derive` feature (enabled by default).
/// use orion_error::prelude::*;
/// use orion_error::UnifiedReason;
///
/// #[derive(Debug, Clone, PartialEq, OrionError)]
/// enum SubReason {
///     #[orion_error(identity = "biz.sub")]
///     Sub,
/// }
///
/// #[derive(Debug, Clone, PartialEq, OrionError)]
/// enum MainReason {
///     #[orion_error(identity = "biz.main")]
///     Main,
/// }
///
/// impl From<SubReason> for MainReason {
///     fn from(_: SubReason) -> Self { MainReason::Main }
/// }
///
/// // conv_err converts StructError<SubReason> → StructError<MainReason>
/// let result: Result<(), StructError<SubReason>> =
///     Err(StructError::from(SubReason::Sub).with_detail("inner"));
/// let converted: Result<(), StructError<MainReason>> = result.conv_err();
/// assert!(converted.is_err());
/// ```
///
/// # Design note
///
/// A blanket `From<StructError<R1>> for StructError<R2>` is blocked by Rust's
/// orphan rule: neither `From` (std) nor `StructError` (orion-error) are local
/// to the user's crate. An explicit trait method is the intended path forward.
pub trait ConvErr<T, R: DomainReason>: Sized {
    fn conv_err(self) -> Result<T, StructError<R>>;

    /// Deprecated: use [`conv_err`](Self::conv_err) instead.
    #[deprecated(since = "0.9.0", note = "renamed to conv_err")]
    fn err_conv(self) -> Result<T, StructError<R>> {
        self.conv_err()
    }
}

/// Convert a `StructError<R1>` into `StructError<R2>`.
///
/// Requires `R2: From<R1>`. Preserves all detail, position, context, and source state.
pub trait ConvStructError<R: DomainReason>: Sized {
    fn conv(self) -> StructError<R>;
}

impl<T, R1, R2> ConvErr<T, R2> for Result<T, StructError<R1>>
where
    R1: DomainReason,
    R2: DomainReason + From<R1>,
{
    fn conv_err(self) -> Result<T, StructError<R2>> {
        match self {
            Ok(o) => Ok(o),
            Err(e) => Err(convert_error::<R1, R2>(e)),
        }
    }
}

impl<R1, R2> ConvStructError<R2> for StructError<R1>
where
    R1: DomainReason,
    R2: DomainReason + From<R1>,
{
    fn conv(self) -> StructError<R2> {
        convert_error::<R1, R2>(self)
    }
}

/// Convenience to wrap any [`DomainReason`] value into a [`StructError`].
///
/// Provides both direct `to_err()` and `err_result::<T>()` via blanket impl
/// for all `R: DomainReason`.
pub trait ToStructError<R>
where
    R: DomainReason,
{
    fn to_err(self) -> StructError<R>;
    fn err_result<T>(self) -> Result<T, StructError<R>>;
}
impl<R> ToStructError<R> for R
where
    R: DomainReason,
{
    fn to_err(self) -> StructError<R> {
        StructError::from(self)
    }
    fn err_result<T>(self) -> Result<T, StructError<R>> {
        Err(StructError::from(self))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::reason::ErrorCode;
    use crate::{core::DomainReason, OperationContext, StructError, UnifiedReason};

    // 定义测试用的 DomainReason
    #[derive(Debug, Clone, PartialEq, thiserror::Error)]
    enum TestReason {
        #[error("test error")]
        TestError,
        #[error("{0}")]
        General(UnifiedReason),
    }

    impl ErrorCode for TestReason {
        fn error_code(&self) -> i32 {
            match self {
                TestReason::TestError => 1001,
                TestReason::General(uvs) => uvs.error_code(),
            }
        }
    }

    impl DomainReason for TestReason {}

    impl From<UnifiedReason> for TestReason {
        fn from(uvs: UnifiedReason) -> Self {
            TestReason::General(uvs)
        }
    }

    // 定义另一个 DomainReason 用于测试转换
    #[derive(Debug, Clone, PartialEq, thiserror::Error)]
    enum AnotherReason {
        #[error("another error")]
        AnotherError,
        #[error("{0}")]
        General(UnifiedReason),
    }

    impl ErrorCode for AnotherReason {
        fn error_code(&self) -> i32 {
            match self {
                AnotherReason::AnotherError => 2001,
                AnotherReason::General(uvs) => uvs.error_code(),
            }
        }
    }

    impl DomainReason for AnotherReason {}

    impl From<UnifiedReason> for AnotherReason {
        fn from(uvs: UnifiedReason) -> Self {
            AnotherReason::General(uvs)
        }
    }

    impl From<TestReason> for AnotherReason {
        fn from(test: TestReason) -> Self {
            match test {
                TestReason::TestError => AnotherReason::AnotherError,
                TestReason::General(uvs) => AnotherReason::General(uvs),
            }
        }
    }

    #[test]
    fn test_error_conv_trait() {
        // 测试 ErrorConv trait 的 upcast 方法
        let original_result: Result<i32, StructError<TestReason>> =
            Err(TestReason::TestError.to_err());

        let converted_result: Result<i32, StructError<AnotherReason>> = original_result.conv_err();

        assert!(converted_result.is_err());
        let converted_error = converted_result.unwrap_err();
        assert_eq!(converted_error.reason().error_code(), 2001);

        // 测试成功情况下的转换
        let success_result: Result<i32, StructError<TestReason>> = Ok(42);
        let converted_success: Result<i32, StructError<AnotherReason>> = success_result.conv_err();

        assert!(converted_success.is_ok());
        assert_eq!(converted_success.unwrap(), 42);
    }

    #[test]
    fn test_conv_struct_error_trait() {
        // 测试 ConvStructError trait 的 conv 方法
        let original_error: StructError<TestReason> = TestReason::TestError.to_err();

        let converted_error: StructError<AnotherReason> = original_error.conv();

        assert_eq!(converted_error.reason().error_code(), 2001);

        // 测试带有 UnifiedReason 的转换
        let uvs_error: StructError<TestReason> =
            TestReason::General(UnifiedReason::network_error()).to_err();

        let converted_uvs_error: StructError<AnotherReason> = uvs_error.conv();

        assert_eq!(converted_uvs_error.reason().error_code(), 202);
    }

    #[test]
    fn test_to_struct_error_trait() {
        // 测试 ToStructError trait 的 to_err 方法
        let reason = TestReason::TestError;
        let error: StructError<TestReason> = reason.to_err();

        assert_eq!(error.reason().error_code(), 1001);

        // 测试 ToStructError trait 的 err_result 方法
        let reason2 = TestReason::TestError;
        let result: Result<String, StructError<TestReason>> = reason2.err_result();

        assert!(result.is_err());
        let error_from_result = result.unwrap_err();
        assert_eq!(error_from_result.reason().error_code(), 1001);

        // 测试使用 UnifiedReason
        let uvs_reason1 = UnifiedReason::validation_error();
        let uvs_error: StructError<UnifiedReason> = uvs_reason1.to_err();

        assert_eq!(uvs_error.reason().error_code(), 100);

        let uvs_reason2 = UnifiedReason::validation_error();
        let uvs_result: Result<i32, StructError<UnifiedReason>> = uvs_reason2.err_result();
        assert!(uvs_result.is_err());
        assert_eq!(uvs_result.unwrap_err().reason().error_code(), 100);
    }

    #[test]
    fn test_upcast_preserves_source() {
        let source = std::io::Error::other("db unavailable");
        let original: Result<i32, StructError<TestReason>> =
            Err(StructError::from(TestReason::TestError).with_std_source(source));

        let converted: Result<i32, StructError<AnotherReason>> = original.conv_err();
        let err = converted.unwrap_err();

        assert_eq!(err.reason().error_code(), 2001);
        assert_eq!(err.source_ref().unwrap().to_string(), "db unavailable");
    }

    #[test]
    fn test_upcast_preserves_context_metadata() {
        let original: Result<i32, StructError<TestReason>> =
            Err(StructError::from(TestReason::TestError).with_context(
                OperationContext::doing("load sink defaults")
                    .with_meta("config.kind", "sink_defaults"),
            ));

        let converted: Result<i32, StructError<AnotherReason>> = original.conv_err();
        let err = converted.unwrap_err();

        assert_eq!(
            err.context_metadata().get_str("config.kind"),
            Some("sink_defaults")
        );
    }
}