//! Configuration for how to serve a Dioxus application #![allow(non_snake_case)] use std::fs::File; use std::io::Read; use std::path::PathBuf; /// A ServeConfig is used to configure how to serve a Dioxus application. It contains information about how to serve static assets, and what content to render with [`dioxus-ssr`]. #[derive(Clone, Default)] pub struct ServeConfigBuilder { pub(crate) root_id: Option<&'static str>, pub(crate) index_html: Option, pub(crate) index_path: Option, pub(crate) incremental: Option, } impl ServeConfigBuilder { /// Create a new ServeConfigBuilder with the root component and props to render on the server. pub fn new() -> Self { Self { root_id: None, index_html: None, index_path: None, incremental: None, } } /// Enable incremental static generation pub fn incremental(mut self, cfg: dioxus_ssr::incremental::IncrementalRendererConfig) -> Self { self.incremental = Some(cfg); self } /// Set the contents of the index.html file to be served. (precedence over index_path) pub fn index_html(mut self, index_html: String) -> Self { self.index_html = Some(index_html); self } /// Set the path of the index.html file to be served. (defaults to {assets_path}/index.html) pub fn index_path(mut self, index_path: PathBuf) -> Self { self.index_path = Some(index_path); self } /// Set the id of the root element in the index.html file to place the prerendered content into. (defaults to main) pub fn root_id(mut self, root_id: &'static str) -> Self { self.root_id = Some(root_id); self } /// Build the ServeConfig pub fn build(self) -> ServeConfig { // The CLI always bundles static assets into the exe/public directory let public_path = public_path(); let index_path = self .index_path .map(PathBuf::from) .unwrap_or_else(|| public_path.join("index.html")); let root_id = self.root_id.unwrap_or("main"); let index_html = self .index_html .unwrap_or_else(|| load_index_path(index_path)); let index = load_index_html(index_html, root_id); ServeConfig { index, incremental: self.incremental, } } } /// Get the path to the public assets directory to serve static files from pub(crate) fn public_path() -> PathBuf { // The CLI always bundles static assets into the exe/public directory std::env::current_exe() .expect("Failed to get current executable path") .parent() .unwrap() .join("public") } fn load_index_path(path: PathBuf) -> String { let mut file = File::open(&path).unwrap_or_else(|_| panic!("Failed to find index.html. Make sure the index_path is set correctly and the WASM application has been built. Tried to open file at path: {path:?}")); let mut contents = String::new(); file.read_to_string(&mut contents) .expect("Failed to read index.html"); contents } fn load_index_html(contents: String, root_id: &'static str) -> IndexHtml { let (pre_main, post_main) = contents.split_once(&format!("id=\"{root_id}\"")).unwrap_or_else(|| panic!("Failed to find id=\"{root_id}\" in index.html. The id is used to inject the application into the page.")); let post_main = post_main.split_once('>').unwrap_or_else(|| { panic!("Failed to find closing > after id=\"{root_id}\" in index.html.") }); let (pre_main, post_main) = ( pre_main.to_string() + &format!("id=\"{root_id}\"") + post_main.0 + ">", post_main.1.to_string(), ); let (head, close_head) = pre_main.split_once("").unwrap_or_else(|| { panic!("Failed to find closing tag after id=\"{root_id}\" in index.html.") }); let (head, close_head) = (head.to_string(), "".to_string() + close_head); let (post_main, after_closing_body_tag) = post_main.split_once("").unwrap_or_else(|| { panic!("Failed to find closing tag after id=\"{root_id}\" in index.html.") }); // Strip out the head if it exists let mut head_before_title = String::new(); let mut head_after_title = head; let mut title = String::new(); if let Some((new_head_before_title, new_title)) = head_after_title.split_once("") { let (new_title, new_head_after_title) = new_title .split_once("") .expect("Failed to find closing tag after in index.html."); title = format!("<title>{new_title}"); head_before_title = new_head_before_title.to_string(); head_after_title = new_head_after_title.to_string(); } IndexHtml { head_before_title, head_after_title, title, close_head, post_main: post_main.to_string(), after_closing_body_tag: "".to_string() + after_closing_body_tag, } } #[derive(Clone)] pub(crate) struct IndexHtml { pub(crate) head_before_title: String, pub(crate) head_after_title: String, pub(crate) title: String, pub(crate) close_head: String, pub(crate) post_main: String, pub(crate) after_closing_body_tag: String, } /// Used to configure how to serve a Dioxus application. It contains information about how to serve static assets, and what content to render with [`dioxus-ssr`]. /// See [`ServeConfigBuilder`] to create a ServeConfig #[derive(Clone)] pub struct ServeConfig { pub(crate) index: IndexHtml, pub(crate) incremental: Option, } impl Default for ServeConfig { fn default() -> Self { Self::builder().build() } } impl ServeConfig { /// Create a new builder for a ServeConfig pub fn builder() -> ServeConfigBuilder { ServeConfigBuilder::new() } } impl From for ServeConfig { fn from(builder: ServeConfigBuilder) -> Self { builder.build() } }