Skip to main content

laterite_admin/
form.rs

1//! Descriptor-driven create and edit forms.
2//!
3//! A [`FormConfig`] describes a table and its editable fields. Generic handlers
4//! render an empty form (new), a populated form (edit), and persist through a
5//! [`crate::persist::Persister`]: the descriptor-driven default (a parameterized
6//! insert/update over the form's columns), or a named handler for a custom write.
7//! A submission is checked by the framework validation engine
8//! ([`laterite_core::validation`]); a failure re-renders the form with per-field
9//! messages instead of writing.
10//!
11//! Field types resolve through the registry ([`crate::field`]); `text`,
12//! `textarea`, `select`, and `reference` ship built-in. Fields needing a typed
13//! stored value (a switch over a bool column, password hashing) arrive with the
14//! typed-save contract.
15//!
16//! The primary key is a `bigint` auto-increment column the database assigns, so
17//! create inserts only the descriptor's fields and never sets the id. An entity
18//! with other required columns that lack defaults (for example audit timestamps)
19//! is beyond this slice; those are filled by a later timestamp-aware widget.
20
21use std::collections::HashMap;
22use std::sync::Arc;
23
24use askama::Template;
25use axum::http::StatusCode;
26use axum::response::{IntoResponse, Redirect, Response};
27use laterite_core::query::{bind_values, build as to_sql, text_cast};
28use laterite_core::validation::{validate, FieldRules, Mode, Rule};
29use laterite_core::{
30    t, Actor, AnyRowExt, Db, ErrorBag, ModelListener, ModelListenerReg, Op, Record, Text,
31};
32use sea_query::{Alias, Expr, Query};
33use serde::{Deserialize, Serialize};
34
35use crate::field::{render_field, FieldCx, FieldValue, OverrideScope, ResolvedOptions, Surface};
36use crate::persist::{self, DefaultPersister, Persister, PersisterRegistry, SaveError};
37use crate::sql::valid_ident;
38use crate::{not_found, render, render_error, AdminState};
39
40/// One editable field: the column, its label, its field-type key (resolved
41/// through the field-type registry), typed options for that type, the validation
42/// rules it carries, and whether it holds translatable content. A serde
43/// descriptor, so it is authorable as data (later YAML) as well as by builder.
44#[derive(Debug, Clone)]
45#[non_exhaustive]
46pub struct FormField {
47    pub name: String,
48    /// The field's label, localized at render. Serde stays a plain string.
49    pub label: Text,
50    /// The field-type registry key (`text`, `textarea`, or a plugin's
51    /// `vendor.name`), resolved to behaviour at render time (see [`crate::field`]).
52    pub field_type: String,
53    /// The keys that belong to the field's type, as an object: in a file they
54    /// are written on the field itself, beside its own. Null when there are none.
55    pub options: serde_json::Value,
56    /// Validation rules run on submit (see [`laterite_core::validation`]).
57    pub rules: Vec<Rule>,
58    /// Marks a field whose value is translatable content. A reserved seam: the
59    /// framework stores the value verbatim; a content-translation plugin reads
60    /// the flag to manage per-locale values.
61    pub translatable: bool,
62    /// Help text shown beneath the control, localized at render.
63    pub help: Option<Text>,
64    /// What Enter does in this field: `submit` (the form's rule), `off`, or
65    /// `next` (moves to the next field).
66    pub enter: FieldEnter,
67    /// The share of the row the field takes, on a twelve-column grid.
68    pub span: Span,
69    /// Starts a new row, whatever room the current one has left.
70    pub break_row: bool,
71    /// Follows another field as it is typed, until this one is edited.
72    pub preset: Option<Preset>,
73    /// Submitted but never shown: a plain hidden input carrying its value. The
74    /// foreign key of a related record's form is one.
75    pub hidden: bool,
76    /// Changes when another field's state meets a condition.
77    pub trigger: Option<Trigger>,
78}
79
80/// How a preset shapes the text it copies.
81#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Serialize, Deserialize)]
82#[serde(rename_all = "lowercase")]
83pub enum PresetShape {
84    /// As typed.
85    Exact,
86    /// Lowercase words joined by hyphens: `hello-world`.
87    #[default]
88    Slug,
89    /// A slug with a leading slash: `/hello-world`.
90    Url,
91    /// A file name: spaces to hyphens, the rest kept.
92    File,
93}
94
95impl PresetShape {
96    /// The word the page carries, for the island.
97    pub fn as_str(self) -> &'static str {
98        match self {
99            PresetShape::Exact => "exact",
100            PresetShape::Slug => "slug",
101            PresetShape::Url => "url",
102            PresetShape::File => "file",
103        }
104    }
105}
106
107/// Fills a field from another as it is typed, until the field is edited.
108///
109/// In YAML, the followed field's name alone (`preset: title`, a slug), or a
110/// map: `preset: { field: title, type: url }`.
111#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
112pub struct Preset {
113    pub field: String,
114    pub shape: PresetShape,
115}
116
117impl Preset {
118    pub fn new(field: impl Into<String>, shape: PresetShape) -> Self {
119        Self {
120            field: field.into(),
121            shape,
122        }
123    }
124}
125
126impl<'de> Deserialize<'de> for Preset {
127    fn deserialize<D: serde::Deserializer<'de>>(de: D) -> Result<Self, D::Error> {
128        #[derive(Deserialize)]
129        #[serde(deny_unknown_fields)]
130        struct Full {
131            field: String,
132            #[serde(rename = "type", default)]
133            shape: PresetShape,
134        }
135        #[derive(Deserialize)]
136        #[serde(untagged)]
137        enum Raw {
138            Field(String),
139            Full(Full),
140        }
141        Ok(match Raw::deserialize(de)? {
142            Raw::Field(field) => Preset::new(field, PresetShape::Slug),
143            Raw::Full(full) => Preset::new(full.field, full.shape),
144        })
145    }
146}
147
148/// Changes a field when another field's state meets a condition.
149///
150/// ```yaml
151/// send_at:
152///   type: date
153///   trigger: { action: show, field: is_delayed, condition: checked }
154/// ```
155#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
156#[serde(deny_unknown_fields)]
157pub struct Trigger {
158    /// What happens when the condition holds: `show`, `hide`, `enable`,
159    /// `disable`, `empty`, `fill[value]`, or several joined by `|`.
160    pub action: String,
161    /// The field watched. `name[]` watches every value of a checklist.
162    pub field: String,
163    /// `checked`, `unchecked`, `value[x]`, `value[x][y]` (either), `value[]`
164    /// (empty), `value[*]` (anything), `value[foo*]` (a prefix).
165    pub condition: String,
166}
167
168impl Trigger {
169    pub fn new(
170        action: impl Into<String>,
171        field: impl Into<String>,
172        condition: impl Into<String>,
173    ) -> Self {
174        Self {
175            action: action.into(),
176            field: field.into(),
177            condition: condition.into(),
178        }
179    }
180
181    /// Refuses an action or condition the island does not know.
182    pub fn check(&self) -> Result<(), String> {
183        for action in self.action.split('|') {
184            let known = matches!(action, "show" | "hide" | "enable" | "disable" | "empty")
185                || (action.starts_with("fill[") && action.ends_with(']'));
186            if !known {
187                return Err(format!(
188                    "unknown trigger action `{action}`: show, hide, enable, disable, empty or fill[value]"
189                ));
190            }
191        }
192        let known = matches!(self.condition.as_str(), "checked" | "unchecked")
193            || (self.condition.starts_with("value[") && self.condition.ends_with(']'));
194        if !known {
195            return Err(format!(
196                "unknown trigger condition `{}`: checked, unchecked or value[..]",
197                self.condition
198            ));
199        }
200        Ok(())
201    }
202
203    /// The name of the field watched, without a `[]` suffix.
204    pub fn watched(&self) -> &str {
205        self.field.trim_end_matches("[]")
206    }
207}
208
209/// The attributes a field's wrapper carries for its preset and trigger, each
210/// led by a space, empty when it has neither.
211pub(crate) fn behaviour_attrs(field: &FormField) -> String {
212    fn escaped(text: &str) -> String {
213        text.replace('&', "&amp;")
214            .replace('<', "&lt;")
215            .replace('>', "&gt;")
216            .replace('"', "&quot;")
217    }
218    let mut attrs = String::new();
219    if let Some(preset) = &field.preset {
220        attrs.push_str(&format!(
221            r#" data-lat-preset="{}" data-lat-preset-type="{}""#,
222            escaped(&preset.field),
223            preset.shape.as_str()
224        ));
225    }
226    if let Some(trigger) = &field.trigger {
227        attrs.push_str(&format!(
228            r#" data-lat-trigger-action="{}" data-lat-trigger-field="{}" data-lat-trigger-condition="{}""#,
229            escaped(&trigger.action),
230            escaped(&trigger.field),
231            escaped(&trigger.condition)
232        ));
233    }
234    attrs
235}
236
237/// The share of a row a field takes, in twelfths. Written in YAML as a
238/// fraction (`1/2`, `1/3`, `2/3`, `1/4`, `3/4`), `full`, a count of columns
239/// (`1` to `12`), or the words `half`, `third`, `quarter`, `left`, `right` and
240/// `auto` (each a half). Fields flow left to right and wrap when a row is full.
241#[derive(Debug, Clone, Copy, PartialEq, Eq)]
242pub struct Span(u8);
243
244impl Span {
245    /// The whole row.
246    pub const FULL: Span = Span(12);
247
248    /// `columns` twelfths of the row, clamped to 1 to 12.
249    pub fn columns(columns: u8) -> Self {
250        Span(columns.clamp(1, 12))
251    }
252
253    /// The twelfths this span covers.
254    pub fn width(self) -> u8 {
255        self.0
256    }
257
258    /// Reads the YAML spellings.
259    pub fn parse(text: &str) -> Result<Self, String> {
260        let columns = match text.trim() {
261            "full" | "12/12" => 12,
262            "1/2" | "half" | "left" | "right" | "auto" => 6,
263            "1/3" | "third" => 4,
264            "2/3" => 8,
265            "1/4" | "quarter" => 3,
266            "3/4" => 9,
267            other => match other.parse::<u8>() {
268                Ok(n) if (1..=12).contains(&n) => n,
269                _ => {
270                    return Err(format!(
271                        "unknown span `{other}`, expected full, 1/2, 1/3, 2/3, 1/4, 3/4 or 1 to 12"
272                    ))
273                }
274            },
275        };
276        Ok(Span(columns))
277    }
278
279    /// The CSS class the field wrapper carries; none for a full row.
280    fn class(self) -> String {
281        if self.0 == 12 {
282            String::new()
283        } else {
284            format!(" lat-field--{}", self.0)
285        }
286    }
287}
288
289impl Default for Span {
290    fn default() -> Self {
291        Span::FULL
292    }
293}
294
295impl Serialize for Span {
296    fn serialize<S: serde::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
297        match self.0 {
298            12 => serializer.serialize_str("full"),
299            6 => serializer.serialize_str("1/2"),
300            4 => serializer.serialize_str("1/3"),
301            8 => serializer.serialize_str("2/3"),
302            3 => serializer.serialize_str("1/4"),
303            9 => serializer.serialize_str("3/4"),
304            n => serializer.serialize_u8(n),
305        }
306    }
307}
308
309impl<'de> Deserialize<'de> for Span {
310    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
311        #[derive(Deserialize)]
312        #[serde(untagged)]
313        enum Raw {
314            Columns(u8),
315            Text(String),
316        }
317        match Raw::deserialize(deserializer)? {
318            Raw::Columns(n) if (1..=12).contains(&n) => Ok(Span(n)),
319            Raw::Columns(n) => Err(serde::de::Error::custom(format!(
320                "unknown span `{n}`, expected 1 to 12"
321            ))),
322            Raw::Text(text) => Span::parse(&text).map_err(serde::de::Error::custom),
323        }
324    }
325}
326
327/// The wrapper classes a field's layout adds: its span, and a row break.
328pub(crate) fn layout_classes(span: Span, break_row: bool) -> String {
329    let mut classes = span.class();
330    if break_row {
331        classes.push_str(" lat-field--break");
332    }
333    classes
334}
335
336/// What Enter does in a form's single-line fields.
337#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Serialize, Deserialize)]
338#[serde(rename_all = "lowercase")]
339pub enum EnterPolicy {
340    /// Submits the form. Cmd/Ctrl+Enter submits from a textarea as well.
341    #[default]
342    Submit,
343    /// Enter never submits; Cmd/Ctrl+Enter still does.
344    Off,
345}
346
347/// Where the cursor goes when a form opens.
348#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Serialize, Deserialize)]
349#[serde(rename_all = "lowercase")]
350pub enum FormFocus {
351    /// A new record opens with the cursor in its first field. A refused save
352    /// comes back with the cursor in the first field it refused.
353    #[default]
354    Auto,
355    /// The cursor is left where the browser puts it.
356    Off,
357}
358
359/// What Enter does in one field, over the form's [`EnterPolicy`].
360#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Serialize, Deserialize)]
361#[serde(rename_all = "lowercase")]
362pub enum FieldEnter {
363    /// The form's rule.
364    #[default]
365    Submit,
366    /// Nothing.
367    Off,
368    /// Focus moves to the next field.
369    Next,
370}
371
372impl FieldEnter {
373    /// The `data-lat-enter` value the field wrapper carries; empty for the
374    /// form's rule.
375    fn attribute(self) -> &'static str {
376        match self {
377            FieldEnter::Submit => "",
378            FieldEnter::Off => "off",
379            FieldEnter::Next => "next",
380        }
381    }
382}
383
384impl Default for FormConfig {
385    /// Everything a descriptor file leaves to the resource level: the entity,
386    /// the path and the id column are filled in when the file is read.
387    fn default() -> Self {
388        Self {
389            entity: String::new(),
390            title: Text::new(""),
391            base_path: String::new(),
392            id_field: "id".to_string(),
393            fields: Vec::new(),
394            enter: EnterPolicy::default(),
395            confirm_leave: true,
396            focus: FormFocus::default(),
397            persist: None,
398            timestamps: false,
399            done_path: None,
400        }
401    }
402}
403
404impl Default for FormField {
405    /// A text field, named by the key it is written under.
406    fn default() -> Self {
407        Self::of("", Text::new(""), "text")
408    }
409}
410
411impl<'de> Deserialize<'de> for FormField {
412    fn deserialize<D: serde::Deserializer<'de>>(de: D) -> Result<Self, D::Error> {
413        struct Entry;
414        impl<'de> serde::de::Visitor<'de> for Entry {
415            type Value = FormField;
416
417            fn expecting(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
418                f.write_str("a field: its own keys and its type's")
419            }
420
421            fn visit_map<A: serde::de::MapAccess<'de>>(
422                self,
423                map: A,
424            ) -> Result<FormField, A::Error> {
425                let mut field = FormField::default();
426                let theirs = crate::keyed::split_entry(map, |key, map| {
427                    match key {
428                        "name" => field.name = map.next_value()?,
429                        "label" => field.label = map.next_value()?,
430                        "type" => field.field_type = map.next_value()?,
431                        "rules" => field.rules = map.next_value()?,
432                        "translatable" => field.translatable = map.next_value()?,
433                        "help" => field.help = map.next_value()?,
434                        "enter" => field.enter = map.next_value()?,
435                        "span" => field.span = map.next_value()?,
436                        "break" => field.break_row = map.next_value()?,
437                        "preset" => field.preset = map.next_value()?,
438                        "trigger" => field.trigger = map.next_value()?,
439                        "hidden" => field.hidden = map.next_value()?,
440                        _ => return Ok(false),
441                    }
442                    Ok(true)
443                })?;
444                field.options = theirs;
445                if let Some(trigger) = &field.trigger {
446                    trigger.check().map_err(serde::de::Error::custom)?;
447                }
448                Ok(field)
449            }
450
451            /// A key written bare (`title:`) is a field with every default.
452            fn visit_unit<E: serde::de::Error>(self) -> Result<FormField, E> {
453                Ok(FormField::default())
454            }
455        }
456        de.deserialize_map(Entry)
457    }
458}
459
460impl Serialize for FormField {
461    fn serialize<S: serde::Serializer>(&self, ser: S) -> Result<S::Ok, S::Error> {
462        use serde::ser::SerializeMap;
463        let mut map = ser.serialize_map(None)?;
464        map.serialize_entry("name", &self.name)?;
465        map.serialize_entry("label", &self.label)?;
466        map.serialize_entry("type", &self.field_type)?;
467        map.serialize_entry("rules", &self.rules)?;
468        map.serialize_entry("translatable", &self.translatable)?;
469        map.serialize_entry("help", &self.help)?;
470        map.serialize_entry("enter", &self.enter)?;
471        map.serialize_entry("span", &self.span)?;
472        map.serialize_entry("break", &self.break_row)?;
473        if let Some(preset) = &self.preset {
474            map.serialize_entry("preset", preset)?;
475        }
476        if self.hidden {
477            map.serialize_entry("hidden", &true)?;
478        }
479        if let Some(trigger) = &self.trigger {
480            map.serialize_entry("trigger", trigger)?;
481        }
482        crate::keyed::serialize_theirs(&mut map, &self.options)?;
483        map.end()
484    }
485}
486
487impl crate::keyed::Keyed for FormField {
488    fn key(&self) -> &str {
489        &self.name
490    }
491    fn set_key(&mut self, key: String) {
492        self.name = key;
493    }
494}
495
496impl FormField {
497    /// A field of a registered type by key.
498    pub fn of(name: &str, label: impl Into<Text>, field_type: &str) -> Self {
499        Self {
500            name: name.to_string(),
501            label: label.into(),
502            field_type: field_type.to_string(),
503            options: serde_json::Value::Null,
504            rules: Vec::new(),
505            translatable: false,
506            help: None,
507            enter: FieldEnter::default(),
508            span: Span::default(),
509            break_row: false,
510            preset: None,
511            trigger: None,
512            hidden: false,
513        }
514    }
515
516    /// Follows `field` as it is typed, shaped as `shape`, until this field is
517    /// edited.
518    pub fn preset(mut self, field: &str, shape: PresetShape) -> Self {
519        self.preset = Some(Preset::new(field, shape));
520        self
521    }
522
523    /// Changes when `trigger`'s condition holds on the field it watches.
524    pub fn trigger(mut self, trigger: Trigger) -> Self {
525        self.trigger = Some(trigger);
526        self
527    }
528
529    pub fn text(name: &str, label: impl Into<Text>) -> Self {
530        Self::of(name, label, "text")
531    }
532
533    pub fn textarea(name: &str, label: impl Into<Text>) -> Self {
534        Self::of(name, label, "textarea")
535    }
536
537    /// A reference field: a picker over a registered picker source (a `vendor.name`
538    /// key), which the field searches and resolves against. Builds the `source`
539    /// option so a descriptor needs no raw JSON.
540    pub fn reference(name: &str, label: impl Into<Text>, source: &str) -> Self {
541        Self::of(name, label, "reference").options(serde_json::json!({ "source": source }))
542    }
543
544    /// A dropdown over a fixed set of `(value, label)` choices.
545    pub fn select(name: &str, label: impl Into<Text>, options: Vec<(&str, &str)>) -> Self {
546        Self::of(name, label, "select").options(Self::choices(options))
547    }
548
549    /// The same choices rendered as radio buttons.
550    pub fn radio(name: &str, label: impl Into<Text>, options: Vec<(&str, &str)>) -> Self {
551        Self::of(name, label, "radio").options(Self::choices(options))
552    }
553
554    /// A checkbox over a boolean column.
555    pub fn switch(name: &str, label: impl Into<Text>) -> Self {
556        Self::of(name, label, "switch")
557    }
558
559    /// A calendar date, stored as `YYYY-MM-DD`.
560    pub fn date(name: &str, label: impl Into<Text>) -> Self {
561        Self::of(name, label, "date")
562    }
563
564    /// A password: hashed on save, never rendered back, and left alone when the
565    /// field is submitted blank on an edit.
566    pub fn password(name: &str, label: impl Into<Text>) -> Self {
567        Self::of(name, label, "password")
568    }
569
570    /// A list of rows, each holding `fields`, stored as an array of objects.
571    pub fn repeater(name: &str, label: impl Into<Text>, fields: Vec<FormField>) -> Self {
572        Self::of(name, label, "repeater").options(serde_json::json!({ "fields": fields }))
573    }
574
575    /// A repeater whose rows collapse to the line that names them, opening one
576    /// at a time. `summary_field` names the sub-field that titles a row; unset,
577    /// the first one does.
578    ///
579    /// Use it when a row holds more than one or two fields: rendered inline
580    /// those become columns, and a row of four is already unreadable. A single
581    /// narrow column is better left inline, where collapsing would hide the one
582    /// thing worth seeing.
583    pub fn repeater_list(
584        name: &str,
585        label: impl Into<Text>,
586        fields: Vec<FormField>,
587        summary_field: Option<&str>,
588    ) -> Self {
589        Self::of(name, label, "repeater").options(serde_json::json!({
590            "fields": fields,
591            "display": "list",
592            "summary_field": summary_field,
593        }))
594    }
595
596    /// The options blob the choice-shaped types read.
597    fn choices(options: Vec<(&str, &str)>) -> serde_json::Value {
598        let options: Vec<serde_json::Value> = options
599            .into_iter()
600            .map(|(value, label)| serde_json::json!({ "value": value, "label": label }))
601            .collect();
602        serde_json::json!({ "options": options })
603    }
604
605    /// Sets the field type's typed options (the type validates them at render).
606    pub fn options(mut self, options: serde_json::Value) -> Self {
607        self.options = options;
608        self
609    }
610
611    /// Requires a non-empty value in every mode.
612    pub fn required(mut self) -> Self {
613        self.rules.push(Rule::Required);
614        self
615    }
616
617    /// Requires a non-empty value in one mode only (for example a password set on
618    /// create but left unchanged on edit).
619    pub fn required_on(mut self, mode: Mode) -> Self {
620        self.rules.push(Rule::RequiredOn(mode));
621        self
622    }
623
624    /// Requires the value to be unique in this field's column (a DB probe that
625    /// ignores the edited row on update).
626    pub fn unique(mut self) -> Self {
627        self.rules.push(Rule::Unique);
628        self
629    }
630
631    /// Caps the value's length.
632    pub fn max_length(mut self, n: usize) -> Self {
633        self.rules.push(Rule::MaxLength(n));
634        self
635    }
636
637    /// Requires at least `n` characters when the value is non-empty.
638    pub fn min_length(mut self, n: usize) -> Self {
639        self.rules.push(Rule::MinLength(n));
640        self
641    }
642
643    /// Requires a syntactically valid email address.
644    pub fn email(mut self) -> Self {
645        self.rules.push(Rule::Email);
646        self
647    }
648
649    /// Marks this field as translatable content (see [`FormField::translatable`]).
650    pub fn translatable(mut self) -> Self {
651        self.translatable = true;
652        self
653    }
654
655    /// Help text shown beneath the control.
656    pub fn help(mut self, text: impl Into<Text>) -> Self {
657        self.help = Some(text.into());
658        self
659    }
660
661    /// The share of the row this field takes.
662    pub fn span(mut self, span: Span) -> Self {
663        self.span = span;
664        self
665    }
666
667    /// Starts a new row.
668    pub fn break_row(mut self) -> Self {
669        self.break_row = true;
670        self
671    }
672}
673
674/// A form descriptor: which table, its editable fields, the id column, and the
675/// base path the form lives under (`{base_path}/new`, `{base_path}/{id}/edit`).
676///
677/// Built with [`FormConfig::new`] plus its builder methods. Non-exhaustive so the
678/// framework can learn something new about a form after 1.0 without a major bump.
679#[derive(Debug, Clone, Serialize, Deserialize)]
680#[serde(deny_unknown_fields, default)]
681#[non_exhaustive]
682pub struct FormConfig {
683    pub entity: String,
684    /// The screen title, localized at render. Serde stays a plain string.
685    pub title: Text,
686    pub base_path: String,
687    pub id_field: String,
688    #[serde(
689        deserialize_with = "crate::keyed::deserialize",
690        serialize_with = "crate::keyed::serialize"
691    )]
692    pub fields: Vec<FormField>,
693    /// What Enter does in the form's single-line fields. Default `submit`.
694    #[serde(default)]
695    pub enter: EnterPolicy,
696    /// Ask before leaving the form with changes unsaved. Default `true`.
697    pub confirm_leave: bool,
698    /// Where the cursor goes when the form opens. Default `auto`.
699    pub focus: FormFocus,
700    /// The registered persister that writes this form (a dotted `vendor.name`),
701    /// or `None` for the built-in descriptor insert/update. See [`crate::persist`].
702    pub persist: Option<String>,
703    /// Stamp `created_at` and `updated_at` on write. Opt in per form, because
704    /// the columns have to exist on this entity's table.
705    #[serde(default)]
706    pub timestamps: bool,
707    /// Where a save and a cancel return to, when it is not the list under
708    /// `base_path`: a related record's form returns to its parent. Set by the
709    /// router, never by a descriptor.
710    #[serde(skip)]
711    pub(crate) done_path: Option<String>,
712}
713
714impl FormConfig {
715    /// A form over `entity`, mounted under `base_path`, keyed by `id_field`.
716    ///
717    /// The four arguments are the ones with no sensible default; everything else
718    /// is opt-in through a builder method, so a later field costs nothing.
719    pub fn new(
720        entity: impl Into<String>,
721        title: impl Into<Text>,
722        base_path: impl Into<String>,
723        id_field: impl Into<String>,
724        fields: Vec<FormField>,
725    ) -> Self {
726        Self {
727            enter: Default::default(),
728            confirm_leave: true,
729            focus: FormFocus::default(),
730            entity: entity.into(),
731            title: title.into(),
732            base_path: base_path.into(),
733            id_field: id_field.into(),
734            fields,
735            persist: None,
736            timestamps: false,
737            done_path: None,
738        }
739    }
740
741    /// Writes this form through a registered persister instead of the built-in
742    /// descriptor insert/update.
743    pub fn persist(mut self, name: impl Into<String>) -> Self {
744        self.persist = Some(name.into());
745        self
746    }
747
748    /// Whether leaving the form with changes unsaved asks first. Default `true`.
749    pub fn confirm_leave(mut self, ask: bool) -> Self {
750        self.confirm_leave = ask;
751        self
752    }
753
754    /// Where the cursor goes when the form opens.
755    pub fn focus(mut self, focus: FormFocus) -> Self {
756        self.focus = focus;
757        self
758    }
759
760    /// Stamps `created_at` and `updated_at` on write. Opt in, because the
761    /// columns have to exist on this entity's table.
762    pub fn timestamps(mut self) -> Self {
763        self.timestamps = true;
764        self
765    }
766
767    fn idents_valid(&self) -> bool {
768        valid_ident(&self.entity)
769            && valid_ident(&self.id_field)
770            && self.fields.iter().all(|f| valid_ident(&f.name))
771    }
772}
773
774/// A [`FormConfig`] with each field's options resolved once, at router build.
775/// Handlers carry this so option resolution and intrinsic-rule merging happen a
776/// single time (not per render), and a malformed option or unregistered type
777/// aborts boot rather than degrading silently to plain text.
778#[derive(Clone)]
779pub(crate) struct PreparedForm {
780    pub(crate) config: FormConfig,
781    /// Parallel to `config.fields`.
782    fields: Vec<PreparedField>,
783    /// The write handler: the named persister, or the built-in default.
784    persister: Arc<dyn Persister>,
785    /// Listeners for this form's entity, in registration order.
786    listeners: Vec<Arc<dyn ModelListener>>,
787    /// Offer "Save and continue editing" beside Save: a resource with relation
788    /// sections wants to land on the edit page, where the sections are.
789    pub(crate) stay: bool,
790}
791
792/// One field's boot-resolved state: its typed options and its merged rules (the
793/// type's intrinsic rules ahead of the descriptor's own).
794#[derive(Clone)]
795struct PreparedField {
796    /// Resolved once at boot, so the save and load hooks need no lookup.
797    field_type: Arc<dyn crate::field::FieldType>,
798    opts: ResolvedOptions,
799    rules: Vec<Rule>,
800}
801
802impl PreparedForm {
803    /// The write handler this form resolved to.
804    pub(crate) fn persister(&self) -> Arc<dyn Persister> {
805        self.persister.clone()
806    }
807
808    /// Whether the form declares `field`.
809    pub(crate) fn has_field(&self, field: &str) -> bool {
810        self.config.fields.iter().any(|f| f.name == field)
811    }
812
813    /// The widget assets `field`'s type declares.
814    pub(crate) fn field_assets(&self, field: &str) -> Vec<&'static str> {
815        self.config
816            .fields
817            .iter()
818            .zip(&self.fields)
819            .find(|(f, _)| f.name == field)
820            .map(|(_, pf)| pf.field_type.assets(&pf.opts))
821            .unwrap_or_default()
822    }
823
824    /// One field's bare control holding `value`, as the form would render it,
825    /// for a place outside the form such as an editable cell. `None` when the
826    /// form has no such field.
827    pub(crate) fn control(
828        &self,
829        state: &AdminState,
830        field: &str,
831        dom_id: &str,
832        value: &str,
833        shell: &crate::Shell,
834    ) -> Option<String> {
835        let (f, pf) = self
836            .config
837            .fields
838            .iter()
839            .zip(&self.fields)
840            .find(|(f, _)| f.name == field)?;
841        let value = FieldValue::Text(value.to_string());
842        let label = shell.tt(&f.label);
843        let cx = FieldCx {
844            name: &f.name,
845            id: dom_id,
846            label: &label,
847            value: &value,
848            required: has_required(&pf.rules),
849            max_length: max_length(&pf.rules),
850            opts: &pf.opts,
851            base: &shell.base,
852            i18n: shell.i18n(),
853        };
854        let ft = state.field_types.get(&f.field_type)?;
855        let scope = OverrideScope {
856            surface: Surface::Field,
857            view_key: &f.field_type,
858            resource: Some(&self.config.base_path),
859            field: Some(&f.name),
860        };
861        Some(render_field(ft.as_ref(), state.overrides.as_ref(), &scope, &cx).into_string())
862    }
863
864    /// Resolves every field against the registry. Returns the offending field
865    /// and reason (for a boot abort) when a type is unregistered or rejects its
866    /// options.
867    pub(crate) fn prepare(
868        config: FormConfig,
869        field_types: &crate::field::FieldRegistry,
870        persisters: &PersisterRegistry,
871        listeners: &[ModelListenerReg],
872    ) -> Result<Self, String> {
873        let mut fields = Vec::with_capacity(config.fields.len());
874        for f in &config.fields {
875            let names = || config.fields.iter().map(|other| other.name.as_str());
876            if let Some(preset) = &f.preset {
877                if !names().any(|n| n == preset.field) {
878                    return Err(format!(
879                        "field `{}` presets from `{}`, which is not in this form",
880                        f.name, preset.field
881                    ));
882                }
883            }
884            if let Some(trigger) = &f.trigger {
885                trigger
886                    .check()
887                    .map_err(|e| format!("field `{}`: {e}", f.name))?;
888                if !names().any(|n| n == trigger.watched()) {
889                    return Err(format!(
890                        "field `{}` watches `{}`, which is not in this form",
891                        f.name,
892                        trigger.watched()
893                    ));
894                }
895            }
896            let ft = field_types.get(&f.field_type).ok_or_else(|| {
897                format!(
898                    "field `{}` uses unregistered type `{}`",
899                    f.name, f.field_type
900                )
901            })?;
902            crate::field::check_field_keys(f, ft.as_ref())
903                .map_err(|e| format!("field `{}` (`{}`): {e}", f.name, f.field_type))?;
904            let opts = ft
905                .resolve_options(&f.options, field_types)
906                .map_err(|e| format!("field `{}` (`{}`): {e}", f.name, f.field_type))?;
907            let mut rules = ft.intrinsic_rules(&opts);
908            rules.extend(f.rules.clone());
909            fields.push(PreparedField {
910                field_type: ft.clone(),
911                opts,
912                rules,
913            });
914        }
915        let persister: Arc<dyn Persister> = match &config.persist {
916            Some(key) => persisters
917                .get(key)
918                .cloned()
919                .ok_or_else(|| format!("form names unregistered persister `{key}`"))?,
920            None => Arc::new(DefaultPersister::from_config(&config)),
921        };
922        // The framework's own listeners run first, so a contributed one can see
923        // or override what they set.
924        let mut resolved: Vec<Arc<dyn ModelListener>> = Vec::new();
925        if config.timestamps {
926            resolved.push(Arc::new(laterite_core::Timestamps));
927        }
928        resolved.extend(
929            listeners
930                .iter()
931                .filter(|reg| reg.matches(&config.entity))
932                .map(|reg| reg.listener.clone()),
933        );
934        let listeners = resolved;
935        Ok(Self {
936            config,
937            fields,
938            persister,
939            listeners,
940            stay: false,
941        })
942    }
943}
944
945/// The submission as a record, carrying only the fields the descriptor declares.
946/// A request cannot introduce an attribute this way, so the persister may widen
947/// its write to whatever the record holds; only registered listeners add keys.
948///
949/// Each value passes through its field type, which decides what gets stored and
950/// may leave the attribute out entirely (a blank password on an edit).
951fn declared_record(
952    form: &PreparedForm,
953    data: &HashMap<String, String>,
954    mode: Mode,
955) -> Result<Record, String> {
956    let mut rec = Record::new(&form.config.entity);
957    for (field, prepared) in form.config.fields.iter().zip(&form.fields) {
958        let submitted = crate::field::SubmittedField::new(&field.name, data);
959        if let Some(value) = prepared
960            .field_type
961            .to_attr(&submitted, &prepared.opts, mode)?
962        {
963            rec.set(field.name.clone(), value);
964        }
965    }
966    Ok(rec)
967}
968
969/// The submission with every field present under its own name.
970///
971/// A field of several controls submits keys of its own and none under its name.
972/// Its type gathers them into one value, so the rules see the field and a
973/// refused save is re-rendered from what the operator entered. A key already
974/// present is left as submitted.
975pub(crate) fn gathered(
976    form: &PreparedForm,
977    mut data: HashMap<String, String>,
978) -> HashMap<String, String> {
979    for (field, prepared) in form.config.fields.iter().zip(&form.fields) {
980        if data.contains_key(&field.name) {
981            continue;
982        }
983        let value = prepared.field_type.submitted(
984            &crate::field::SubmittedField::new(&field.name, &data),
985            &prepared.opts,
986        );
987        if let Some(value) = value {
988            data.insert(field.name.clone(), value);
989        }
990    }
991    data
992}
993
994/// The merged validation rules for every field, in order.
995fn merged_field_rules(form: &PreparedForm) -> Vec<FieldRules> {
996    form.config
997        .fields
998        .iter()
999        .zip(&form.fields)
1000        // The rules carry the label's source string; the validation message re-wraps
1001        // it as a nested Text, so it localizes at render like any other label.
1002        .map(|(f, pf)| FieldRules::new(f.name.clone(), f.label.source(), pf.rules.clone()))
1003        .collect()
1004}
1005
1006/// The write a submit and a [`FormHandle`] share: `data` (already gathered)
1007/// validated against the merged rules, shaped into the declared record and saved
1008/// through the listeners and the persister. `id` names the row an edit updates;
1009/// `None` creates. Returns the record as saved, its id set on a create.
1010pub(crate) async fn write(
1011    db: &Db,
1012    form: &PreparedForm,
1013    data: &HashMap<String, String>,
1014    id: Option<&str>,
1015    actor: &Actor,
1016) -> Result<Record, SaveError> {
1017    let (mut rec, op) = prepare(db, form, data, id).await?;
1018    persist::save(
1019        persist::SaveRequest {
1020            db,
1021            listeners: &form.listeners,
1022            persister: form.persister.as_ref(),
1023            actor,
1024            op,
1025            id,
1026        },
1027        &mut rec,
1028    )
1029    .await?;
1030    Ok(rec)
1031}
1032
1033/// The write up to the point of writing: the data validated and shaped into
1034/// the record, with the operation it would be. What a check runs, and what a
1035/// write runs first.
1036async fn prepare(
1037    db: &Db,
1038    form: &PreparedForm,
1039    data: &HashMap<String, String>,
1040    id: Option<&str>,
1041) -> Result<(Record, Op), SaveError> {
1042    if !form.config.idents_valid() {
1043        return Err(SaveError::Failed(format!(
1044            "form `{}` names an invalid entity or field identifier",
1045            form.config.entity
1046        )));
1047    }
1048    let (mode, op) = match id {
1049        None => (Mode::Create, Op::Create),
1050        Some(_) => (Mode::Update, Op::Update),
1051    };
1052    let bag = validate(
1053        db,
1054        &form.config.entity,
1055        &form.config.id_field,
1056        &merged_field_rules(form),
1057        data,
1058        mode,
1059        id,
1060    )
1061    .await
1062    .map_err(|e| SaveError::Failed(e.to_string()))?;
1063    if !bag.is_empty() {
1064        return Err(SaveError::Invalid(bag));
1065    }
1066    let mut rec = declared_record(form, data, mode).map_err(|e| {
1067        tracing::error!(entity = %form.config.entity, error = %e, "preparing the write failed");
1068        SaveError::Failed(e)
1069    })?;
1070    if let Some(n) = id.and_then(|id| id.parse::<i64>().ok()) {
1071        rec.set_id(n);
1072    }
1073    Ok((rec, op))
1074}
1075
1076/// The forms the resources mounted, keyed by each resource's path as its
1077/// descriptor declares it, relative to the admin root.
1078pub(crate) type Forms = Arc<HashMap<String, Arc<PreparedForm>>>;
1079
1080/// A resource's form, written through from code.
1081///
1082/// Runs what the form's own submit runs, with no request in hand: the values
1083/// are validated against the form's rules, shaped by its field types and saved
1084/// through its listeners and persister, so an importer or a sync writes exactly
1085/// what an operator could have typed, audited the same way. A screen reaches one
1086/// through [`crate::routes::RouteCtx::form`].
1087#[derive(Clone)]
1088pub struct FormHandle {
1089    db: Db,
1090    form: Arc<PreparedForm>,
1091}
1092
1093impl FormHandle {
1094    pub(crate) fn new(db: Db, form: Arc<PreparedForm>) -> Self {
1095        Self { db, form }
1096    }
1097
1098    /// The table the form writes.
1099    pub fn entity(&self) -> &str {
1100        &self.form.config.entity
1101    }
1102
1103    /// The primary key column.
1104    pub fn id_field(&self) -> &str {
1105        &self.form.config.id_field
1106    }
1107
1108    /// The fields the form declares, in order. `data` is keyed by their names.
1109    pub fn fields(&self) -> &[FormField] {
1110        &self.form.config.fields
1111    }
1112
1113    /// Validates `data` as a submission and saves a new record, returning its id.
1114    ///
1115    /// `data` holds each field's value under the field's name, as the form's
1116    /// control submits it; a field left out is blank. `Invalid` carries the
1117    /// per-field messages a refused submit would show.
1118    pub async fn create(
1119        &self,
1120        data: HashMap<String, String>,
1121        actor: &Actor,
1122    ) -> Result<i64, SaveError> {
1123        let data = gathered(&self.form, data);
1124        let rec = write(&self.db, &self.form, &data, None, actor).await?;
1125        rec.id()
1126            .ok_or_else(|| SaveError::Failed("the persister returned no id".to_string()))
1127    }
1128
1129    /// The record `id` as the edit form shows it: each stored value back through
1130    /// its field type, keyed by field name. `None` when no record has that id.
1131    /// Lay a partial `data` over it before [`update`](Self::update) to change
1132    /// some fields and keep the rest.
1133    pub async fn load(&self, id: i64) -> Result<Option<HashMap<String, String>>, SaveError> {
1134        load_values(&self.db, &self.form, &id.to_string())
1135            .await
1136            .map_err(|e| SaveError::Failed(e.to_string()))
1137    }
1138
1139    /// What [`create`](Self::create) or [`update`](Self::update) would do with
1140    /// `data`, with nothing written: the rules and the field conversions run,
1141    /// the listeners and the persister do not. `id` names the record an edit
1142    /// would change; `None` checks as a create.
1143    pub async fn check(
1144        &self,
1145        id: Option<i64>,
1146        data: HashMap<String, String>,
1147    ) -> Result<(), SaveError> {
1148        let data = gathered(&self.form, data);
1149        let id = id.map(|id| id.to_string());
1150        prepare(&self.db, &self.form, &data, id.as_deref())
1151            .await
1152            .map(|_| ())
1153    }
1154
1155    /// Validates `data` as an edit of the record `id` and saves it. Every field
1156    /// is written, so a field left out of `data` is stored blank.
1157    pub async fn update(
1158        &self,
1159        id: i64,
1160        data: HashMap<String, String>,
1161        actor: &Actor,
1162    ) -> Result<(), SaveError> {
1163        let data = gathered(&self.form, data);
1164        write(&self.db, &self.form, &data, Some(&id.to_string()), actor)
1165            .await
1166            .map(|_| ())
1167    }
1168}
1169
1170/// The longest value the rules accept, when they set one.
1171pub(crate) fn max_length(rules: &[Rule]) -> Option<usize> {
1172    rules
1173        .iter()
1174        .filter_map(|r| match r {
1175            Rule::MaxLength(n) => Some(*n),
1176            _ => None,
1177        })
1178        .min()
1179}
1180
1181/// Whether any rule marks the field required.
1182fn has_required(rules: &[Rule]) -> bool {
1183    rules
1184        .iter()
1185        .any(|r| matches!(r, Rule::Required | Rule::RequiredOn(_)))
1186}
1187
1188/// Renders an empty create form.
1189pub(crate) fn new_form(
1190    state: &AdminState,
1191    form: &PreparedForm,
1192    shell: crate::Shell,
1193    pending: Vec<String>,
1194) -> Response {
1195    let mut page = build(
1196        state,
1197        form,
1198        &format!("{}/new", form.config.base_path),
1199        None,
1200        &HashMap::new(),
1201        &ErrorBag::default(),
1202        &shell,
1203    );
1204    page.pending = pending;
1205    render(page)
1206}
1207
1208/// Where a save goes: the edit page when the operator asked to stay, else the
1209/// form's done path or its list.
1210fn after_save(form: &PreparedForm, data: &HashMap<String, String>, id: Option<i64>) -> String {
1211    let stay = data.get("then").map(String::as_str) == Some("stay");
1212    match (stay, id) {
1213        (true, Some(id)) => format!("{}/{}/edit", form.config.base_path, id),
1214        _ => form
1215            .config
1216            .done_path
1217            .clone()
1218            .unwrap_or_else(|| form.config.base_path.clone()),
1219    }
1220}
1221
1222/// Persists a new record, then redirects to the list. Re-renders with per-field
1223/// errors when validation fails.
1224pub(crate) async fn create(
1225    state: &AdminState,
1226    form: &PreparedForm,
1227    data: HashMap<String, String>,
1228    shell: crate::Shell,
1229    user: &laterite_auth::AuthenticatedUser,
1230    session: &crate::session::SessionHandle,
1231    headers: &axum::http::HeaderMap,
1232) -> Response {
1233    if !form.config.idents_valid() {
1234        return render_error();
1235    }
1236    let htmx = is_htmx(headers);
1237    let action = format!("{}/new", form.config.base_path);
1238    let mut data = gathered(form, data);
1239    let then = data.remove("then");
1240    let actor = Actor::from(user);
1241    match write(&state.db, form, &data, None, &actor).await {
1242        // The audit entry is written by the framework's audit listener, which
1243        // runs on every entity after the commit.
1244        Ok(rec) => {
1245            session.push_flash(crate::session::FlashLevel::Success, t!("Saved."));
1246            let mut choice = HashMap::new();
1247            if let Some(then) = then {
1248                choice.insert("then".to_string(), then);
1249            }
1250            saved_response(htmx, &after_save(form, &choice, rec.id()))
1251        }
1252        // A refused submission re-renders the form with per-field errors as 422,
1253        // the cross-surface "validation failure" status.
1254        Err(SaveError::Invalid(bag)) => {
1255            invalid_response(htmx, state, form, &action, None, &data, &bag, &shell)
1256        }
1257        Err(SaveError::Failed(msg)) => {
1258            tracing::error!(error = %msg, "admin create failed");
1259            render(build(
1260                state,
1261                form,
1262                &action,
1263                Some(t!("Could not save. Check the values and try again.")),
1264                &data,
1265                &ErrorBag::default(),
1266                &shell,
1267            ))
1268        }
1269    }
1270}
1271
1272/// Renders a form populated with an existing record.
1273pub(crate) async fn edit_form(
1274    state: &AdminState,
1275    form: &PreparedForm,
1276    id: String,
1277    shell: crate::Shell,
1278    sections: Vec<RelationSection>,
1279) -> Response {
1280    if !form.config.idents_valid() {
1281        return render_error();
1282    }
1283    let values = match load_values(&state.db, form, &id).await {
1284        Ok(Some(values)) => values,
1285        Ok(None) => return not_found(),
1286        Err(_) => return render_error(),
1287    };
1288
1289    let mut page = build(
1290        state,
1291        form,
1292        &format!("{}/{}/edit", form.config.base_path, id),
1293        None,
1294        &values,
1295        &ErrorBag::default(),
1296        &shell,
1297    );
1298    page.sections = sections;
1299    render(page)
1300}
1301
1302/// The stored record `id` as control values: each column back through its
1303/// field type, since what a column holds and what its control shows are not
1304/// always the same string. `None` when no record has that id.
1305pub(crate) async fn load_values(
1306    db: &Db,
1307    form: &PreparedForm,
1308    id: &str,
1309) -> Result<Option<HashMap<String, String>>, sqlx::Error> {
1310    // Scope the sea-query builder so it is dropped before the await below: its
1311    // identifiers are reference-counted (not `Send`), and a live builder across
1312    // the await would make the caller's future non-`Send`.
1313    let (sql, values) = {
1314        let cast = text_cast(db.backend);
1315        let mut select = Query::select();
1316        for field in &form.config.fields {
1317            select.expr_as(
1318                Expr::col(Alias::new(&field.name)).cast_as(Alias::new(cast)),
1319                Alias::new(&field.name),
1320            );
1321        }
1322        select.from(Alias::new(&form.config.entity)).and_where(
1323            Expr::col(Alias::new(&form.config.id_field))
1324                .cast_as(Alias::new(cast))
1325                .eq(id.to_string()),
1326        );
1327        to_sql(db.backend, select)
1328    };
1329    let Some(row) = bind_values(sqlx::query(&sql), values)
1330        .fetch_optional(&db.pool)
1331        .await?
1332    else {
1333        return Ok(None);
1334    };
1335    Ok(Some(
1336        form.config
1337            .fields
1338            .iter()
1339            .zip(&form.fields)
1340            .map(|(f, prepared)| {
1341                let stored = row.get_text_opt(f.name.as_str()).ok().flatten();
1342                let value = prepared
1343                    .field_type
1344                    .to_control(stored.as_deref(), &prepared.opts);
1345                (f.name.clone(), value)
1346            })
1347            .collect(),
1348    ))
1349}
1350
1351/// Persists an edited record, then redirects to the list. Re-renders with
1352/// per-field errors when validation fails.
1353// The generic handlers thread the request's pieces explicitly rather than through
1354// a context struct; the list is long but each argument is named at the call site.
1355#[allow(clippy::too_many_arguments)]
1356pub(crate) async fn update(
1357    state: &AdminState,
1358    form: &PreparedForm,
1359    id: String,
1360    data: HashMap<String, String>,
1361    shell: crate::Shell,
1362    user: &laterite_auth::AuthenticatedUser,
1363    session: &crate::session::SessionHandle,
1364    headers: &axum::http::HeaderMap,
1365) -> Response {
1366    if !form.config.idents_valid() {
1367        return render_error();
1368    }
1369    let htmx = is_htmx(headers);
1370    let action = format!("{}/{}/edit", form.config.base_path, id);
1371    let mut data = gathered(form, data);
1372    let then = data.remove("then");
1373    let actor = Actor::from(user);
1374    match write(&state.db, form, &data, Some(&id), &actor).await {
1375        Ok(_) => {
1376            session.push_flash(crate::session::FlashLevel::Success, t!("Saved."));
1377            let mut choice = HashMap::new();
1378            if let Some(then) = then {
1379                choice.insert("then".to_string(), then);
1380            }
1381            saved_response(htmx, &after_save(form, &choice, id.parse().ok()))
1382        }
1383        // A refused submission re-renders the form with per-field errors as 422,
1384        // the cross-surface "validation failure" status.
1385        Err(SaveError::Invalid(bag)) => {
1386            invalid_response(htmx, state, form, &action, None, &data, &bag, &shell)
1387        }
1388        Err(SaveError::Failed(msg)) => {
1389            tracing::error!(error = %msg, "admin update failed");
1390            render(build(
1391                state,
1392                form,
1393                &action,
1394                Some(t!("Could not save. Check the values and try again.")),
1395                &data,
1396                &ErrorBag::default(),
1397                &shell,
1398            ))
1399        }
1400    }
1401}
1402
1403/// The 422 response for a failed save. An HTMX submit gets the form alone, which
1404/// replaces the form in place; anything else gets the whole page, so the admin
1405/// still works with scripting off.
1406#[allow(clippy::too_many_arguments)]
1407/// A form page posting to `action`, holding `values`: the shape another screen
1408/// borrows when it edits one thing a record owns, such as its tree parent.
1409pub(crate) fn page(
1410    state: &AdminState,
1411    form: &PreparedForm,
1412    action: &str,
1413    values: &HashMap<String, String>,
1414    shell: &crate::Shell,
1415) -> Response {
1416    render(build(
1417        state,
1418        form,
1419        action,
1420        None,
1421        values,
1422        &ErrorBag::default(),
1423        shell,
1424    ))
1425}
1426
1427/// The 422 for a submission the list's own checks refused, shaped like a
1428/// failed save: the form again with the messages against their fields.
1429#[allow(clippy::too_many_arguments)]
1430pub(crate) fn refused(
1431    htmx: bool,
1432    state: &AdminState,
1433    form: &PreparedForm,
1434    action: &str,
1435    error: Option<Text>,
1436    values: &HashMap<String, String>,
1437    bag: &ErrorBag,
1438    shell: &crate::Shell,
1439) -> Response {
1440    invalid_response(htmx, state, form, action, error, values, bag, shell)
1441}
1442
1443#[allow(clippy::too_many_arguments)]
1444fn invalid_response(
1445    htmx: bool,
1446    state: &AdminState,
1447    form: &PreparedForm,
1448    action: &str,
1449    error: Option<Text>,
1450    values: &HashMap<String, String>,
1451    bag: &ErrorBag,
1452    shell: &crate::Shell,
1453) -> Response {
1454    let page = build(state, form, action, error, values, bag, shell);
1455    let body = if htmx {
1456        render(FormFragment {
1457            shell: page.shell,
1458            action: page.action,
1459            cancel_path: page.cancel_path,
1460            error: page.error,
1461            fields: page.fields,
1462            stay: page.stay,
1463            enter_off: page.enter_off,
1464            refused: page.refused,
1465            leave_off: page.leave_off,
1466            focus: page.focus,
1467        })
1468    } else {
1469        render(page)
1470    };
1471    (StatusCode::UNPROCESSABLE_ENTITY, body).into_response()
1472}
1473
1474/// Where to send the browser after a successful save. HTMX will not follow a
1475/// 303 usefully (it would swap the redirected page into the form), so it gets
1476/// the header it understands instead.
1477pub(crate) fn saved_response(htmx: bool, to: &str) -> Response {
1478    if htmx {
1479        ([("HX-Redirect", to)], StatusCode::NO_CONTENT).into_response()
1480    } else {
1481        Redirect::to(to).into_response()
1482    }
1483}
1484
1485/// Whether this request came from HTMX rather than a plain form post.
1486pub(crate) fn is_htmx(headers: &axum::http::HeaderMap) -> bool {
1487    headers.contains_key("hx-request")
1488}
1489
1490fn build(
1491    state: &AdminState,
1492    form: &PreparedForm,
1493    action: &str,
1494    error: Option<Text>,
1495    values: &HashMap<String, String>,
1496    bag: &ErrorBag,
1497    shell: &crate::Shell,
1498) -> FormTemplate {
1499    let fields = form
1500        .config
1501        .fields
1502        .iter()
1503        .zip(&form.fields)
1504        .map(|(f, pf)| {
1505            let value = FieldValue::Text(values.get(&f.name).cloned().unwrap_or_default());
1506            let required = has_required(&pf.rules);
1507            // Localize the label once: the field type sees it (aria/inline labels)
1508            // and the framework chrome renders it.
1509            let label = shell.tt(&f.label);
1510            let cx = FieldCx {
1511                name: &f.name,
1512                id: &f.name,
1513                label: &label,
1514                value: &value,
1515                required,
1516                max_length: max_length(&pf.rules),
1517                opts: &pf.opts,
1518                base: &shell.base,
1519                i18n: shell.i18n(),
1520            };
1521            // The type is registered (prepare validated it); the lookup here is
1522            // only to render.
1523            let control = if f.hidden {
1524                format!(
1525                    r#"<input type="hidden" name="{}" value="{}">"#,
1526                    escape_attr(&f.name),
1527                    escape_attr(values.get(&f.name).map(String::as_str).unwrap_or_default())
1528                )
1529            } else {
1530                match state.field_types.get(&f.field_type) {
1531                    Some(ft) => {
1532                        let scope = OverrideScope {
1533                            surface: Surface::Field,
1534                            view_key: &f.field_type,
1535                            resource: Some(&form.config.base_path),
1536                            field: Some(&f.name),
1537                        };
1538                        render_field(ft.as_ref(), state.overrides.as_ref(), &scope, &cx)
1539                            .into_string()
1540                    }
1541                    None => String::new(),
1542                }
1543            };
1544            FieldView {
1545                id: f.name.clone(),
1546                label,
1547                control,
1548                required,
1549                enter: f.enter.attribute(),
1550                layout: layout_classes(f.span, f.break_row),
1551                attrs: behaviour_attrs(f),
1552                hidden: f.hidden,
1553                // Localize each per-field message through the request translator.
1554                errors: bag.messages(&f.name).iter().map(|m| shell.tt(m)).collect(),
1555            }
1556        })
1557        .collect();
1558    // Collect the widget assets the rendered field types declare, deduped and
1559    // resolved to URLs for the head. Most declare none (their widgets ship in
1560    // core laterite.js).
1561    let keys: Vec<&str> = form
1562        .config
1563        .fields
1564        .iter()
1565        .zip(&form.fields)
1566        .filter_map(|(f, pf)| {
1567            state
1568                .field_types
1569                .get(&f.field_type)
1570                .map(|ft| ft.assets(&pf.opts))
1571        })
1572        .flatten()
1573        .collect();
1574    // Localize the title and banner before the shell is moved into the template.
1575    let shell_title = shell.tt(&form.config.title);
1576    let refused = error.is_some() || !bag.is_empty();
1577    let error = error.map(|m| shell.tt(&m));
1578    let mut shell = shell.clone();
1579    shell.assets = crate::page_assets(&keys, &shell.base, &state.assets, &state.asset_urls);
1580    FormTemplate {
1581        shell,
1582        title: shell_title,
1583        action: action.to_string(),
1584        cancel_path: form
1585            .config
1586            .done_path
1587            .clone()
1588            .unwrap_or_else(|| form.config.base_path.clone()),
1589        error,
1590        fields,
1591        stay: form.stay,
1592        sections: Vec::new(),
1593        pending: Vec::new(),
1594        enter_off: form.config.enter == EnterPolicy::Off,
1595        refused,
1596        leave_off: !form.config.confirm_leave,
1597        focus: match form.config.focus {
1598            FormFocus::Off => "off",
1599            // A new record has nothing in it yet, so the first field is where
1600            // the operator starts. An edit opens for reading first.
1601            FormFocus::Auto if action.ends_with("/new") => "first",
1602            FormFocus::Auto => "",
1603        },
1604    }
1605}
1606
1607struct FieldView {
1608    /// DOM id for the control and its label's `for`.
1609    id: String,
1610    label: String,
1611    /// The control HTML, rendered by the field-type registry (override-aware).
1612    /// The framework owns the surrounding chrome (label, required marker, errors).
1613    control: String,
1614    required: bool,
1615    errors: Vec<String>,
1616    /// The field's own Enter rule (`off`, `next`), or empty for the form's.
1617    enter: &'static str,
1618    /// Wrapper classes for the span and a row break, each led by a space.
1619    layout: String,
1620    /// The wrapper's preset and trigger attributes, each led by a space.
1621    attrs: String,
1622    /// A hidden input with no chrome around it.
1623    hidden: bool,
1624}
1625
1626/// One relation on an edit page: its heading, its New link and the list region.
1627pub(crate) struct RelationSection {
1628    /// The section's toolbar: its title and the New or Attach button.
1629    pub toolbar: crate::html::Markup,
1630    pub html: crate::html::Markup,
1631}
1632
1633pub(crate) fn escape_attr(s: &str) -> String {
1634    s.replace('&', "&amp;")
1635        .replace('"', "&quot;")
1636        .replace('<', "&lt;")
1637        .replace('>', "&gt;")
1638}
1639
1640/// Just the form element, for an HTMX submit that failed validation: the
1641/// response replaces the form in place rather than reloading the page.
1642#[derive(Template)]
1643#[template(path = "_form_fields.html")]
1644struct FormFragment {
1645    shell: crate::Shell,
1646    action: String,
1647    cancel_path: String,
1648    error: Option<String>,
1649    fields: Vec<FieldView>,
1650    stay: bool,
1651    /// Enter never submits this form.
1652    enter_off: bool,
1653    /// The form holds a submission that was not saved.
1654    refused: bool,
1655    /// Leaving with changes unsaved does not ask.
1656    leave_off: bool,
1657    /// `first`, `off`, or empty for the default.
1658    focus: &'static str,
1659}
1660
1661#[derive(Template)]
1662#[template(path = "form.html")]
1663struct FormTemplate {
1664    shell: crate::Shell,
1665    title: String,
1666    action: String,
1667    cancel_path: String,
1668    error: Option<String>,
1669    fields: Vec<FieldView>,
1670    /// Offer "Save and continue editing".
1671    stay: bool,
1672    /// The related records, one section each, on an edit page.
1673    sections: Vec<RelationSection>,
1674    /// The relations a create page cannot show yet, by section title.
1675    pending: Vec<String>,
1676    /// Enter never submits this form.
1677    enter_off: bool,
1678    /// The form holds a submission that was not saved.
1679    refused: bool,
1680    /// Leaving with changes unsaved does not ask.
1681    leave_off: bool,
1682    /// `first`, `off`, or empty for the default.
1683    focus: &'static str,
1684}
1685
1686/// A field as a value form renders it: the label, the control its type drew,
1687/// the help, and the wrapper's layout classes and behaviour attributes.
1688pub struct ValueFieldView {
1689    pub label: String,
1690    pub help: Option<String>,
1691    /// The control, rendered by the field's own type.
1692    pub control: String,
1693    /// Wrapper classes for the span and a row break, each led by a space.
1694    pub layout: String,
1695    /// The wrapper's preset and trigger attributes, each led by a space.
1696    pub attrs: String,
1697}
1698
1699#[derive(Template)]
1700#[template(path = "_value_fields.html")]
1701struct ValueFieldsTemplate {
1702    fields: Vec<ValueFieldView>,
1703}
1704
1705/// A form over a JSON object: the declared fields rendered with their stored
1706/// values, and a submission collected back through the field types into an
1707/// object with every declared key. The settings screens are one, a theme's
1708/// settings another. Built from a [`RouteCtx`](crate::routes::RouteCtx) with
1709/// [`value_form`](crate::routes::RouteCtx::value_form).
1710pub struct ValueForm {
1711    fields: Vec<FormField>,
1712    types: Arc<crate::field::FieldRegistry>,
1713    overrides: Arc<dyn crate::field::OverrideResolver>,
1714    /// What an override is scoped to (a settings code, a theme code).
1715    scope: String,
1716}
1717
1718impl ValueForm {
1719    /// Checks every field's type is registered and its options resolve. The
1720    /// error names the field and the type, for a form declared at runtime.
1721    pub(crate) fn new(
1722        fields: &[FormField],
1723        types: Arc<crate::field::FieldRegistry>,
1724        overrides: Arc<dyn crate::field::OverrideResolver>,
1725        scope: &str,
1726    ) -> Result<Self, Text> {
1727        for field in fields {
1728            let Some(ft) = types.get(&field.field_type) else {
1729                return Err(Text::dynamic(format!(
1730                    "field {:?} uses unregistered type {:?}",
1731                    field.name, field.field_type
1732                )));
1733            };
1734            if ft.resolve_options(&field.options, &types).is_err() {
1735                return Err(Text::dynamic(format!(
1736                    "field {:?} has malformed options",
1737                    field.name
1738                )));
1739            }
1740        }
1741        Ok(Self {
1742            fields: fields.to_vec(),
1743            types,
1744            overrides,
1745            scope: scope.to_string(),
1746        })
1747    }
1748
1749    /// The fields, in order.
1750    pub fn fields(&self) -> &[FormField] {
1751        &self.fields
1752    }
1753
1754    /// Each field over `stored`, ready for a template.
1755    pub fn views(&self, stored: &serde_json::Value, shell: &crate::Shell) -> Vec<ValueFieldView> {
1756        value_views(
1757            &self.fields,
1758            &self.types,
1759            self.overrides.as_ref(),
1760            stored,
1761            shell,
1762            &self.scope,
1763        )
1764    }
1765
1766    /// The fields over `stored` as one `.lat-fields` block, for a form a screen
1767    /// builds by hand around it.
1768    pub fn render(&self, stored: &serde_json::Value, shell: &crate::Shell) -> crate::html::Markup {
1769        let template = ValueFieldsTemplate {
1770            fields: self.views(stored, shell),
1771        };
1772        crate::html::Markup::from_template(&template).unwrap_or_default()
1773    }
1774
1775    /// A submission as the stored object: every declared key, each value
1776    /// through its field type. A type that refuses its input refuses the whole.
1777    pub fn collect(&self, data: &HashMap<String, String>) -> Result<serde_json::Value, Text> {
1778        value_collect(&self.fields, &self.types, data)
1779    }
1780}
1781
1782/// Each of `fields` over `stored`, rendered by its type with overrides scoped
1783/// to `scope`.
1784pub(crate) fn value_views(
1785    fields: &[FormField],
1786    types: &crate::field::FieldRegistry,
1787    overrides: &dyn crate::field::OverrideResolver,
1788    stored: &serde_json::Value,
1789    shell: &crate::Shell,
1790    scope: &str,
1791) -> Vec<ValueFieldView> {
1792    fields
1793        .iter()
1794        .map(|f| {
1795            let label = shell.tt(&f.label);
1796            let control = match types.get(&f.field_type) {
1797                Some(ft) => {
1798                    let opts = ft
1799                        .resolve_options(&f.options, types)
1800                        .unwrap_or_else(|_| ResolvedOptions::none());
1801                    let value = match stored.get(&f.name) {
1802                        Some(serde_json::Value::Array(rows)) => {
1803                            FieldValue::Json(serde_json::Value::Array(rows.clone()))
1804                        }
1805                        Some(serde_json::Value::String(text)) => {
1806                            FieldValue::Text(ft.to_control(Some(text), &opts))
1807                        }
1808                        Some(serde_json::Value::Null) | None => {
1809                            FieldValue::Text(ft.to_control(None, &opts))
1810                        }
1811                        Some(other) => {
1812                            FieldValue::Text(ft.to_control(Some(&other.to_string()), &opts))
1813                        }
1814                    };
1815                    let cx = FieldCx {
1816                        name: &f.name,
1817                        id: &f.name,
1818                        label: &label,
1819                        value: &value,
1820                        required: false,
1821                        max_length: max_length(&f.rules),
1822                        opts: &opts,
1823                        base: &shell.base,
1824                        i18n: shell.i18n(),
1825                    };
1826                    let scope = OverrideScope {
1827                        surface: Surface::Field,
1828                        view_key: &f.field_type,
1829                        resource: Some(scope),
1830                        field: Some(&f.name),
1831                    };
1832                    render_field(ft.as_ref(), overrides, &scope, &cx).into_string()
1833                }
1834                None => String::new(),
1835            };
1836            ValueFieldView {
1837                label,
1838                help: f.help.as_ref().map(|h| shell.tt(h)),
1839                control,
1840                layout: layout_classes(f.span, f.break_row),
1841                attrs: behaviour_attrs(f),
1842            }
1843        })
1844        .collect()
1845}
1846
1847/// A submission over `fields` as a JSON object with every declared key.
1848pub(crate) fn value_collect(
1849    fields: &[FormField],
1850    types: &crate::field::FieldRegistry,
1851    data: &HashMap<String, String>,
1852) -> Result<serde_json::Value, Text> {
1853    let mut object = serde_json::Map::new();
1854    for field in fields {
1855        let Some(field_type) = types.get(&field.field_type) else {
1856            return Err(t!("This screen uses a field type that is not registered."));
1857        };
1858        let opts = field_type
1859            .resolve_options(&field.options, types)
1860            .map_err(|_| t!("This screen has a malformed field."))?;
1861        let submitted = crate::field::SubmittedField::new(&field.name, data);
1862        let value = match field_type.to_attr(&submitted, &opts, Mode::Update) {
1863            Ok(Some(value)) => attr_to_json(value),
1864            Ok(None) => serde_json::Value::String(String::new()),
1865            Err(_) => return Err(t!("Check the values and try again.")),
1866        };
1867        object.insert(field.name.clone(), value);
1868    }
1869    Ok(serde_json::Value::Object(object))
1870}
1871
1872/// A field type's attribute value as settings JSON stores it.
1873pub(crate) fn attr_to_json(value: laterite_core::AttrValue) -> serde_json::Value {
1874    use laterite_core::AttrValue;
1875    match value {
1876        AttrValue::Null => serde_json::Value::String(String::new()),
1877        AttrValue::Bool(b) => serde_json::Value::Bool(b),
1878        AttrValue::Int(i) => serde_json::Value::from(i),
1879        AttrValue::Float(f) => serde_json::Value::from(f),
1880        AttrValue::Json(j) => j,
1881        other => serde_json::Value::String(other.to_text().unwrap_or_default()),
1882    }
1883}
1884
1885#[cfg(test)]
1886mod tests {
1887    use super::*;
1888    use axum::http::StatusCode;
1889    use laterite_core::strata::{
1890        async_trait, ColumnDef, CoreResult, Migration, MigrationSet, Schema, Table,
1891    };
1892    use laterite_core::testing::{connect_test, TestGuard};
1893    use laterite_core::Db;
1894    use laterite_core::SaveCx;
1895
1896    /// A minimal table for exercising the generic insert/update path in isolation,
1897    /// defined as a portable migration so the test runs on any backend.
1898    struct CreateSamples;
1899    #[async_trait(?Send)]
1900    impl Migration for CreateSamples {
1901        fn name(&self) -> &str {
1902            "0001_create_samples"
1903        }
1904        async fn up(&self, s: &mut Schema<'_>) -> CoreResult<()> {
1905            s.exec(
1906                Table::create()
1907                    .table(Alias::new("samples"))
1908                    .if_not_exists()
1909                    .col(
1910                        ColumnDef::new(Alias::new("id"))
1911                            .big_integer()
1912                            .not_null()
1913                            .auto_increment()
1914                            .primary_key(),
1915                    )
1916                    .col(ColumnDef::new(Alias::new("code")).text().not_null())
1917                    .col(ColumnDef::new(Alias::new("name")).text().not_null())
1918                    // Nullable, so a form that does not opt into timestamps
1919                    // still inserts.
1920                    .col(ColumnDef::new(Alias::new("created_at")).text())
1921                    .col(ColumnDef::new(Alias::new("updated_at")).text())
1922                    .to_owned(),
1923            )
1924            .await
1925        }
1926    }
1927
1928    fn config() -> PreparedForm {
1929        let config = FormConfig {
1930            enter: Default::default(),
1931            confirm_leave: true,
1932            focus: Default::default(),
1933            entity: "samples".to_string(),
1934            title: "Sample".into(),
1935            base_path: "/admin/samples".to_string(),
1936            id_field: "id".to_string(),
1937            fields: vec![
1938                FormField::text("code", "Code").required().unique(),
1939                FormField::text("name", "Name").required(),
1940            ],
1941            persist: None,
1942            timestamps: false,
1943            done_path: None,
1944        };
1945        PreparedForm::prepare(
1946            config,
1947            &crate::field::builtin_registry(),
1948            &PersisterRegistry::new(),
1949            &[],
1950        )
1951        .unwrap()
1952    }
1953
1954    /// The whole delete path against a real table: the row is read, the
1955    /// listeners run, the row goes, and the after-stage sees what went.
1956    #[tokio::test]
1957    async fn a_delete_removes_the_row_through_the_pipeline() {
1958        use crate::persist::{delete, DefaultPersister, DeleteRequest};
1959
1960        let (db, _guard) = test_db().await;
1961        let st = state(db.clone());
1962        let form = config();
1963
1964        let mut data = HashMap::new();
1965        data.insert("code".to_string(), "c1".to_string());
1966        data.insert("name".to_string(), "Chair".to_string());
1967        create(
1968            &st,
1969            &form,
1970            data,
1971            crate::Shell::test(),
1972            &crate::audit::test_actor(),
1973            &crate::session::SessionHandle::from_blob(None),
1974            &axum::http::HeaderMap::new(),
1975        )
1976        .await;
1977        assert_eq!(
1978            fetch_text(&db, "name", "c1").await.as_deref(),
1979            Some("Chair")
1980        );
1981
1982        let id = row_id(&db, "c1").await;
1983        let persister = DefaultPersister::from_config(&form.config);
1984        let rec = delete(DeleteRequest {
1985            db: &db,
1986            listeners: &[],
1987            persister: &persister,
1988            actor: &laterite_core::Actor::system("test"),
1989            entity: "samples",
1990            id: &id,
1991        })
1992        .await
1993        .expect("deleted");
1994
1995        // Gone from the table, and the caller learns what it removed.
1996        assert_eq!(fetch_text(&db, "name", "c1").await, None);
1997        assert_eq!(rec.text("code"), Some("c1"));
1998    }
1999
2000    /// The stored id for a row, as text, the shape the delete path takes.
2001    async fn row_id(db: &Db, code: &str) -> String {
2002        let stmt = Query::select()
2003            .expr_as(
2004                Expr::col(Alias::new("id")).cast_as(Alias::new(text_cast(db.backend))),
2005                Alias::new("v"),
2006            )
2007            .from(Alias::new("samples"))
2008            .and_where(Expr::col(Alias::new("code")).eq(code))
2009            .to_owned();
2010        let (sql, values) = laterite_core::query::build(db.backend, stmt);
2011        let row = bind_values(sqlx::query(&sql), values)
2012            .fetch_one(&db.pool)
2013            .await
2014            .unwrap();
2015        row.get_text("v").unwrap()
2016    }
2017
2018    pub(super) fn state(db: Db) -> AdminState {
2019        AdminState::new(
2020            laterite_auth::AuthService::new(db.clone(), laterite_auth::AuthConfig::default()),
2021            db,
2022        )
2023    }
2024
2025    /// A fresh test database holding a minimal `samples` table, on whichever
2026    /// backend the run targets. Hold the returned guard for the test's lifetime.
2027    pub(super) async fn test_db() -> (Db, TestGuard) {
2028        let samples = MigrationSet::new("test.samples", vec![Box::new(CreateSamples)]);
2029        connect_test(&[samples]).await
2030    }
2031
2032    /// Reads a single text column from the one row matching `code`, so a test can
2033    /// assert what was persisted without depending on the read path under test.
2034    pub(super) async fn fetch_text(db: &Db, column: &str, code: &str) -> Option<String> {
2035        let stmt = Query::select()
2036            .expr_as(
2037                Expr::col(Alias::new(column)).cast_as(Alias::new(text_cast(db.backend))),
2038                Alias::new("v"),
2039            )
2040            .from(Alias::new("samples"))
2041            .and_where(Expr::col(Alias::new("code")).eq(code))
2042            .to_owned();
2043        let (sql, values) = to_sql(db.backend, stmt);
2044        let row = bind_values(sqlx::query(&sql), values)
2045            .fetch_optional(&db.pool)
2046            .await
2047            .unwrap()?;
2048        row.get_text_opt("v").ok().flatten()
2049    }
2050
2051    async fn body_of(resp: Response) -> String {
2052        let bytes = axum::body::to_bytes(resp.into_body(), usize::MAX)
2053            .await
2054            .unwrap();
2055        String::from_utf8(bytes.to_vec()).unwrap()
2056    }
2057
2058    async fn count(db: &Db) -> i64 {
2059        sqlx::query_scalar("select count(*) from samples")
2060            .fetch_one(&db.pool)
2061            .await
2062            .unwrap()
2063    }
2064
2065    fn data(pairs: &[(&str, &str)]) -> HashMap<String, String> {
2066        pairs
2067            .iter()
2068            .map(|(k, v)| (k.to_string(), v.to_string()))
2069            .collect()
2070    }
2071
2072    /// The header htmx sets on every request it makes.
2073    pub(super) fn htmx_headers() -> axum::http::HeaderMap {
2074        let mut h = axum::http::HeaderMap::new();
2075        h.insert("hx-request", "true".parse().unwrap());
2076        h
2077    }
2078
2079    #[tokio::test]
2080    async fn create_then_fetch() {
2081        let (db, _guard) = test_db().await;
2082        let cfg = config();
2083        let st = state(db.clone());
2084
2085        let resp = create(
2086            &st,
2087            &cfg,
2088            data(&[("code", "editor"), ("name", "Content Editor")]),
2089            crate::Shell::test(),
2090            &crate::audit::test_actor(),
2091            &crate::session::SessionHandle::from_blob(None),
2092            &axum::http::HeaderMap::new(),
2093        )
2094        .await;
2095        assert_eq!(resp.status(), StatusCode::SEE_OTHER);
2096
2097        assert_eq!(
2098            fetch_text(&db, "name", "editor").await.as_deref(),
2099            Some("Content Editor")
2100        );
2101    }
2102
2103    #[tokio::test]
2104    async fn update_changes_the_row() {
2105        let (db, _guard) = test_db().await;
2106        let cfg = config();
2107        let st = state(db.clone());
2108        create(
2109            &st,
2110            &cfg,
2111            data(&[("code", "editor"), ("name", "Editor")]),
2112            crate::Shell::test(),
2113            &crate::audit::test_actor(),
2114            &crate::session::SessionHandle::from_blob(None),
2115            &axum::http::HeaderMap::new(),
2116        )
2117        .await;
2118
2119        let id = fetch_text(&db, "id", "editor")
2120            .await
2121            .expect("row should exist after create");
2122
2123        // The code is unchanged, so its unique rule must ignore the edited row.
2124        let resp = update(
2125            &st,
2126            &cfg,
2127            id,
2128            data(&[("code", "editor"), ("name", "Senior Editor")]),
2129            crate::Shell::test(),
2130            &crate::audit::test_actor(),
2131            &crate::session::SessionHandle::from_blob(None),
2132            &axum::http::HeaderMap::new(),
2133        )
2134        .await;
2135        assert_eq!(resp.status(), StatusCode::SEE_OTHER);
2136
2137        assert_eq!(
2138            fetch_text(&db, "name", "editor").await.as_deref(),
2139            Some("Senior Editor")
2140        );
2141    }
2142
2143    #[tokio::test]
2144    async fn create_re_renders_with_a_required_message_and_inserts_nothing() {
2145        let (db, _guard) = test_db().await;
2146        let cfg = config();
2147        let st = state(db.clone());
2148
2149        let resp = create(
2150            &st,
2151            &cfg,
2152            data(&[("code", ""), ("name", "No Code")]),
2153            crate::Shell::test(),
2154            &crate::audit::test_actor(),
2155            &crate::session::SessionHandle::from_blob(None),
2156            &axum::http::HeaderMap::new(),
2157        )
2158        .await;
2159        // Re-renders the form (200), does not redirect.
2160        assert_eq!(resp.status(), StatusCode::UNPROCESSABLE_ENTITY);
2161        assert_eq!(count(&db).await, 0);
2162        // The per-field message is rendered.
2163        assert!(body_of(resp).await.contains("Code is required."));
2164    }
2165
2166    #[tokio::test]
2167    async fn create_rejects_a_duplicate_unique_value() {
2168        let (db, _guard) = test_db().await;
2169        let cfg = config();
2170        let st = state(db.clone());
2171        create(
2172            &st,
2173            &cfg,
2174            data(&[("code", "editor"), ("name", "Editor")]),
2175            crate::Shell::test(),
2176            &crate::audit::test_actor(),
2177            &crate::session::SessionHandle::from_blob(None),
2178            &axum::http::HeaderMap::new(),
2179        )
2180        .await;
2181
2182        // A second row with the same code is refused by the unique rule.
2183        let resp = create(
2184            &st,
2185            &cfg,
2186            data(&[("code", "editor"), ("name", "Other")]),
2187            crate::Shell::test(),
2188            &crate::audit::test_actor(),
2189            &crate::session::SessionHandle::from_blob(None),
2190            &axum::http::HeaderMap::new(),
2191        )
2192        .await;
2193        assert_eq!(resp.status(), StatusCode::UNPROCESSABLE_ENTITY);
2194        assert_eq!(count(&db).await, 1);
2195        assert!(body_of(resp).await.contains("already taken"));
2196    }
2197
2198    #[tokio::test]
2199    async fn text_email_input_rejects_a_bad_address_via_its_intrinsic_rule() {
2200        let (db, _guard) = test_db().await;
2201        let st = state(db.clone());
2202        // The `name` column is a text field with the `email` input, which
2203        // contributes Rule::Email without the descriptor listing it.
2204        let cfg = PreparedForm::prepare(
2205            FormConfig {
2206                enter: Default::default(),
2207                confirm_leave: true,
2208                focus: Default::default(),
2209                entity: "samples".to_string(),
2210                title: "Sample".into(),
2211                base_path: "/admin/samples".to_string(),
2212                id_field: "id".to_string(),
2213                fields: vec![
2214                    FormField::text("code", "Code").required(),
2215                    FormField::of("name", "Email", "text")
2216                        .options(serde_json::json!({ "input": "email" }))
2217                        .required(),
2218                ],
2219                persist: None,
2220                timestamps: false,
2221                done_path: None,
2222            },
2223            &st.field_types,
2224            &PersisterRegistry::new(),
2225            &[],
2226        )
2227        .unwrap();
2228
2229        let resp = create(
2230            &st,
2231            &cfg,
2232            data(&[("code", "c1"), ("name", "nope")]),
2233            crate::Shell::test(),
2234            &crate::audit::test_actor(),
2235            &crate::session::SessionHandle::from_blob(None),
2236            &axum::http::HeaderMap::new(),
2237        )
2238        .await;
2239        assert_eq!(resp.status(), StatusCode::UNPROCESSABLE_ENTITY);
2240        assert_eq!(count(&db).await, 0);
2241
2242        let resp = create(
2243            &st,
2244            &cfg,
2245            data(&[("code", "c1"), ("name", "a@b.test")]),
2246            crate::Shell::test(),
2247            &crate::audit::test_actor(),
2248            &crate::session::SessionHandle::from_blob(None),
2249            &axum::http::HeaderMap::new(),
2250        )
2251        .await;
2252        assert_eq!(resp.status(), StatusCode::SEE_OTHER);
2253        assert_eq!(count(&db).await, 1);
2254    }
2255
2256    #[test]
2257    fn prepare_rejects_an_unregistered_field_type() {
2258        let config = FormConfig {
2259            enter: Default::default(),
2260            confirm_leave: true,
2261            focus: Default::default(),
2262            entity: "samples".to_string(),
2263            title: "Sample".into(),
2264            base_path: "/admin/samples".to_string(),
2265            id_field: "id".to_string(),
2266            fields: vec![FormField::of("place", "Place", "no.such.type")],
2267            persist: None,
2268            timestamps: false,
2269            done_path: None,
2270        };
2271        let Err(err) = PreparedForm::prepare(
2272            config,
2273            &crate::field::builtin_registry(),
2274            &PersisterRegistry::new(),
2275            &[],
2276        ) else {
2277            panic!("expected prepare to reject an unregistered type");
2278        };
2279        assert!(err.contains("no.such.type"), "{err}");
2280    }
2281
2282    #[test]
2283    fn prepare_rejects_a_malformed_option() {
2284        // The text field's `input` option is a string; a wrong JSON type for it
2285        // aborts prepare naming the field.
2286        let config = FormConfig {
2287            enter: Default::default(),
2288            confirm_leave: true,
2289            focus: Default::default(),
2290            entity: "samples".to_string(),
2291            title: "Sample".into(),
2292            base_path: "/admin/samples".to_string(),
2293            id_field: "id".to_string(),
2294            fields: vec![
2295                FormField::of("email", "Email", "text").options(serde_json::json!({ "input": 7 }))
2296            ],
2297            persist: None,
2298            timestamps: false,
2299            done_path: None,
2300        };
2301        let Err(err) = PreparedForm::prepare(
2302            config,
2303            &crate::field::builtin_registry(),
2304            &PersisterRegistry::new(),
2305            &[],
2306        ) else {
2307            panic!("expected prepare to reject a malformed option");
2308        };
2309        assert!(err.contains("`email`"), "{err}");
2310    }
2311
2312    /// A persister that inserts a row then fails. The pipeline owns the
2313    /// transaction, so the insert must roll back with it.
2314    struct RollbackPersister;
2315    #[laterite_core::strata::async_trait]
2316    impl Persister for RollbackPersister {
2317        async fn create(&self, cx: &mut SaveCx<'_>, _rec: &Record) -> Result<i64, SaveError> {
2318            let backend = cx.backend();
2319            let insert = Query::insert()
2320                .into_table(Alias::new("samples"))
2321                .columns([Alias::new("code"), Alias::new("name")])
2322                .values_panic(["rolled".into(), "back".into()])
2323                .to_owned();
2324            let (sql, values) = to_sql(backend, insert);
2325            bind_values(sqlx::query(&sql), values)
2326                .execute(cx.conn())
2327                .await
2328                .map_err(|e| SaveError::Failed(e.to_string()))?;
2329            Err(SaveError::Failed("deliberate".to_string()))
2330        }
2331        async fn update(
2332            &self,
2333            _cx: &mut SaveCx<'_>,
2334            _id: &str,
2335            _rec: &Record,
2336        ) -> Result<(), SaveError> {
2337            Ok(())
2338        }
2339    }
2340
2341    /// A persister that always rejects create with a per-field validation error.
2342    struct RejectingPersister;
2343    #[laterite_core::strata::async_trait]
2344    impl Persister for RejectingPersister {
2345        async fn create(&self, _cx: &mut SaveCx<'_>, _rec: &Record) -> Result<i64, SaveError> {
2346            let mut bag = ErrorBag::default();
2347            bag.add("code", t!("Code is not allowed here."));
2348            Err(SaveError::Invalid(bag))
2349        }
2350        async fn update(
2351            &self,
2352            _cx: &mut SaveCx<'_>,
2353            _id: &str,
2354            _rec: &Record,
2355        ) -> Result<(), SaveError> {
2356            Ok(())
2357        }
2358    }
2359
2360    fn config_with(persister: &str) -> FormConfig {
2361        FormConfig {
2362            enter: Default::default(),
2363            confirm_leave: true,
2364            focus: Default::default(),
2365            entity: "samples".to_string(),
2366            title: "Sample".into(),
2367            base_path: "/admin/samples".to_string(),
2368            id_field: "id".to_string(),
2369            fields: vec![
2370                FormField::text("code", "Code").required(),
2371                FormField::text("name", "Name").required(),
2372            ],
2373            persist: Some(persister.to_string()),
2374            timestamps: false,
2375            done_path: None,
2376        }
2377    }
2378
2379    #[test]
2380    fn prepare_rejects_an_unregistered_persister() {
2381        let Err(err) = PreparedForm::prepare(
2382            config_with("no.such.persister"),
2383            &crate::field::builtin_registry(),
2384            &PersisterRegistry::new(),
2385            &[],
2386        ) else {
2387            panic!("expected prepare to reject an unregistered persister");
2388        };
2389        assert!(err.contains("no.such.persister"), "{err}");
2390    }
2391
2392    #[tokio::test]
2393    async fn a_persister_transaction_rolls_back_on_error() {
2394        let (db, _guard) = test_db().await;
2395        let st = state(db.clone());
2396        let mut persisters = PersisterRegistry::new();
2397        persisters.insert("test.rollback".to_string(), Arc::new(RollbackPersister));
2398        let form = PreparedForm::prepare(
2399            config_with("test.rollback"),
2400            &st.field_types,
2401            &persisters,
2402            &[],
2403        )
2404        .unwrap();
2405
2406        let resp = create(
2407            &st,
2408            &form,
2409            data(&[("code", "rolled"), ("name", "back")]),
2410            crate::Shell::test(),
2411            &crate::audit::test_actor(),
2412            &crate::session::SessionHandle::from_blob(None),
2413            &axum::http::HeaderMap::new(),
2414        )
2415        .await;
2416        // The persister failed, so the form re-renders (200) and its in-tx insert
2417        // rolled back: no row landed.
2418        assert_eq!(resp.status(), StatusCode::OK);
2419        assert_eq!(count(&db).await, 0);
2420    }
2421
2422    #[tokio::test]
2423    async fn a_persister_invalid_error_re_renders_422() {
2424        let (db, _guard) = test_db().await;
2425        let st = state(db.clone());
2426        let mut persisters = PersisterRegistry::new();
2427        persisters.insert("test.reject".to_string(), Arc::new(RejectingPersister));
2428        let form = PreparedForm::prepare(
2429            config_with("test.reject"),
2430            &st.field_types,
2431            &persisters,
2432            &[],
2433        )
2434        .unwrap();
2435
2436        let resp = create(
2437            &st,
2438            &form,
2439            data(&[("code", "editor"), ("name", "Editor")]),
2440            crate::Shell::test(),
2441            &crate::audit::test_actor(),
2442            &crate::session::SessionHandle::from_blob(None),
2443            &axum::http::HeaderMap::new(),
2444        )
2445        .await;
2446        assert_eq!(resp.status(), StatusCode::UNPROCESSABLE_ENTITY);
2447        assert!(body_of(resp).await.contains("Code is not allowed here."));
2448    }
2449}
2450
2451#[cfg(test)]
2452mod timestamp_tests {
2453    use super::tests::*;
2454    use super::*;
2455    use laterite_core::listeners::{CREATED_AT, UPDATED_AT};
2456    use laterite_core::Actor;
2457
2458    fn timestamped(on: bool) -> FormConfig {
2459        FormConfig {
2460            enter: Default::default(),
2461            confirm_leave: true,
2462            focus: Default::default(),
2463            entity: "samples".to_string(),
2464            title: "Sample".into(),
2465            base_path: "/admin/samples".to_string(),
2466            id_field: "id".to_string(),
2467            fields: vec![
2468                FormField::text("code", "Code").required(),
2469                FormField::text("name", "Name").required(),
2470            ],
2471            persist: None,
2472            timestamps: on,
2473            done_path: None,
2474        }
2475    }
2476
2477    async fn create_through_pipeline(db: &laterite_core::Db, on: bool) -> Record {
2478        let form = PreparedForm::prepare(
2479            timestamped(on),
2480            &crate::field::builtin_registry(),
2481            &PersisterRegistry::new(),
2482            &[],
2483        )
2484        .unwrap();
2485        let mut data = HashMap::new();
2486        data.insert("code".to_string(), "c1".to_string());
2487        data.insert("name".to_string(), "Chair".to_string());
2488        let mut rec = declared_record(&form, &data, Mode::Create).unwrap();
2489        let actor = Actor::system("test");
2490        persist::save(
2491            persist::SaveRequest {
2492                db,
2493                listeners: &form.listeners,
2494                persister: form.persister.as_ref(),
2495                actor: &actor,
2496                op: Op::Create,
2497                id: None,
2498            },
2499            &mut rec,
2500        )
2501        .await
2502        .expect("the insert should succeed");
2503        rec
2504    }
2505
2506    #[tokio::test]
2507    async fn opting_in_stamps_the_row() {
2508        let (db, _guard) = test_db().await;
2509        let rec = create_through_pipeline(&db, true).await;
2510        assert!(rec.datetime(CREATED_AT).is_some());
2511        assert!(rec.datetime(UPDATED_AT).is_some());
2512        // The stamp reached the table, not just the record.
2513        assert!(fetch_text(&db, CREATED_AT, "c1").await.is_some());
2514    }
2515
2516    #[tokio::test]
2517    async fn leaving_it_off_writes_no_timestamps() {
2518        let (db, _guard) = test_db().await;
2519        let rec = create_through_pipeline(&db, false).await;
2520        assert!(rec.get(CREATED_AT).is_none());
2521        assert_eq!(fetch_text(&db, CREATED_AT, "c1").await, None);
2522    }
2523}
2524
2525#[cfg(test)]
2526mod htmx_tests {
2527    use super::tests::*;
2528    use super::*;
2529    use axum::http::StatusCode;
2530
2531    /// A submission missing a required field, so validation refuses it.
2532    fn invalid() -> HashMap<String, String> {
2533        let mut d = HashMap::new();
2534        d.insert("code".to_string(), String::new());
2535        d.insert("name".to_string(), "No code".to_string());
2536        d
2537    }
2538
2539    fn valid() -> HashMap<String, String> {
2540        let mut d = HashMap::new();
2541        d.insert("code".to_string(), "c1".to_string());
2542        d.insert("name".to_string(), "Chair".to_string());
2543        d
2544    }
2545
2546    async fn post(data: HashMap<String, String>, headers: axum::http::HeaderMap) -> Response {
2547        let (db, _guard) = test_db().await;
2548        let st = state(db);
2549        let form = PreparedForm::prepare(
2550            FormConfig {
2551                enter: Default::default(),
2552                confirm_leave: true,
2553                focus: Default::default(),
2554                entity: "samples".to_string(),
2555                title: "Sample".into(),
2556                base_path: "/admin/samples".to_string(),
2557                id_field: "id".to_string(),
2558                fields: vec![
2559                    FormField::text("code", "Code").required(),
2560                    FormField::text("name", "Name").required(),
2561                ],
2562                persist: None,
2563                timestamps: false,
2564                done_path: None,
2565            },
2566            &st.field_types,
2567            &PersisterRegistry::new(),
2568            &[],
2569        )
2570        .unwrap();
2571        create(
2572            &st,
2573            &form,
2574            data,
2575            crate::Shell::test(),
2576            &crate::audit::test_actor(),
2577            &crate::session::SessionHandle::from_blob(None),
2578            &headers,
2579        )
2580        .await
2581    }
2582
2583    async fn body_of(resp: Response) -> String {
2584        let bytes = axum::body::to_bytes(resp.into_body(), usize::MAX)
2585            .await
2586            .unwrap();
2587        String::from_utf8(bytes.to_vec()).unwrap()
2588    }
2589
2590    #[tokio::test]
2591    async fn an_htmx_submit_that_fails_returns_the_form_alone() {
2592        let resp = post(invalid(), htmx_headers()).await;
2593        assert_eq!(resp.status(), StatusCode::UNPROCESSABLE_ENTITY);
2594        let html = body_of(resp).await;
2595        assert!(html.contains("<form"), "the form comes back");
2596        assert!(html.contains("lat-field__error"), "with its errors");
2597        // A fragment, not a page: swapping a whole document into the form would
2598        // nest the admin inside itself.
2599        assert!(!html.contains("<body"), "no page chrome");
2600    }
2601
2602    #[tokio::test]
2603    async fn a_plain_submit_that_fails_returns_the_whole_page() {
2604        let resp = post(invalid(), axum::http::HeaderMap::new()).await;
2605        assert_eq!(resp.status(), StatusCode::UNPROCESSABLE_ENTITY);
2606        let html = body_of(resp).await;
2607        assert!(html.contains("<body"), "the admin still works without htmx");
2608        assert!(html.contains("lat-field__error"));
2609    }
2610
2611    #[tokio::test]
2612    async fn an_htmx_submit_that_succeeds_redirects_by_header() {
2613        let resp = post(valid(), htmx_headers()).await;
2614        // htmx cannot follow a 303 usefully; it reads this header instead.
2615        assert_eq!(resp.status(), StatusCode::NO_CONTENT);
2616        assert_eq!(resp.headers().get("HX-Redirect").unwrap(), "/admin/samples");
2617    }
2618
2619    #[tokio::test]
2620    async fn a_plain_submit_that_succeeds_still_redirects() {
2621        let resp = post(valid(), axum::http::HeaderMap::new()).await;
2622        assert_eq!(resp.status(), StatusCode::SEE_OTHER);
2623    }
2624}