faucet_cli/serve/
state.rs

1//! Shared, cheaply-cloneable server state handed to every handler via
2//! `axum::extract::State`. Holds auth, the Prometheus render handle, the
3//! server-wide shutdown token, the run registry, the execution semaphore, the
4//! run-history backend, and the `--default-config` merge base.
5
6use crate::serve::config::{AuthMode, ServeConfig};
7use crate::serve::history::RunHistory;
8use crate::serve::logs::LogHub;
9use crate::serve::registry::Registry;
10use metrics_exporter_prometheus::PrometheusHandle;
11use serde_json::Value;
12use std::sync::Arc;
13use std::time::Duration;
14use tokio::sync::Semaphore;
15use tokio_util::sync::CancellationToken;
16
17#[derive(Clone)]
18pub struct ServerState {
19    inner: Arc<Inner>,
20}
21
22struct Inner {
23    auth: AuthMode,
24    prometheus: Option<PrometheusHandle>,
25    shutdown: CancellationToken,
26    registry: Registry,
27    semaphore: Arc<Semaphore>,
28    history: Arc<dyn RunHistory>,
29    log_hub: LogHub,
30    default_base: Option<Value>,
31    idempotency_retention: Duration,
32    probe_timeout: Duration,
33    cluster: crate::serve::cluster::ClusterHandle,
34    #[cfg(feature = "triggers")]
35    triggers: crate::serve::triggers::health::TriggersHandle,
36}
37
38impl ServerState {
39    #[allow(clippy::too_many_arguments)]
40    pub fn new(
41        config: &ServeConfig,
42        prometheus: Option<PrometheusHandle>,
43        shutdown: CancellationToken,
44        history: Arc<dyn RunHistory>,
45        log_hub: LogHub,
46        default_base: Option<Value>,
47        #[cfg(feature = "triggers")] triggers: crate::serve::triggers::health::TriggersHandle,
48    ) -> Self {
49        Self {
50            inner: Arc::new(Inner {
51                auth: config.auth.clone(),
52                prometheus,
53                shutdown,
54                registry: Registry::new(config.max_queued_runs),
55                semaphore: Arc::new(Semaphore::new(config.max_concurrent_runs)),
56                history,
57                log_hub,
58                default_base,
59                idempotency_retention: config.idempotency_retention,
60                probe_timeout: config.probe_timeout,
61                cluster: crate::serve::cluster::ClusterHandle::from_config(config),
62                #[cfg(feature = "triggers")]
63                triggers,
64            }),
65        }
66    }
67
68    pub fn auth_token(&self) -> Option<&str> {
69        match &self.inner.auth {
70            AuthMode::Token(t) => Some(t),
71            AuthMode::None => None,
72        }
73    }
74
75    pub fn render_metrics(&self) -> Option<String> {
76        self.inner.prometheus.as_ref().map(|h| h.render())
77    }
78
79    pub fn shutdown_token(&self) -> CancellationToken {
80        self.inner.shutdown.clone()
81    }
82
83    pub fn registry(&self) -> &Registry {
84        &self.inner.registry
85    }
86
87    pub fn semaphore(&self) -> Arc<Semaphore> {
88        Arc::clone(&self.inner.semaphore)
89    }
90
91    pub fn history(&self) -> Arc<dyn RunHistory> {
92        Arc::clone(&self.inner.history)
93    }
94
95    /// The per-run log buffer registry shared with the tracing [`LogHub`] layer.
96    pub fn log_hub(&self) -> &LogHub {
97        &self.inner.log_hub
98    }
99
100    pub fn default_base(&self) -> Option<&Value> {
101        self.inner.default_base.as_ref()
102    }
103
104    pub fn idempotency_retention(&self) -> Duration {
105        self.inner.idempotency_retention
106    }
107
108    pub fn probe_timeout(&self) -> Duration {
109        self.inner.probe_timeout
110    }
111
112    pub fn cluster(&self) -> &crate::serve::cluster::ClusterHandle {
113        &self.inner.cluster
114    }
115
116    #[cfg(feature = "triggers")]
117    pub fn triggers(&self) -> &crate::serve::triggers::health::TriggersHandle {
118        &self.inner.triggers
119    }
120}
121
122#[cfg(test)]
123mod tests {
124    use super::*;
125    use crate::serve::config::HistoryBackendSpec;
126    use crate::serve::history::memory::MemoryHistory;
127
128    fn cfg(auth: AuthMode) -> ServeConfig {
129        ServeConfig {
130            listen: "127.0.0.1:0".parse().unwrap(),
131            auth,
132            max_concurrent_runs: 4,
133            max_queued_runs: 32,
134            default_config_path: None,
135            history: HistoryBackendSpec::Memory,
136            cors_origins: vec![],
137            body_limit_bytes: 1_048_576,
138            shutdown_grace: Duration::from_secs(60),
139            retain_terminal_runs: Duration::from_secs(60),
140            idempotency_retention: Duration::from_secs(60),
141            lease_ttl: Duration::from_secs(30),
142            probe_timeout: Duration::from_secs(10),
143            env_file: None,
144            no_env_file: false,
145            log_level: "info".into(),
146            ui_enabled: true,
147            cluster: crate::serve::cluster::ClusterConfig::disabled(),
148            triggers_path: None,
149        }
150    }
151
152    fn state(auth: AuthMode) -> ServerState {
153        use crate::serve::logs::LogHub;
154        let history = Arc::new(MemoryHistory::new(Duration::from_secs(60))) as Arc<dyn RunHistory>;
155        ServerState::new(
156            &cfg(auth),
157            None,
158            CancellationToken::new(),
159            history,
160            LogHub::new(),
161            None,
162            #[cfg(feature = "triggers")]
163            crate::serve::triggers::health::TriggersHandle::empty(),
164        )
165    }
166
167    #[test]
168    fn auth_token_reflects_mode() {
169        assert_eq!(state(AuthMode::Token("x".into())).auth_token(), Some("x"));
170        assert_eq!(state(AuthMode::None).auth_token(), None);
171    }
172
173    #[test]
174    fn render_metrics_none_without_handle() {
175        assert!(state(AuthMode::None).render_metrics().is_none());
176    }
177
178    #[test]
179    fn registry_starts_empty() {
180        let s = state(AuthMode::None);
181        assert_eq!(s.registry().queued(), 0);
182        assert_eq!(s.registry().in_flight(), 0);
183    }
184}
faucet_cli/serve/state.rs

faucet_cli/serve/
state.rs
