examples: add ssr_mode_axum (#575)

examples/ssr_modes_axum/.gitignore

@@ -0,0 +1,13 @@
+# Generated by Cargo
+# will have compiled files and executables
+/target/
+pkg
+
+# These are backup files generated by rustfmt
+**/*.rs.bk
+
+# node e2e test tools and outputs
+node_modules/
+test-results/
+end2end/playwright-report/
+playwright/.cache/

examples/ssr_modes_axum/Cargo.toml

@@ -0,0 +1,91 @@
+[package]
+name = "ssr_modes_axum"
+version = "0.1.0"
+edition = "2021"
+
+[lib]
+crate-type = ["cdylib", "rlib"]
+
+[dependencies]
+console_error_panic_hook = "0.1"
+console_log = "0.2"
+cfg-if = "1"
+lazy_static = "1"
+leptos = { path = "../../leptos", default-features = false, features = [
+  "serde",
+] }
+leptos_meta = { path = "../../meta", default-features = false }
+leptos_axum = { path = "../../integrations/axum", default-features = false, optional = true }
+leptos_router = { path = "../../router", default-features = false }
+log = "0.4"
+serde = { version = "1", features = ["derive"] }
+simple_logger = "4"
+thiserror = "1"
+axum = { version = "0.6.1", optional = true }
+tower = { version = "0.4.13", optional = true }
+tower-http = { version = "0.3.4", features = ["fs"], optional = true }
+tokio = { version = "1", features = ["time"], optional = true}
+wasm-bindgen = "0.2"
+
+[features]
+hydrate = ["leptos/hydrate", "leptos_meta/hydrate", "leptos_router/hydrate"]
+ssr = [
+  "dep:axum",
+  "dep:tower",
+  "dep:tower-http",
+  "dep:tokio",
+  "leptos/ssr",
+  "leptos_meta/ssr",
+  "leptos_router/ssr",
+  "dep:leptos_axum",
+]
+
+[package.metadata.leptos]
+# The name used by wasm-bindgen/cargo-leptos for the JS/WASM bundle. Defaults to the crate name   
+output-name = "ssr_modes"
+# The site root folder is where cargo-leptos generate all output. WARNING: all content of this folder will be erased on a rebuild. Use it in your server setup.
+site-root = "target/site"
+# The site-root relative folder where all compiled output (JS, WASM and CSS) is written
+# Defaults to pkg	
+site-pkg-dir = "pkg"
+# [Optional] The source CSS file. If it ends with .sass or .scss then it will be compiled by dart-sass into CSS. The CSS is optimized by Lightning CSS before being written to <site-root>/<site-pkg>/app.css
+style-file = "style/main.scss"
+# Assets source dir. All files found here will be copied and synchronized to site-root.
+# The assets-dir cannot have a sub directory with the same name/path as site-pkg-dir.
+#
+# Optional. Env: LEPTOS_ASSETS_DIR.
+assets-dir = "assets"
+# The IP and port (ex: 127.0.0.1:3000) where the server serves the content. Use it in your server setup.
+site-addr = "127.0.0.1:3000"
+# The port to use for automatic reload monitoring
+reload-port = 3001
+# [Optional] Command to use when running end2end tests. It will run in the end2end dir.
+#   [Windows] for non-WSL use "npx.cmd playwright test"
+#   This binary name can be checked in Powershell with Get-Command npx
+end2end-cmd = "npx playwright test"
+end2end-dir = "end2end"
+#  The browserlist query used for optimizing the CSS.
+browserquery = "defaults"
+# Set by cargo-leptos watch when building with that tool. Controls whether autoreload JS will be included in the head
+watch = false
+# The environment Leptos will run in, usually either "DEV" or "PROD"
+env = "DEV"
+# The features to use when compiling the bin target
+#
+# Optional. Can be over-ridden with the command line parameter --bin-features
+bin-features = ["ssr"]
+
+# If the --no-default-features flag should be used when compiling the bin target
+#
+# Optional. Defaults to false.
+bin-default-features = false
+
+# The features to use when compiling the lib target
+#
+# Optional. Can be over-ridden with the command line parameter --lib-features
+lib-features = ["hydrate"]
+
+# If the --no-default-features flag should be used when compiling the lib target
+#
+# Optional. Defaults to false.
+lib-default-features = false

examples/ssr_modes_axum/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 henrik
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

examples/ssr_modes_axum/README.md

@@ -0,0 +1,54 @@
+# Server-Side Rendering Modes
+
+This example shows the different "rendering modes" that can be used while server-side 
+rendering an application:
+1. **Synchronous**: Serve an HTML shell that includes `fallback` for any `Suspense`. Load data on the client, replacing `fallback` once they're loaded.
+     - *Pros*: App shell appears very quickly: great TTFB (time to first byte).
+     - *Cons*: Resources load relatively slowly; you need to wait for JS + Wasm to load before even making a request.
+ 2. **Out-of-order streaming**: Serve an HTML shell that includes `fallback` for any `Suspense`. Load data on the **server**, streaming it down to the client as it resolves, and streaming down HTML for `Suspense` nodes.
+     - *Pros*: Combines the best of **synchronous** and **`async`**, with a very fast shell and resources that begin loading on the server.
+     - *Cons*: Requires JS for suspended fragments to appear in correct order. Weaker meta tag support when it depends on data that's under suspense (has already streamed down `<head>`)
+ 3. **In-order streaming**: Walk through the tree, returning HTML synchronously as in synchronous rendering and out-of-order streaming until you hit a `Suspense`. At that point, wait for all its data to load, then render it, then the rest of the tree.
+     - *Pros*: Does not require JS for HTML to appear in correct order.
+     - *Cons*: Loads the shell more slowly than out-of-order streaming or synchronous rendering because it needs to pause at every `Suspense`. Cannot begin hydration until the entire page has loaded, so earlier pieces
+       of the page will not be interactive until the suspended chunks have loaded.
+ 4. **`async`**: Load all resources on the server. Wait until all data are loaded, and render HTML in one sweep.
+     - *Pros*: Better handling for meta tags (because you know async data even before you render the `<head>`). Faster complete load than **synchronous** because async resources begin loading on server.
+     - *Cons*: Slower load time/TTFB: you need to wait for all async resources to load before displaying anything on the client.
+
+## Server Side Rendering with `cargo-leptos`
+`cargo-leptos` is now the easiest and most featureful way to build server side rendered apps with hydration. It provides automatic recompilation of client and server code, wasm optimisation, CSS minification, and more! Check out more about it [here](https://github.com/akesson/cargo-leptos)
+
+1. Install cargo-leptos
+```bash
+cargo install --locked cargo-leptos
+``` 
+2. Build the site in watch mode, recompiling on file changes
+```bash
+cargo leptos watch
+```
+
+Open browser on [http://localhost:3000/](http://localhost:3000/)
+
+3. When ready to deploy, run
+```bash
+cargo leptos build --release
+```
+
+## Server Side Rendering without cargo-leptos
+To run it as a server side app with hydration, you'll need to have wasm-pack installed.
+
+0. Edit the `[package.metadata.leptos]` section and set `site-root` to `"."`. You'll also want to change the path of the `<StyleSheet / >` component in the root component to point towards the CSS file in the root. This tells leptos that the WASM/JS files generated by wasm-pack are available at `./pkg` and that the CSS files are no longer processed by cargo-leptos. Building to alternative folders is not supported at this time. You'll also want to edit the call to `get_configuration()` to pass in `Some(Cargo.toml)`, so that Leptos will read the settings instead of cargo-leptos. If you do so, your file/folder names cannot include dashes.
+1. Install wasm-pack
+```bash
+cargo install wasm-pack
+```
+2. Build the Webassembly used to hydrate the HTML from the server
+```bash
+wasm-pack build --target=web --debug --no-default-features --features=hydrate
+```
+3. Run the server to serve the Webassembly, JS, and HTML 
+```bash
+cargo run --no-default-features --features=ssr
+```
+

examples/ssr_modes_axum/src/app.rs

@@ -0,0 +1,189 @@
+use lazy_static::lazy_static;
+use leptos::*;
+use leptos_meta::*;
+use leptos_router::*;
+use serde::{Deserialize, Serialize};
+use thiserror::Error;
+
+#[component]
+pub fn App(cx: Scope) -> impl IntoView {
+    // Provides context that manages stylesheets, titles, meta tags, etc.
+    provide_meta_context(cx);
+
+    view! { cx,
+        <Stylesheet id="leptos" href="/pkg/ssr_modes.css"/>
+        <Title text="Welcome to Leptos"/>
+
+        <Router>
+            <main>
+                <Routes>
+                    // We’ll load the home page with out-of-order streaming and <Suspense/>
+                    <Route path="" view=|cx| view! { cx, <HomePage/> }/>
+
+                    // We'll load the posts with async rendering, so they can set
+                    // the title and metadata *after* loading the data
+                    <Route
+                        path="/post/:id"
+                        view=|cx| view! { cx, <Post/> }
+                        ssr=SsrMode::Async
+                    />
+                    <Route
+                        path="/post_in_order/:id"
+                        view=|cx| view! { cx, <Post/> }
+                        ssr=SsrMode::InOrder
+                    />
+                </Routes>
+            </main>
+        </Router>
+    }
+}
+
+#[component]
+fn HomePage(cx: Scope) -> impl IntoView {
+    // load the posts
+    let posts =
+        create_resource(cx, || (), |_| async { list_post_metadata().await });
+    let posts_view = move || {
+        posts.with(cx, |posts| posts
+            .clone()
+            .map(|posts| {
+                posts.iter()
+                .map(|post| view! { cx, <li><a href=format!("/post/{}", post.id)>{&post.title}</a> "|" <a href=format!("/post_in_order/{}", post.id)>{&post.title}"(in order)"</a></li>})
+                .collect::<Vec<_>>()
+            })
+        )
+    };
+
+    view! { cx,
+        <h1>"My Great Blog"</h1>
+        <Suspense fallback=move || view! { cx, <p>"Loading posts..."</p> }>
+            <ul>{posts_view}</ul>
+        </Suspense>
+    }
+}
+
+#[derive(Params, Copy, Clone, Debug, PartialEq, Eq)]
+pub struct PostParams {
+    id: usize,
+}
+
+#[component]
+fn Post(cx: Scope) -> impl IntoView {
+    let query = use_params::<PostParams>(cx);
+    let id = move || {
+        query.with(|q| {
+            q.as_ref().map(|q| q.id).map_err(|_| PostError::InvalidId)
+        })
+    };
+    let post = create_resource(cx, id, |id| async move {
+        match id {
+            Err(e) => Err(e),
+            Ok(id) => get_post(id)
+                .await
+                .map(|data| data.ok_or(PostError::PostNotFound))
+                .map_err(|_| PostError::ServerError)
+                .flatten(),
+        }
+    });
+
+    let post_view = move || {
+        post.with(cx, |post| {
+            post.clone().map(|post| {
+                view! { cx,
+                    // render content
+                    <h1>{&post.title}</h1>
+                    <p>{&post.content}</p>
+
+                    // since we're using async rendering for this page,
+                    // this metadata should be included in the actual HTML <head>
+                    // when it's first served
+                    <Title text=post.title/>
+                    <Meta name="description" content=post.content/>
+                }
+            })
+        })
+    };
+
+    view! { cx,
+        <Suspense fallback=move || view! { cx, <p>"Loading post..."</p> }>
+            <ErrorBoundary fallback=|cx, errors| {
+                view! { cx,
+                    <div class="error">
+                        <h1>"Something went wrong."</h1>
+                        <ul>
+                        {move || errors.get()
+                            .into_iter()
+                            .map(|(_, error)| view! { cx, <li>{error.to_string()} </li> })
+                            .collect::<Vec<_>>()
+                        }
+                        </ul>
+                    </div>
+                }
+            }>
+                {post_view}
+            </ErrorBoundary>
+        </Suspense>
+    }
+}
+
+// Dummy API
+lazy_static! {
+    static ref POSTS: Vec<Post> = vec![
+        Post {
+            id: 0,
+            title: "My first post".to_string(),
+            content: "This is my first post".to_string(),
+        },
+        Post {
+            id: 1,
+            title: "My second post".to_string(),
+            content: "This is my second post".to_string(),
+        },
+        Post {
+            id: 2,
+            title: "My third post".to_string(),
+            content: "This is my third post".to_string(),
+        },
+    ];
+}
+
+#[derive(Error, Debug, Copy, Clone, PartialEq, Eq, Serialize, Deserialize)]
+pub enum PostError {
+    #[error("Invalid post ID.")]
+    InvalidId,
+    #[error("Post not found.")]
+    PostNotFound,
+    #[error("Server error.")]
+    ServerError,
+}
+
+#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
+pub struct Post {
+    id: usize,
+    title: String,
+    content: String,
+}
+
+#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
+pub struct PostMetadata {
+    id: usize,
+    title: String,
+}
+
+#[server(ListPostMetadata, "/api")]
+pub async fn list_post_metadata() -> Result<Vec<PostMetadata>, ServerFnError> {
+    tokio::time::sleep(std::time::Duration::from_secs(1)).await;
+    Ok(POSTS
+        .iter()
+        .map(|data| PostMetadata {
+            id: data.id,
+            title: data.title.clone(),
+        })
+        .collect())
+}
+
+#[server(GetPost, "/api")]
+pub async fn get_post(id: usize) -> Result<Option<Post>, ServerFnError> {
+    tokio::time::sleep(std::time::Duration::from_secs(1)).await;
+    Ok(POSTS.iter().find(|post| post.id == id).cloned())
+}

examples/ssr_modes_axum/src/fallback.rs

@@ -0,0 +1,45 @@
+use cfg_if::cfg_if;
+
+cfg_if! { if #[cfg(feature = "ssr")] {
+    use axum::{
+        body::{boxed, Body, BoxBody},
+        extract::Extension,
+        response::IntoResponse,
+        http::{Request, Response, StatusCode, Uri},
+    };
+    use axum::response::Response as AxumResponse;
+    use tower::ServiceExt;
+    use tower_http::services::ServeDir;
+    use std::sync::Arc;
+    use leptos::{LeptosOptions, Errors, view};
+    use crate::app::{App, AppProps};
+
+    pub async fn file_and_error_handler(uri: Uri, Extension(options): Extension<Arc<LeptosOptions>>, req: Request<Body>) -> AxumResponse {
+        let options = &*options;
+        let root = options.site_root.clone();
+        let res = get_static_file(uri.clone(), &root).await.unwrap();
+
+        if res.status() == StatusCode::OK {
+           res.into_response()
+        } else{
+            let handler = leptos_axum::render_app_to_stream(
+                options.to_owned(),
+                move |cx| view!{ cx, <App/> }
+            );
+            handler(req).await.into_response()
+        }
+    }
+
+    async fn get_static_file(uri: Uri, root: &str) -> Result<Response<BoxBody>, (StatusCode, String)> {
+        let req = Request::builder().uri(uri.clone()).body(Body::empty()).unwrap();
+        // `ServeDir` implements `tower::Service` so we can call it with `tower::ServiceExt::oneshot`
+        // This path is relative to the cargo root
+        match ServeDir::new(root).oneshot(req).await {
+            Ok(res) => Ok(res.map(boxed)),
+            Err(err) => Err((
+                StatusCode::INTERNAL_SERVER_ERROR,
+                format!("Something went wrong: {err}"),
+            )),
+        }
+    }
+}}

examples/ssr_modes_axum/src/lib.rs

@@ -0,0 +1,26 @@
+#![feature(result_flattening)]
+
+pub mod app;
+pub mod fallback;
+use cfg_if::cfg_if;
+
+cfg_if! {
+if #[cfg(feature = "hydrate")] {
+
+  use wasm_bindgen::prelude::wasm_bindgen;
+
+    #[wasm_bindgen]
+    pub fn hydrate() {
+      use app::*;
+      use leptos::*;
+
+      // initializes logging using the `log` crate
+      _ = console_log::init_with_level(log::Level::Debug);
+      console_error_panic_hook::set_once();
+
+      leptos::mount_to_body(move |cx| {
+          view! { cx, <App/> }
+      });
+    }
+}
+}

examples/ssr_modes_axum/src/main.rs

@@ -0,0 +1,40 @@
+#[cfg(feature = "ssr")]
+#[tokio::main]
+async fn main(){
+    use leptos::*;
+    use leptos_axum::{generate_route_list, LeptosRoutes};
+    use axum::{extract::{Extension, Path}, Router, routing::{get, post}};
+    use std::sync::Arc;
+    use ssr_modes_axum::fallback::file_and_error_handler;
+    use ssr_modes_axum::app::*;
+
+    let conf = get_configuration(None).await.unwrap();
+    let addr = conf.leptos_options.site_addr;
+    let leptos_options = conf.leptos_options;
+    // Generate the list of routes in your Leptos App
+    let routes = generate_route_list(|cx| view! { cx, <App/> }).await;
+
+    GetPost::register();
+    ListPostMetadata::register();
+
+    let app = Router::new()
+        .route("/api/*fn_name", post(leptos_axum::handle_server_fns))
+        .leptos_routes(leptos_options.clone(), routes, |cx| view! { cx, <App/> })
+        .fallback(file_and_error_handler)
+        .layer(Extension(Arc::new(leptos_options)));
+
+    // run our app with hyper
+    // `axum::Server` is a re-export of `hyper::Server`
+    log!("listening on http://{}", &addr);
+    axum::Server::bind(&addr)
+        .serve(app.into_make_service())
+        .await
+        .unwrap();
+}
+
+#[cfg(not(feature = "ssr"))]
+pub fn main() {
+    // no client-side main function
+    // unless we want this to work with e.g., Trunk for pure client-side testing
+    // see lib.rs for hydration function instead
+}

examples/ssr_modes_axum/style/main.scss

@@ -0,0 +1,3 @@
+body {
+	font-family: sans-serif;
+}

integrations/axum/src/lib.rs

@@ -912,7 +912,7 @@ where
                                             };
 
                                             let (stream, runtime, scope) =
-                                                render_to_stream_with_prefix_undisposed_with_context(
+                                                render_to_stream_in_order_with_prefix_undisposed_with_context(
                                                     app,
                                                     |_| "".into(),
                                                     add_context,