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
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
use crate::{use_navigate, use_resolved_path, ToHref, Url};
use leptos::{html::form, *};
use serde::{de::DeserializeOwned, Serialize};
use std::{error::Error, rc::Rc};
use wasm_bindgen::{JsCast, UnwrapThrowExt};
use wasm_bindgen_futures::JsFuture;
use web_sys::RequestRedirect;

type OnFormData = Rc<dyn Fn(&web_sys::FormData)>;
type OnResponse = Rc<dyn Fn(&web_sys::Response)>;

/// An HTML [`form`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form) progressively
/// enhanced to use client-side routing.
#[cfg_attr(
    any(debug_assertions, feature = "ssr"),
    tracing::instrument(level = "trace", skip_all,)
)]
#[component]
pub fn Form<A>(
    cx: Scope,
    /// [`method`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form#attr-method)
    /// is the HTTP method to submit the form with (`get` or `post`).
    #[prop(optional)]
    method: Option<&'static str>,
    /// [`action`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form#attr-action)
    /// is the URL that processes the form submission. Takes a [String], [&str], or a reactive
    /// function that returns a [String].
    action: A,
    /// [`enctype`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form#attr-enctype)
    /// is the MIME type of the form submission if `method` is `post`.
    #[prop(optional)]
    enctype: Option<String>,
    /// A signal that will be incremented whenever the form is submitted with `post`. This can useful
    /// for reactively updating a [Resource] or another signal whenever the form has been submitted.
    #[prop(optional)]
    version: Option<RwSignal<usize>>,
    /// A signal that will be set if the form submission ends in an error.
    #[prop(optional)]
    error: Option<RwSignal<Option<Box<dyn Error>>>>,
    /// A callback will be called with the [FormData](web_sys::FormData) when the form is submitted.
    #[prop(optional)]
    on_form_data: Option<OnFormData>,
    /// Sets the `class` attribute on the underlying `<form>` tag, making it easier to style.
    #[prop(optional, into)]
    class: Option<AttributeValue>,
    /// A callback will be called with the [Response](web_sys::Response) the server sends in response
    /// to a form submission.
    #[prop(optional)]
    on_response: Option<OnResponse>,
    /// A [`NodeRef`] in which the `<form>` element should be stored.
    #[prop(optional)]
    node_ref: Option<NodeRef<html::Form>>,
    /// Arbitrary attributes to add to the `<form>`
    #[prop(optional, into)]
    attributes: Option<MaybeSignal<AdditionalAttributes>>,
    /// Component children; should include the HTML of the form elements.
    children: Children,
) -> impl IntoView
where
    A: ToHref + 'static,
{
    fn inner(
        cx: Scope,
        method: Option<&'static str>,
        action: Memo<Option<String>>,
        enctype: Option<String>,
        version: Option<RwSignal<usize>>,
        error: Option<RwSignal<Option<Box<dyn Error>>>>,
        on_form_data: Option<OnFormData>,
        on_response: Option<OnResponse>,
        class: Option<Attribute>,
        children: Children,
        node_ref: Option<NodeRef<html::Form>>,
        attributes: Option<MaybeSignal<AdditionalAttributes>>,
    ) -> HtmlElement<html::Form> {
        let action_version = version;
        let on_submit = move |ev: web_sys::SubmitEvent| {
            if ev.default_prevented() {
                return;
            }
            let navigate = use_navigate(cx);

            let (form, method, action, enctype) = extract_form_attributes(&ev);

            let form_data =
                web_sys::FormData::new_with_form(&form).unwrap_throw();
            if let Some(on_form_data) = on_form_data.clone() {
                on_form_data(&form_data);
            }
            let params =
                web_sys::UrlSearchParams::new_with_str_sequence_sequence(
                    &form_data,
                )
                .unwrap_throw();
            let action = use_resolved_path(cx, move || action.clone())
                .get()
                .unwrap_or_default();
            // POST
            if method == "post" {
                ev.prevent_default();
                ev.stop_propagation();

                let on_response = on_response.clone();
                spawn_local(async move {
                    let res = gloo_net::http::Request::post(&action)
                        .header("Accept", "application/json")
                        .header("Content-Type", &enctype)
                        .redirect(RequestRedirect::Follow)
                        .body(params)
                        .send()
                        .await;
                    match res {
                        Err(e) => {
                            error!("<Form/> error while POSTing: {e:#?}");
                            if let Some(error) = error {
                                error.set(Some(Box::new(e)));
                            }
                        }
                        Ok(resp) => {
                            if let Some(version) = action_version {
                                version.update(|n| *n += 1);
                            }
                            if let Some(error) = error {
                                error.set(None);
                            }
                            if let Some(on_response) = on_response.clone() {
                                on_response(resp.as_raw());
                            }
                            // Check all the logical 3xx responses that might
                            // get returned from a server function
                            if resp.redirected() {
                                let resp_url = &resp.url();
                                match Url::try_from(resp_url.as_str()) {
                                    Ok(url) => {
                                        request_animation_frame(move || {
                                            if let Err(e) = navigate(
                                                &format!(
                                                    "{}{}",
                                                    url.pathname, url.search,
                                                ),
                                                Default::default(),
                                            ) {
                                                warn!("{}", e);
                                            }
                                        });
                                    }
                                    Err(e) => warn!("{}", e),
                                }
                            }
                        }
                    }
                });
            }
            // otherwise, GET
            else {
                let params = params.to_string().as_string().unwrap_or_default();
                if navigate(&format!("{action}?{params}"), Default::default())
                    .is_ok()
                {
                    ev.prevent_default();
                    ev.stop_propagation();
                }
            }
        };

        let method = method.unwrap_or("get");

        let mut form = form(cx)
            .attr("method", method)
            .attr("action", move || action.get())
            .attr("enctype", enctype)
            .on(ev::submit, on_submit)
            .attr("class", class)
            .child(children(cx));
        if let Some(node_ref) = node_ref {
            form = form.node_ref(node_ref)
        };
        if let Some(attributes) = attributes {
            let attributes = attributes.get();
            for (attr_name, attr_value) in attributes.into_iter() {
                let attr_name = attr_name.to_owned();
                let attr_value = attr_value.to_owned();
                form = form.attr(attr_name, move || attr_value.get());
            }
        }
        form
    }

    let action = use_resolved_path(cx, move || action.to_href()());
    let class = class.map(|bx| bx.into_attribute_boxed(cx));
    inner(
        cx,
        method,
        action,
        enctype,
        version,
        error,
        on_form_data,
        on_response,
        class,
        children,
        node_ref,
        attributes,
    )
}

