arcbox-api 0.6.3

API server for ArcBox (gRPC + REST)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

//! Error types for the API server.

use arcbox_error::CommonError;
use thiserror::Error;

/// Result type alias for API operations.
pub type Result<T> = std::result::Result<T, ApiError>;

/// Errors that can occur in API operations.
#[derive(Debug, Error)]
pub enum ApiError {
    /// Common errors (I/O, config, etc.).
    #[error(transparent)]
    Common(#[from] CommonError),

    /// Core error.
    #[error("core error: {0}")]
    Core(#[from] arcbox_core::CoreError),

    /// Server error.
    #[error("server error: {0}")]
    Server(String),

    /// Transport error.
    #[error("transport error: {0}")]
    Transport(String),
}

// Allow automatic conversion from std::io::Error to ApiError via CommonError.
impl From<std::io::Error> for ApiError {
    fn from(err: std::io::Error) -> Self {
        Self::Common(CommonError::from(err))
    }
}

/// Every service answers over Connect, so `ApiError` classifies straight
/// into a Connect error code. The assignments predate the tonic retirement
/// (CORE-68/73): clients see the same codes the gRPC services always
/// answered.
impl From<ApiError> for connectrpc::ConnectError {
    fn from(err: ApiError) -> Self {
        use connectrpc::ErrorCode;

        let message = err.to_string();
        let code = match &err {
            ApiError::Common(common) => match common {
                CommonError::Config(_) => ErrorCode::InvalidArgument,
                CommonError::NotFound(_) => ErrorCode::NotFound,
                CommonError::AlreadyExists(_) => ErrorCode::AlreadyExists,
                CommonError::InvalidState(_) => ErrorCode::FailedPrecondition,
                CommonError::Timeout(_) => ErrorCode::DeadlineExceeded,
                CommonError::PermissionDenied(_) => ErrorCode::PermissionDenied,
                _ => ErrorCode::Internal,
            },
            // Agent-reported errors carry an HTTP-style code over the wire.
            ApiError::Core(arcbox_core::CoreError::Agent { code, .. }) => match code {
                400 => ErrorCode::InvalidArgument,
                404 => ErrorCode::NotFound,
                409 => ErrorCode::AlreadyExists,
                412 => ErrorCode::FailedPrecondition,
                // Stdin offset gap: the client resyncs via GetStdinStatus.
                416 => ErrorCode::OutOfRange,
                503 => ErrorCode::Unavailable,
                _ => ErrorCode::Internal,
            },
            _ => ErrorCode::Internal,
        };
        Self::new(code, message)
    }
}

impl ApiError {
    /// Creates a new configuration error.
    #[must_use]
    pub fn config(msg: impl Into<String>) -> Self {
        Self::Common(CommonError::config(msg))
    }
}