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
1 parent ffa36a67c3
commit 022e4ad203
@@ -98,6 +98,10 @@ export class BaseInterpreter {
    return this.nodes[id];
  }

+  pushRoot(node: Node) {
+    this.stack.push(node);
+  }
+
  appendChildren(id: NodeId, many: number) {
    const root = this.nodes[id];
    const els = this.stack.splice(this.stack.length - many);
@@ -125,55 +129,93 @@ export class BaseInterpreter {
    this.templates[tmpl_id] = nodes;
  }

-  hydrate(ids: { [key: number]: number }) {
-    const hydrateNodes = document.querySelectorAll("[data-node-hydration]");
+  hydrate_node(hydrateNode: HTMLElement, ids: { [key: number]: number }) {
+    const hydration = hydrateNode.getAttribute("data-node-hydration");
+    const split = hydration!.split(",");
+    const id = ids[parseInt(split[0])];

-    for (let i = 0; i < hydrateNodes.length; i++) {
-      const hydrateNode = hydrateNodes[i] as HTMLElement;
-      const hydration = hydrateNode.getAttribute("data-node-hydration");
-      const split = hydration!.split(",");
-      const id = ids[parseInt(split[0])];
+    this.nodes[id] = hydrateNode;

-      this.nodes[id] = hydrateNode;
-
-      if (split.length > 1) {
-        // @ts-ignore
-        hydrateNode.listening = split.length - 1;
-        hydrateNode.setAttribute("data-dioxus-id", id.toString());
-        for (let j = 1; j < split.length; j++) {
-          const listener = split[j];
-          const split2 = listener.split(":");
-          const event_name = split2[0];
-          const bubbles = split2[1] === "1";
-          this.createListener(event_name, hydrateNode, bubbles);
-        }
+    if (split.length > 1) {
+      // @ts-ignore
+      hydrateNode.listening = split.length - 1;
+      hydrateNode.setAttribute("data-dioxus-id", id.toString());
+      for (let j = 1; j < split.length; j++) {
+        const listener = split[j];
+        const split2 = listener.split(":");
+        const event_name = split2[0];
+        const bubbles = split2[1] === "1";
+        this.createListener(event_name, hydrateNode, bubbles);
      }
    }
+  }

-    const treeWalker = document.createTreeWalker(
-      document.body,
-      NodeFilter.SHOW_COMMENT
-    );
+  hydrate(ids: { [key: number]: number }, underNodes: Node[]) {
+    for (let i = 0; i < underNodes.length; i++) {
+      const under = underNodes[i];
+      if (under instanceof HTMLElement) {
+        if (under.getAttribute("data-node-hydration")) {
+          this.hydrate_node(under, ids);
+        }
+        const hydrateNodes = under.querySelectorAll("[data-node-hydration]");

-    let currentNode = treeWalker.nextNode();
-
-    while (currentNode) {
-      const id = currentNode.textContent!;
-      const split = id.split("node-id");
-
-      if (split.length > 1) {
-        let next = currentNode.nextSibling;
-        // If we are hydrating an empty text node, we may see two comment nodes in a row instead of a comment node, text node and then comment node
-        if (next.nodeType === Node.COMMENT_NODE) {
-          next = next.parentElement.insertBefore(
-            document.createTextNode(""),
-            next
-          );
+        for (let i = 0; i < hydrateNodes.length; i++) {
+          this.hydrate_node(hydrateNodes[i] as HTMLElement, ids);
        }
-        this.nodes[ids[parseInt(split[1])]] = next;
      }

-      currentNode = treeWalker.nextNode();
+      const treeWalker = document.createTreeWalker(
+        under,
+        NodeFilter.SHOW_COMMENT
+      );
+
+      while (treeWalker.currentNode) {
+        const currentNode = treeWalker.currentNode as ChildNode;
+        if (currentNode.nodeType === Node.COMMENT_NODE) {
+          const id = currentNode.textContent!;
+          const split = id.split("node-id");
+
+          if (split.length > 1) {
+            // For most text nodes, this should be text
+            let next = currentNode.nextSibling;
+            // remove the comment node
+            currentNode.remove();
+
+            let commentAfterText;
+            let textNode;
+
+            // If we are hydrating an empty text node, we may see two comment nodes in a row instead of a comment node, text node and then comment node
+            if (next.nodeType === Node.COMMENT_NODE) {
+              const newText = next.parentElement.insertBefore(
+                document.createTextNode(""),
+                next
+              );
+              commentAfterText = next;
+              textNode = newText;
+            } else {
+              // The node after text should be a comment node marking the end of the text node
+              textNode = next;
+              commentAfterText = textNode.nextSibling;
+            }
+            treeWalker.currentNode = commentAfterText;
+            this.nodes[ids[parseInt(split[1])]] = textNode;
+            let exit = !treeWalker.nextNode();
+            // remove the comment node after the text node
+            commentAfterText.remove();
+            if (exit) {
+              break;
+            }
+          } else {
+            if (!treeWalker.nextNode()) {
+              break;
+            }
+          }
+        } else {
+          if (!treeWalker.nextNode()) {
+            break;
+          }
+        }
+      }
    }
  }

@@ -0,0 +1,11 @@
+import "./hydrate_types";
+
+export function register_rehydrate_chunk_for_streaming(
+  callback: (id: number[], data: Uint8Array) => void
+): void {
+  window.hydration_callback = callback;
+  for (let i = 0; i < window.hydrate_queue.length; i++) {
+    const [id, data] = window.hydrate_queue[i];
+    window.hydration_callback(id, data);
+  }
+}
@@ -0,0 +1,8 @@
+export {};
+
+declare global {
+  interface Window {
+    hydrate_queue: [number[], Uint8Array][];
+    hydration_callback: null | ((id: number[], data: Uint8Array) => void);
+  }
+}
@@ -0,0 +1,16 @@
+import "./hydrate_types";
+
+// Chunks may load before the wasm has loaded and the callback to hydrate the dom is registered. We queue up hydration ids and data until the wasm is ready
+window.hydrate_queue = [];
+
+// @ts-ignore
+window.dx_hydrate = (id: number[], data: string) => {
+  // First convert the base64 encoded string to a Uint8Array
+  const decoded = atob(data);
+  const bytes = Uint8Array.from(decoded, (c) => c.charCodeAt(0));
+  if (window.hydration_callback) {
+    window.hydration_callback(id, bytes);
+  } else {
+    window.hydrate_queue.push([id, bytes]);
+  }
+};