Files
dioxus/packages/interpreter/src/write_native_mutations.rs
T
Evan AlmloffandJonathan Kelley 022e4ad203 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>
2024-07-01 20:50:36 -07:00

202 lines
6.9 KiB
Rust

use crate::unified_bindings::Interpreter as Channel;
use dioxus_core::{TemplateAttribute, TemplateNode, WriteMutations};
use dioxus_html::event_bubbles;
use sledgehammer_utils::rustc_hash::FxHashMap;
/// The state needed to apply mutations to a channel. This state should be kept across all mutations for the app
#[derive(Default)]
pub struct MutationState {
/// The maximum number of templates that we have registered
max_template_count: u16,
/// The currently registered templates with the template ids
templates: FxHashMap<String, u16>,
/// The channel that we are applying mutations to
channel: Channel,
}
impl MutationState {
pub fn new() -> Self {
Self::default()
}
pub fn export_memory(&mut self) -> Vec<u8> {
let bytes: Vec<_> = self.channel.export_memory().collect();
self.channel.reset();
bytes
}
pub fn write_memory_into(&mut self, buffer: &mut Vec<u8>) {
buffer.extend(self.channel.export_memory());
self.channel.reset();
}
pub fn channel(&mut self) -> &mut Channel {
&mut self.channel
}
pub fn channel_mut(&mut self) -> &mut Channel {
&mut self.channel
}
fn create_template_node(&mut self, node: &'static TemplateNode) {
use TemplateNode::*;
match node {
Element {
tag,
namespace,
attrs,
children,
..
} => {
// Push the current node onto the stack
match namespace {
Some(ns) => self.channel.create_element_ns(tag, ns),
None => self.channel.create_element(tag),
}
// Set attributes on the current node
for attr in *attrs {
if let TemplateAttribute::Static {
name,
value,
namespace,
} = attr
{
self.channel
.set_top_attribute(name, value, namespace.unwrap_or_default())
}
}
// Add each child to the stack
for child in *children {
self.create_template_node(child);
}
// Add all children to the parent
self.channel.append_children_to_top(children.len() as u16);
}
Text { text } => self.channel.create_raw_text(text),
Dynamic { .. } => self.channel.add_placeholder(),
}
}
}
impl WriteMutations for MutationState {
fn register_template(&mut self, template: dioxus_core::prelude::Template) {
let current_max_template_count = self.max_template_count;
for root in template.roots.iter() {
self.create_template_node(root);
self.templates
.insert(template.name.to_owned(), current_max_template_count);
}
self.channel
.add_templates(current_max_template_count, template.roots.len() as u16);
self.max_template_count += 1;
}
fn append_children(&mut self, id: dioxus_core::ElementId, m: usize) {
self.channel.append_children(id.0 as u32, m as u16);
}
fn assign_node_id(&mut self, path: &'static [u8], id: dioxus_core::ElementId) {
self.channel.assign_id_ref(path, id.0 as u32);
}
fn create_placeholder(&mut self, id: dioxus_core::ElementId) {
self.channel.create_placeholder(id.0 as u32);
}
fn create_text_node(&mut self, value: &str, id: dioxus_core::ElementId) {
self.channel.create_text_node(value, id.0 as u32);
}
fn hydrate_text_node(&mut self, path: &'static [u8], value: &str, id: dioxus_core::ElementId) {
self.channel.hydrate_text_ref(path, value, id.0 as u32);
}
fn load_template(&mut self, name: &'static str, index: usize, id: dioxus_core::ElementId) {
if let Some(tmpl_id) = self.templates.get(name) {
self.channel
.load_template(*tmpl_id, index as u16, id.0 as u32)
}
}
fn replace_node_with(&mut self, id: dioxus_core::ElementId, m: usize) {
self.channel.replace_with(id.0 as u32, m as u16);
}
fn replace_placeholder_with_nodes(&mut self, path: &'static [u8], m: usize) {
self.channel.replace_placeholder_ref(path, m as u16);
}
fn insert_nodes_after(&mut self, id: dioxus_core::ElementId, m: usize) {
self.channel.insert_after(id.0 as u32, m as u16);
}
fn insert_nodes_before(&mut self, id: dioxus_core::ElementId, m: usize) {
self.channel.insert_before(id.0 as u32, m as u16);
}
fn set_attribute(
&mut self,
name: &'static str,
ns: Option<&'static str>,
value: &dioxus_core::AttributeValue,
id: dioxus_core::ElementId,
) {
match value {
dioxus_core::AttributeValue::Text(txt) => {
self.channel
.set_attribute(id.0 as u32, name, txt, ns.unwrap_or_default())
}
dioxus_core::AttributeValue::Float(f) => self.channel.set_attribute(
id.0 as u32,
name,
&f.to_string(),
ns.unwrap_or_default(),
),
dioxus_core::AttributeValue::Int(n) => self.channel.set_attribute(
id.0 as u32,
name,
&n.to_string(),
ns.unwrap_or_default(),
),
dioxus_core::AttributeValue::Bool(b) => self.channel.set_attribute(
id.0 as u32,
name,
if *b { "true" } else { "false" },
ns.unwrap_or_default(),
),
dioxus_core::AttributeValue::None => {
self.channel
.remove_attribute(id.0 as u32, name, ns.unwrap_or_default())
}
_ => unreachable!("Any attributes are not supported by the current renderer"),
}
}
fn set_node_text(&mut self, value: &str, id: dioxus_core::ElementId) {
self.channel.set_text(id.0 as u32, value);
}
fn create_event_listener(&mut self, name: &'static str, id: dioxus_core::ElementId) {
// note that we use the foreign event listener here instead of the native one
// the native method assumes we have direct access to the dom, which we don't.
self.channel
.foreign_event_listener(name, id.0 as u32, event_bubbles(name) as u8);
}
fn remove_event_listener(&mut self, name: &'static str, id: dioxus_core::ElementId) {
self.channel
.remove_event_listener(name, id.0 as u32, event_bubbles(name) as u8);
}
fn remove_node(&mut self, id: dioxus_core::ElementId) {
self.channel.remove(id.0 as u32);
}
fn push_root(&mut self, id: dioxus_core::ElementId) {
self.channel.push_root(id.0 as _);
}
}