Streamed SSR Response

.github/workflows/main-checks.yml

@@ -25,15 +25,10 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: clippy
-          args: --all-targets --features "csr,ssr,hydration" -- -D warnings
+          args: --all-targets --features "csr,ssr,hydration,tokio" -- -D warnings
 
       - name: Lint feature soundness
-        run: |
-          cargo clippy -- --deny=warnings
-          cargo clippy --features=ssr -- --deny=warnings
-          cargo clippy --features=csr -- --deny=warnings
-          cargo clippy --features=hydration -- --deny=warnings
-          cargo clippy --features "csr,ssr,hydration,tokio" --all-targets -- --deny=warnings
+        run: bash ../../ci/feature-soundness.sh
         working-directory: packages/yew
 
 
@@ -55,15 +50,10 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: clippy
-          args: --all-targets --features "csr,ssr,hydration" --release -- -D warnings
+          args: --all-targets --features "csr,ssr,hydration,tokio" --release -- -D warnings
 
       - name: Lint feature soundness
-        run: |
-          cargo clippy --release -- --deny=warnings
-          cargo clippy --release --features=ssr -- --deny=warnings
-          cargo clippy --release --features=csr -- --deny=warnings
-          cargo clippy --release --features=hydration -- --deny=warnings
-          cargo clippy --release --features "csr,ssr,hydration,tokio" --all-targets -- --deny=warnings
+        run: bash ../../ci/feature-soundness-release.sh
         working-directory: packages/yew
 
   spell_check:
@@ -129,7 +119,7 @@ jobs:
       matrix:
         toolchain:
           # anyway to dynamically grep the MSRV from Cargo.toml?
-          - 1.56.1 # MSRV
+          - 1.60.0 # MSRV
           - stable
 
     steps:
@@ -180,7 +170,7 @@ jobs:
       matrix:
         toolchain:
           # anyway to dynamically grep the MSRV from Cargo.toml?
-          - 1.56.1 # MSRV
+          - 1.60.0 # MSRV
           - stable
           - nightly
 

Cargo.toml

@@ -45,3 +45,4 @@ members = [
   "tools/process-benchmark-results",
   "tools/website-test",
 ]
+resolver = "2"

ci/feature-soundness-release.sh

@@ -0,0 +1,32 @@
+#!/usr/bin/env bash
+set -xe
+
+# You can extract the feature list with the following command:
+# cargo hack check --feature-powerset --exclude-features nightly
+
+# You need to run this script in packages/yew
+
+cargo clippy --release --no-default-features -- --deny=warnings
+cargo clippy --release --no-default-features --features csr -- --deny=warnings
+cargo clippy --release --no-default-features --features default -- --deny=warnings
+cargo clippy --release --no-default-features --features csr,default -- --deny=warnings
+cargo clippy --release --no-default-features --features hydration -- --deny=warnings
+cargo clippy --release --no-default-features --features default,hydration -- --deny=warnings
+cargo clippy --release --no-default-features --features ssr -- --deny=warnings
+cargo clippy --release --no-default-features --features csr,ssr -- --deny=warnings
+cargo clippy --release --no-default-features --features default,ssr -- --deny=warnings
+cargo clippy --release --no-default-features --features csr,default,ssr -- --deny=warnings
+cargo clippy --release --no-default-features --features hydration,ssr -- --deny=warnings
+cargo clippy --release --no-default-features --features default,hydration,ssr -- --deny=warnings
+cargo clippy --release --no-default-features --features tokio -- --deny=warnings
+cargo clippy --release --no-default-features --features csr,tokio -- --deny=warnings
+cargo clippy --release --no-default-features --features default,tokio -- --deny=warnings
+cargo clippy --release --no-default-features --features csr,default,tokio -- --deny=warnings
+cargo clippy --release --no-default-features --features hydration,tokio -- --deny=warnings
+cargo clippy --release --no-default-features --features default,hydration,tokio -- --deny=warnings
+cargo clippy --release --no-default-features --features ssr,tokio -- --deny=warnings
+cargo clippy --release --no-default-features --features csr,ssr,tokio -- --deny=warnings
+cargo clippy --release --no-default-features --features default,ssr,tokio -- --deny=warnings
+cargo clippy --release --no-default-features --features csr,default,ssr,tokio -- --deny=warnings
+cargo clippy --release --no-default-features --features hydration,ssr,tokio -- --deny=warnings
+cargo clippy --release --no-default-features --features default,hydration,ssr,tokio -- --deny=warnings

ci/feature-soundness.sh

