use crate::{ ssr::{SSRError, SsrRendererPool}, ServeConfig, ServerFunction, }; use crate::{IncrementalRendererError, RenderFreshness}; use axum::{ body, body::Body, extract::State, http::{Request, Response, StatusCode}, response::IntoResponse, routing::*, }; use dioxus_core::{Element, VirtualDom}; use futures::Stream; use http::header::*; use std::path::Path; use std::sync::Arc; use tower::util::MapResponse; use tower::ServiceExt; use tower_http::services::fs::ServeFileSystemResponseBody; /// SSR renderer handler for Axum with added context injection. /// /// # Example /// ```rust,no_run /// #![allow(non_snake_case)] /// use std::sync::{Arc, Mutex}; /// /// use axum::routing::get; /// use dioxus::prelude::*; /// use dioxus_server::{RenderHandleState, render_handler, ServeConfig}; /// /// fn app() -> Element { /// rsx! { /// "hello!" /// } /// } /// /// #[tokio::main] /// async fn main() { /// let addr = dioxus::cli_config::fullstack_address_or_localhost(); /// let router = axum::Router::new() /// // Register server functions, etc. /// // Note you can use `register_server_functions_with_context` /// // to inject the context into server functions running outside /// // of an SSR render context. /// .fallback(get(render_handler) /// .with_state(RenderHandleState::new(ServeConfig::new().unwrap(), app)) /// ) /// .into_make_service(); /// let listener = tokio::net::TcpListener::bind(addr).await.unwrap(); /// axum::serve(listener, router).await.unwrap(); /// } /// ``` pub async fn render_handler( State(state): State, request: Request, ) -> impl IntoResponse { RenderHandleState::render_handler(State(state), request).await } /// A extension trait with utilities for integrating Dioxus with your Axum router. pub trait DioxusRouterExt: DioxusRouterFnExt { /// Serves the static WASM for your Dioxus application (except the generated index.html). /// /// # Example /// ```rust, no_run /// # #![allow(non_snake_case)] /// # use dioxus::prelude::*; /// use dioxus_server::{DioxusRouterExt, DioxusRouterFnExt}; /// /// #[tokio::main] /// async fn main() -> anyhow::Result<()> { /// let addr = dioxus::cli_config::fullstack_address_or_localhost(); /// let router = axum::Router::new() /// // Server side render the application, serve static assets, and register server functions /// .serve_static_assets() /// // Server render the application /// // ... /// .into_make_service(); /// let listener = tokio::net::TcpListener::bind(addr).await?; /// axum::serve(listener, router).await?; /// Ok(()) /// } /// ``` fn serve_static_assets(self) -> Self where Self: Sized; /// Serves the Dioxus application. This will serve a complete server side rendered application. /// This will serve static assets, server render the application, register server functions, and integrate with hot reloading. /// /// # Example /// ```rust, no_run /// # #![allow(non_snake_case)] /// # use dioxus::prelude::*; /// use dioxus_server::{DioxusRouterExt, DioxusRouterFnExt, ServeConfig}; /// /// #[tokio::main] /// async fn main() { /// let addr = dioxus::cli_config::fullstack_address_or_localhost(); /// let router = axum::Router::new() /// // Server side render the application, serve static assets, and register server functions /// .serve_dioxus_application(ServeConfig::new().unwrap(), app) /// .into_make_service(); /// let listener = tokio::net::TcpListener::bind(addr).await.unwrap(); /// axum::serve(listener, router).await.unwrap(); /// } /// /// fn app() -> Element { /// rsx! { "Hello World" } /// } /// ``` fn serve_dioxus_application(self, cfg: ServeConfig, app: fn() -> Element) -> Self where Self: Sized; } #[cfg(not(target_arch = "wasm32"))] impl DioxusRouterExt for Router where S: Send + Sync + Clone + 'static, { fn serve_static_assets(self) -> Self { let public_path = crate::public_path(); if !public_path.exists() { return self; } // Serve all files in public folder except index.html serve_dir_cached(self, &public_path, &public_path) } fn serve_dioxus_application(self, cfg: ServeConfig, app: fn() -> Element) -> Self { self.register_server_functions() .serve_static_assets() .fallback( get(RenderHandleState::render_handler).with_state(RenderHandleState::new(cfg, app)), ) } } /// A extension trait with server function utilities for integrating Dioxus with your Axum router. pub trait DioxusRouterFnExt { /// Registers server functions with the default handler. /// /// # Example /// ```rust, no_run /// # use dioxus::prelude::*; /// # use dioxus_server::DioxusRouterFnExt; /// #[tokio::main] /// async fn main() { /// let addr = dioxus::cli_config::fullstack_address_or_localhost(); /// let router = axum::Router::new() /// // Register server functions routes with the default handler /// .register_server_functions() /// .into_make_service(); /// let listener = tokio::net::TcpListener::bind(addr).await.unwrap(); /// axum::serve(listener, router).await.unwrap(); /// } /// ``` #[allow(dead_code)] fn register_server_functions(self) -> Self where Self: Sized; /// Serves a Dioxus application without static assets. /// Sets up server function routes and rendering endpoints only. /// /// Useful for WebAssembly environments or when static assets /// are served by another system. /// /// # Example /// ```rust, no_run /// # use dioxus::prelude::*; /// # use dioxus_server::{DioxusRouterFnExt, ServeConfig}; /// #[tokio::main] /// async fn main() { /// let router = axum::Router::new() /// .serve_api_application(ServeConfig::new().unwrap(), app) /// .into_make_service(); /// // ... /// } /// /// fn app() -> Element { /// rsx! { "Hello World" } /// } /// ``` fn serve_api_application(self, cfg: ServeConfig, app: fn() -> Element) -> Self where Self: Sized; } impl DioxusRouterFnExt for Router { fn register_server_functions(mut self) -> Self { for f in ServerFunction::collect() { self = f.register_server_fn_on_router(self); } self } fn serve_api_application(self, cfg: ServeConfig, app: fn() -> Element) -> Self where Self: Sized, { self.register_server_functions().fallback( get(RenderHandleState::render_handler).with_state(RenderHandleState::new(cfg, app)), ) } } /// State used by [`RenderHandleState::render_handler`] to render a dioxus component with axum #[derive(Clone)] pub struct RenderHandleState { config: ServeConfig, build_virtual_dom: Arc VirtualDom + Send + Sync>, renderers: Arc, } impl RenderHandleState { /// Create a new [`RenderHandleState`] pub fn new(config: ServeConfig, root: fn() -> Element) -> Self { Self { renderers: Arc::new(SsrRendererPool::new(4, config.incremental.clone())), build_virtual_dom: Arc::new(move || VirtualDom::new(root)), config, } } /// Create a new [`RenderHandleState`] with a custom [`VirtualDom`] factory. This method can be used to pass context into the root component of your application. pub fn new_with_virtual_dom_factory( config: ServeConfig, build_virtual_dom: impl Fn() -> VirtualDom + Send + Sync + 'static, ) -> Self { Self { renderers: Arc::new(SsrRendererPool::new(4, config.incremental.clone())), config, build_virtual_dom: Arc::new(build_virtual_dom), } } /// Set the [`ServeConfig`] for this [`RenderHandleState`] pub fn with_config(mut self, config: ServeConfig) -> Self { self.config = config; self } /// SSR renderer handler for Axum with added context injection. /// /// # Example /// ```rust,no_run /// #![allow(non_snake_case)] /// use std::sync::{Arc, Mutex}; /// /// use axum::routing::get; /// use dioxus::prelude::*; /// use dioxus_server::{RenderHandleState, render_handler, ServeConfig}; /// /// fn app() -> Element { /// rsx! { /// "hello!" /// } /// } /// /// #[tokio::main] /// async fn main() { /// let addr = dioxus::cli_config::fullstack_address_or_localhost(); /// let router = axum::Router::new() /// // Register server functions, etc. /// // Note you can use `register_server_functions_with_context` /// // to inject the context into server functions running outside /// // of an SSR render context. /// .fallback(get(render_handler) /// .with_state(RenderHandleState::new(ServeConfig::new().unwrap(), app)) /// ) /// .into_make_service(); /// let listener = tokio::net::TcpListener::bind(addr).await.unwrap(); /// axum::serve(listener, router).await.unwrap(); /// } /// ``` pub async fn render_handler( State(state): State, request: Request, ) -> impl IntoResponse { let cfg = &state.config; let build_virtual_dom = { let build_virtual_dom = state.build_virtual_dom.clone(); let context_providers = state.config.context_providers.clone(); move || { let mut vdom = build_virtual_dom(); for state in context_providers.as_slice() { vdom.insert_any_root_context(state()); } vdom } }; let (parts, _) = request.into_parts(); let url = parts .uri .path_and_query() .ok_or(StatusCode::BAD_REQUEST)? .to_string(); match state.render(url, cfg, build_virtual_dom).await { Ok((freshness, rx)) => { let mut response = axum::response::Html::from(Body::from_stream(rx)).into_response(); freshness.write(response.headers_mut()); Result::, StatusCode>::Ok(response) } Err(SSRError::Incremental(e)) => { tracing::error!("Failed to render page: {}", e); Ok(Self::err_to_axum_response(e).into_response()) } Err(SSRError::HttpError { status, message }) => Ok(Response::builder() .status(status) .body(Body::from(message.unwrap_or_else(|| { status .canonical_reason() .unwrap_or("An unknown error occurred") .to_string() }))) .unwrap()), } } fn err_to_axum_response(e: E) -> Response { Response::builder() .status(StatusCode::INTERNAL_SERVER_ERROR) .body(body::Body::new(format!("Error: {}", e))) .unwrap() } /// Render the application to HTML. pub async fn render<'a>( &'a self, route: String, cfg: &'a ServeConfig, virtual_dom_factory: impl FnOnce() -> VirtualDom + Send + Sync + 'static, ) -> Result< ( RenderFreshness, impl Stream>, ), SSRError, > { self.renderers .clone() .render_to(cfg, route, virtual_dom_factory) .await } } fn serve_dir_cached( mut router: Router, public_path: &std::path::Path, directory: &std::path::Path, ) -> Router where S: Send + Sync + Clone + 'static, { use tower_http::services::ServeFile; let dir = std::fs::read_dir(directory) .unwrap_or_else(|e| panic!("Couldn't read public directory at {:?}: {}", &directory, e)); for entry in dir.flatten() { let path = entry.path(); // Don't serve the index.html file. The SSR handler will generate it. if path == public_path.join("index.html") { continue; } let route = path.strip_prefix(public_path).unwrap(); let route = path_components_to_route_lossy(route); if path.is_dir() { router = serve_dir_cached(router, public_path, &path); } else { let serve_file = ServeFile::new(&path).precompressed_br(); // All cached assets are served at the root of the asset directory. If we know an asset // is hashed for cache busting, we can cache the response on the client side forever. If // the asset changes, the hash in the path will also change and the client will refetch it. if file_name_looks_immutable(&route) { router = router.nest_service(&route, cache_response_forever(serve_file)) } else { router = router.nest_service(&route, serve_file) } } } router } fn path_components_to_route_lossy(path: &Path) -> String { let route = path .iter() .map(|segment| segment.to_string_lossy()) .collect::>() .join("/"); format!("/{}", route) } type MappedAxumService = MapResponse< S, fn(Response) -> Response, >; fn cache_response_forever(service: S) -> MappedAxumService where S: ServiceExt, Response = Response>, { service.map_response(|mut response: Response| { response.headers_mut().insert( CACHE_CONTROL, HeaderValue::from_static("public, max-age=31536000, immutable"), ); response }) } fn file_name_looks_immutable(file_name: &str) -> bool { // Check if the file name looks like a hash (e.g., "main-dxh12345678.js") file_name.rsplit_once("-dxh").is_some_and(|(_, hash)| { hash.chars() .take_while(|c| *c != '.') .all(|c| c.is_ascii_hexdigit()) }) } #[test] fn test_file_name_looks_immutable() { assert!(file_name_looks_immutable("main-dxh12345678.js")); assert!(file_name_looks_immutable("style-dxhabcdef.css")); assert!(!file_name_looks_immutable("index.html")); assert!(!file_name_looks_immutable("script.js")); assert!(!file_name_looks_immutable("main-dxh1234wyz.js")); assert!(!file_name_looks_immutable("main-dxh12345678-invalid.js")); }