/// Automatically turns a server [Action](leptos_server::Action) into an HTML
/// [`form`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form)
/// progressively enhanced to use client-side routing.
///
/// ## Encoding
/// **Note:** `<ActionForm/>` only works with server functions that use the
/// default `Url` encoding or the `GetJSON` encoding, not with `CBOR` or other
/// encoding schemes. This is to ensure that `<ActionForm/>` works correctly
/// both before and after WASM has loaded.
#[cfg_attr(
    any(debug_assertions, feature = "ssr"),
    tracing::instrument(level = "trace", skip_all,)
)]
#[component]
pub fn ActionForm<I, O>(
    cx: Scope,
    /// The action from which to build the form. This should include a URL, which can be generated
    /// by default using [create_server_action](leptos_server::create_server_action) or added
    /// manually using [leptos_server::Action::using_server_fn].
    action: Action<I, Result<O, ServerFnError>>,
    /// Sets the `class` attribute on the underlying `<form>` tag, making it easier to style.
    #[prop(optional, into)]
    class: Option<AttributeValue>,
    /// A signal that will be set if the form submission ends in an error.
    #[prop(optional)]
    error: Option<RwSignal<Option<Box<dyn Error>>>>,
    /// A [`NodeRef`] in which the `<form>` element should be stored.
    #[prop(optional)]
    node_ref: Option<NodeRef<html::Form>>,
    /// Arbitrary attributes to add to the `<form>`
    #[prop(optional, into)]
    attributes: Option<MaybeSignal<AdditionalAttributes>>,
    /// Component children; should include the HTML of the form elements.
    children: Children,
) -> impl IntoView
where
    I: Clone + ServerFn + 'static,
    O: Clone + Serialize + DeserializeOwned + 'static,
{
    let action_url = if let Some(url) = action.url() {
        url
    } else {
        debug_warn!(
            "<ActionForm/> action needs a URL. Either use \
             create_server_action() or Action::using_server_fn()."
        );
        String::new()
    };
    let version = action.version();
    let value = action.value();
    let input = action.input();

    let on_form_data = Rc::new(move |form_data: &web_sys::FormData| {
        let data = I::from_form_data(form_data);
        match data {
            Ok(data) => {
                input.set(Some(data));
                action.set_pending(true);
            }
            Err(e) => error!("{e}"),
        }
    });

    let on_response = Rc::new(move |resp: &web_sys::Response| {
        let resp = resp.clone().expect("couldn't get Response");
        spawn_local(async move {
            let redirected = resp.redirected();

            if !redirected {
                let body = JsFuture::from(
                    resp.text().expect("couldn't get .text() from Response"),
                )
                .await;
                let status = resp.status();
                match body {
                    Ok(json) => {
                        let json = json
                            .as_string()
                            .expect("couldn't get String from JsString");
                        if (500..=599).contains(&status) {
                            match serde_json::from_str::<ServerFnError>(&json) {
                                Ok(res) => {
                                    value.try_set(Some(Err(res)));
                                    if let Some(error) = error {
                                        error.try_set(None);
                                    }
                                }
                                Err(e) => {
                                    value.try_set(Some(Err(
                                        ServerFnError::Deserialization(
                                            e.to_string(),
                                        ),
                                    )));
                                    if let Some(error) = error {
                                        error.try_set(Some(Box::new(e)));
                                    }
                                }
                            }
                        } else {
                            match serde_json::from_str::<O>(&json) {
                                Ok(res) => {
                                    value.try_set(Some(Ok(res)));
                                    if let Some(error) = error {
                                        error.try_set(None);
                                    }
                                }
                                Err(e) => {
                                    value.try_set(Some(Err(
                                        ServerFnError::Deserialization(
                                            e.to_string(),
                                        ),
                                    )));
                                    if let Some(error) = error {
                                        error.try_set(Some(Box::new(e)));
                                    }
                                }
                            }
                        }
                    }
                    Err(e) => {
                        error!("{e:?}");
                        if let Some(error) = error {
                            error.try_set(Some(Box::new(
                                ServerFnError::Request(
                                    e.as_string().unwrap_or_default(),
                                ),
                            )));
                        }
                    }
                };
            }
            input.try_set(None);
            action.set_pending(false);
        });
    });
    let class = class.map(|bx| bx.into_attribute_boxed(cx));
    let mut props = FormProps::builder()
        .action(action_url)
        .version(version)
        .on_form_data(on_form_data)
        .on_response(on_response)
        .method("post")
        .class(class)
        .children(children)
        .build();
    props.error = error;
    props.node_ref = node_ref;
    props.attributes = attributes;
    Form(cx, props)
}

