1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
#![cfg(not(all(target_arch = "wasm32", feature = "web")))]

//! Server-side HTML rendering utilities for in-order streaming and async rendering.

use crate::{
    html::{ElementChildren, StringOrView},
    ssr::render_serializers,
    CoreComponent, HydrationCtx, View,
};
use async_recursion::async_recursion;
use cfg_if::cfg_if;
use futures::{channel::mpsc::UnboundedSender, Stream, StreamExt};
use itertools::Itertools;
use leptos_reactive::{
    create_runtime, run_scope_undisposed, suspense::StreamChunk, RuntimeId,
    Scope, ScopeId,
};
use std::borrow::Cow;

/// Renders a view to HTML, waiting to return until all `async` [Resource](leptos_reactive::Resource)s
/// loaded in `<Suspense/>` elements have finished loading.
pub async fn render_to_string_async(
    view: impl FnOnce(Scope) -> View + 'static,
) -> String {
    let mut buf = String::new();
    let mut stream = Box::pin(render_to_stream_in_order(view));
    while let Some(chunk) = stream.next().await {
        buf.push_str(&chunk);
    }
    buf
}

/// Renders an in-order HTML stream, pausing at `<Suspense/>` components. The stream contains,
/// in order:
/// 1. HTML from the `view` in order, pausing to wait for each `<Suspense/>`
/// 2. any serialized [Resource](leptos_reactive::Resource)s
pub fn render_to_stream_in_order(
    view: impl FnOnce(Scope) -> View + 'static,
) -> impl Stream<Item = String> {
    render_to_stream_in_order_with_prefix(view, |_| "".into())
}

/// Renders an in-order HTML stream, pausing at `<Suspense/>` components. The stream contains,
/// in order:
/// 1. `prefix`
/// 2. HTML from the `view` in order, pausing to wait for each `<Suspense/>`
/// 3. any serialized [Resource](leptos_reactive::Resource)s
///
/// `additional_context` is injected before the `view` is rendered. The `prefix` is generated
/// after the `view` is rendered, but before `<Suspense/>` nodes have resolved.
pub fn render_to_stream_in_order_with_prefix(
    view: impl FnOnce(Scope) -> View + 'static,
    prefix: impl FnOnce(Scope) -> Cow<'static, str> + 'static,
) -> impl Stream<Item = String> {
    let (stream, runtime, _) =
        render_to_stream_in_order_with_prefix_undisposed_with_context(
            view,
            prefix,
            |_| {},
        );
    runtime.dispose();
    stream
}

/// Renders an in-order HTML stream, pausing at `<Suspense/>` components. The stream contains,
/// in order:
/// 1. `prefix`
/// 2. HTML from the `view` in order, pausing to wait for each `<Suspense/>`
/// 3. any serialized [Resource](leptos_reactive::Resource)s
///
/// `additional_context` is injected before the `view` is rendered. The `prefix` is generated
/// after the `view` is rendered, but before `<Suspense/>` nodes have resolved.
pub fn render_to_stream_in_order_with_prefix_undisposed_with_context(
    view: impl FnOnce(Scope) -> View + 'static,
    prefix: impl FnOnce(Scope) -> Cow<'static, str> + 'static,
    additional_context: impl FnOnce(Scope) + 'static,
) -> (impl Stream<Item = String>, RuntimeId, ScopeId) {
    HydrationCtx::reset_id();

    // create the runtime
    let runtime = create_runtime();

    let ((chunks, prefix, pending_resources, serializers), scope_id, disposer) =
        run_scope_undisposed(runtime, |cx| {
            // add additional context
            additional_context(cx);

            // render view and return chunks
            let view = view(cx);

            let prefix = prefix(cx);
            (
                view.into_stream_chunks(cx),
                prefix,
                serde_json::to_string(&cx.pending_resources()).unwrap(),
                cx.serialization_resolvers(),
            )
        });

    let (tx, rx) = futures::channel::mpsc::unbounded();
    leptos_reactive::spawn_local(async move {
        handle_chunks(tx, chunks).await;
    });

    let stream = futures::stream::once(async move {
        format!(
            r#"
        {prefix}
        <script>
            __LEPTOS_PENDING_RESOURCES = {pending_resources};
            __LEPTOS_RESOLVED_RESOURCES = new Map();
            __LEPTOS_RESOURCE_RESOLVERS = new Map();
        </script>
      "#
        )
    })
    .chain(rx)
    .chain(render_serializers(serializers))
    // dispose of the scope
    .chain(futures::stream::once(async move {
        disposer.dispose();
        Default::default()
    }));

    (stream, runtime, scope_id)
}

