1use 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#[derive(Debug, Clone)]
45#[non_exhaustive]
46pub struct FormField {
47 pub name: String,
48 pub label: Text,
50 pub field_type: String,
53 pub options: serde_json::Value,
56 pub rules: Vec<Rule>,
58 pub translatable: bool,
62 pub help: Option<Text>,
64 pub enter: FieldEnter,
67 pub span: Span,
69 pub break_row: bool,
71 pub preset: Option<Preset>,
73 pub hidden: bool,
76 pub trigger: Option<Trigger>,
78}
79
80#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Serialize, Deserialize)]
82#[serde(rename_all = "lowercase")]
83pub enum PresetShape {
84 Exact,
86 #[default]
88 Slug,
89 Url,
91 File,
93}
94
95impl PresetShape {
96 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#[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#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
156#[serde(deny_unknown_fields)]
157pub struct Trigger {
158 pub action: String,
161 pub field: String,
163 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 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 pub fn watched(&self) -> &str {
205 self.field.trim_end_matches("[]")
206 }
207}
208
209pub(crate) fn behaviour_attrs(field: &FormField) -> String {
212 fn escaped(text: &str) -> String {
213 text.replace('&', "&")
214 .replace('<', "<")
215 .replace('>', ">")
216 .replace('"', """)
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#[derive(Debug, Clone, Copy, PartialEq, Eq)]
242pub struct Span(u8);
243
244impl Span {
245 pub const FULL: Span = Span(12);
247
248 pub fn columns(columns: u8) -> Self {
250 Span(columns.clamp(1, 12))
251 }
252
253 pub fn width(self) -> u8 {
255 self.0
256 }
257
258 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 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
327pub(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#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Serialize, Deserialize)]
338#[serde(rename_all = "lowercase")]
339pub enum EnterPolicy {
340 #[default]
342 Submit,
343 Off,
345}
346
347#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Serialize, Deserialize)]
349#[serde(rename_all = "lowercase")]
350pub enum FormFocus {
351 #[default]
354 Auto,
355 Off,
357}
358
359#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Serialize, Deserialize)]
361#[serde(rename_all = "lowercase")]
362pub enum FieldEnter {
363 #[default]
365 Submit,
366 Off,
368 Next,
370}
371
372impl FieldEnter {
373 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 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 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 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 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 pub fn preset(mut self, field: &str, shape: PresetShape) -> Self {
519 self.preset = Some(Preset::new(field, shape));
520 self
521 }
522
523 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 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 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 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 pub fn switch(name: &str, label: impl Into<Text>) -> Self {
556 Self::of(name, label, "switch")
557 }
558
559 pub fn date(name: &str, label: impl Into<Text>) -> Self {
561 Self::of(name, label, "date")
562 }
563
564 pub fn password(name: &str, label: impl Into<Text>) -> Self {
567 Self::of(name, label, "password")
568 }
569
570 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 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 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 pub fn options(mut self, options: serde_json::Value) -> Self {
607 self.options = options;
608 self
609 }
610
611 pub fn required(mut self) -> Self {
613 self.rules.push(Rule::Required);
614 self
615 }
616
617 pub fn required_on(mut self, mode: Mode) -> Self {
620 self.rules.push(Rule::RequiredOn(mode));
621 self
622 }
623
624 pub fn unique(mut self) -> Self {
627 self.rules.push(Rule::Unique);
628 self
629 }
630
631 pub fn max_length(mut self, n: usize) -> Self {
633 self.rules.push(Rule::MaxLength(n));
634 self
635 }
636
637 pub fn min_length(mut self, n: usize) -> Self {
639 self.rules.push(Rule::MinLength(n));
640 self
641 }
642
643 pub fn email(mut self) -> Self {
645 self.rules.push(Rule::Email);
646 self
647 }
648
649 pub fn translatable(mut self) -> Self {
651 self.translatable = true;
652 self
653 }
654
655 pub fn help(mut self, text: impl Into<Text>) -> Self {
657 self.help = Some(text.into());
658 self
659 }
660
661 pub fn span(mut self, span: Span) -> Self {
663 self.span = span;
664 self
665 }
666
667 pub fn break_row(mut self) -> Self {
669 self.break_row = true;
670 self
671 }
672}
673
674#[derive(Debug, Clone, Serialize, Deserialize)]
680#[serde(deny_unknown_fields, default)]
681#[non_exhaustive]
682pub struct FormConfig {
683 pub entity: String,
684 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 #[serde(default)]
695 pub enter: EnterPolicy,
696 pub confirm_leave: bool,
698 pub focus: FormFocus,
700 pub persist: Option<String>,
703 #[serde(default)]
706 pub timestamps: bool,
707 #[serde(skip)]
711 pub(crate) done_path: Option<String>,
712}
713
714impl FormConfig {
715 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 pub fn persist(mut self, name: impl Into<String>) -> Self {
744 self.persist = Some(name.into());
745 self
746 }
747
748 pub fn confirm_leave(mut self, ask: bool) -> Self {
750 self.confirm_leave = ask;
751 self
752 }
753
754 pub fn focus(mut self, focus: FormFocus) -> Self {
756 self.focus = focus;
757 self
758 }
759
760 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#[derive(Clone)]
779pub(crate) struct PreparedForm {
780 pub(crate) config: FormConfig,
781 fields: Vec<PreparedField>,
783 persister: Arc<dyn Persister>,
785 listeners: Vec<Arc<dyn ModelListener>>,
787 pub(crate) stay: bool,
790}
791
792#[derive(Clone)]
795struct PreparedField {
796 field_type: Arc<dyn crate::field::FieldType>,
798 opts: ResolvedOptions,
799 rules: Vec<Rule>,
800}
801
802impl PreparedForm {
803 pub(crate) fn persister(&self) -> Arc<dyn Persister> {
805 self.persister.clone()
806 }
807
808 pub(crate) fn has_field(&self, field: &str) -> bool {
810 self.config.fields.iter().any(|f| f.name == field)
811 }
812
813 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 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 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 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
945fn 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
969pub(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
994fn merged_field_rules(form: &PreparedForm) -> Vec<FieldRules> {
996 form.config
997 .fields
998 .iter()
999 .zip(&form.fields)
1000 .map(|(f, pf)| FieldRules::new(f.name.clone(), f.label.source(), pf.rules.clone()))
1003 .collect()
1004}
1005
1006pub(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
1033async 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
1076pub(crate) type Forms = Arc<HashMap<String, Arc<PreparedForm>>>;
1079
1080#[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 pub fn entity(&self) -> &str {
1100 &self.form.config.entity
1101 }
1102
1103 pub fn id_field(&self) -> &str {
1105 &self.form.config.id_field
1106 }
1107
1108 pub fn fields(&self) -> &[FormField] {
1110 &self.form.config.fields
1111 }
1112
1113 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 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 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 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
1170pub(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
1181fn has_required(rules: &[Rule]) -> bool {
1183 rules
1184 .iter()
1185 .any(|r| matches!(r, Rule::Required | Rule::RequiredOn(_)))
1186}
1187
1188pub(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
1208fn 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
1222pub(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 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 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
1272pub(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
1302pub(crate) async fn load_values(
1306 db: &Db,
1307 form: &PreparedForm,
1308 id: &str,
1309) -> Result<Option<HashMap<String, String>>, sqlx::Error> {
1310 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#[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 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#[allow(clippy::too_many_arguments)]
1407pub(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#[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
1474pub(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
1485pub(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 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 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 errors: bag.messages(&f.name).iter().map(|m| shell.tt(m)).collect(),
1555 }
1556 })
1557 .collect();
1558 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 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 FormFocus::Auto if action.ends_with("/new") => "first",
1602 FormFocus::Auto => "",
1603 },
1604 }
1605}
1606
1607struct FieldView {
1608 id: String,
1610 label: String,
1611 control: String,
1614 required: bool,
1615 errors: Vec<String>,
1616 enter: &'static str,
1618 layout: String,
1620 attrs: String,
1622 hidden: bool,
1624}
1625
1626pub(crate) struct RelationSection {
1628 pub toolbar: crate::html::Markup,
1630 pub html: crate::html::Markup,
1631}
1632
1633pub(crate) fn escape_attr(s: &str) -> String {
1634 s.replace('&', "&")
1635 .replace('"', """)
1636 .replace('<', "<")
1637 .replace('>', ">")
1638}
1639
1640#[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_off: bool,
1653 refused: bool,
1655 leave_off: bool,
1657 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 stay: bool,
1672 sections: Vec<RelationSection>,
1674 pending: Vec<String>,
1676 enter_off: bool,
1678 refused: bool,
1680 leave_off: bool,
1682 focus: &'static str,
1684}
1685
1686pub struct ValueFieldView {
1689 pub label: String,
1690 pub help: Option<String>,
1691 pub control: String,
1693 pub layout: String,
1695 pub attrs: String,
1697}
1698
1699#[derive(Template)]
1700#[template(path = "_value_fields.html")]
1701struct ValueFieldsTemplate {
1702 fields: Vec<ValueFieldView>,
1703}
1704
1705pub struct ValueForm {
1711 fields: Vec<FormField>,
1712 types: Arc<crate::field::FieldRegistry>,
1713 overrides: Arc<dyn crate::field::OverrideResolver>,
1714 scope: String,
1716}
1717
1718impl ValueForm {
1719 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 pub fn fields(&self) -> &[FormField] {
1751 &self.fields
1752 }
1753
1754 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 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 pub fn collect(&self, data: &HashMap<String, String>) -> Result<serde_json::Value, Text> {
1778 value_collect(&self.fields, &self.types, data)
1779 }
1780}
1781
1782pub(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
1847pub(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
1872pub(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 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 .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 #[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 assert_eq!(fetch_text(&db, "name", "c1").await, None);
1997 assert_eq!(rec.text("code"), Some("c1"));
1998 }
1999
2000 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 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 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 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 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 assert_eq!(resp.status(), StatusCode::UNPROCESSABLE_ENTITY);
2161 assert_eq!(count(&db).await, 0);
2162 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 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 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 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 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 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 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 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 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 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 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}