follow up to serveconfig (#4820)
* remove latent dbg! * cleanup serveconfig
This commit is contained in:
Jonathan Kelley authored and GitHub committed
1 parent
7408a33be7
commit
306639ee9f
5 files changed
+120
-119
No files matched your search
@@ -11,11 +11,9 @@ use crate::{IncrementalRendererConfig, IndexHtml};
|
||||
pub(crate) type ContextProviders = Arc<Vec<Box<dyn Fn() -> Box<dyn Any> + Send + Sync + 'static>>>;
|
||||
|
||||
/// 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)]
|
||||
#[derive(Clone)]
|
||||
pub struct ServeConfig {
|
||||
pub(crate) root_id: Option<&'static str>,
|
||||
pub(crate) index: Option<IndexHtml>,
|
||||
pub(crate) index_html_override: Option<String>,
|
||||
pub(crate) index: IndexHtml,
|
||||
pub(crate) incremental: Option<IncrementalRendererConfig>,
|
||||
pub(crate) context_providers: Vec<Arc<dyn Fn() -> Box<dyn Any> + Send + Sync + 'static>>,
|
||||
pub(crate) streaming_mode: StreamingMode,
|
||||
@@ -35,6 +33,12 @@ pub enum StreamingMode {
|
||||
|
||||
impl LaunchConfig for ServeConfig {}
|
||||
|
||||
impl Default for ServeConfig {
|
||||
fn default() -> Self {
|
||||
Self::new()
|
||||
}
|
||||
}
|
||||
|
||||
impl ServeConfig {
|
||||
/// Create a new ServeConfig with incremental static generation disabled and the default index.html settings.
|
||||
pub fn builder() -> Self {
|
||||
@@ -42,17 +46,54 @@ impl ServeConfig {
|
||||
}
|
||||
|
||||
/// Create a new ServeConfig with incremental static generation disabled and the default index.html settings
|
||||
///
|
||||
/// This will automatically use the `index.html` file in the `/public` directory if it exists.
|
||||
/// The `/public` folder is meant located next to the current executable. If no `index.html` file is found,
|
||||
/// a default index.html will be used, which will not include any JavaScript or WASM initialization code.
|
||||
///
|
||||
/// To provide an alternate `index.html`, you can use `with_index_html` method instead.
|
||||
pub fn new() -> Self {
|
||||
let index = if let Some(public_path) = crate::public_path() {
|
||||
let index_html_path = public_path.join("index.html");
|
||||
|
||||
if index_html_path.exists() {
|
||||
let index_html = std::fs::read_to_string(index_html_path)
|
||||
.expect("Failed to read index.html from public directory");
|
||||
|
||||
IndexHtml::new(&index_html, "main")
|
||||
.expect("Failed to parse index.html from public directory")
|
||||
} else {
|
||||
tracing::warn!("No index.html found in public directory, using default index.html");
|
||||
IndexHtml::ssr_only()
|
||||
}
|
||||
} else {
|
||||
tracing::warn!(
|
||||
"Cannot identify public directory, using default index.html. If you need client-side scripts (like JS + WASM), please provide an explicit public directory."
|
||||
);
|
||||
IndexHtml::ssr_only()
|
||||
};
|
||||
|
||||
Self {
|
||||
root_id: None,
|
||||
index,
|
||||
incremental: None,
|
||||
index: None,
|
||||
index_html_override: None,
|
||||
context_providers: Default::default(),
|
||||
streaming_mode: StreamingMode::default(),
|
||||
}
|
||||
}
|
||||
|
||||
/// Create a new ServeConfig with the given parsed `IndexHtml` structure.
|
||||
///
|
||||
/// You can create the `IndexHtml` structure by using `IndexHtml::new` method, or manually from
|
||||
/// a string or file.
|
||||
pub fn with_index_html(index: IndexHtml) -> Self {
|
||||
Self {
|
||||
index,
|
||||
incremental: Default::default(),
|
||||
context_providers: Default::default(),
|
||||
streaming_mode: Default::default(),
|
||||
}
|
||||
}
|
||||
|
||||
/// Enable incremental static generation. Incremental static generation caches the
|
||||
/// rendered html in memory and/or the file system. It can be used to improve performance of heavy routes.
|
||||
///
|
||||
@@ -71,56 +112,6 @@ impl ServeConfig {
|
||||
self
|
||||
}
|
||||
|
||||
/// Set the contents of the index.html file to be served.
|
||||
pub fn index_html(mut self, index_html: String) -> Self {
|
||||
self.index_html_override = Some(index_html);
|
||||
self
|
||||
}
|
||||
|
||||
/// Set the id of the root element in the index.html file to place the prerendered content into. (defaults to main)
|
||||
///
|
||||
/// # Example
|
||||
///
|
||||
/// If your index.html file looks like this:
|
||||
/// ```html
|
||||
/// <!DOCTYPE html>
|
||||
/// <html>
|
||||
/// <head>
|
||||
/// <title>My App</title>
|
||||
/// </head>
|
||||
/// <body>
|
||||
/// <div id="my-custom-root"></div>
|
||||
/// </body>
|
||||
/// </html>
|
||||
/// ```
|
||||
///
|
||||
/// You can set the root id to `"my-custom-root"` to render the app into that element:
|
||||
///
|
||||
/// ```rust, no_run
|
||||
/// # fn app() -> Element { unimplemented!() }
|
||||
/// use dioxus::prelude::*;
|
||||
///
|
||||
/// // Finally, launch the app with the config
|
||||
/// LaunchBuilder::new()
|
||||
/// // Only set the server config if the server feature is enabled
|
||||
/// .with_cfg(server_only! {
|
||||
/// dioxus_server::ServeConfig::default().root_id("app")
|
||||
/// })
|
||||
/// // You also need to set the root id in your web config
|
||||
/// .with_cfg(web! {
|
||||
/// dioxus::web::Config::default().rootname("app")
|
||||
/// })
|
||||
/// // And desktop config
|
||||
/// .with_cfg(desktop! {
|
||||
/// dioxus::desktop::Config::default().with_root_name("app")
|
||||
/// })
|
||||
/// .launch(app);
|
||||
/// ```
|
||||
pub fn root_id(mut self, root_id: &'static str) -> Self {
|
||||
self.root_id = Some(root_id);
|
||||
self
|
||||
}
|
||||
|
||||
/// Provide context to the root and server functions. You can use this context while rendering with [`consume_context`](dioxus_core::consume_context).
|
||||
///
|
||||
///
|
||||
@@ -313,32 +304,4 @@ impl ServeConfig {
|
||||
self.streaming_mode = StreamingMode::OutOfOrder;
|
||||
self
|
||||
}
|
||||
|
||||
pub(crate) fn resolve_index(&mut self) -> &IndexHtml {
|
||||
// Create the IndexHtml object if the user has specified an override
|
||||
if let Some(raw_index_html) = self.index_html_override.as_ref() {
|
||||
self.index = Some(
|
||||
IndexHtml::new(raw_index_html, self.root_id.unwrap_or("main"))
|
||||
.expect("Failed to parse custom index.html"),
|
||||
);
|
||||
} else if !cfg!(target_arch = "wasm32") {
|
||||
let public_path = crate::public_path();
|
||||
let index_html_path = public_path.join("index.html");
|
||||
|
||||
if index_html_path.exists() {
|
||||
let index_html = std::fs::read_to_string(index_html_path)
|
||||
.expect("Failed to read index.html from public directory");
|
||||
self.index = Some(
|
||||
IndexHtml::new(&index_html, self.root_id.unwrap_or("main"))
|
||||
.expect("Failed to parse index.html from public directory"),
|
||||
);
|
||||
}
|
||||
} else if self.index.is_none() {
|
||||
self.index = Some(IndexHtml::default());
|
||||
}
|
||||
|
||||
self.index
|
||||
.as_ref()
|
||||
.expect("IndexHtml is always set after it is resolved")
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user