vyuh 0.2.9

Vyuh web framework for Axum and SQLx with handler-first APIs
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

use serde::{Deserialize, Serialize};

use crate::conf::ConfError;

#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "snake_case")]
pub enum ConsoleBootstrapMode {
    LocalOnly,
    Always,
    Disabled,
}

impl Default for ConsoleBootstrapMode {
    fn default() -> Self {
        Self::LocalOnly
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ConsoleConf {
    pub enabled: bool,
    pub path: String,
    pub bootstrap_token_ttl_seconds: u64,
    pub session_ttl_seconds: u64,
    pub print_bootstrap_url: ConsoleBootstrapMode,
    pub cookie_name: String,
    pub page_size_default: usize,
    pub page_size_max: usize,
    pub status_cache_ttl_seconds: u64,
}

impl Default for ConsoleConf {
    fn default() -> Self {
        Self {
            enabled: false,
            path: "/_console".to_string(),
            bootstrap_token_ttl_seconds: 300,
            session_ttl_seconds: 28_800,
            print_bootstrap_url: ConsoleBootstrapMode::LocalOnly,
            cookie_name: "vyuh_console".to_string(),
            page_size_default: 50,
            page_size_max: 250,
            status_cache_ttl_seconds: 5,
        }
    }
}

impl ConsoleConf {
    pub fn enabled(mut self, enabled: bool) -> Self {
        self.enabled = enabled;
        self
    }

    pub fn path(mut self, path: impl Into<String>) -> Self {
        self.path = path.into();
        self
    }

    pub fn bootstrap_token_ttl_seconds(mut self, seconds: u64) -> Self {
        self.bootstrap_token_ttl_seconds = seconds;
        self
    }

    pub fn session_ttl_seconds(mut self, seconds: u64) -> Self {
        self.session_ttl_seconds = seconds;
        self
    }

    pub fn print_bootstrap_url(mut self, mode: ConsoleBootstrapMode) -> Self {
        self.print_bootstrap_url = mode;
        self
    }

    pub fn cookie_name(mut self, name: impl Into<String>) -> Self {
        self.cookie_name = name.into();
        self
    }

    pub fn page_size_default(mut self, size: usize) -> Self {
        self.page_size_default = size;
        self
    }

    pub fn page_size_max(mut self, size: usize) -> Self {
        self.page_size_max = size;
        self
    }

    pub fn status_cache_ttl_seconds(mut self, seconds: u64) -> Self {
        self.status_cache_ttl_seconds = seconds;
        self
    }

    pub(crate) fn validate(&self, errors: &mut Vec<ConfError>) {
        if !self.enabled {
            return;
        }
        if !self.path.starts_with('/') || self.path.len() <= 1 {
            errors.push(ConfError::InvalidValue {
                field: "console.path".into(),
                reason: "must be an absolute non-root path".into(),
                expected: Some("a path such as /_console".into()),
            });
        }
        if self.path.ends_with('/') {
            errors.push(ConfError::InvalidValue {
                field: "console.path".into(),
                reason: "must not end with '/'".into(),
                expected: Some("a path such as /_console".into()),
            });
        }
        if self.bootstrap_token_ttl_seconds == 0 {
            errors.push(ConfError::InvalidValue {
                field: "console.bootstrap_token_ttl_seconds".into(),
                reason: "must be greater than zero".into(),
                expected: Some("a positive duration in seconds".into()),
            });
        }
        if self.session_ttl_seconds == 0 {
            errors.push(ConfError::InvalidValue {
                field: "console.session_ttl_seconds".into(),
                reason: "must be greater than zero".into(),
                expected: Some("a positive duration in seconds".into()),
            });
        }
        if self.cookie_name.trim().is_empty() {
            errors.push(ConfError::InvalidValue {
                field: "console.cookie_name".into(),
                reason: "must not be empty".into(),
                expected: Some("a cookie name".into()),
            });
        }
        if self.page_size_default == 0 || self.page_size_max == 0 {
            errors.push(ConfError::InvalidValue {
                field: "console.page_size".into(),
                reason: "default and max page sizes must be greater than zero".into(),
                expected: Some("positive page sizes".into()),
            });
        }
        if self.page_size_default > self.page_size_max {
            errors.push(ConfError::InvalidValue {
                field: "console.page_size_default".into(),
                reason: "must not exceed page_size_max".into(),
                expected: Some(format!("at most {}", self.page_size_max)),
            });
        }
        if self.status_cache_ttl_seconds == 0 {
            errors.push(ConfError::InvalidValue {
                field: "console.status_cache_ttl_seconds".into(),
                reason: "must be greater than zero".into(),
                expected: Some("a positive duration in seconds".into()),
            });
        }
    }
}