Suspense boundaries/out of order streaming/anyhow like error handling (#2365)

* create static site generation helpers in the router crate

* work on integrating static site generation into fullstack

* move ssg into a separate crate

* integrate ssg with the launch builder

* simplify ssg example

* fix static_routes for child routes

* move CLI hot reloading websocket code into dioxus-hot-reload

* fix some unused imports

* use the same hot reloading websocket code for fullstack

* fix fullstack hot reloading

* move cli hot reloading logic into the hot reload crate

* ssg example working with dx serve

* add more examples

* fix clippy

* switch to a result for Element

* fix formatting

* fix hot reload doctest imports

* fix axum imports

* add show method to error context

* implement retaining nodes during suspense

* fix unterminated if statements

* communicate between tasks and suspense boundaries

* make suspense placeholders easier to use

* implement IntoDynNode and IntoVNode for more wrappers

* fix clippy examples

* fix rsx tests

* add streaming html utilities to the ssr package

* unify hydration and non-hydration ssr cache

* fix router with Result Element

* don't run server doc tests

* Fix hot reload websocket doc examples

* simple apps working with fullstack streaming

* fix preloading wasm

* Report errors encountered while streaming

* remove async from incremental renderer

* document new VirtualDom suspense methods

* make streaming work with incremental rendering

* fix static site generation

* document suspense structs

* create closure type; allow async event handlers in props; allow shorthand event handlers

* test forwarding event handlers with the shorthand syntax

* fix clippy

* fix imports in spawn async doctest

* fix empty rsx

* fix async result event handlers

* fix mounting router in multiple places

* Fix task dead cancel race condition

* simplify diffing before adding suspense

* fix binary size increase

* fix attribute diffing

* more diffing fixes

* create minimal fullstack feature

* smaller fullstack bundles

* allow mounting nodes that are already created and creating nodes without mounting them

* fix hot reload feature

* fix replacing components

* don't reclaim virtual nodes

* client side suspense working!

* fix CLI

* slightly smaller fullstack builds

* fix multiple suspended scopes

* fix merge errors

* yield back to tokio every few polls to fix suspending on many tasks at once

* remove logs

* document suspense boundary and update suspense example

* fix ssg

* make streaming optional

* fix some router and core tests

* fix suspense example

* fix serialization with out of order server futures

* add incremental streaming hackernews demo

* fix hackernews demo

* fix root hackernews redirect

* fix formatting

* add tests for suspense cases

* slightly smaller binaries

* slightly smaller

* improve error handling docs

* fix errors example link

* fix doc tests

* remove log file

* fix ssr cache type inference

* remove index.html

* fix ssg render template

* fix assigning ids on elements with dynamic attributes

* add desktop feature to the workspace examples

* remove router static generation example; ssg lives in the dioxus-static-generation package

* add a test for effects during suspense

* only run effects on mounted nodes

* fix multiple suspense roots

* fix node iterator

* fix closures without arguments

* fix dioxus-core readme doctest

* remove suspense logs

* fix scope stack

* fix clippy

* remove unused suspense boundary from hackernews

* assert that launch never returns for better compiler errors

* fix static generation launch function

* fix web renderer

* pass context providers into server functions

* add an example for FromContext

* clean up DioxusRouterExt

* fix server function context

* fix fullstack desktop example

* forward CLI serve settings to fullstack

* re-export serve config at the root of fullstack

* forward env directly instead of using a guard

* just set the port in the CLI for fullstack playwright tests

* fix fullstack dioxus-cli-config feature

* fix launch server merge conflicts

* fix fullstack launch context

* Merge branch 'main' into suspense-2.0

* fix fullstack html data

* remove drop virtual dom feature

* add a comment about only_write_templates binary size workaround

* remove explicit dependencies from use_server_future

* make ErrorContext and SuspenseContext more similar

* Tweak: small tweaks to tomls to make diff smaller

* only rerun components under suspense after the initial placeholders are sent to the client

* add module docs for suspense

* keep track of when suspense boundaries are resolved

* start implementing JS out of order streaming

* fix core tests

* implement the server side of suspense with js

* fix streaming ssr with nested suspense

* move streaming ssr code into fullstack

* revert minification changes

* serialize server future data as the html streams

* start loading scripts wasm immediately instead of defering the script

* very basic nested suspense example working with minimal html updates

* clean up some suspense/error docs

* fix hydrating nested pending server futures

* sort resolved boundaries by height

* Fix disconnecting clients while streaming

* fix static generation crate

* don't insert extra divs when hydrating streamed chunks

* wait to swap in the elements until they are hydrated

* remove inline streaming script

* hackernews partially working

* fix spa mode

* banish the open shadow dom

* fix removing placeholder

* set up streaming playwright test

* run web playwright tests on 9999 to avoid port conflicts with other local servers

* remove suspense nodes if the suspense boundary is replaced before the suspense resolves on the server

* ignore hydration of removed suspense boundaries

* use path based indexing to fix hydrating suspense after parent suspense with child is removed

* re-export dioxus error

* remove resolved suspense divs if the suspense boundary has been removed

* Fix client side initialized server futures

* ignore comment nodes while traversing nodes in core to avoid lists getting swapped out with suspense

* Pass initial hydration data to the client

* hide pre nodes

* don't panic if reclaiming an element fails

* fix scope stack when polling tasks

* improve deserialization out of length message

* Ok(VNode::placeholder()) -> VNode::empty()

* fix typo in rsx usage

* restore testing changes from suspense example

* clean up some logs and comments

* fix playwright tests

* clean up more changes in core

* clean up core tests

* remove anymap dependency

* clean up changes to hooks

* clean up changes in the router, rsx, and web

* revert changes to axum-hello-world

* fix use_server_future

* fix clippy in dioxus-core

* check that the next or previous node exist before checking if we should ignore them

* fix formatting

* fix suspense playwright test

* remove unused suspense code

* add more suspense playwright tests

* add more docs for error boundaries

* fix suspense core tests

* fix ErrorBoundary example

* remove a bunch of debug logging in js

* fix router failure_external_navigation

* use absolute paths in the interpreter build.rs

* strip '\r' while hashing ts files

* add a wrapper with a default error boundary and suspense boundary

* restore hot reloading

* ignore non-ts files when hashing

* sort ts files before hashing them

* fix rsx tests

* fix fullstack doc tests

* fix core tests

* fix axum auth example

* update suspense hydration diagram

* longer playwright build limit

* tiny fixes - spelling, formatting

* update diagram link

* remove comment and template nodes for suspense placeholders

* remove comment nodes as we hydrate text

* simplify hackernews example

* clean up hydrating text nodes

* switch to a separate environment variable for the base path for smaller binaries

* clean up file system html trait

* fix form data

* move streaming code into fullstack

* implement serialize and deserialize for CapturedError

* remove waits in the nested suspense playwright spec

* force sequential fullstack builds for CI

* longer nested suspense delay for CI

* fix --force-sequential flag

* wait to launch server until client build is done

---------

Co-authored-by: Jonathan Kelley <jkelleyrtp@gmail.com>

packages/static-generation/src/config.rs

@@ -158,10 +158,7 @@ impl Config {
 
 #[cfg(feature = "server")]
 impl Config {
-    pub(crate) fn fullstack_template(
-        &self,
-        server_context: &dioxus_fullstack::prelude::DioxusServerContext,
-    ) -> impl dioxus_ssr::incremental::WrapBody {
+    pub(crate) fn fullstack_template(&self) -> dioxus_fullstack::prelude::FullstackHTMLTemplate {
         use dioxus_fullstack::prelude::{FullstackHTMLTemplate, ServeConfig};
         let mut cfg_builder = ServeConfig::builder();
         if let Some(index_html) = &self.index_html {
@@ -175,16 +172,21 @@ impl Config {
         }
         let cfg = cfg_builder.build();
 
-        FullstackHTMLTemplate::new(&cfg, server_context)
+        FullstackHTMLTemplate::new(&cfg)
     }
 
-    pub(crate) fn create_renderer(&mut self) -> dioxus_ssr::incremental::IncrementalRenderer {
+    pub(crate) fn create_cache(&mut self) -> dioxus_ssr::incremental::IncrementalRenderer {
         let mut builder = dioxus_ssr::incremental::IncrementalRenderer::builder()
-            .static_dir(self.output_dir.clone())
-            .pre_render(true);
+            .static_dir(self.output_dir.clone());
         if let Some(map_path) = self.map_path.take() {
             builder = builder.map_path(map_path);
         }
         builder.build()
     }
+
+    pub(crate) fn create_renderer(&mut self) -> dioxus_ssr::Renderer {
+        let mut renderer = dioxus_ssr::Renderer::new();
+        renderer.pre_render = true;
+        renderer
+    }
 }

packages/static-generation/src/ssg.rs

@@ -1,5 +1,7 @@
 use dioxus_lib::prelude::*;
 use dioxus_router::prelude::*;
+use dioxus_ssr::incremental::*;
+use dioxus_ssr::renderer;
 use std::collections::HashSet;
 use std::fs;
 use std::path::Path;
@@ -8,11 +10,10 @@ use crate::Config;
 
 fn server_context_for_route(route: &str) -> dioxus_fullstack::prelude::DioxusServerContext {
     use dioxus_fullstack::prelude::*;
-    use std::sync::Arc;
     let request = http::Request::builder().uri(route).body(()).unwrap();
     let (parts, _) = request.into_parts();
 
-    DioxusServerContext::new(Arc::new(tokio::sync::RwLock::new(parts)))
+    DioxusServerContext::new(parts)
 }
 
 /// Try to extract the site map by finding the root router that a component renders.
@@ -37,6 +38,7 @@ pub async fn generate_static_site(
     std::fs::create_dir_all(&config.output_dir)?;
 
     let mut renderer = config.create_renderer();
+    let mut cache = config.create_cache();
 
     let mut routes_to_render: HashSet<String> = config.additional_routes.iter().cloned().collect();
     if let Some(site_map) = block_in_place(|| extract_site_map(app)) {
@@ -59,7 +61,7 @@ pub async fn generate_static_site(
     }
 
     for url in routes_to_render {
-        prerender_route(app, url, &mut renderer, &config).await?;
+        prerender_route(app, url, &mut renderer, &mut cache, &config).await?;
     }
 
     // Copy over the web output dir into the static output dir
@@ -100,30 +102,30 @@ fn copy_static_files(src: &Path, dst: &Path) -> Result<(), std::io::Error> {
 async fn prerender_route(
     app: fn() -> Element,
     route: String,
-    renderer: &mut dioxus_ssr::incremental::IncrementalRenderer,
+    renderer: &mut renderer::Renderer,
+    cache: &mut dioxus_ssr::incremental::IncrementalRenderer,
     config: &Config,
-) -> Result<(), dioxus_ssr::incremental::IncrementalRendererError> {
+) -> Result<RenderFreshness, dioxus_ssr::incremental::IncrementalRendererError> {
     use dioxus_fullstack::prelude::*;
 
     let context = server_context_for_route(&route);
-    let wrapper = config.fullstack_template(&context);
-    renderer
-        .render(
-            route,
-            || VirtualDom::new(app),
-            &mut tokio::io::sink(),
-            |vdom| {
-                Box::pin(async move {
-                    with_server_context(context.clone(), || {
-                        tokio::task::block_in_place(|| vdom.rebuild_in_place());
-                    });
-                    ProvideServerContext::new(vdom.wait_for_suspense(), context).await;
-                })
-            },
-            &wrapper,
-        )
-        .await?;
-    Ok(())
+    let wrapper = config.fullstack_template();
+    let mut virtual_dom = VirtualDom::new(app);
+    with_server_context(context.clone(), || {
+        tokio::task::block_in_place(|| virtual_dom.rebuild_in_place());
+    });
+    ProvideServerContext::new(virtual_dom.wait_for_suspense(), context).await;
+
+    let mut wrapped = String::new();
+
+    // Render everything before the body
+    wrapper.render_before_body(&mut wrapped)?;
+
+    renderer.render_to(&mut wrapped, &virtual_dom)?;
+
+    wrapper.render_after_body(&mut wrapped)?;
+
+    cache.cache(route, wrapped)
 }
 
 #[test]