@@ -0,0 +1,32 @@
+#!/usr/bin/env bash
+set -xe
+
+# You can extract the feature list with the following command:
+# cargo hack check --feature-powerset --exclude-features nightly
+
+# You need to run this script in packages/yew
+
+cargo clippy --no-default-features -- --deny=warnings
+cargo clippy --no-default-features --features csr -- --deny=warnings
+cargo clippy --no-default-features --features default -- --deny=warnings
+cargo clippy --no-default-features --features csr,default -- --deny=warnings
+cargo clippy --no-default-features --features hydration -- --deny=warnings
+cargo clippy --no-default-features --features default,hydration -- --deny=warnings
+cargo clippy --no-default-features --features ssr -- --deny=warnings
+cargo clippy --no-default-features --features csr,ssr -- --deny=warnings
+cargo clippy --no-default-features --features default,ssr -- --deny=warnings
+cargo clippy --no-default-features --features csr,default,ssr -- --deny=warnings
+cargo clippy --no-default-features --features hydration,ssr -- --deny=warnings
+cargo clippy --no-default-features --features default,hydration,ssr -- --deny=warnings
+cargo clippy --no-default-features --features tokio -- --deny=warnings
+cargo clippy --no-default-features --features csr,tokio -- --deny=warnings
+cargo clippy --no-default-features --features default,tokio -- --deny=warnings
+cargo clippy --no-default-features --features csr,default,tokio -- --deny=warnings
+cargo clippy --no-default-features --features hydration,tokio -- --deny=warnings
+cargo clippy --no-default-features --features default,hydration,tokio -- --deny=warnings
+cargo clippy --no-default-features --features ssr,tokio -- --deny=warnings
+cargo clippy --no-default-features --features csr,ssr,tokio -- --deny=warnings
+cargo clippy --no-default-features --features default,ssr,tokio -- --deny=warnings
+cargo clippy --no-default-features --features csr,default,ssr,tokio -- --deny=warnings
+cargo clippy --no-default-features --features hydration,ssr,tokio -- --deny=warnings
+cargo clippy --no-default-features --features default,hydration,ssr,tokio -- --deny=warnings

examples/function_router/src/app.rs

@@ -1,7 +1,6 @@
 use std::collections::HashMap;
 
 use yew::prelude::*;
-use yew::virtual_dom::AttrValue;
 use yew_router::history::{AnyHistory, History, MemoryHistory};
 use yew_router::prelude::*;
 

examples/simple_ssr/Cargo.toml

@@ -10,6 +10,8 @@ yew = { path = "../../packages/yew" }
 reqwest = { version = "0.11.8", features = ["json"] }
 serde = { version = "1.0.132", features = ["derive"] }
 uuid = { version = "1.0.0", features = ["serde"] }
+futures = "0.3"
+bytes = "1.0"
 
 [target.'cfg(target_arch = "wasm32")'.dependencies]
 wasm-bindgen-futures = "0.4"
@@ -19,9 +21,6 @@ log = "0.4"
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]
 tokio = { version = "1.15.0", features = ["full"] }
 warp = "0.3"
-num_cpus = "1.13"
-tokio-util = { version = "0.7", features = ["rt"] }
-once_cell = "1.5"
 clap = { version = "3.1.7", features = ["derive"] }
 
 [features]

examples/simple_ssr/src/bin/simple_ssr_server.rs

@@ -1,13 +1,13 @@
+use std::error::Error;
 use std::path::PathBuf;
 
+use bytes::Bytes;
 use clap::Parser;
-use once_cell::sync::Lazy;
+use futures::stream::{self, Stream, StreamExt};
 use simple_ssr::App;
-use tokio_util::task::LocalPoolHandle;
 use warp::Filter;
 
-// We spawn a local pool that is as big as the number of cpu threads.
-static LOCAL_POOL: Lazy<LocalPoolHandle> = Lazy::new(|| LocalPoolHandle::new(num_cpus::get()));
+type BoxedError = Box<dyn Error + Send + Sync + 'static>;
 
 /// A basic example
 #[derive(Parser, Debug)]
@@ -17,19 +17,18 @@ struct Opt {
     dir: PathBuf,
 }
 
