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
@@ -105,13 +105,16 @@ fn copy_dir_to(src_dir: PathBuf, dest_dir: PathBuf, pre_compress: bool) -> std::

                // Then pre-compress the file if needed
                if pre_compress {
-                    if let Err(err) = pre_compress_file(&entry_path.clone()) {
+                    if let Err(err) = pre_compress_file(&output_file_location) {
                        tracing::error!(
                            "Failed to pre-compress static assets {}: {}",
-                            entry_path.display(),
+                            output_file_location.display(),
                            err
                        );
                    }
+                    // If pre-compression isn't enabled, we should remove the old compressed file if it exists
+                } else if let Some(compressed_path) = compressed_path(&output_file_location) {
+                    _ = std::fs::remove_file(compressed_path);
                }
            }

@@ -124,12 +127,12 @@ fn copy_dir_to(src_dir: PathBuf, dest_dir: PathBuf, pre_compress: bool) -> std::
    Ok(())
 }

-/// pre-compress a file with brotli
-pub(crate) fn pre_compress_file(path: &Path) -> std::io::Result<()> {
+/// Get the path to the compressed version of a file
+fn compressed_path(path: &Path) -> Option<PathBuf> {
    let new_extension = match path.extension() {
        Some(ext) => {
            if ext.to_string_lossy().to_lowercase().ends_with("br") {
-                return Ok(());
+                return None;
            }
            let mut ext = ext.to_os_string();
            ext.push(".br");
@@ -137,22 +140,37 @@ pub(crate) fn pre_compress_file(path: &Path) -> std::io::Result<()> {
        }
        None => OsString::from("br"),
    };
+    Some(path.with_extension(new_extension))
+}
+
+/// pre-compress a file with brotli
+pub(crate) fn pre_compress_file(path: &Path) -> std::io::Result<()> {
+    let Some(compressed_path) = compressed_path(path) else {
+        return Ok(());
+    };
    let file = std::fs::File::open(path)?;
    let mut stream = std::io::BufReader::new(file);
-    let output = path.with_extension(new_extension);
-    let mut buffer = std::fs::File::create(output)?;
+    let mut buffer = std::fs::File::create(compressed_path)?;
    let params = BrotliEncoderParams::default();
    brotli::BrotliCompress(&mut stream, &mut buffer, &params)?;
    Ok(())
 }

 /// pre-compress all files in a folder
-pub(crate) fn pre_compress_folder(path: &Path) -> std::io::Result<()> {
+pub(crate) fn pre_compress_folder(path: &Path, pre_compress: bool) -> std::io::Result<()> {
    let walk_dir = WalkDir::new(path);
    for entry in walk_dir.into_iter().filter_map(|e| e.ok()) {
        let entry_path = entry.path();
        if entry_path.is_file() {
-            pre_compress_file(entry_path)?;
+            if pre_compress {
+                if let Err(err) = pre_compress_file(entry_path) {
+                    tracing::error!("Failed to pre-compress file {entry_path:?}: {err}");
+                }
+            }
+            // If pre-compression isn't enabled, we should remove the old compressed file if it exists
+            else if let Some(compressed_path) = compressed_path(entry_path) {
+                _ = std::fs::remove_file(compressed_path);
+            }
        }
    }
    Ok(())
@@ -1,22 +1,38 @@
 <!DOCTYPE html>
 <html>
-<head>
-  <title>{app_title}</title>
-  <meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
-  <meta name="viewport" content="width=device-width, initial-scale=1">
-  <meta charset="UTF-8" />
-  {style_include}
-</head>
-<body>
-  <div id="main"></div>
-  <script type="module">
-    import init from "/{base_path}/assets/dioxus/{app_name}.js";
-    init("/{base_path}/assets/dioxus/{app_name}_bg.wasm").then(wasm => {
-      if (wasm.__wbindgen_start == undefined) {
-        wasm.main();
-      }
-    });
-  </script>
-  {script_include}
-</body>
-</html>
+  <head>
+    <title>{app_title}</title>
+    <meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta charset="UTF-8" />
+    <link
+      rel="preload"
+      href="/{base_path}/assets/dioxus/{app_name}.js"
+      as="style"
+    />
+    <link
+      rel="preload"
+      href="/{base_path}/assets/dioxus/{app_name}_bg.wasm"
+      as="fetch"
+      type="application/wasm"
+      crossorigin=""
+    />
+    {style_include}
+  </head>
+  <body>
+    <div id="main"></div>
+    <script>
+      // We can't use a module script here because we need to start the script immediately when streaming
+      import("/{base_path}/assets/dioxus/{app_name}.js").then(
+        ({ default: init }) => {
+          init("/{base_path}/assets/dioxus/{app_name}_bg.wasm").then((wasm) => {
+            if (wasm.__wbindgen_start == undefined) {
+              wasm.main();
+            }
+          });
+        }
+      );
+    </script>
+    {script_include}
+  </body>
+</html>
@@ -230,9 +230,7 @@ pub fn build_web(
    }

    // If pre-compressing is enabled, we can pre_compress the wasm-bindgen output
-    if config.should_pre_compress_web_assets() {
-        pre_compress_folder(&bindgen_outdir)?;
-    }
+    pre_compress_folder(&bindgen_outdir, config.should_pre_compress_web_assets())?;

    // [5][OPTIONAL] If tailwind is enabled and installed we run it to generate the CSS
    let dioxus_tools = dioxus_config.application.tools.clone();
@@ -624,6 +622,16 @@ pub fn gen_page(config: &CrateConfig, manifest: Option<&AssetManifest>, serve: b
    </body"#
            ),
        );
+
+        // And try to insert preload links for the wasm and js files
+        html = html.replace(
+            "</head",
+            &format!(
+                r#"<link rel="preload" href="/{base_path}/assets/dioxus/{app_name}_bg.wasm" as="fetch" type="application/wasm" crossorigin="">
+                    <link rel="preload" href="/{base_path}/assets/dioxus/{app_name}.js" as="script">
+    </head"#
+            ),
+        );
    }

    let title = config.dioxus_config.web.app.title.clone();
@@ -16,6 +16,11 @@ pub struct ConfigOptsBuild {
    #[serde(default)]
    pub force_debug: bool,

+    /// This flag only applies to fullstack builds. By default fullstack builds will run the server and client builds in parallel. This flag will force the build to run the server build first, then the client build. [default: false]
+    #[clap(long)]
+    #[serde(default)]
+    pub force_sequential: bool,
+
    // Use verbose output [default: false]
    #[clap(long)]
    #[serde(default)]
@@ -73,6 +78,7 @@ impl From<ConfigOptsServe> for ConfigOptsBuild {
            server_feature: serve.server_feature,
            skip_assets: serve.skip_assets,
            force_debug: serve.force_debug,
+            force_sequential: serve.force_sequential,
            cargo_args: serve.cargo_args,
        }
    }
@@ -104,6 +110,11 @@ pub struct ConfigOptsServe {
    #[serde(default)]
    pub force_debug: bool,

+    /// This flag only applies to fullstack builds. By default fullstack builds will run the server and client builds in parallel. This flag will force the build to run the server build first, then the client build. [default: false]
+    #[clap(long)]
+    #[serde(default)]
+    pub force_sequential: bool,
+
    // Use verbose output [default: false]
    #[clap(long)]
    #[serde(default)]
@@ -240,17 +240,11 @@ fn send_msg(msg: HotReloadMsg, channel: &mut impl std::io::Write) -> bool {
    }
 }

-fn start_desktop(
-    config: &CrateConfig,
-    skip_assets: bool,
-    rust_flags: Option<String>,
+fn run_desktop(
    args: &Vec<String>,
    env: Vec<(String, String)>,
+    result: BuildResult,
 ) -> Result<(RAIIChild, BuildResult)> {
-    // Run the desktop application
-    // Only used for the fullstack platform,
-    let result = crate::builder::build_desktop(config, true, skip_assets, rust_flags)?;
-
    let active = "DIOXUS_ACTIVE";
    let child = RAIIChild(
        Command::new(
@@ -278,13 +272,12 @@ impl DesktopPlatform {
    /// `rust_flags` argument is added because it is used by the
    /// `DesktopPlatform`'s implementation of the `Platform::start()`.
    pub fn start_with_options(
+        build_result: BuildResult,
        config: &CrateConfig,
        serve: &ConfigOptsServe,
-        rust_flags: Option<String>,
        env: Vec<(String, String)>,
    ) -> Result<Self> {
-        let (child, first_build_result) =
-            start_desktop(config, serve.skip_assets, rust_flags, &serve.args, env)?;
+        let (child, first_build_result) = run_desktop(&serve.args, env, build_result)?;

        tracing::info!("🚀 Starting development server...");

@@ -337,7 +330,9 @@ impl DesktopPlatform {
        // Todo: add a timeout here to kill the process if it doesn't shut down within a reasonable time
        self.currently_running_child.0.wait()?;

-        let (child, result) = start_desktop(config, self.skip_assets, rust_flags, &self.args, env)?;
+        let build_result =
+            crate::builder::build_desktop(config, true, self.skip_assets, rust_flags)?;
+        let (child, result) = run_desktop(&self.args, env, build_result)?;
        self.currently_running_child = child;
        Ok(result)
    }
@@ -349,11 +344,8 @@ impl Platform for DesktopPlatform {
        serve: &ConfigOptsServe,
        env: Vec<(String, String)>,
    ) -> Result<Self> {
-        // See `start_with_options()`'s docs for the explanation why the code
-        // was moved there.
-        // Since desktop platform doesn't use `rust_flags`, this argument is
-        // explicitly set to `None`.
-        DesktopPlatform::start_with_options(config, serve, None, env)
+        let build_result = crate::builder::build_desktop(config, true, serve.skip_assets, None)?;
+        DesktopPlatform::start_with_options(build_result, config, serve, env)
    }

    fn rebuild(
@@ -5,7 +5,10 @@ use crate::{
    BuildResult, Result,
 };

-use super::{desktop, Platform};
+use super::{
+    desktop::{self, DesktopPlatform},
+    Platform,
+};

 static CLIENT_RUST_FLAGS: &str = "-C debuginfo=none -C strip=debuginfo";
 // The `opt-level=2` increases build times, but can noticeably decrease time
@@ -49,7 +52,9 @@ fn start_web_build_thread(

 fn make_desktop_config(config: &CrateConfig, serve: &ConfigOptsServe) -> CrateConfig {
    let mut desktop_config = config.clone();
-    desktop_config.target_dir = config.server_target_dir();
+    if !serve.force_sequential {
+        desktop_config.target_dir = config.server_target_dir();
+    }
    let desktop_feature = serve.server_feature.clone();
    let features = &mut desktop_config.features;
    match features {
@@ -89,16 +94,20 @@ impl Platform for FullstackPlatform {
        let server_rust_flags = server_rust_flags(&serve.clone().into());
        let mut desktop_env = env.clone();
        add_serve_options_to_env(serve, &mut desktop_env);
-        let desktop = desktop::DesktopPlatform::start_with_options(
+        let build_result = crate::builder::build_desktop(
            &desktop_config,
-            serve,
+            true,
+            serve.skip_assets,
            Some(server_rust_flags.clone()),
-            desktop_env,
        )?;
        thread_handle
            .join()
            .map_err(|_| anyhow::anyhow!("Failed to join thread"))??;

+        // Only start the server after the web build is finished
+        let desktop =
+            DesktopPlatform::start_with_options(build_result, &desktop_config, serve, desktop_env)?;
+
        if serve.open {
            crate::server::web::open_browser(
                config,
@@ -157,7 +166,7 @@ fn build_web(serve: ConfigOptsServe, target_directory: &std::path::Path) -> Resu
    }
    .build(
        None,
-        Some(target_directory),
+        (!web_config.force_sequential).then_some(target_directory),
        Some(client_rust_flags(&web_config)),
    )
 }