boatramp-core 0.1.2

Core domain types, streaming storage trait, pluggable KV, and content-addressed deploys for boatramp
Documentation 
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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

//! Error types shared across storage backends, the KV layer, and deploys.

// Config parsing/compiling errors live in the shared `boatramp-types` crate;
// re-exported so `boatramp_core::error::ConfigError` is unchanged.
pub use boatramp_types::error::ConfigError;

/// Errors that can occur while interacting with a [`crate::Storage`] backend.
#[derive(Debug, thiserror::Error)]
pub enum StorageError {
    /// The requested key does not exist.
    #[error("object not found: {0}")]
    NotFound(String),

    /// The key was rejected (e.g. a path-traversal attempt).
    #[error("invalid key: {0}")]
    InvalidKey(String),

    /// The backend does not support this operation yet.
    #[error("unsupported operation: {0}")]
    Unsupported(String),

    /// An underlying I/O error.
    #[error("i/o error: {0}")]
    Io(#[from] std::io::Error),

    /// A backend-specific error.
    #[error("backend error: {0}")]
    Backend(String),
}

impl StorageError {
    /// Convenience constructor for [`StorageError::Unsupported`].
    pub fn unsupported(msg: impl Into<String>) -> Self {
        Self::Unsupported(msg.into())
    }

    /// Convenience constructor for [`StorageError::Backend`].
    pub fn backend(msg: impl Into<String>) -> Self {
        Self::Backend(msg.into())
    }
}

/// Errors from a [`crate::kv::KvStore`] backend.
#[derive(Debug, thiserror::Error)]
pub enum KvError {
    /// An underlying I/O error.
    #[error("kv i/o error: {0}")]
    Io(#[from] std::io::Error),

    /// A backend-specific error.
    #[error("kv backend error: {0}")]
    Backend(String),
}

impl KvError {
    /// Convenience constructor for [`KvError::Backend`].
    pub fn backend(msg: impl Into<String>) -> Self {
        Self::Backend(msg.into())
    }
}

/// Errors from the content-addressed deploy layer ([`crate::deploy`]).
#[derive(Debug, thiserror::Error)]
pub enum DeployError {
    /// A blob-storage error.
    #[error(transparent)]
    Storage(#[from] StorageError),

    /// A KV (manifest/pointer) error.
    #[error(transparent)]
    Kv(#[from] KvError),

    /// (De)serialization of a manifest failed.
    #[error("manifest serialization error: {0}")]
    Serde(String),

    /// A referenced deployment, site, or path was not found.
    #[error("not found: {0}")]
    NotFound(String),

    /// An uploaded blob did not hash to the key it was stored under.
    #[error("blob hash mismatch: expected {expected}, got {actual}")]
    HashMismatch {
        /// The hash the blob was supposed to have.
        expected: String,
        /// The hash actually computed from the bytes.
        actual: String,
    },

    /// A deployment cannot be activated because some blobs are missing.
    #[error("deployment incomplete: {} blob(s) still missing", .0.len())]
    Incomplete(Vec<String>),

    /// A deployment-id prefix matched more than one deployment.
    #[error("ambiguous deployment id prefix: {0}")]
    Ambiguous(String),

    /// A host is already claimed by a different site — refusing to overwrite the
    /// routing index would let one site hijack another's domain. Surfaced as a
    /// `409 Conflict`.
    #[error("conflict: {0}")]
    Conflict(String),
}

impl From<serde_json::Error> for DeployError {
    fn from(err: serde_json::Error) -> Self {
        Self::Serde(err.to_string())
    }
}

impl From<ConfigError> for DeployError {
    fn from(err: ConfigError) -> Self {
        Self::Serde(err.to_string())
    }
}