/// Automatically turns a server [MultiAction](leptos_server::MultiAction) into an HTML
/// [`form`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form)
/// progressively enhanced to use client-side routing.
#[cfg_attr(
    any(debug_assertions, feature = "ssr"),
    tracing::instrument(level = "trace", skip_all,)
)]
#[component]
pub fn MultiActionForm<I, O>(
    cx: Scope,
    /// The action from which to build the form. This should include a URL, which can be generated
    /// by default using [create_server_action](leptos_server::create_server_action) or added
    /// manually using [leptos_server::Action::using_server_fn].
    action: MultiAction<I, Result<O, ServerFnError>>,
    /// Sets the `class` attribute on the underlying `<form>` tag, making it easier to style.
    #[prop(optional, into)]
    class: Option<AttributeValue>,
    /// A signal that will be set if the form submission ends in an error.
    #[prop(optional)]
    error: Option<RwSignal<Option<Box<dyn Error>>>>,
    /// A [`NodeRef`] in which the `<form>` element should be stored.
    #[prop(optional)]
    node_ref: Option<NodeRef<html::Form>>,
    /// Arbitrary attributes to add to the `<form>`
    #[prop(optional, into)]
    attributes: Option<MaybeSignal<AdditionalAttributes>>,
    /// Component children; should include the HTML of the form elements.
    children: Children,
) -> impl IntoView
where
    I: Clone + ServerFn + 'static,
    O: Clone + Serializable + 'static,
{
    let multi_action = action;
    let action = if let Some(url) = multi_action.url() {
        url
    } else {
        debug_warn!(
            "<MultiActionForm/> action needs a URL. Either use \
             create_server_action() or Action::using_server_fn()."
        );
        String::new()
    };

    let on_submit = move |ev: web_sys::SubmitEvent| {
        if ev.default_prevented() {
            return;
        }

        match I::from_event(&ev) {
            Err(e) => {
                error!("{e}");
                if let Some(error) = error {
                    error.set(Some(Box::new(e)));
                }
            }
            Ok(input) => {
                ev.prevent_default();
                ev.stop_propagation();
                multi_action.dispatch(input);
                if let Some(error) = error {
                    error.set(None);
                }
            }
        }
    };

    let class = class.map(|bx| bx.into_attribute_boxed(cx));
    let mut form = form(cx)
        .attr("method", "POST")
        .attr("action", action)
        .on(ev::submit, on_submit)
        .attr("class", class)
        .child(children(cx));
    if let Some(node_ref) = node_ref {
        form = form.node_ref(node_ref)
    };
    if let Some(attributes) = attributes {
        let attributes = attributes.get();
        for (attr_name, attr_value) in attributes.into_iter() {
            let attr_name = attr_name.to_owned();
            let attr_value = attr_value.to_owned();
            form = form.attr(attr_name, move || attr_value.get());
        }
    }
    form
}
#[cfg_attr(
    any(debug_assertions, feature = "ssr"),
    tracing::instrument(level = "trace", skip_all,)
)]
fn extract_form_attributes(
    ev: &web_sys::Event,
) -> (web_sys::HtmlFormElement, String, String, String) {
    let submitter = ev.unchecked_ref::<web_sys::SubmitEvent>().submitter();
    match &submitter {
        Some(el) => {
            if let Some(form) = el.dyn_ref::<web_sys::HtmlFormElement>() {
                (
                    form.clone(),
                    form.get_attribute("method")
                        .unwrap_or_else(|| "get".to_string())
                        .to_lowercase(),
                    form.get_attribute("action")
                        .unwrap_or_default()
                        .to_lowercase(),
                    form.get_attribute("enctype")
                        .unwrap_or_else(|| {
                            "application/x-www-form-urlencoded".to_string()
                        })
                        .to_lowercase(),
                )
            } else if let Some(input) =
                el.dyn_ref::<web_sys::HtmlInputElement>()
            {
                let form = ev
                    .target()
                    .unwrap()
                    .unchecked_into::<web_sys::HtmlFormElement>();
                (
                    form.clone(),
                    input.get_attribute("method").unwrap_or_else(|| {
                        form.get_attribute("method")
                            .unwrap_or_else(|| "get".to_string())
                            .to_lowercase()
                    }),
                    input.get_attribute("action").unwrap_or_else(|| {
                        form.get_attribute("action")
                            .unwrap_or_default()
                            .to_lowercase()
                    }),
                    input.get_attribute("enctype").unwrap_or_else(|| {
                        form.get_attribute("enctype")
                            .unwrap_or_else(|| {
                                "application/x-www-form-urlencoded".to_string()
                            })
                            .to_lowercase()
                    }),
                )
            } else if let Some(button) =
                el.dyn_ref::<web_sys::HtmlButtonElement>()
            {
                let form = ev
                    .target()
                    .unwrap()
                    .unchecked_into::<web_sys::HtmlFormElement>();
                (
                    form.clone(),
                    button.get_attribute("method").unwrap_or_else(|| {
                        form.get_attribute("method")
                            .unwrap_or_else(|| "get".to_string())
                            .to_lowercase()
                    }),
                    button.get_attribute("action").unwrap_or_else(|| {
                        form.get_attribute("action")
                            .unwrap_or_default()
                            .to_lowercase()
                    }),
                    button.get_attribute("enctype").unwrap_or_else(|| {
                        form.get_attribute("enctype")
                            .unwrap_or_else(|| {
                                "application/x-www-form-urlencoded".to_string()
                            })
                            .to_lowercase()
                    }),
                )
            } else {
                leptos_dom::debug_warn!(
                    "<Form/> cannot be submitted from a tag other than \
                     <form>, <input>, or <button>"
                );
                panic!()
            }
        }
        None => match ev.target() {
            None => {
                leptos_dom::debug_warn!(
                    "<Form/> SubmitEvent fired without a target."
                );
                panic!()
            }
            Some(form) => {
                let form = form.unchecked_into::<web_sys::HtmlFormElement>();
                (
                    form.clone(),
                    form.get_attribute("method")
                        .unwrap_or_else(|| "get".to_string()),
                    form.get_attribute("action").unwrap_or_default(),
                    form.get_attribute("enctype").unwrap_or_else(|| {
                        "application/x-www-form-urlencoded".to_string()
                    }),
                )
            }
        },
    }
}

