add cache headers

This commit is contained in:
Evan Almloff committed 2023-06-24 13:21:12 -07:00
1 parent b8806b0854
commit a165e13564
17 files changed
+350 -194

No files matched your search

+3 -3
View File
@@ -21,7 +21,7 @@ warp = { version = "0.3.3", optional = true }
http-body = { version = "0.4.5", optional = true } http-body = { version = "0.4.5", optional = true }
# axum # axum
axum = { version = "0.6.1", features = ["ws"], optional = true } axum = { version = "0.6.1", features = ["ws", "macros"], optional = true }
tower-http = { version = "0.4.0", optional = true, features = ["fs"] } tower-http = { version = "0.4.0", optional = true, features = ["fs"] }
axum-macros = "0.3.7" axum-macros = "0.3.7"
@@ -36,7 +36,7 @@ hyper = { version = "0.14.25", optional = true }
http = { version = "0.2.9", optional = true } http = { version = "0.2.9", optional = true }
# Router Intigration # Router Intigration
dioxus-router = { path = "../router", version = "^0.3.0", features = ["ssr"], optional = true } dioxus-router = { path = "../router", version = "^0.3.0", optional = true }
log = "0.4.17" log = "0.4.17"
once_cell = "1.17.1" once_cell = "1.17.1"
@@ -65,7 +65,7 @@ hot-reload = ["serde_json", "tokio-stream", "futures-util"]
warp = ["dep:warp", "http-body", "ssr"] warp = ["dep:warp", "http-body", "ssr"]
axum = ["dep:axum", "tower-http", "ssr"] axum = ["dep:axum", "tower-http", "ssr"]
salvo = ["dep:salvo", "ssr"] salvo = ["dep:salvo", "ssr"]
ssr = ["server_fn/ssr", "tokio", "dioxus-ssr", "hyper", "http"] ssr = ["server_fn/ssr", "tokio", "dioxus-ssr", "hyper", "http", "dioxus-router/ssr"]
default-tls = ["server_fn/default-tls"] default-tls = ["server_fn/default-tls"]
rustls = ["server_fn/rustls"] rustls = ["server_fn/rustls"]
@@ -1,2 +1,3 @@
dist dist
target target
static
@@ -35,7 +35,7 @@ fn app(cx: Scope<AppProps>) -> Element {
} }
} }
}, },
"Run a server function! testing1234" "Run a server function!"
} }
"Server said: {text}" "Server said: {text}"
}) })
@@ -60,6 +60,6 @@ async fn get_server_data() -> Result<String, ServerFnError> {
fn main() { fn main() {
launch!(@([127, 0, 0, 1], 8080), app, { launch!(@([127, 0, 0, 1], 8080), app, {
server_cfg: ServeConfigBuilder::new(app, (AppProps { count: 0 })), server_cfg: ServeConfigBuilder::new(app, (AppProps { count: 0 })),
incremental, incremental: IncrementalRendererConfig::default().invalidate_after(std::time::Duration::from_secs(120)),
}); });
} }
@@ -1,2 +1,3 @@
dist dist
target target
static
@@ -6,13 +6,14 @@
//! ``` //! ```
#![allow(non_snake_case)] #![allow(non_snake_case)]
use dioxus::prelude::*; use dioxus::prelude::*;
use dioxus_fullstack::prelude::*; use dioxus_fullstack::prelude::*;
use dioxus_router::prelude::*; use dioxus_router::prelude::*;
fn main() { fn main() {
launch_router!(@([127, 0, 0, 1], 8080), Route, { launch_router!(@([127, 0, 0, 1], 8080), Route, {
incremental, incremental: IncrementalRendererConfig::default().invalidate_after(std::time::Duration::from_secs(120)),
}); });
} }
@@ -1,2 +1,3 @@
dist dist
target target
static
@@ -12,7 +12,7 @@ use serde::{Deserialize, Serialize};
fn main() { fn main() {
launch!(@([127, 0, 0, 1], 8080), app, (AppProps { count: 5 }), { launch!(@([127, 0, 0, 1], 8080), app, (AppProps { count: 5 }), {
incremental, incremental: IncrementalRendererConfig::default().invalidate_after(std::time::Duration::from_secs(120)),
}); });
} }
@@ -1,2 +1,3 @@
dist dist
target target
static
@@ -12,7 +12,7 @@ use serde::{Deserialize, Serialize};
fn main() { fn main() {
launch!(@([127, 0, 0, 1], 8080), app, (AppProps { count: 5 }), { launch!(@([127, 0, 0, 1], 8080), app, (AppProps { count: 5 }), {
incremental, incremental: IncrementalRendererConfig::default().invalidate_after(std::time::Duration::from_secs(120)),
}); });
} }
@@ -349,6 +349,17 @@ where
} }
} }
fn apply_request_parts_to_response<B>(
parts: &RequestParts,
response: &mut axum::response::Response<B>,
) {
let headers = response.headers_mut();
for (key, value) in parts.headers.iter() {
headers.insert(key, value.clone());
}
}
#[axum::debug_handler]
async fn render_handler<P: Clone + serde::Serialize + Send + Sync + 'static>( async fn render_handler<P: Clone + serde::Serialize + Send + Sync + 'static>(
State((cfg, ssr_state)): State<(ServeConfig<P>, SSRState)>, State((cfg, ssr_state)): State<(ServeConfig<P>, SSRState)>,
request: Request<Body>, request: Request<Body>,
@@ -356,12 +367,21 @@ async fn render_handler<P: Clone + serde::Serialize + Send + Sync + 'static>(
let (parts, _) = request.into_parts(); let (parts, _) = request.into_parts();
let parts: Arc<RequestParts> = Arc::new(parts.into()); let parts: Arc<RequestParts> = Arc::new(parts.into());
let url = parts.uri.path_and_query().unwrap().to_string(); let url = parts.uri.path_and_query().unwrap().to_string();
let server_context = DioxusServerContext::new(parts); let server_context = DioxusServerContext::new(parts.clone());
match ssr_state.render(url, &cfg, |vdom| { match ssr_state
vdom.base_scope().provide_context(server_context); .render(url, &cfg, |vdom| {
}) { vdom.base_scope().provide_context(server_context);
Ok(html) => Full::from(html).into_response(), })
.await
{
Ok(rendered) => {
let crate::render::RenderResponse { html, freshness } = rendered;
let mut response = axum::response::Html::from(html).into_response();
freshness.write(response.headers_mut());
apply_request_parts_to_response(&parts, &mut response);
response
}
Err(e) => { Err(e) => {
log::error!("Failed to render page: {}", e); log::error!("Failed to render page: {}", e);
report_err(e).into_response() report_err(e).into_response()
@@ -332,16 +332,25 @@ impl<P: Clone + serde::Serialize + Send + Sync + 'static> Handler for SSRHandler
let route = parts.uri.path().to_string(); let route = parts.uri.path().to_string();
let server_context = DioxusServerContext::new(parts); let server_context = DioxusServerContext::new(parts);
res.write_body( match renderer_pool
renderer_pool .render(route, &self.cfg, |vdom| {
.render(route, &self.cfg, |vdom| { vdom.base_scope().provide_context(server_context.clone());
vdom.base_scope().provide_context(server_context.clone()); })
}) .await
.unwrap(), {
) Ok(rendered) => {
.unwrap(); let crate::render::RenderResponse { html, freshness } = rendered;
*res.headers_mut() = server_context.take_response_headers(); res.write_body(html).unwrap();
*res.headers_mut() = server_context.take_response_headers();
freshness.write(res.headers_mut());
}
Err(err) => {
log::error!("Error rendering SSR: {}", err);
res.write_body("Error rendering SSR").unwrap();
}
};
} }
} }
+31 -14
View File
@@ -185,24 +185,42 @@ pub fn render_ssr<P: Clone + serde::Serialize + Send + Sync + 'static>(
warp::get() warp::get()
.and(request_parts()) .and(request_parts())
.and(with_ssr_state(&cfg)) .and(with_ssr_state(&cfg))
.map(move |parts: RequestParts, renderer: SSRState| { .then(move |parts: RequestParts, renderer: SSRState| {
let route = parts.uri.path().to_string(); let route = parts.uri.path().to_string();
let parts = Arc::new(parts); let parts = Arc::new(parts);
let cfg = cfg.clone();
async move {
let server_context = DioxusServerContext::new(parts);
let server_context = DioxusServerContext::new(parts); match renderer
.render(route, &cfg, |vdom| {
vdom.base_scope().provide_context(server_context.clone());
})
.await
{
Ok(rendered) => {
let crate::render::RenderResponse { html, freshness } = rendered;
let html = renderer.render(route, &cfg, |vdom| { let mut res = Response::builder()
vdom.base_scope().provide_context(server_context.clone()); .header("Content-Type", "text/html")
}); .body(html)
.unwrap();
let mut res = Response::builder(); let headers_mut = res.headers_mut();
*headers_mut = server_context.take_response_headers();
freshness.write(headers_mut);
*res.headers_mut().expect("empty request should be valid") = res
server_context.take_response_headers(); }
Err(err) => {
res.header("Content-Type", "text/html") log::error!("Failed to render ssr: {}", err);
.body(Bytes::from(html.unwrap())) Response::builder()
.unwrap() .status(500)
.body("Failed to render ssr".into())
.unwrap()
}
}
}
}) })
} }
@@ -364,9 +382,8 @@ pub fn connect_hot_reload() -> impl Filter<Extract = (impl Reply,), Error = warp
#[cfg(not(all(debug_assertions, feature = "hot-reload", feature = "ssr")))] #[cfg(not(all(debug_assertions, feature = "hot-reload", feature = "ssr")))]
{ {
warp::path!("_dioxus" / "hot_reload") warp::path!("_dioxus" / "hot_reload")
.and(warp::ws())
.map(warp::reply) .map(warp::reply)
.map(|reply| warp::reply::with_status(reply, warp::http::StatusCode::NOT_FOUND)); .map(|reply| warp::reply::with_status(reply, warp::http::StatusCode::NOT_FOUND))
} }
#[cfg(all(debug_assertions, feature = "hot-reload", feature = "ssr"))] #[cfg(all(debug_assertions, feature = "hot-reload", feature = "ssr"))]
{ {
+58 -27
View File
@@ -3,7 +3,10 @@
use std::sync::Arc; use std::sync::Arc;
use dioxus::prelude::VirtualDom; use dioxus::prelude::VirtualDom;
use dioxus_ssr::{incremental::IncrementalRendererConfig, Renderer}; use dioxus_ssr::{
incremental::{IncrementalRendererConfig, RenderFreshness},
Renderer,
};
use crate::prelude::*; use crate::prelude::*;
use dioxus::prelude::*; use dioxus::prelude::*;
@@ -20,7 +23,7 @@ enum SsrRendererPool {
} }
impl SsrRendererPool { impl SsrRendererPool {
fn render_to<P: Clone + 'static>( async fn render_to<P: Clone + 'static>(
&self, &self,
cfg: &ServeConfig<P>, cfg: &ServeConfig<P>,
route: String, route: String,
@@ -28,7 +31,7 @@ impl SsrRendererPool {
props: P, props: P,
to: &mut String, to: &mut String,
modify_vdom: impl FnOnce(&mut VirtualDom), modify_vdom: impl FnOnce(&mut VirtualDom),
) -> Result<(), dioxus_ssr::incremental::IncrementalRendererError> { ) -> Result<RenderFreshness, dioxus_ssr::incremental::IncrementalRendererError> {
match self { match self {
Self::Renderer(pool) => { Self::Renderer(pool) => {
let mut vdom = VirtualDom::new_with_props(component, props); let mut vdom = VirtualDom::new_with_props(component, props);
@@ -37,13 +40,16 @@ impl SsrRendererPool {
let _ = vdom.rebuild(); let _ = vdom.rebuild();
let mut renderer = pool.pull(pre_renderer); let mut renderer = pool.pull(pre_renderer);
renderer.render_to(to, &vdom)?; renderer.render_to(to, &vdom)?;
Ok(RenderFreshness::now(None))
} }
Self::Incremental(pool) => { Self::Incremental(pool) => {
let mut renderer = pool.pull(|| incremental_pre_renderer(cfg)); let mut renderer = pool.pull(|| incremental_pre_renderer(cfg));
renderer.render_to_string(route, component, props, to, modify_vdom)?; Ok(renderer
.render_to_string(route, component, props, to, modify_vdom)
.await?)
} }
} }
Ok(())
} }
} }
@@ -74,30 +80,36 @@ impl SSRState {
} }
/// Render the application to HTML. /// Render the application to HTML.
pub fn render<P: 'static + Clone + serde::Serialize>( pub fn render<'a, P: 'static + Clone + serde::Serialize + Send + Sync>(
&self, &'a self,
route: String, route: String,
cfg: &ServeConfig<P>, cfg: &'a ServeConfig<P>,
modify_vdom: impl FnOnce(&mut VirtualDom), modify_vdom: impl FnOnce(&mut VirtualDom) + Send + 'a,
) -> Result<String, dioxus_ssr::incremental::IncrementalRendererError> { ) -> impl std::future::Future<
let ServeConfig { app, props, .. } = cfg; Output = Result<RenderResponse, dioxus_ssr::incremental::IncrementalRendererError>,
> + Send
+ 'a {
async move {
let ServeConfig { app, props, .. } = cfg;
let ServeConfig { index, .. } = cfg; let ServeConfig { index, .. } = cfg;
let mut html = String::new(); let mut html = String::new();
html += &index.pre_main; html += &index.pre_main;
self.renderers let freshness = self
.render_to(cfg, route, *app, props.clone(), &mut html, modify_vdom)?; .renderers
.render_to(cfg, route, *app, props.clone(), &mut html, modify_vdom)
.await?;
// serialize the props // serialize the props
let _ = crate::props_html::serialize_props::encode_in_element(&cfg.props, &mut html); let _ = crate::props_html::serialize_props::encode_in_element(&cfg.props, &mut html);
#[cfg(all(debug_assertions, feature = "hot-reload"))] #[cfg(all(debug_assertions, feature = "hot-reload"))]
{ {
// In debug mode, we need to add a script to the page that will reload the page if the websocket disconnects to make full recompile hot reloads work // In debug mode, we need to add a script to the page that will reload the page if the websocket disconnects to make full recompile hot reloads work
let disconnect_js = r#"(function () { let disconnect_js = r#"(function () {
const protocol = window.location.protocol === 'https:' ? 'wss:' : 'ws:'; const protocol = window.location.protocol === 'https:' ? 'wss:' : 'ws:';
const url = protocol + '//' + window.location.host + '/_dioxus/disconnect'; const url = protocol + '//' + window.location.host + '/_dioxus/disconnect';
const poll_interval = 1000; const poll_interval = 1000;
@@ -123,14 +135,33 @@ impl SSRState {
ws.onclose = reload_upon_connect; ws.onclose = reload_upon_connect;
})()"#; })()"#;
html += r#"<script>"#; html += r#"<script>"#;
html += disconnect_js; html += disconnect_js;
html += r#"</script>"#; html += r#"</script>"#;
}
html += &index.post_main;
Ok(RenderResponse { html, freshness })
} }
}
}
html += &index.post_main; /// A rendered response from the server.
pub struct RenderResponse {
pub(crate) html: String,
pub(crate) freshness: RenderFreshness,
}
Ok(html) impl RenderResponse {
/// Get the rendered HTML.
pub fn html(&self) -> &str {
&self.html
}
/// Get the freshness of the rendered HTML.
pub fn freshness(&self) -> RenderFreshness {
self.freshness
} }
} }
+3 -2
View File
@@ -24,10 +24,11 @@ web-sys = { version = "0.3.60", optional = true, features = ["ScrollRestoration"
js-sys = { version = "0.3.63", optional = true } js-sys = { version = "0.3.63", optional = true }
gloo-utils = { version = "0.1.6", optional = true } gloo-utils = { version = "0.1.6", optional = true }
dioxus-ssr = { path = "../ssr", optional = true } dioxus-ssr = { path = "../ssr", optional = true }
tokio = { version = "1.28", features = ["full"], optional = true }
[features] [features]
default = ["web", "ssr"] default = ["web"]
ssr = ["dioxus-ssr"] ssr = ["dioxus-ssr", "tokio"]
wasm_test = [] wasm_test = []
serde = ["dep:serde", "gloo-utils/serde"] serde = ["dep:serde", "gloo-utils/serde"]
web = ["gloo", "web-sys", "wasm-bindgen", "gloo-utils", "js-sys"] web = ["gloo", "web-sys", "wasm-bindgen", "gloo-utils", "js-sys"]
+63 -77
View File
@@ -2,103 +2,89 @@
use std::str::FromStr; use std::str::FromStr;
use dioxus::prelude::*; use dioxus::prelude::*;
use dioxus_ssr::incremental::{IncrementalRenderer, IncrementalRendererError, RenderHTML}; use dioxus_ssr::incremental::{
IncrementalRenderer, IncrementalRendererError, RenderFreshness, RenderHTML,
};
use crate::prelude::*; use crate::prelude::*;
trait IncrementalRendererRouterExt { /// Pre-cache all static routes.
/// Pre-cache all static routes. pub async fn pre_cache_static_routes<R: RenderHTML + Send, Rt>(
fn pre_cache_static_routes<Rt>(&mut self) -> Result<(), IncrementalRendererError> renderer: &mut IncrementalRenderer<R>,
where ) -> Result<(), IncrementalRendererError>
Rt: Routable, where
<Rt as FromStr>::Err: std::fmt::Display; Rt: Routable,
<Rt as FromStr>::Err: std::fmt::Display,
/// Render a route to a writer. {
fn render_route<Rt, W, F: FnOnce(&mut VirtualDom)>( for route in Rt::SITE_MAP
&mut self, .iter()
route: Rt, .flat_map(|seg| seg.flatten().into_iter())
writer: &mut W,
modify_vdom: F,
) -> Result<(), IncrementalRendererError>
where
Rt: Routable,
<Rt as FromStr>::Err: std::fmt::Display,
W: std::io::Write;
}
impl<R: RenderHTML> IncrementalRendererRouterExt for IncrementalRenderer<R> {
fn pre_cache_static_routes<Rt>(&mut self) -> Result<(), IncrementalRendererError>
where
Rt: Routable,
<Rt as FromStr>::Err: std::fmt::Display,
{ {
for route in Rt::SITE_MAP // check if this is a static segment
.iter() let mut is_static = true;
.flat_map(|seg| seg.flatten().into_iter()) let mut full_path = String::new();
{ for segment in &route {
// check if this is a static segment match segment {
let mut is_static = true; SegmentType::Static(s) => {
let mut full_path = String::new(); full_path += "/";
for segment in &route { full_path += s;
match segment {
SegmentType::Static(s) => {
full_path += "/";
full_path += s;
}
_ => {
// skip routes with any dynamic segments
is_static = false;
break;
}
} }
} _ => {
// skip routes with any dynamic segments
if is_static { is_static = false;
match Rt::from_str(&full_path) { break;
Ok(route) => {
self.render_route(route, &mut std::io::sink(), |_| {})?;
}
Err(e) => {
log::error!("Error pre-caching static route: {}", e);
}
} }
} }
} }
Ok(()) if is_static {
match Rt::from_str(&full_path) {
Ok(route) => {
render_route(renderer, route, &mut tokio::io::sink(), |_| {}).await?;
}
Err(e) => {
log::error!("Error pre-caching static route: {}", e);
}
}
}
} }
fn render_route<Rt, W, F: FnOnce(&mut VirtualDom)>( Ok(())
&mut self, }
route: Rt,
writer: &mut W, /// Render a route to a writer.
modify_vdom: F, pub async fn render_route<R: RenderHTML + Send, Rt, W, F: FnOnce(&mut VirtualDom)>(
) -> Result<(), IncrementalRendererError> renderer: &mut IncrementalRenderer<R>,
route: Rt,
writer: &mut W,
modify_vdom: F,
) -> Result<RenderFreshness, IncrementalRendererError>
where
Rt: Routable,
<Rt as FromStr>::Err: std::fmt::Display,
W: tokio::io::AsyncWrite + Unpin + Send,
{
#[inline_props]
fn RenderPath<R>(cx: Scope, path: R) -> Element
where where
Rt: Routable, R: Routable,
<Rt as FromStr>::Err: std::fmt::Display, <R as FromStr>::Err: std::fmt::Display,
W: std::io::Write,
{ {
#[inline_props] let path = path.clone();
fn RenderPath<R>(cx: Scope, path: R) -> Element render! {
where GenericRouter::<R> {
R: Routable, config: || RouterConfig::default().history(MemoryHistory::with_initial_path(path))
<R as FromStr>::Err: std::fmt::Display,
{
let path = path.clone();
render! {
GenericRouter::<R> {
config: || RouterConfig::default().history(MemoryHistory::with_initial_path(path))
}
} }
} }
}
self.render( renderer
.render(
route.to_string(), route.to_string(),
RenderPath, RenderPath,
RenderPathProps { path: route }, RenderPathProps { path: route },
writer, writer,
modify_vdom, modify_vdom,
) )
} .await
} }
+2
View File
@@ -19,6 +19,8 @@ thiserror = "1.0.23"
rustc-hash = "1.1.0" rustc-hash = "1.1.0"
lru = "0.10.0" lru = "0.10.0"
log = "0.4.13" log = "0.4.13"
http = "0.2.9"
tokio = { version = "1.28", features = ["full"] }
[dev-dependencies] [dev-dependencies]
dioxus = { path = "../dioxus", version = "0.3.0" } dioxus = { path = "../dioxus", version = "0.3.0" }
+137 -52
View File
@@ -8,9 +8,11 @@ use std::{
hash::BuildHasherDefault, hash::BuildHasherDefault,
io::Write, io::Write,
num::NonZeroUsize, num::NonZeroUsize,
ops::{Deref, DerefMut},
path::{Path, PathBuf}, path::{Path, PathBuf},
time::{Duration, SystemTime}, time::{Duration, SystemTime},
}; };
use tokio::io::{AsyncWrite, AsyncWriteExt, BufReader};
/// Something that can render a HTML page from a body. /// Something that can render a HTML page from a body.
pub trait RenderHTML { pub trait RenderHTML {
@@ -127,7 +129,7 @@ pub struct IncrementalRenderer<R: RenderHTML> {
render: R, render: R,
} }
impl<R: RenderHTML> IncrementalRenderer<R> { impl<R: RenderHTML + std::marker::Send> IncrementalRenderer<R> {
/// Get the inner renderer. /// Get the inner renderer.
pub fn renderer(&self) -> &crate::Renderer { pub fn renderer(&self) -> &crate::Renderer {
&self.ssr_renderer &self.ssr_renderer
@@ -166,34 +168,43 @@ impl<R: RenderHTML> IncrementalRenderer<R> {
self.invalidate_after.is_some() self.invalidate_after.is_some()
} }
fn render_and_cache<P: 'static>( fn render_and_cache<'a, P: 'static>(
&mut self, &'a mut self,
route: String, route: String,
comp: fn(Scope<P>) -> Element, comp: fn(Scope<P>) -> Element,
props: P, props: P,
output: &mut impl Write, output: &'a mut (impl AsyncWrite + Unpin + Send),
modify_vdom: impl FnOnce(&mut VirtualDom), modify_vdom: impl FnOnce(&mut VirtualDom),
) -> Result<(), IncrementalRendererError> { ) -> impl std::future::Future<Output = Result<RenderFreshness, IncrementalRendererError>> + 'a + Send
let mut vdom = VirtualDom::new_with_props(comp, props); {
modify_vdom(&mut vdom);
let _ = vdom.rebuild();
let mut html_buffer = WriteBuffer { buffer: Vec::new() }; let mut html_buffer = WriteBuffer { buffer: Vec::new() };
self.render.render_before_body(&mut html_buffer)?; let result_1;
self.ssr_renderer.render_to(&mut html_buffer, &vdom)?; let result2;
self.render.render_after_body(&mut html_buffer)?; {
let html_buffer = html_buffer.buffer; let mut vdom = VirtualDom::new_with_props(comp, props);
modify_vdom(&mut vdom);
let _ = vdom.rebuild();
output.write_all(&html_buffer)?; result_1 = self.render.render_before_body(&mut *html_buffer);
result2 = self.ssr_renderer.render_to(&mut html_buffer, &vdom);
}
async move {
result_1?;
result2?;
self.render.render_after_body(&mut *html_buffer)?;
let html_buffer = html_buffer.buffer;
self.add_to_cache(route, html_buffer) output.write_all(&*html_buffer).await?;
self.add_to_cache(route, html_buffer)
}
} }
fn add_to_cache( fn add_to_cache(
&mut self, &mut self,
route: String, route: String,
html: Vec<u8>, html: Vec<u8>,
) -> Result<(), IncrementalRendererError> { ) -> Result<RenderFreshness, IncrementalRendererError> {
let file_path = self.route_as_path(&route); let file_path = self.route_as_path(&route);
if let Some(parent) = file_path.parent() { if let Some(parent) = file_path.parent() {
if !parent.exists() { if !parent.exists() {
@@ -204,7 +215,7 @@ impl<R: RenderHTML> IncrementalRenderer<R> {
let mut file = std::io::BufWriter::new(file); let mut file = std::io::BufWriter::new(file);
file.write_all(&html)?; file.write_all(&html)?;
self.add_to_memory_cache(route, html); self.add_to_memory_cache(route, html);
Ok(()) Ok(RenderFreshness::now(self.invalidate_after))
} }
fn add_to_memory_cache(&mut self, route: String, html: Vec<u8>) { fn add_to_memory_cache(&mut self, route: String, html: Vec<u8>) {
@@ -219,73 +230,83 @@ impl<R: RenderHTML> IncrementalRenderer<R> {
} }
} }
fn search_cache( async fn search_cache(
&mut self, &mut self,
route: String, route: String,
output: &mut impl Write, output: &mut (impl AsyncWrite + Unpin + std::marker::Send),
) -> Result<bool, IncrementalRendererError> { ) -> Result<Option<RenderFreshness>, IncrementalRendererError> {
// check the memory cache
if let Some((timestamp, cache_hit)) = self if let Some((timestamp, cache_hit)) = self
.memory_cache .memory_cache
.as_mut() .as_mut()
.and_then(|cache| cache.get(&route)) .and_then(|cache| cache.get(&route))
{ {
if let (Ok(elapsed), Some(invalidate_after)) = if let Ok(elapsed) = timestamp.elapsed() {
(timestamp.elapsed(), self.invalidate_after) let age = elapsed.as_secs();
{ if let Some(invalidate_after) = self.invalidate_after {
if elapsed < invalidate_after { if elapsed < invalidate_after {
log::trace!("memory cache hit {:?}", route);
output.write_all(cache_hit).await?;
let max_age = invalidate_after.as_secs();
return Ok(Some(RenderFreshness::new(age, max_age)));
}
} else {
log::trace!("memory cache hit {:?}", route); log::trace!("memory cache hit {:?}", route);
output.write_all(cache_hit)?; output.write_all(cache_hit).await?;
return Ok(true); return Ok(Some(RenderFreshness::new_age(age)));
} }
} else {
log::trace!("memory cache hit {:?}", route);
output.write_all(cache_hit)?;
return Ok(true);
} }
} }
// check the file cache
if let Some(file_path) = self.find_file(&route) { if let Some(file_path) = self.find_file(&route) {
if let Ok(file) = std::fs::File::open(file_path.full_path) { if let Some(freshness) = file_path.freshness(self.invalidate_after) {
let mut file = std::io::BufReader::new(file); if let Ok(file) = tokio::fs::File::open(file_path.full_path).await {
std::io::copy(&mut file, output)?; let mut file = BufReader::new(file);
log::trace!("file cache hit {:?}", route); tokio::io::copy_buf(&mut file, output).await?;
self.promote_memory_cache(&route); log::trace!("file cache hit {:?}", route);
return Ok(true); self.promote_memory_cache(&route);
return Ok(Some(freshness));
}
} }
} }
Ok(false) Ok(None)
} }
/// Render a route or get it from cache. /// Render a route or get it from cache.
pub fn render<P: 'static>( pub async fn render<P: 'static>(
&mut self, &mut self,
route: String, route: String,
component: fn(Scope<P>) -> Element, component: fn(Scope<P>) -> Element,
props: P, props: P,
output: &mut impl Write, output: &mut (impl AsyncWrite + Unpin + std::marker::Send),
modify_vdom: impl FnOnce(&mut VirtualDom), modify_vdom: impl FnOnce(&mut VirtualDom),
) -> Result<(), IncrementalRendererError> { ) -> Result<RenderFreshness, IncrementalRendererError> {
// check if this route is cached // check if this route is cached
if !self.search_cache(route.to_string(), output)? { if let Some(freshness) = self.search_cache(route.to_string(), output).await? {
Ok(freshness)
} else {
// if not, create it // if not, create it
self.render_and_cache(route, component, props, output, modify_vdom)?; let freshness = self
.render_and_cache(route, component, props, output, modify_vdom)
.await?;
log::trace!("cache miss"); log::trace!("cache miss");
Ok(freshness)
} }
Ok(())
} }
/// Render a route or get it from cache to a string. /// Render a route or get it from cache to a string.
pub fn render_to_string<P: 'static>( pub async fn render_to_string<P: 'static>(
&mut self, &mut self,
route: String, route: String,
component: fn(Scope<P>) -> Element, component: fn(Scope<P>) -> Element,
props: P, props: P,
output: &mut String, output: &mut String,
modify_vdom: impl FnOnce(&mut VirtualDom), modify_vdom: impl FnOnce(&mut VirtualDom),
) -> Result<(), IncrementalRendererError> { ) -> Result<RenderFreshness, IncrementalRendererError> {
unsafe { unsafe {
// SAFETY: The renderer will only write utf8 to the buffer // SAFETY: The renderer will only write utf8 to the buffer
self.render(route, component, props, output.as_mut_vec(), modify_vdom) self.render(route, component, props, output.as_mut_vec(), modify_vdom)
.await
} }
} }
@@ -344,6 +365,60 @@ impl<R: RenderHTML> IncrementalRenderer<R> {
} }
} }
/// Information about the freshness of a rendered response
#[derive(Debug, Clone, Copy)]
pub struct RenderFreshness {
/// The age of the rendered response
age: u64,
/// The maximum age of the rendered response
max_age: Option<u64>,
}
impl RenderFreshness {
/// Create new freshness information
pub fn new(age: u64, max_age: u64) -> Self {
Self {
age,
max_age: Some(max_age),
}
}
/// Create new freshness information with only the age
pub fn new_age(age: u64) -> Self {
Self { age, max_age: None }
}
/// Create new freshness information at the current time
pub fn now(max_age: Option<Duration>) -> Self {
Self {
age: 0,
max_age: max_age.map(|d| d.as_secs()),
}
}
/// Get the age of the rendered response in seconds
pub fn age(&self) -> u64 {
self.age
}
/// Get the maximum age of the rendered response in seconds
pub fn max_age(&self) -> Option<u64> {
self.max_age
}
/// Write the freshness to the response headers.
pub fn write(&self, headers: &mut http::HeaderMap<http::HeaderValue>) {
let age = self.age();
headers.insert(http::header::AGE, age.into());
if let Some(max_age) = self.max_age() {
headers.insert(
http::header::CACHE_CONTROL,
http::HeaderValue::from_str(&format!("max-age={}", max_age)).unwrap(),
);
}
}
}
struct WriteBuffer { struct WriteBuffer {
buffer: Vec<u8>, buffer: Vec<u8>,
} }
@@ -355,13 +430,17 @@ impl std::fmt::Write for WriteBuffer {
} }
} }
impl Write for WriteBuffer { impl Deref for WriteBuffer {
fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> { type Target = Vec<u8>;
self.buffer.write(buf)
}
fn flush(&mut self) -> std::io::Result<()> { fn deref(&self) -> &Self::Target {
self.buffer.flush() &self.buffer
}
}
impl DerefMut for WriteBuffer {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.buffer
} }
} }
@@ -382,6 +461,12 @@ impl ValidCachedPath {
timestamp, timestamp,
}) })
} }
fn freshness(&self, max_age: Option<std::time::Duration>) -> Option<RenderFreshness> {
let age = self.timestamp.elapsed().ok()?.as_secs();
let max_age = max_age.map(|max_age| max_age.as_secs());
Some(RenderFreshness::new(age, max_age?))
}
} }
fn decode_timestamp(timestamp: &str) -> Option<std::time::SystemTime> { fn decode_timestamp(timestamp: &str) -> Option<std::time::SystemTime> {