-async fn render(index_html_s: &str) -> String {
-    let content = LOCAL_POOL
-        .spawn_pinned(move || async move {
-            let renderer = yew::ServerRenderer::<App>::new();
-
-            renderer.render().await
-        })
-        .await
-        .expect("the task has failed.");
-
-    // Good enough for an example, but developers should avoid the replace and extra allocation
-    // here in an actual app.
-    index_html_s.replace("<body>", &format!("<body>{}", content))
+async fn render(
+    index_html_before: String,
+    index_html_after: String,
+) -> Box<dyn Stream<Item = Result<Bytes, BoxedError>> + Send> {
+    let renderer = yew::ServerRenderer::<App>::new();
+
+    Box::new(
+        stream::once(async move { index_html_before })
+            .chain(renderer.render_stream().await)
+            .chain(stream::once(async move { index_html_after }))
+            .map(|m| Result::<_, BoxedError>::Ok(m.into())),
+    )
 }
 
 #[tokio::main]
@@ -40,10 +39,16 @@ async fn main() {
         .await
         .expect("failed to read index.html");
 
+    let (index_html_before, index_html_after) = index_html_s.split_once("<body>").unwrap();
+    let mut index_html_before = index_html_before.to_owned();
+    index_html_before.push_str("<body>");
+    let index_html_after = index_html_after.to_owned();
+
     let html = warp::path::end().then(move || {
-        let index_html_s = index_html_s.clone();
+        let index_html_before = index_html_before.clone();
+        let index_html_after = index_html_after.clone();
 
-        async move { warp::reply::html(render(&index_html_s).await) }
+        async move { warp::reply::html(render(index_html_before, index_html_after).await) }
     });
 
     let routes = html.or(warp::fs::dir(opts.dir));

examples/ssr_router/Cargo.toml

@@ -9,6 +9,7 @@ edition = "2021"
 yew = { path = "../../packages/yew" }
 function_router = { path = "../function_router" }
 log = "0.4"
+futures = "0.3"
 
 [target.'cfg(target_arch = "wasm32")'.dependencies]
 wasm-bindgen-futures = "0.4"
@@ -20,9 +21,6 @@ axum = "0.5"
 tower = { version = "0.4", features = ["make"] }
 tower-http = { version = "0.3", features = ["fs"] }
 env_logger = "0.9"
-num_cpus = "1.13"
-tokio-util = { version = "0.7", features = ["rt"] }
-once_cell = "1.5"
 clap = { version = "3.1.7", features = ["derive"] }
 
 [features]

examples/ssr_router/src/bin/ssr_router_server.rs

@@ -1,24 +1,21 @@
 use std::collections::HashMap;
+use std::convert::Infallible;
 use std::path::PathBuf;
 
-use axum::body::Body;
+use axum::body::{Body, StreamBody};
 use axum::error_handling::HandleError;
 use axum::extract::Query;
 use axum::handler::Handler;
 use axum::http::{Request, StatusCode};
-use axum::response::Html;
+use axum::response::IntoResponse;
 use axum::routing::get;
 use axum::{Extension, Router};
 use clap::Parser;
 use function_router::{ServerApp, ServerAppProps};
-use once_cell::sync::Lazy;
-use tokio_util::task::LocalPoolHandle;
+use futures::stream::{self, StreamExt};
 use tower::ServiceExt;
 use tower_http::services::ServeDir;
 
-// We spawn a local pool that is as big as the number of cpu threads.
-static LOCAL_POOL: Lazy<LocalPoolHandle> = Lazy::new(|| LocalPoolHandle::new(num_cpus::get()));
-
 /// A basic example
 #[derive(Parser, Debug)]
 struct Opt {
@@ -28,29 +25,23 @@ struct Opt {
 }
 
 async fn render(
-    Extension(index_html_s): Extension<String>,
+    Extension((index_html_before, index_html_after)): Extension<(String, String)>,
     url: Request<Body>,
     Query(queries): Query<HashMap<String, String>>,
-) -> Html<String> {
+) -> impl IntoResponse {
     let url = url.uri().to_string();
 
-    let content = LOCAL_POOL
-        .spawn_pinned(move || async move {
-            let server_app_props = ServerAppProps {
-                url: url.into(),
-                queries,
-            };
-
-            let renderer = yew::ServerRenderer::<ServerApp>::with_props(server_app_props);
-
-            renderer.render().await
-        })
-        .await
-        .expect("the task has failed.");
+    let renderer = yew::ServerRenderer::<ServerApp>::with_props(move || ServerAppProps {
+        url: url.into(),
+        queries,
+    });
 
-    // Good enough for an example, but developers should avoid the replace and extra allocation
-    // here in an actual app.
-    Html(index_html_s.replace("<body>", &format!("<body>{}", content)))
+    StreamBody::new(
+        stream::once(async move { index_html_before })
+            .chain(renderer.render_stream().await)
+            .chain(stream::once(async move { index_html_after }))
+            .map(Result::<_, Infallible>::Ok),
+    )
 }
 
 #[tokio::main]
@@ -63,6 +54,12 @@ async fn main() {
         .await
         .expect("failed to read index.html");
 
+    let (index_html_before, index_html_after) = index_html_s.split_once("<body>").unwrap();
+    let mut index_html_before = index_html_before.to_owned();
+    index_html_before.push_str("<body>");
+
+    let index_html_after = index_html_after.to_owned();
+
     let handle_error = |e| async move {
         (
             StatusCode::INTERNAL_SERVER_ERROR,
@@ -77,7 +74,10 @@ async fn main() {
                 .append_index_html_on_directories(false)
                 .fallback(
                     render
-                        .layer(Extension(index_html_s))
+                        .layer(Extension((
+                            index_html_before.clone(),
+                            index_html_after.clone(),
+                        )))
                         .into_service()
                         .map_err(|err| -> std::io::Error { match err {} }),
                 ),

packages/yew-macro/Cargo.toml

@@ -10,7 +10,7 @@ license = "MIT OR Apache-2.0"
 keywords = ["web", "wasm", "frontend", "webasm", "webassembly"]
 categories = ["gui", "web-programming", "wasm"]
 description = "A framework for making client-side single-page apps"
-rust-version = "1.56.1"
+rust-version = "1.60.0"
 
 [lib]
 proc-macro = true

packages/yew-macro/Makefile.toml

@@ -1,6 +1,6 @@
 [tasks.test]
 clear = true
-toolchain = "1.56.1"
+toolchain = "1.60.0"
 command = "cargo"
 # test target can be optionally specified like `cargo make test html_macro`,
 args = ["test", "${@}"]