/// Tries to deserialize a type from form data. This can be used for client-side
/// validation during form submission.
pub trait FromFormData
where
    Self: Sized + serde::de::DeserializeOwned,
{
    /// Tries to deserialize the data, given only the `submit` event.
    fn from_event(ev: &web_sys::Event) -> Result<Self, serde_qs::Error>;

    /// Tries to deserialize the data, given the actual form data.
    fn from_form_data(
        form_data: &web_sys::FormData,
    ) -> Result<Self, serde_qs::Error>;
}

impl<T> FromFormData for T
where
    T: serde::de::DeserializeOwned,
{
    #[cfg_attr(
        any(debug_assertions, feature = "ssr"),
        tracing::instrument(level = "trace", skip_all,)
    )]
    fn from_event(ev: &web_sys::Event) -> Result<Self, serde_qs::Error> {
        let (form, _, _, _) = extract_form_attributes(ev);

        let form_data = web_sys::FormData::new_with_form(&form).unwrap_throw();

        Self::from_form_data(&form_data)
    }
    #[cfg_attr(
        any(debug_assertions, feature = "ssr"),
        tracing::instrument(level = "trace", skip_all,)
    )]
    fn from_form_data(
        form_data: &web_sys::FormData,
    ) -> Result<Self, serde_qs::Error> {
        let data =
            web_sys::UrlSearchParams::new_with_str_sequence_sequence(form_data)
                .unwrap_throw();
        let data = data.to_string().as_string().unwrap_or_default();
        serde_qs::from_str::<Self>(&data)
    }
}