resuma 0.4.6

Resuma - SSR + Resumability + Islands + Server Actions + JS Bridge for Rust
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

use thiserror::Error;

#[derive(Debug, Error)]
pub enum ResumaError {
    #[error("serialization error: {0}")]
    Serde(#[from] serde_json::Error),

    #[error("render error: {0}")]
    Render(String),

    #[error("server action `{0}` not found")]
    UnknownAction(String),

    #[error("loader `{0}` not found")]
    UnknownLoader(String),

    #[error("submit `{0}` not found")]
    UnknownSubmit(String),

    #[error("island `{0}` not found")]
    UnknownIsland(String),

    #[error("io error: {0}")]
    Io(#[from] std::io::Error),

    #[error("unauthorized")]
    Unauthorized,

    #[error("forbidden: {0}")]
    Forbidden(String),

    #[error("invalid or missing CSRF token")]
    InvalidCsrf,

    #[error("rate limit exceeded")]
    RateLimited,

    #[error("request payload too large")]
    PayloadTooLarge,

    #[error("validation error: {0}")]
    Validation(String),

    #[error("{0}")]
    Other(String),
}

impl ResumaError {
    /// Suggested HTTP status for API/action responses.
    pub fn status_code(&self) -> u16 {
        match self {
            Self::Unauthorized => 401,
            Self::Forbidden(_) | Self::InvalidCsrf => 403,
            Self::RateLimited => 429,
            Self::UnknownAction(_)
            | Self::UnknownLoader(_)
            | Self::UnknownSubmit(_)
            | Self::UnknownIsland(_) => 404,
            Self::Serde(_) | Self::PayloadTooLarge | Self::Validation(_) => 422,
            Self::Render(_) | Self::Io(_) => 500,
            Self::Other(msg) if msg.eq_ignore_ascii_case("unauthorized") => 401,
            Self::Other(_) => 400,
        }
    }

    /// Safe client-facing message (no internal details in production).
    pub fn client_message(&self, production: bool) -> String {
        if production {
            match self {
                Self::Unauthorized => "Unauthorized".into(),
                Self::Forbidden(_) | Self::InvalidCsrf => "Forbidden".into(),
                Self::RateLimited => "Too many requests".into(),
                Self::UnknownAction(_) | Self::UnknownLoader(_) | Self::UnknownSubmit(_) => {
                    "Not found".into()
                }
                Self::Serde(_) | Self::PayloadTooLarge | Self::Validation(_) => {
                    "Invalid request".into()
                }
                Self::Render(_) | Self::Io(_) => "Internal server error".into(),
                Self::Other(msg) if msg.eq_ignore_ascii_case("unauthorized") => {
                    "Unauthorized".into()
                }
                Self::Other(_) => "Bad request".into(),
                Self::UnknownIsland(_) => "Not found".into(),
            }
        } else {
            self.to_string()
        }
    }

    /// Convenience constructor for typed validation failures.
    pub fn validation(message: impl Into<String>) -> Self {
        Self::Validation(message.into())
    }
}

pub type Result<T> = std::result::Result<T, ResumaError>;