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/ssr/src/renderer.rs

@@ -2,31 +2,25 @@ use super::cache::Segment;
 use crate::cache::StringCache;
 
 use dioxus_core::{prelude::*, AttributeValue, DynamicNode};
-use std::collections::HashMap;
+use rustc_hash::FxHashMap;
 use std::fmt::Write;
 use std::sync::Arc;
 
+type ComponentRenderCallback = Arc<
+    dyn Fn(&mut Renderer, &mut dyn Write, &VirtualDom, ScopeId) -> std::fmt::Result + Send + Sync,
+>;
+
 /// A virtualdom renderer that caches the templates it has seen for faster rendering
 #[derive(Default)]
 pub struct Renderer {
-    /// should we do our best to prettify the output?
-    pub pretty: bool,
-
-    /// Control if elements are written onto a new line
-    pub newline: bool,
-
-    /// Should we sanitize text nodes? (escape HTML)
-    pub sanitize: bool,
-
     /// Choose to write ElementIDs into elements so the page can be re-hydrated later on
     pub pre_render: bool,
 
-    // Currently not implemented
-    // Don't proceed onto new components. Instead, put the name of the component.
-    pub skip_components: bool,
+    /// A callback used to render components. You can set this callback to control what components are rendered and add wrappers around components that are not present in CSR
+    render_components: Option<ComponentRenderCallback>,
 
     /// A cache of templates that have been rendered
-    template_cache: HashMap<&'static str, Arc<StringCache>>,
+    template_cache: FxHashMap<usize, Arc<StringCache>>,
 
     /// The current dynamic node id for hydration
     dynamic_node_id: usize,
@@ -37,42 +31,64 @@ impl Renderer {
         Self::default()
     }
 
+    /// Set the callback that the renderer uses to render components
+    pub fn set_render_components(
+        &mut self,
+        callback: impl Fn(&mut Renderer, &mut dyn Write, &VirtualDom, ScopeId) -> std::fmt::Result
+            + Send
+            + Sync
+            + 'static,
+    ) {
+        self.render_components = Some(Arc::new(callback));
+    }
+
+    /// Reset the callback that the renderer uses to render components
+    pub fn reset_render_components(&mut self) {
+        self.render_components = None;
+    }
+
     pub fn render(&mut self, dom: &VirtualDom) -> String {
         let mut buf = String::new();
         self.render_to(&mut buf, dom).unwrap();
         buf
     }
 
-    pub fn render_to(&mut self, buf: &mut impl Write, dom: &VirtualDom) -> std::fmt::Result {
+    pub fn render_to<W: Write + ?Sized>(
+        &mut self,
+        buf: &mut W,
+        dom: &VirtualDom,
+    ) -> std::fmt::Result {
+        self.reset_hydration();
         self.render_scope(buf, dom, ScopeId::ROOT)
     }
 
-    pub fn render_scope(
+    /// Reset the renderer hydration state
+    pub fn reset_hydration(&mut self) {
+        self.dynamic_node_id = 0;
+    }
+
+    pub fn render_scope<W: Write + ?Sized>(
         &mut self,
-        buf: &mut impl Write,
+        buf: &mut W,
         dom: &VirtualDom,
         scope: ScopeId,
     ) -> std::fmt::Result {
         let node = dom.get_scope(scope).unwrap().root_node();
-        self.dynamic_node_id = 0;
         self.render_template(buf, dom, node)?;
 
         Ok(())
     }
 
-    fn render_template(
+    fn render_template<W: Write + ?Sized>(
         &mut self,
-        buf: &mut impl Write,
+        mut buf: &mut W,
         dom: &VirtualDom,
         template: &VNode,
     ) -> std::fmt::Result {
         let entry = self
             .template_cache
-            .entry(template.template.get().name)
-            .or_insert_with({
-                let prerender = self.pre_render;
-                move || Arc::new(StringCache::from_template(template, prerender).unwrap())
-            })
+            .entry(template.template.get().id())
+            .or_insert_with(move || Arc::new(StringCache::from_template(template).unwrap()))
             .clone();
 
         let mut inner_html = None;
@@ -83,8 +99,19 @@ impl Renderer {
         // We need to keep track of the listeners so we can insert them into the right place
         let mut accumulated_listeners = Vec::new();
 
-        for segment in entry.segments.iter() {
+        // We keep track of the index we are on manually so that we can jump forward to a new section quickly without iterating every item
+        let mut index = 0;
+
+        while let Some(segment) = entry.segments.get(index) {
             match segment {
+                Segment::HydrationOnlySection(jump_to) => {
+                    // If we are not prerendering, we don't need to write the content of the hydration only section
+                    // Instead we can jump to the next section
+                    if !self.pre_render {
+                        index = *jump_to;
+                        continue;
+                    }
+                }
                 Segment::Attr(idx) => {
                     let attrs = &*template.dynamic_attrs[*idx];
                     for attr in attrs {
@@ -112,8 +139,10 @@ impl Renderer {
                 }
                 Segment::Node(idx) => match &template.dynamic_nodes[*idx] {
                     DynamicNode::Component(node) => {
-                        if self.skip_components {
-                            write!(buf, "<{}><{}/>", node.name, node.name)?;
+                        if let Some(render_components) = self.render_components.clone() {
+                            let scope_id = node.mounted_scope_id(*idx, template, dom).unwrap();
+
+                            render_components(self, &mut buf, dom, scope_id)?;
                         } else {
                             let scope = node.mounted_scope(*idx, template, dom).unwrap();
                             let node = scope.root_node();
@@ -147,7 +176,7 @@ impl Renderer {
                         if self.pre_render {
                             write!(
                                 buf,
-                                "<pre data-node-hydration={}></pre>",
+                                "<pre data-node-hydration={} hidden></pre>",
                                 self.dynamic_node_id
                             )?;
                             self.dynamic_node_id += 1;
@@ -206,6 +235,8 @@ impl Renderer {
                     self.dynamic_node_id += 1
                 }
             }
+
+            index += 1;
         }
 
         Ok(())
@@ -243,25 +274,30 @@ fn to_string_works() {
     let out = renderer.render(&dom);
 
     for item in renderer.template_cache.iter() {
-        if item.1.segments.len() > 5 {
+        if item.1.segments.len() > 10 {
             assert_eq!(
                 item.1.segments,
                 vec![
-                    PreRendered("<div class=\"asdasdasd asdasdasd\"".into(),),
-                    Attr(0,),
+                    PreRendered("<div class=\"asdasdasd asdasdasd\"".to_string()),
+                    Attr(0),
                     StyleMarker {
-                        inside_style_tag: false,
+                        inside_style_tag: false
                     },
-                    PreRendered(">".into()),
+                    HydrationOnlySection(7), // jump to `>` if we don't need to hydrate
+                    PreRendered(" data-node-hydration=\"".to_string()),
+                    AttributeNodeMarker,
+                    PreRendered("\"".to_string()),
+                    PreRendered(">".to_string()),
                     InnerHtmlMarker,
-                    PreRendered("Hello world 1 --&gt;".into(),),
-                    Node(0,),
+                    PreRendered("Hello world 1 --&gt;".to_string()),
+                    Node(0),
                     PreRendered(
-                        "&lt;-- Hello world 2<div>nest 1</div><div></div><div>nest 2</div>".into(),
+                        "&lt;-- Hello world 2<div>nest 1</div><div></div><div>nest 2</div>"
+                            .to_string()
                     ),
-                    Node(1,),
-                    Node(2,),
-                    PreRendered("</div>".into(),),
+                    Node(1),
+                    Node(2),
+                    PreRendered("</div>".to_string())
                 ]
             );
         }
@@ -297,14 +333,14 @@ fn empty_for_loop_works() {
             assert_eq!(
                 item.1.segments,
                 vec![
-                    PreRendered("<div class=\"asdasdasd\"".into(),),
-                    Attr(0,),
-                    StyleMarker {
-                        inside_style_tag: false,
-                    },
-                    PreRendered(">".into()),
-                    InnerHtmlMarker,
-                    PreRendered("</div>".into(),),
+                    PreRendered("<div class=\"asdasdasd\"".to_string()),
+                    HydrationOnlySection(5), // jump to `>` if we don't need to hydrate
+                    PreRendered(" data-node-hydration=\"".to_string()),
+                    RootNodeMarker,
+                    PreRendered("\"".to_string()),
+                    PreRendered(">".to_string()),
+                    Node(0),
+                    PreRendered("</div>".to_string())
                 ]
             );
         }
@@ -381,7 +417,10 @@ pub(crate) fn truthy(value: &AttributeValue) -> bool {
     }
 }
 
-pub(crate) fn write_attribute(buf: &mut impl Write, attr: &Attribute) -> std::fmt::Result {
+pub(crate) fn write_attribute<W: Write + ?Sized>(
+    buf: &mut W,
+    attr: &Attribute,
+) -> std::fmt::Result {
     let name = &attr.name;
     match &attr.value {
         AttributeValue::Text(value) => write!(buf, " {name}=\"{value}\""),
@@ -392,8 +431,8 @@ pub(crate) fn write_attribute(buf: &mut impl Write, attr: &Attribute) -> std::fm
     }
 }
 
-pub(crate) fn write_value_unquoted(
-    buf: &mut impl Write,
+pub(crate) fn write_value_unquoted<W: Write + ?Sized>(
+    buf: &mut W,
     value: &AttributeValue,
 ) -> std::fmt::Result {
     match value {