Skip to main content

ferro_rs/
server.rs

1use crate::cache::Cache;
2use crate::config::{Config, ServerConfig};
3use crate::container::App;
4use crate::http::{HttpResponse, Request};
5use crate::middleware::{Middleware, MiddlewareChain, MiddlewareRegistry};
6use crate::routing::Router;
7use crate::websocket::handle_ws_upgrade;
8use bytes::Bytes;
9use http_body_util::Full;
10use hyper::server::conn::http1;
11use hyper::service::service_fn;
12use hyper_util::rt::TokioIo;
13use std::convert::Infallible;
14use std::net::SocketAddr;
15use std::sync::Arc;
16use tokio::net::TcpListener;
17
18/// Pre-routing WebSocket interceptor.
19///
20/// Called for every WS upgrade request before Ferro routing.
21/// Returns `Ok(Response)` to handle the request, `Err(Request)` to decline
22/// and pass to normal routing (including the built-in `/_ferro/ws` check).
23type WsInterceptor = Box<
24    dyn Fn(
25            hyper::Request<hyper::body::Incoming>,
26        ) -> Result<hyper::Response<Full<Bytes>>, hyper::Request<hyper::body::Incoming>>
27        + Send
28        + Sync,
29>;
30
31/// HTTP server that binds routes, middleware, and optional WebSocket handling.
32pub struct Server {
33    router: Arc<Router>,
34    middleware: MiddlewareRegistry,
35    host: String,
36    port: u16,
37    ws_interceptor: Option<Arc<WsInterceptor>>,
38}
39
40impl Server {
41    /// Create a server with default host/port and no global middleware.
42    pub fn new(router: impl Into<Router>) -> Self {
43        Self {
44            router: Arc::new(router.into()),
45            middleware: MiddlewareRegistry::new(),
46            host: "127.0.0.1".to_string(),
47            port: 8080,
48            ws_interceptor: None,
49        }
50    }
51
52    /// Create a server from environment configuration, booting all services.
53    pub fn from_config(router: impl Into<Router>) -> Self {
54        // Initialize the App container
55        App::init();
56
57        // Boot all auto-registered services from #[service(ConcreteType)]
58        App::boot_services();
59
60        let config = Config::get::<ServerConfig>().unwrap_or_else(ServerConfig::from_env);
61        Self {
62            router: Arc::new(router.into()),
63            // Pull global middleware registered via global_middleware! in bootstrap.rs
64            middleware: MiddlewareRegistry::from_global(),
65            host: config.host,
66            port: config.port,
67            ws_interceptor: None,
68        }
69    }
70
71    /// Set a WebSocket interceptor that runs before all routing.
72    ///
73    /// The interceptor receives every WS upgrade request first.
74    /// Return `Ok(response)` to handle the connection; return `Err(request)` to
75    /// decline and let normal routing (including `/_ferro/ws`) proceed.
76    ///
77    /// # Example
78    ///
79    /// ```rust,ignore
80    /// Server::from_config(router)
81    ///     .ws_interceptor(|req| {
82    ///         if req.uri().path().starts_with("/sessions/") {
83    ///             Ok(my_ws_handler(req))
84    ///         } else {
85    ///             Err(req) // pass to /_ferro/ws
86    ///         }
87    ///     })
88    ///     .run()
89    ///     .await;
90    /// ```
91    pub fn ws_interceptor<F>(mut self, handler: F) -> Self
92    where
93        F: Fn(
94                hyper::Request<hyper::body::Incoming>,
95            )
96                -> Result<hyper::Response<Full<Bytes>>, hyper::Request<hyper::body::Incoming>>
97            + Send
98            + Sync
99            + 'static,
100    {
101        self.ws_interceptor = Some(Arc::new(Box::new(handler)));
102        self
103    }
104
105    /// Add global middleware (runs on every request)
106    ///
107    /// For route-specific middleware, use `.middleware(M)` on the route itself.
108    ///
109    /// # Example
110    ///
111    /// ```rust,ignore
112    /// Server::from_config(router)
113    ///     .middleware(LoggingMiddleware)  // Global
114    ///     .middleware(CorsMiddleware)     // Global
115    ///     .run()
116    ///     .await;
117    /// ```
118    pub fn middleware<M: Middleware + 'static>(mut self, middleware: M) -> Self {
119        self.middleware = self.middleware.append(middleware);
120        self
121    }
122
123    /// Override the listen host address.
124    pub fn host(mut self, host: &str) -> Self {
125        self.host = host.to_string();
126        self
127    }
128
129    /// Override the listen port.
130    pub fn port(mut self, port: u16) -> Self {
131        self.port = port;
132        self
133    }
134
135    fn get_addr(&self) -> SocketAddr {
136        SocketAddr::new(self.host.parse().unwrap(), self.port)
137    }
138
139    /// Start listening and serving requests until the process is terminated.
140    pub async fn run(self) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
141        // Bootstrap cache (Redis with in-memory fallback)
142        Cache::bootstrap().await;
143
144        let addr: SocketAddr = self.get_addr();
145        let listener = TcpListener::bind(addr).await?;
146
147        println!("Ferro server running on http://{addr}");
148
149        let router = self.router;
150        let middleware = Arc::new(self.middleware);
151        let ws_interceptor = self.ws_interceptor;
152
153        loop {
154            let (stream, _) = listener.accept().await?;
155            let io = TokioIo::new(stream);
156            let router = router.clone();
157            let middleware = middleware.clone();
158            let ws_interceptor = ws_interceptor.clone();
159
160            tokio::spawn(async move {
161                let service = service_fn(move |req: hyper::Request<hyper::body::Incoming>| {
162                    let router = router.clone();
163                    let middleware = middleware.clone();
164                    let ws_interceptor = ws_interceptor.clone();
165                    async move {
166                        Ok::<_, Infallible>(
167                            handle_request(router, middleware, ws_interceptor, req).await,
168                        )
169                    }
170                });
171
172                if let Err(err) = http1::Builder::new()
173                    .serve_connection(io, service)
174                    .with_upgrades()
175                    .await
176                {
177                    eprintln!("Error serving connection: {err:?}");
178                }
179            });
180        }
181    }
182}
183
184async fn handle_request(
185    router: Arc<Router>,
186    middleware_registry: Arc<MiddlewareRegistry>,
187    ws_interceptor: Option<Arc<WsInterceptor>>,
188    mut req: hyper::Request<hyper::body::Incoming>,
189) -> hyper::Response<Full<Bytes>> {
190    // Application WS interceptor runs before /_ferro/ws
191    if let Some(ref interceptor) = ws_interceptor {
192        if hyper_tungstenite::is_upgrade_request(&req) {
193            match interceptor(req) {
194                Ok(response) => return response,
195                Err(returned_req) => {
196                    // Interceptor declined — continue with returned request
197                    req = returned_req;
198                }
199            }
200        }
201    }
202
203    let method = req.method().clone();
204    let path = req.uri().path().to_string();
205    let query = req.uri().query().unwrap_or("");
206
207    // WebSocket upgrade at /_ferro/ws (must run before middleware/routing)
208    if path == "/_ferro/ws" && hyper_tungstenite::is_upgrade_request(&req) {
209        return handle_ws_upgrade(req);
210    }
211
212    // Built-in framework endpoints at /_ferro/*
213    // Uses framework prefix to avoid conflicts with user-defined routes
214    if path.starts_with("/_ferro/") && method == hyper::Method::GET {
215        return match path.as_str() {
216            "/_ferro/health" => health_response(query).await,
217            "/_ferro/routes" => crate::debug::handle_routes(),
218            "/_ferro/middleware" => crate::debug::handle_middleware(),
219            "/_ferro/services" => crate::debug::handle_services(),
220            "/_ferro/metrics" => crate::debug::handle_metrics(),
221            "/_ferro/queue/jobs" => crate::debug::handle_queue_jobs().await,
222            "/_ferro/queue/stats" => crate::debug::handle_queue_stats().await,
223            "/_ferro/ferro-base.css" => {
224                #[cfg(feature = "json-ui")]
225                {
226                    serve_ferro_base_css()
227                }
228                #[cfg(not(feature = "json-ui"))]
229                {
230                    HttpResponse::text("404 Not Found").status(404).into_hyper()
231                }
232            }
233            _ => HttpResponse::text("404 Not Found").status(404).into_hyper(),
234        };
235    }
236
237    // Run pre-route middleware (e.g. custom domain path rewriting) before routing.
238    let pre_route = crate::middleware::get_pre_route_middleware();
239    for hook in &pre_route {
240        match hook.handle(req).await {
241            Ok(rewritten) => req = rewritten,
242            Err(response) => return response,
243        }
244    }
245
246    let method = req.method().clone();
247    let path = req.uri().path().to_string();
248
249    let ferro_request = Request::new(req);
250    let routing_path = path.clone();
251
252    // Extract host before request is consumed by routing.
253    let request_host = ferro_request
254        .header("host")
255        .unwrap_or_default()
256        .split(':')
257        .next()
258        .unwrap_or("")
259        .to_ascii_lowercase();
260
261    let response = match router.match_route(&method, &routing_path) {
262        Some((handler, params, route_pattern)) => {
263            let request = ferro_request
264                .with_params(params)
265                .with_route_pattern(route_pattern.clone());
266
267            // Build middleware chain
268            let mut chain = MiddlewareChain::new();
269
270            // 1. Add global middleware
271            chain.extend(middleware_registry.global_middleware().iter().cloned());
272
273            // 2. Add route-level middleware (already boxed)
274            let route_middleware = router.get_route_middleware(&route_pattern);
275            chain.extend(route_middleware);
276
277            // 3. Execute chain with handler inside request host context
278            let response = crate::http::request_context::REQUEST_HOST
279                .scope(request_host, chain.execute(request, handler))
280                .await;
281
282            // Unwrap the Result - both Ok and Err contain HttpResponse
283            let http_response = response.unwrap_or_else(|e| e);
284            http_response.into_hyper()
285        }
286        None => {
287            // Try static file serving before fallback (only GET/HEAD)
288            if method == hyper::Method::GET || method == hyper::Method::HEAD {
289                if let Some(response) =
290                    crate::static_files::try_serve_static_file(&routing_path).await
291                {
292                    return response;
293                }
294            }
295
296            // Check for fallback handler
297            if let Some((fallback_handler, fallback_middleware)) = router.get_fallback() {
298                let request = ferro_request.with_params(std::collections::HashMap::new());
299
300                // Build middleware chain for fallback
301                let mut chain = MiddlewareChain::new();
302
303                // 1. Add global middleware
304                chain.extend(middleware_registry.global_middleware().iter().cloned());
305
306                // 2. Add fallback-specific middleware
307                chain.extend(fallback_middleware);
308
309                // 3. Execute chain with fallback handler
310                let response = chain.execute(request, fallback_handler).await;
311
312                // Unwrap the Result - both Ok and Err contain HttpResponse
313                let http_response = response.unwrap_or_else(|e| e);
314                http_response.into_hyper()
315            } else {
316                // No fallback defined, return default 404
317                HttpResponse::text("404 Not Found").status(404).into_hyper()
318            }
319        }
320    };
321
322    response
323}
324
325/// Built-in health check endpoint at /_ferro/health
326/// Returns {"status": "ok", "timestamp": "..."} by default
327/// Add ?db=true to also check database connectivity (/_ferro/health?db=true)
328async fn health_response(query: &str) -> hyper::Response<Full<Bytes>> {
329    use chrono::Utc;
330    use serde_json::json;
331
332    let timestamp = Utc::now().to_rfc3339();
333    let check_db = query.contains("db=true");
334
335    let mut response = json!({
336        "status": "ok",
337        "timestamp": timestamp
338    });
339
340    if check_db {
341        // Try to check database connection
342        match check_database_health().await {
343            Ok(_) => {
344                response["database"] = json!("connected");
345            }
346            Err(e) => {
347                response["database"] = json!("error");
348                response["database_error"] = json!(e);
349            }
350        }
351    }
352
353    let body =
354        serde_json::to_string(&response).unwrap_or_else(|_| r#"{"status":"ok"}"#.to_string());
355
356    hyper::Response::builder()
357        .status(200)
358        .header("Content-Type", "application/json")
359        .body(Full::new(Bytes::from(body)))
360        .unwrap()
361}
362
363/// Serve the pre-built ferro-json-ui base CSS.
364///
365/// The bytes are embedded at compile time via ferro_json_ui::FERRO_BASE_CSS.
366/// Response: 200, text/css, 24h cache. No user input reaches this handler —
367/// the match arm is an exact string, and the body is static framework content.
368#[cfg(feature = "json-ui")]
369fn serve_ferro_base_css() -> hyper::Response<Full<Bytes>> {
370    let css = ferro_json_ui::FERRO_BASE_CSS;
371    hyper::Response::builder()
372        .status(200)
373        .header("Content-Type", "text/css; charset=utf-8")
374        .header("Content-Length", css.len().to_string())
375        .header("Cache-Control", "public, max-age=31536000, immutable")
376        .body(Full::new(Bytes::from_static(css.as_bytes())))
377        .unwrap()
378}
379
380/// Check database health by attempting a simple query
381async fn check_database_health() -> Result<(), String> {
382    use crate::database::DB;
383    use sea_orm::ConnectionTrait;
384
385    if !DB::is_connected() {
386        return Err("Database not initialized".to_string());
387    }
388
389    let conn = DB::connection().map_err(|e| e.to_string())?;
390
391    // Execute a simple query to verify connection is alive
392    conn.inner()
393        .execute_unprepared("SELECT 1")
394        .await
395        .map_err(|e| format!("Database query failed: {e}"))?;
396
397    Ok(())
398}
399
400#[cfg(all(test, feature = "json-ui"))]
401mod ferro_base_css_route_tests {
402    use super::*;
403    use http_body_util::BodyExt;
404
405    #[tokio::test]
406    async fn serve_ferro_base_css_returns_200_with_text_css_content_type() {
407        let response = serve_ferro_base_css();
408
409        assert_eq!(response.status(), 200, "expected 200 OK");
410
411        let ct = response
412            .headers()
413            .get("Content-Type")
414            .expect("Content-Type header missing")
415            .to_str()
416            .unwrap();
417        assert_eq!(ct, "text/css; charset=utf-8");
418
419        let cc = response
420            .headers()
421            .get("Cache-Control")
422            .expect("Cache-Control header missing")
423            .to_str()
424            .unwrap();
425        assert_eq!(cc, "public, max-age=31536000, immutable");
426
427        let cl = response
428            .headers()
429            .get("Content-Length")
430            .expect("Content-Length header missing")
431            .to_str()
432            .unwrap()
433            .parse::<usize>()
434            .expect("Content-Length must be an integer");
435        assert_eq!(cl, ferro_json_ui::FERRO_BASE_CSS.len());
436    }
437
438    #[tokio::test]
439    async fn serve_ferro_base_css_body_equals_embedded_constant() {
440        let response = serve_ferro_base_css();
441        let body_bytes = response
442            .into_body()
443            .collect()
444            .await
445            .expect("body collect")
446            .to_bytes();
447        assert_eq!(
448            body_bytes.as_ref(),
449            ferro_json_ui::FERRO_BASE_CSS.as_bytes()
450        );
451        assert!(!body_bytes.is_empty());
452    }
453}