#[async_recursion(?Send)]
async fn handle_chunks(tx: UnboundedSender<String>, chunks: Vec<StreamChunk>) {
    let mut buffer = String::new();
    for chunk in chunks {
        match chunk {
            StreamChunk::Sync(sync) => buffer.push_str(&sync),
            StreamChunk::Async(suspended) => {
                // add static HTML before the Suspense and stream it down
                tx.unbounded_send(std::mem::take(&mut buffer))
                    .expect("failed to send async HTML chunk");

                // send the inner stream
                let suspended = suspended.await;
                handle_chunks(tx.clone(), suspended).await;
            }
        }
    }
    // send final sync chunk
    tx.unbounded_send(std::mem::take(&mut buffer))
        .expect("failed to send final HTML chunk");
}

impl View {
    /// Renders the view into a set of HTML chunks that can be streamed.
    pub fn into_stream_chunks(self, cx: Scope) -> Vec<StreamChunk> {
        let mut chunks = Vec::new();
        self.into_stream_chunks_helper(cx, &mut chunks);
        chunks
    }

    fn into_stream_chunks_helper(
        self,
        cx: Scope,
        chunks: &mut Vec<StreamChunk>,
    ) {
        match self {
            View::Suspense(id, _) => {
                let id = id.to_string();
                if let Some((_, fragment)) = cx.take_pending_fragment(&id) {
                    chunks.push(StreamChunk::Async(fragment));
                }
            }
            View::Text(node) => chunks.push(StreamChunk::Sync(node.content)),
            View::Component(node) => {
                cfg_if! {
                  if #[cfg(debug_assertions)] {
                    let name = crate::ssr::to_kebab_case(&node.name);
                    chunks.push(StreamChunk::Sync(format!(r#"<!--hk={}|leptos-{name}-start-->"#, HydrationCtx::to_string(&node.id, false)).into()));
                    for child in node.children {
                        child.into_stream_chunks_helper(cx, chunks);
                    }
                    chunks.push(StreamChunk::Sync(format!(r#"<!--hk={}|leptos-{name}-end-->"#, HydrationCtx::to_string(&node.id, true)).into()));
                  } else {
                    for child in node.children {
                        child.into_stream_chunks_helper(cx, chunks);
                    }
                    chunks.push(StreamChunk::Sync(format!(r#"<!--hk={}-->"#, HydrationCtx::to_string(&node.id, true)).into()))
                  }
                }
            }
            View::Element(el) => {
                #[cfg(debug_assertions)]
                if let Some(id) = &el.view_marker {
                    chunks.push(StreamChunk::Sync(
                        format!("<!--leptos-view|{id}|open-->").into(),
                    ));
                }
                if let ElementChildren::Chunks(el_chunks) = el.children {
                    for chunk in el_chunks {
                        match chunk {
                            StringOrView::String(string) => {
                                chunks.push(StreamChunk::Sync(string))
                            }
                            StringOrView::View(view) => {
                                view().into_stream_chunks_helper(cx, chunks);
                            }
                        }
                    }
                } else {
                    let tag_name = el.name;

                    let mut inner_html = None;

                    let attrs = el
                        .attrs
                        .into_iter()
                        .filter_map(
                            |(name, value)| -> Option<Cow<'static, str>> {
                                if value.is_empty() {
                                    Some(format!(" {name}").into())
                                } else if name == "inner_html" {
                                    inner_html = Some(value);
                                    None
                                } else {
                                    Some(
                                        format!(
                    " {name}=\"{}\"",
                    html_escape::encode_double_quoted_attribute(&value)
                  )
                                        .into(),
                                    )
                                }
                            },
                        )
                        .join("");

                    if el.is_void {
                        chunks.push(StreamChunk::Sync(
                            format!("<{tag_name}{attrs}/>").into(),
                        ));
                    } else if let Some(inner_html) = inner_html {
                        chunks.push(StreamChunk::Sync(
                            format!(
                                "<{tag_name}{attrs}>{inner_html}</{tag_name}>"
                            )
                            .into(),
                        ));
                    } else {
                        chunks.push(StreamChunk::Sync(
                            format!("<{tag_name}{attrs}>").into(),
                        ));

                        match el.children {
                            ElementChildren::Empty => {}
                            ElementChildren::Children(children) => {
                                for child in children {
                                    child.into_stream_chunks_helper(cx, chunks);
                                }
                            }
                            ElementChildren::InnerHtml(inner_html) => {
                                chunks.push(StreamChunk::Sync(inner_html));
                            }
                            // handled above
                            ElementChildren::Chunks(_) => unreachable!(),
                        }

                        chunks.push(StreamChunk::Sync(
                            format!("</{tag_name}>").into(),
                        ));
                    }
                }
                #[cfg(debug_assertions)]
                if let Some(id) = &el.view_marker {
                    chunks.push(StreamChunk::Sync(
                        format!("<!--leptos-view|{id}|close-->").into(),
                    ));
                }
            }
            View::Transparent(_) => {}
            View::CoreComponent(node) => {
                let (id, name, wrap, content) = match node {
                    CoreComponent::Unit(u) => (
                        u.id.clone(),
                        "",
                        false,
                        Box::new(move |chunks: &mut Vec<StreamChunk>| {
                            #[cfg(debug_assertions)]
                            {
                                chunks.push(StreamChunk::Sync(
                                    format!(
                                        "<!--hk={}|leptos-unit-->",
                                        HydrationCtx::to_string(&u.id, true)
                                    )
                                    .into(),
                                ));
                            }

                            #[cfg(not(debug_assertions))]
                            chunks.push(StreamChunk::Sync(
                                format!(
                                    "<!--hk={}-->",
                                    HydrationCtx::to_string(&u.id, true)
                                )
                                .into(),
                            ));
                        })
                            as Box<dyn FnOnce(&mut Vec<StreamChunk>)>,
                    ),
                    CoreComponent::DynChild(node) => {
                        let child = node.child.take();
                        (
                            node.id,
                            "dyn-child",
                            true,
                            Box::new(move |chunks: &mut Vec<StreamChunk>| {
                                if let Some(child) = *child {
                                    // On debug builds, `DynChild` has two marker nodes,
                                    // so there is no way for the text to be merged with
                                    // surrounding text when the browser parses the HTML,
                                    // but in release, `DynChild` only has a trailing marker,
                                    // and the browser automatically merges the dynamic text
                                    // into one single node, so we need to artificially make the
                                    // browser create the dynamic text as it's own text node
                                    if let View::Text(t) = child {
                                        chunks.push(
                                            if !cfg!(debug_assertions) {
                                                StreamChunk::Sync(
                                                    format!("<!>{}", t.content)
                                                        .into(),
                                                )
                                            } else {
                                                StreamChunk::Sync(t.content)
                                            },
                                        );
                                    } else {
                                        child.into_stream_chunks_helper(
                                            cx, chunks,
                                        );
                                    }
                                }
                            })
                                as Box<dyn FnOnce(&mut Vec<StreamChunk>)>,
                        )
                    }
                    CoreComponent::Each(node) => {
                        let children = node.children.take();
                        (
                            node.id,
                            "each",
                            true,
                            Box::new(move |chunks: &mut Vec<StreamChunk>| {
                                for node in children.into_iter().flatten() {
                                    let id = node.id;

                                    #[cfg(debug_assertions)]
                                    {
                                        chunks.push(StreamChunk::Sync(
                                            format!(
                        "<!--hk={}|leptos-each-item-start-->",
                        HydrationCtx::to_string(&id, false)
                      )
                                            .into(),
                                        ));
                                        node.child.into_stream_chunks_helper(
                                            cx, chunks,
                                        );
                                        chunks.push(StreamChunk::Sync(
                                            format!(
                        "<!--hk={}|leptos-each-item-end-->",
                        HydrationCtx::to_string(&id, true)
                      )
                                            .into(),
                                        ));
                                    }
                                }
                            })
                                as Box<dyn FnOnce(&mut Vec<StreamChunk>)>,
                        )
                    }
                };

                if wrap {
                    cfg_if! {
                      if #[cfg(debug_assertions)] {
                        chunks.push(StreamChunk::Sync(format!("<!--hk={}|leptos-{name}-start-->", HydrationCtx::to_string(&id, false)).into()));
                        content(chunks);
                        chunks.push(StreamChunk::Sync(format!("<!--hk={}|leptos-{name}-end-->", HydrationCtx::to_string(&id, true)).into()));
                      } else {
                        let _ = name;
                        content(chunks);
                        chunks.push(StreamChunk::Sync(format!("<!--hk={}-->", HydrationCtx::to_string(&id, true)).into()))
                      }
                    }
                } else {
                    content(chunks);
                }
            }
        }
    }
}