Files
portal/src/content/mod.rs
T

1584 lines
65 KiB
Rust
Raw Normal View History

//! Content: the YAML a site is made of, loaded from its Gitea repo,
//! resolved into a router, validated, and rendered. The types and the
//! resolution rules live here; the rest is split by concern and
//! re-exported, so every path stays `content::x`:
//!
//! - `gitea`: loading and the reload watcher;
//! - `validate`: the checks a repo must pass before it serves;
//! - `markdown`: inline markdown for descriptions;
//! - `handlers`: the Axum routes that expose content and buckets.
use serde::{Deserialize, Serialize};
// Loading is server-only; the rest is shared with the browser build.
#[cfg(feature = "ssr")]
mod gitea;
mod handlers;
mod markdown;
mod validate;
#[cfg(feature = "ssr")]
pub use gitea::*;
pub use handlers::*;
pub use markdown::*;
pub use validate::*;
/// One page: a prompt plus the paths on from it. The `questions/`
/// directory tree IS the URL tree (`index.yaml` names its directory,
/// `develop/proposal.yaml` serves `/develop/proposal`), so `id` is
/// derived from the file's path - declaring it explicitly still works
/// (and wins, with a logged warning when it disagrees) but is only
/// needed by legacy content. Loaded from plain YAML files in a content
/// directory kept in its own git repo - editing content is a
/// content-repo commit, not a Rust rebuild.
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct Question {
/// The URL path this page is served at. Derived from the file path
/// when absent. A `[name]` segment (from a `[name].yaml` file)
/// makes this a dynamic page: `/review/[record]` serves any
/// `/review/<value>`, with the value substituted into `{record}`
/// placeholders in the page's resource keys (see
/// `resolve_question`).
#[serde(default)]
pub id: String,
pub name: String,
#[serde(default)]
pub description: String,
/// Kanidm group required to view/submit this question - `None` means
/// open to anyone. Content-driven on purpose: a gated page like
/// "/review" is just a Question with this set, not a bespoke Rust
/// route. Inherited from the nearest ancestor `_section.yaml` when
/// not set on the question itself.
#[serde(default)]
pub qualifies: Option<String>,
/// Question id (relative refs resolve against this file's
/// directory) the visitor must have answered - their `?chain=`
/// lineage's tip - to see this page. The provenance counterpart to
/// `qualifies`' identity check. Inherited from `_section.yaml`
/// like `qualifies`.
#[serde(default)]
pub requires_chain: Option<String>,
#[serde(default)]
pub alternatives: Vec<Alternative>,
/// Who to contact if a visitor gets stuck - rendered as a small line
/// on the page. Inherited from `_section.yaml` when not set.
#[serde(default)]
pub responsible: Option<Responsible>,
/// A page that only makes sense after answering something (the
/// post-submission pages) - kept out of the question nav until the
/// visitor has earned it: their verified `?chain=` answered the
/// alternative that leads there, or it hangs off an earned page by
/// a link that records nothing (see `earned_followups`). Nothing
/// behind an answer they have not given is offered. Unset means inferred
/// from the file's place in the tree: files nested in a
/// subdirectory are followups unless they're the directory's
/// `index.yaml`; top-level files keep the historical default
/// (not a followup).
#[serde(default)]
pub followup: Option<bool>,
/// This page announces something with a time window. While the
/// window is open the page is announced in the header (see
/// `app::Announcements`) instead of listed in the footer nav; once
/// it closes the page behaves like a `followup` (visible only to
/// visitors carrying an answer chain) and a "post what happened"
/// task lands in the `portal_events` desk (see `announce.rs`).
#[serde(default)]
pub event: Option<EventConfig>,
}
/// A page's announcement window. `starts` is RFC 3339 with an offset
/// (`2026-09-12T18:00:00+02:00`); `duration` is a plain span like
/// `3h`, `90m`, `2d`, `1d 6h`. Optional `place` is shown verbatim.
#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)]
pub struct EventConfig {
pub starts: String,
pub duration: String,
#[serde(default)]
pub place: Option<String>,
}
/// `3h`, `90m`, `2d`, `1d 6h 30m` -> milliseconds. Whole units only;
/// the smallest is a minute.
pub fn parse_duration_ms(text: &str) -> Result<i64, String> {
let mut total: i64 = 0;
let mut seen = false;
for token in text.split_whitespace() {
let (num, unit) = token.split_at(token.trim_end_matches(|c: char| c.is_ascii_alphabetic()).len());
let n: i64 = num.parse().map_err(|_| format!("bad duration {text:?}: {token:?}"))?;
let per = match unit {
"m" => 60_000,
"h" => 3_600_000,
"d" => 86_400_000,
_ => return Err(format!("bad duration {text:?}: unit {unit:?} (use m, h, d)")),
};
total += n * per;
seen = true;
}
if !seen || total <= 0 {
return Err(format!("bad duration {text:?}: must be positive"));
}
Ok(total)
}
#[cfg(feature = "ssr")]
impl EventConfig {
/// `(starts_ms, ends_ms)` as Unix milliseconds.
pub fn window_ms(&self) -> Result<(i64, i64), String> {
let starts = chrono::DateTime::parse_from_rfc3339(&self.starts)
.map_err(|e| format!("bad starts {:?}: {e} (RFC 3339 with offset)", self.starts))?
.timestamp_millis();
Ok((starts, starts + parse_duration_ms(&self.duration)?))
}
}
impl Question {
pub fn is_followup(&self) -> bool {
self.followup.unwrap_or(false)
}
/// The announcement window is still open at `now_ms` (Unix ms).
#[cfg(feature = "ssr")]
pub fn event_live_at(&self, now_ms: i64) -> bool {
self.event
.as_ref()
.and_then(|e| e.window_ms().ok())
.is_some_and(|(_, ends)| now_ms < ends)
}
/// The announcement window has closed at `now_ms`.
#[cfg(feature = "ssr")]
pub fn event_ended_at(&self, now_ms: i64) -> bool {
self.event
.as_ref()
.and_then(|e| e.window_ms().ok())
.is_some_and(|(_, ends)| now_ms >= ends)
}
/// A dynamic page - one whose id still contains a `[name]`
/// segment. Served per-value via `resolve_question`, never listed
/// in nav, never a valid `action` target.
pub fn is_dynamic(&self) -> bool {
self.id.contains('[')
}
}
/// An alternative's `action` may carry `{field}` / `{field.sub}`
/// placeholders filled from the submitted responses - `/shape/{curve.key}`
/// lands on the dynamic page `/shape/[key]` for the key the visitor's
/// stroke was given. Returns `None` when a placeholder has no value
/// (or a non-scalar one) in `responses`.
pub fn template_action(action: &str, responses: &serde_json::Value) -> Option<String> {
let mut out = String::new();
let mut rest = action;
while let Some(start) = rest.find('{') {
out.push_str(&rest[..start]);
let end = rest[start..].find('}')? + start;
let path = &rest[start + 1..end];
let mut value = responses;
for seg in path.split('.') {
value = value.get(seg)?;
}
let scalar = match value {
serde_json::Value::String(s) => s.clone(),
serde_json::Value::Number(n) => n.to_string(),
serde_json::Value::Bool(b) => b.to_string(),
_ => return None,
};
if scalar.is_empty() {
return None;
}
// A URL segment: keep it to what a segment can carry.
let safe: String = scalar
.chars()
.map(|c| if c.is_ascii_alphanumeric() || "-_.".contains(c) { c } else { '-' })
.collect();
out.push_str(&safe);
rest = &rest[end + 1..];
}
out.push_str(rest);
Some(out)
}
/// Directory-scoped defaults: a `_section.yaml` file applies to every
/// question at or below its directory (nearest ancestor wins per
/// field, and a question's own declaration always overrides). This is
/// what makes a URL prefix a trust boundary - "everything under
/// /review is owner-only" is one line in `review/_section.yaml`
/// instead of a flag per file. Underscore-prefixed files that aren't
/// `_section.yaml` are skipped entirely (drafts).
#[derive(Clone, Debug, Default, Serialize, Deserialize)]
pub struct SectionConfig {
#[serde(default)]
pub qualifies: Option<String>,
#[serde(default)]
pub requires_chain: Option<String>,
#[serde(default)]
pub responsible: Option<Responsible>,
}
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct Responsible {
pub name: String,
/// A mailto address or plain email - deliberately just a string,
/// same as everywhere else content keeps contact info simple.
pub contact: String,
}
/// Whether to render `question`'s alternatives or its sign-in gate for
/// `user`. A rendering hint for the browser, which has no policy: the
/// server decides every submit, read, move and listing through
/// `access::Policy`, and this must agree with the `open` rule there
/// (a page is open to anyone unless `qualifies` names a group).
/// Group membership is fixed at login, not re-checked live.
pub fn is_qualified(user: Option<&crate::auth::User>, question: &Question) -> bool {
match &question.qualifies {
None => true,
Some(group) => user.is_some_and(|u| u.groups.iter().any(|g| g == group)),
}
}
/// One path through a question: a short pitch, an optional next question
/// to advance to on submit, and the form (via `features`) that collects
/// what's needed to get there.
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct Alternative {
pub name: String,
#[serde(default)]
pub description: String,
#[serde(default)]
pub action: Option<String>,
/// Shown but not takeable yet - the button renders disabled and the
/// server refuses the submission. For advertising a path before it
/// works (lysbue had the same flag).
#[serde(default)]
pub disabled: bool,
#[serde(default)]
pub consequence: Vec<String>,
#[serde(default)]
pub encouragements: Vec<String>,
/// Banner image urls, rendered above the description - one renders
/// as a plain image, several as a swipeable card deck (Swiper
/// Element, vendored in `public/`). Purely decorative, no
/// upload/hosting mechanism of their own, just already-hosted urls
/// the browser fetches directly (unlike `ResourceSource::Url`,
/// never fetched server-side, so none of that variant's SSRF
/// concern).
#[serde(default)]
pub images: Vec<String>,
#[serde(default)]
pub features: Vec<Feature>,
2026-08-12 22:55:36 +02:00
/// NATS KV bucket to durably store this submission into - just a
/// bucket name, never a keyword the runtime special-cases.
#[serde(default)]
pub record_as: Option<String>,
2026-08-12 22:55:36 +02:00
/// A transition fireable by anyone holding one specific item's own
/// reference (`?chain=` link) plus a matching `email` - the
/// anonymous, single-item counterpart to `ResourceSpec.transitions`'
/// group-gated bucket browsing. The email is a second factor
/// checked against the stored item, not the lookup key.
#[serde(default)]
pub self_transition: Option<SelfTransition>,
/// Submitting this alternative invites a person into a Kanidm
/// group: the form's `name` and `email` become an account, the
/// group membership, and a one-time link to set their own
/// credentials (see `people.rs`). Only on a page gated by
/// `qualifies`: the inviting group is that page's, the invited
/// group is this. The link lands in the runtime's `portal_invites`
/// bucket for the inviter's desk, and on `portal.people.invited`.
#[serde(default)]
pub invite: Option<Invite>,
}
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct Invite {
pub group: String,
}
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct SelfTransition {
pub bucket: String,
pub to: String,
pub label: String,
}
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct Feature {
pub name: String,
#[serde(default)]
pub description: String,
2026-08-12 22:55:36 +02:00
/// Any valid CSS color - set as the feature's `--feature-accent`
/// custom property (never interpolated into a stylesheet, so a bad
/// value fails to apply instead of injecting CSS). Unset means no
/// accent border at all.
#[serde(default)]
pub color: Option<String>,
/// An Iconify icon name (`{prefix}:{name}`, e.g. `lucide:star`),
2026-08-12 22:55:36 +02:00
/// rendered via Iconify's public SVG API - no icon library bundled.
#[serde(default)]
pub icon: Option<String>,
#[serde(default)]
pub requirements: Vec<Requirement>,
/// Live data this feature pulls in. Read-only unless `transitions`
/// is non-empty, in which case listed answers get one action button
/// per transition (see `src/resource.rs`, `src/answers.rs`).
#[serde(default)]
pub resource: Option<ResourceSpec>,
}
2026-08-12 22:55:36 +02:00
/// A live-data read declared in content. The bucket/key are only ever
/// resolved server-side from trusted content - a client names a
/// question + feature, never a bucket directly, so a visitor can't
/// probe arbitrary buckets. No render-mode tag: what a resource
/// displays as follows from its data's shape.
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct ResourceSpec {
pub source: ResourceSource,
/// A single item; omit to list the whole bucket. Only meaningful
/// for a `Kv` source.
#[serde(default)]
pub key: Option<String>,
/// Kanidm group required to read this resource.
#[serde(default)]
pub requires_group: Option<String>,
/// Must be explicitly set for an anonymous-readable resource - a
2026-08-12 22:55:36 +02:00
/// spec with neither this nor `requires_group` is unreachable
/// (fail closed). Reads only: mutations always require
/// `requires_group` regardless of this flag.
#[serde(default)]
pub public: bool,
2026-08-12 22:55:36 +02:00
/// The moves a listed answer may make, one button each - empty
/// means read-only. Server calls are checked against this
/// allow-list, so a client can never fire a transition content
/// didn't declare. `Kv` sources only.
#[serde(default)]
pub transitions: Vec<Transition>,
2026-08-12 22:55:36 +02:00
/// A jq filter (evaluated via `jaq`, no shell-out) reshaping the
/// fetched value before it reaches the frontend - e.g.
/// `.[] | {name, url: .html_url}`. `None` returns it as-is.
#[serde(default)]
pub jq: Option<String>,
/// What to say when the resource yields nothing - an empty list,
/// or `null` (a `.[] | ...` jq over an empty list produces no
/// output at all). Defaults to "Nothing here yet."; content sets
/// it where the silence needs a voice ("Nothing released yet").
#[serde(default)]
pub empty: Option<String>,
}
2026-08-12 22:55:36 +02:00
/// Where a resource's live data comes from. `Kv` (a NATS KV bucket
/// this server owns) is the only mutable source; the rest are
/// read-only live pulls.
#[derive(Clone, Debug, Serialize, Deserialize)]
#[serde(tag = "kind", rename_all = "snake_case")]
pub enum ResourceSource {
Kv { bucket: String },
GiteaStarred { username: String },
GiteaOrgRepos { org: String },
/// A repo's releases - fetched with `GITEA_API_TOKEN`, so it works
/// for private repos too (shape the link with jq: a private
/// release's html_url 404s for anonymous visitors, so map it to
/// null unless the repo is public).
GiteaReleases { owner: String, repo: String },
2026-08-12 22:55:36 +02:00
/// Any other HTTPS JSON endpoint. Scheme-restricted and checked
/// against loopback/private/link-local addresses at fetch time
/// (`resource::fetch_url_resource`) - a server-side fetch of a
/// content-supplied URL is SSRF surface, so it fails closed.
Url { url: String },
}
impl ResourceSpec {
2026-08-12 22:55:36 +02:00
/// The KV bucket this resource reads/writes - `None` for a live
/// external pull.
pub fn bucket(&self) -> Option<&str> {
match &self.source {
ResourceSource::Kv { bucket } => Some(bucket),
ResourceSource::GiteaStarred { .. }
| ResourceSource::GiteaOrgRepos { .. }
| ResourceSource::GiteaReleases { .. }
| ResourceSource::Url { .. } => None,
}
}
}
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct Transition {
2026-08-12 22:55:36 +02:00
/// The state a row must be in for this transition's button to
/// render and its server call to be accepted. Defaults to "open".
#[serde(default = "default_transition_from")]
pub from: String,
pub to: String,
pub label: String,
}
fn default_transition_from() -> String {
crate::answers::OPEN_STATE.to_string()
}
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct Requirement {
pub name: String,
#[serde(default)]
pub label: Option<String>,
#[serde(default)]
pub placeholder: Option<String>,
#[serde(default = "default_requirement_type", rename = "type")]
pub kind: String,
#[serde(default)]
pub optional: bool,
/// `type: file` - accept multiple files. `type: select` - pick more
/// than one option (checkbox-style toggle) instead of exactly one
/// (radio-style); the submitted value is a JSON array of ids
/// instead of a single id string.
#[serde(default)]
pub multiple: bool,
/// `type: file` only - HTML `accept` hint (UX only, not a security
/// boundary - the upload handler re-checks content-type itself).
#[serde(default)]
pub accept: Option<String>,
2026-08-12 22:55:36 +02:00
/// `type: select` only - where the options come from; the same
/// `ResourceSpec` mechanism a `Feature.resource` uses.
#[serde(default)]
pub resource: Option<ResourceSpec>,
2026-09-01 20:20:50 +02:00
/// `type: select` only - a static list of options, as an
/// alternative to a `resource`. Each string is both the option's
/// stored value and its label. Faithful to the ancestor format's
/// inline enums.
#[serde(default)]
pub options: Vec<String>,
2026-08-12 22:55:36 +02:00
/// `type: select` only - which field in each item is the option's
/// stable id. Defaults to trying `_id` then `id`.
#[serde(default)]
pub id_field: Option<String>,
/// Load this field's value from a resource whenever a sibling
/// field changes - e.g. a file select populating a textarea with
/// the selected file's current content.
#[serde(default)]
pub bind: Option<Bind>,
/// A preset value the field starts with. On a dynamic page the
/// URL segment substitutes into `{name}` placeholders here, like
/// resource keys - `value: "{key}"` on a hidden field carries the
/// page's key into the answer.
#[serde(default)]
pub value: Option<String>,
/// `type: gesture` / `type: voice` - ws(s):// URL of a redoal-relay instance
/// the drawing widget connects to for live echoes of similar
/// strokes. Absent means the widget works offline: the drawn path
/// still submits, it just never gets a network-computed key or
/// echoes.
#[serde(default)]
pub relay: Option<String>,
}
/// A field's live data source, parameterized by a sibling field's
/// value. When the sibling changes, `resource` is fetched with the
/// value as a parameter and the result replaces this field's value
/// (an empty sibling never fetches, and never clears an edit).
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct Bind {
/// The sibling requirement (same alternative) to watch.
pub field: String,
/// The parameter name the sibling's value is sent as - `{name}`
/// templates into a Url source's path, otherwise it's appended as
/// a query pair. Defaults to `field`.
#[serde(default)]
pub param: Option<String>,
pub resource: ResourceSpec,
}
impl Bind {
pub fn param_name(&self) -> &str {
self.param.as_deref().unwrap_or(&self.field)
}
}
fn default_requirement_type() -> String {
"text".to_string()
}
impl Requirement {
pub fn display_label(&self) -> String {
self.label.clone().unwrap_or_else(|| self.name.clone())
}
}
/// Site-wide branding declared by the content repo - `site.yaml` at
/// the repo root, sibling of `aggregates.yaml`. An absent file means
/// all defaults, which is exactly the historical uhhm look: existing
/// deployments change nothing without a content edit. Everything the
/// browser needs, so it travels through a server fn (`get_site`).
#[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq)]
pub struct SiteConfig {
/// Browser-tab title and wordmark alt text. `None` falls back to
/// the compile-time `SITE_NAME`.
#[serde(default)]
pub title: Option<String>,
/// Wordmark image URL (absolute or a path this instance serves).
/// `None` falls back to `/wordmark.svg`.
#[serde(default)]
pub wordmark: Option<String>,
/// Whether to invert the wordmark in light theme. `None` inverts
/// only the built-in house wordmark (a white-stroke SVG); a
/// content-shipped logo keeps its own colours unless it sets this
/// true (e.g. a sibling site's white-stroke mark).
#[serde(default)]
pub wordmark_invert: Option<bool>,
/// Wordmark display height in rem (0.5–6.0). `None` keeps the
/// stylesheet's default. Raster logos look best at or below their
/// intrinsic pixel height.
#[serde(default)]
pub wordmark_height: Option<f32>,
/// BCP 47-ish language code for the portal's own chrome strings
/// ("Asked by", the nav lead...) and the html lang attribute.
/// `None` means "en"; unknown codes fall back to English per key.
#[serde(default)]
pub lang: Option<String>,
/// A content-repo-relative CSS file (e.g. "custom.css") layered
/// *after* the default stylesheet, so it overrides. Served
/// same-origin at `/site/<path>`; plain path only.
#[serde(default)]
pub stylesheet: Option<String>,
2026-09-01 22:12:20 +02:00
/// A content-repo-relative favicon (svg/png/ico), served at
/// `/site/<path>` and used in place of the built-in one.
#[serde(default)]
pub favicon: Option<String>,
#[serde(default)]
pub hero: HeroConfig,
}
/// What the landing page's hero is. `plain` is just the copy; `module`
/// hands the hero to a JavaScript module the content repo itself
/// ships (`module: hero.js`, a repo-relative path portal serves
/// same-origin at `/site/<path>`, since Gitea's raw endpoint sends no
/// CORS headers). The module exports `mount(container) -> handle` and
/// the handle has `stop()`; portal starts it at HTML parse time and
/// adopts it on hydration. The piece's look - canvases, SVG, CSS - is
/// entirely the module's: portal only reserves the box.
#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
pub struct HeroConfig {
#[serde(default = "default_hero_kind")]
pub kind: String,
#[serde(default)]
pub module: Option<String>,
}
impl Default for HeroConfig {
fn default() -> Self {
Self { kind: default_hero_kind(), module: None }
}
}
fn default_hero_kind() -> String {
"plain".to_string()
}
#[cfg(feature = "ssr")]
impl SiteConfig {
/// Same policy as `validate_questions`: content declares, the
/// runtime refuses what it doesn't understand at load time, so a
/// typo'd hero kind is a caught rejection, not a silently plain
/// hero.
pub fn validate(&self) -> anyhow::Result<()> {
match self.hero.kind.as_str() {
"plain" => {
if self.hero.module.is_some() {
anyhow::bail!("site.yaml: hero.module only makes sense with hero.kind: module");
}
}
"module" => {
let Some(module) = &self.hero.module else {
anyhow::bail!("site.yaml: hero.kind: module needs hero.module (a repo-relative path like hero.js)");
};
if !is_safe_site_path(module) {
anyhow::bail!(
"site.yaml: hero.module {module:?} must be a plain repo-relative path (no scheme, no .., no leading /)"
);
}
}
other => anyhow::bail!("site.yaml: hero.kind {other:?} is not one of plain | module"),
}
if let Some(sheet) = &self.stylesheet {
if !is_safe_site_path(sheet) || !sheet.ends_with(".css") {
anyhow::bail!(
"site.yaml: stylesheet {sheet:?} must be a plain repo-relative .css path"
);
}
}
2026-09-01 22:12:20 +02:00
if let Some(icon) = &self.favicon {
let ok = [".svg", ".png", ".ico"].iter().any(|e| icon.ends_with(e));
if !is_safe_site_path(icon) || !ok {
anyhow::bail!(
"site.yaml: favicon {icon:?} must be a plain repo-relative .svg/.png/.ico path"
);
}
}
Ok(())
}
}
/// Fetches every `*.yaml` file under `subdir` in a Gitea repo as a
/// `Question`, keyed by its own `id`. `repo_url` is the repo's normal
/// browser URL (e.g. `https://project.uhhm.no/uhhm/questions`) - the
/// Gitea host, owner and repo name are all read from it. Called once at
/// startup, and again on every `CONTENT_RELOAD_SUBJECT` message (see
/// `watch_for_reload`), over Gitea's public contents API (no auth - the
/// content repo is public).
/// The URL a file at `rel` (path relative to the questions dir, forward
/// slashes) serves: `index.yaml` names its directory, everything else
/// appends its stem.
pub fn route_from_path(rel: &str) -> String {
let stem = rel.strip_suffix(".yaml").unwrap_or(rel);
let mut segments: Vec<&str> = stem.split('/').collect();
if segments.last() == Some(&"index") {
segments.pop();
}
if segments.is_empty() {
"/".to_string()
} else {
format!("/{}", segments.join("/"))
}
}
/// The directory (as a URL prefix) of the file at `rel` - the base
/// relative references resolve against.
pub fn dir_from_path(rel: &str) -> String {
match rel.rsplit_once('/') {
Some((dir, _)) => format!("/{dir}"),
None => "/".to_string(),
}
}
/// Resolves a possibly-relative question reference (`action:`,
/// `requires_chain:`) against the referencing file's directory:
/// `/x` is absolute, `proposed` names a sibling, `../x` climbs.
pub fn resolve_ref(base_dir: &str, reference: &str) -> String {
if reference.starts_with('/') {
return reference.to_string();
}
let mut segments: Vec<&str> = base_dir.split('/').filter(|s| !s.is_empty()).collect();
for part in reference.split('/') {
match part {
"" | "." => {}
".." => {
segments.pop();
}
s => segments.push(s),
}
}
if segments.is_empty() {
"/".to_string()
} else {
format!("/{}", segments.join("/"))
}
}
/// Whether `path` matches `pattern`, capturing `[name]` segments.
/// Returns the captured (name, value) pairs on a match - empty for an
/// exact literal match.
pub fn path_matches(pattern: &str, path: &str) -> Option<Vec<(String, String)>> {
let pat: Vec<&str> = pattern.split('/').filter(|s| !s.is_empty()).collect();
let got: Vec<&str> = path.split('/').filter(|s| !s.is_empty()).collect();
if pat.len() != got.len() {
return None;
}
let mut captures = Vec::new();
for (p, g) in pat.iter().zip(got.iter()) {
if let Some(name) = p.strip_prefix('[').and_then(|s| s.strip_suffix(']')) {
if g.is_empty() {
return None;
}
captures.push((name.to_string(), (*g).to_string()));
} else if p != g {
return None;
}
}
Some(captures)
}
/// The question an alternative's `action` lands on, as a question id:
/// a plain path resolves directly, a templated one
/// (`/shape/{curve.key}`) to the dynamic page whose pattern has the
/// same shape (`/shape/[key]`). `None` when no page declares it.
pub fn action_target_id(
questions: &std::collections::HashMap<String, Question>,
action: &str,
) -> Option<String> {
if questions.contains_key(action) {
return Some(action.to_string());
}
let want: Vec<&str> = action.split('/').filter(|s| !s.is_empty()).collect();
questions
.values()
.filter(|q| q.is_dynamic())
.map(|q| &q.id)
.find(|id| {
let pat: Vec<&str> = id.split('/').filter(|s| !s.is_empty()).collect();
pat.len() == want.len()
&& pat
.iter()
.zip(&want)
.all(|(p, w)| p == w || (p.starts_with('[') && w.starts_with('{')))
})
.cloned()
}
/// An alternative whose action asks nothing of the visitor: no answer
/// is recorded, so following it is navigation, not a step they have to
/// complete.
fn asks_nothing(alt: &Alternative) -> bool {
!alt.disabled && alt.record_as.is_none() && alt.self_transition.is_none()
}
/// The pages a verified answer has earned: where the answered
/// alternative sends the visitor next (a templated action resolves to
/// its dynamic pattern). When the node predates alternatives being
/// indexed, every recording alternative of that question counts - the
/// visitor did answer it, only which alternative is unknown.
pub fn unlocked_by(
questions: &std::collections::HashMap<String, Question>,
question_id: &str,
alternative: Option<&str>,
) -> Vec<String> {
let Some(question) = resolve_question(questions, question_id) else {
return Vec::new();
};
question
.alternatives
.iter()
.filter(|a| match alternative {
Some(name) => a.name == name,
None => a.record_as.is_some(),
})
.filter_map(|a| a.action.as_deref())
.filter_map(|action| action_target_id(questions, action))
.collect()
}
/// The followups a visitor may be offered, given the pages they have
/// earned: `seeds` (the page a verified chain sent them to) plus every
/// outcome page reachable from a seed or from `current` over
/// alternatives that ask nothing - never through one that records an
/// answer, since that answer is exactly what they have not given. A
/// front door is never in the result and ends the walk, so "back to
/// the start" never fans out into the site; standing on a page earns
/// nothing by itself beyond what it links to for free.
pub fn earned_followups(
questions: &std::collections::HashMap<String, Question>,
current: &str,
seeds: &[String],
is_outcome: &dyn Fn(&Question) -> bool,
) -> std::collections::HashSet<String> {
use std::collections::{HashSet, VecDeque};
let mut earned: HashSet<String> = HashSet::new();
let mut queue: VecDeque<Question> = VecDeque::new();
for seed in seeds {
if let Some(q) = questions.get(seed).filter(|q| is_outcome(q)) {
earned.insert(seed.clone());
queue.push_back(q.clone());
}
}
if let Some(q) = resolve_question(questions, current) {
queue.push_back(q);
}
while let Some(q) = queue.pop_front() {
for action in q.alternatives.iter().filter(|a| asks_nothing(a)).filter_map(|a| a.action.as_deref()) {
let Some(id) = action_target_id(questions, action) else {
continue;
};
let target = &questions[&id];
if !is_outcome(target) || earned.contains(&id) || path_matches(&id, current).is_some() {
continue;
}
earned.insert(id.clone());
queue.push_back(target.clone());
}
}
earned
}
/// Resolves a URL path to its question: an exact id first, else the
/// one dynamic page whose pattern matches, with each captured segment
/// substituted into `{name}` placeholders in the clone's resource keys
/// and its id set to the concrete path (so every follow-up server call
/// - resources, submissions - re-resolves the same way). The
/// substituted key is still looked up in the content-declared bucket,
/// so a visitor varies the key, never the bucket - the same trust
/// shape as a `?chain=` link, where knowing a record's key is holding
/// it.
pub fn resolve_question(
questions: &std::collections::HashMap<String, Question>,
path: &str,
) -> Option<Question> {
if let Some(q) = questions.get(path) {
return Some(q.clone());
}
for q in questions.values() {
if !q.is_dynamic() {
continue;
}
if let Some(captures) = path_matches(&q.id, path) {
let mut resolved = q.clone();
resolved.id = path.to_string();
let substitute = |key: &mut Option<String>| {
if let Some(k) = key {
for (name, value) in &captures {
*k = k.replace(&format!("{{{name}}}"), value);
}
}
};
// A url source's address takes the segment too:
// `https://relay.redoal.com/place/{key}`.
let substitute_url = |src: &mut ResourceSource| {
if let ResourceSource::Url { url } = src {
for (name, value) in &captures {
*url = url.replace(&format!("{{{name}}}"), value);
}
}
};
for alt in &mut resolved.alternatives {
for feature in &mut alt.features {
if let Some(res) = &mut feature.resource {
substitute(&mut res.key);
substitute_url(&mut res.source);
}
for req in &mut feature.requirements {
if let Some(res) = &mut req.resource {
substitute(&mut res.key);
}
substitute(&mut req.value);
}
}
}
return Some(resolved);
}
}
None
}
/// Builds the question map from raw (path, yaml) files - the shared
/// back half of both loaders (Gitea tree and `question_lint --path`).
/// Applies the whole filesystem-routing contract: derived ids,
/// relative-reference resolution, followup inference, `_section.yaml`
/// inheritance, and the tree-shape rules (no id collisions, at most
/// one dynamic page per directory).
#[cfg(feature = "ssr")]
pub fn build_questions(
files: &[(String, String)],
) -> anyhow::Result<std::collections::HashMap<String, Question>> {
// Sections first: (directory prefix, config), shallowest first so a
// later (deeper) section overrides an outer one field-by-field.
let mut sections: Vec<(String, SectionConfig)> = Vec::new();
for (rel, raw) in files {
let name = rel.rsplit('/').next().unwrap_or(rel);
if name != "_section.yaml" {
continue;
}
let mut section: SectionConfig = serde_yaml::from_str(raw)
.map_err(|e| anyhow::anyhow!("parsing {rel}: {e}"))?;
let dir = dir_from_path(rel);
if let Some(rc) = &section.requires_chain {
section.requires_chain = Some(resolve_ref(&dir, rc));
}
sections.push((dir, section));
}
sections.sort_by_key(|(dir, _)| dir.len());
let mut out = std::collections::HashMap::new();
let mut dynamic_dirs = std::collections::HashSet::new();
for (rel, raw) in files {
let name = rel.rsplit('/').next().unwrap_or(rel);
// Underscore files are sections or drafts, never pages.
if name.starts_with('_') {
continue;
}
let mut question: Question =
serde_yaml::from_str(raw).map_err(|e| anyhow::anyhow!("parsing {rel}: {e}"))?;
let derived = route_from_path(rel);
let dir = dir_from_path(rel);
if question.id.is_empty() {
question.id = derived.clone();
} else if question.id != derived {
tracing::warn!(
"{rel}: declared id {:?} disagrees with its path ({derived}) - the declared id wins, but consider moving the file",
question.id
);
}
for alt in &mut question.alternatives {
if let Some(action) = &alt.action {
alt.action = Some(resolve_ref(&dir, action));
}
}
if let Some(rc) = &question.requires_chain {
question.requires_chain = Some(resolve_ref(&dir, rc));
}
if question.followup.is_none() {
// Nested non-index files are flow steps and outcomes -
// followups by construction. Top-level files keep the
// historical flat-repo default.
let nested = rel.contains('/');
let is_index = name == "index.yaml";
question.followup = Some(nested && !is_index);
}
// Nearest-ancestor section fills whatever the question left
// unset (walk deepest-last, so later matches override earlier
// section values but never the question's own).
for (sdir, section) in &sections {
let applies = *sdir == "/" || dir == *sdir || dir.starts_with(&format!("{sdir}/"));
if !applies {
continue;
}
if question.qualifies.is_none() {
question.qualifies = section.qualifies.clone();
}
if question.requires_chain.is_none() {
question.requires_chain = section.requires_chain.clone();
}
if question.responsible.is_none() {
question.responsible = section.responsible.clone();
}
}
if question.is_dynamic() && !dynamic_dirs.insert(dir.clone()) {
anyhow::bail!(
"{rel}: more than one dynamic ([name].yaml) page in {dir} - matching would be ambiguous"
);
}
if let Some(previous) = out.insert(question.id.clone(), question) {
anyhow::bail!(
"{rel}: id {:?} is already declared by another file",
previous.id
);
}
}
Ok(out)
}
#[cfg(all(test, feature = "ssr"))]
mod tests {
use super::*;
fn schema_fixture() -> std::collections::HashMap<String, crate::aggregates::AggregateSchema> {
crate::aggregates::parse_aggregates_yaml(
r#"
aggregates:
- bucket: things
initial: open
states:
open: { event: opened }
middle: { event: advanced }
done: { event: finished }
transitions:
open: [middle]
middle: [done]
"#,
)
.unwrap()
}
fn question_with_transitions(transitions_yaml: &str) -> std::collections::HashMap<String, Question> {
let question: Question = serde_yaml::from_str(&format!(
r#"
id: /t
name: T
alternatives:
- name: A
features:
- name: ""
resource:
source: {{ kind: kv, bucket: things }}
requires_group: owners
transitions:
{transitions_yaml}
"#
))
.unwrap();
std::collections::HashMap::from([(question.id.clone(), question)])
}
#[test]
fn declared_edge_passes() {
let questions = question_with_transitions(
" - { from: open, to: middle, label: Advance }\n - { from: middle, to: done, label: Finish }",
);
assert!(validate_questions(&questions, &schema_fixture()).is_ok());
}
#[test]
fn from_defaults_to_open() {
let questions = question_with_transitions(" - { to: middle, label: Advance }");
assert!(validate_questions(&questions, &schema_fixture()).is_ok());
}
#[test]
fn undeclared_from_state_is_rejected() {
let questions = question_with_transitions(" - { from: bogus, to: middle, label: X }");
let err = validate_questions(&questions, &schema_fixture()).unwrap_err();
assert!(err.to_string().contains("transition.from"));
}
#[test]
fn undeclared_edge_is_rejected() {
// Both states exist, but open -> done skips a step the graph
// never declared.
let questions = question_with_transitions(" - { from: open, to: done, label: Skip }");
let err = validate_questions(&questions, &schema_fixture()).unwrap_err();
assert!(err.to_string().contains("not a declared edge"));
}
#[test]
fn dangling_action_is_rejected() {
let question: Question =
serde_yaml::from_str("id: /a\nname: A\nalternatives:\n - name: Go\n action: /nowhere\n")
.unwrap();
let questions = std::collections::HashMap::from([(question.id.clone(), question)]);
let err = validate_questions(&questions, &Default::default()).unwrap_err();
assert!(err.to_string().contains("does not match any declared question id"));
}
#[test]
fn self_referencing_action_passes() {
let question: Question =
serde_yaml::from_str("id: /a\nname: A\nalternatives:\n - name: Go\n action: /a\n")
.unwrap();
let questions = std::collections::HashMap::from([(question.id.clone(), question)]);
assert!(validate_questions(&questions, &Default::default()).is_ok());
}
fn question_with_bind(bind_field: &str) -> std::collections::HashMap<String, Question> {
let question: Question = serde_yaml::from_str(&format!(
r#"
id: /b
name: B
alternatives:
- name: A
features:
- name: ""
requirements:
- name: picker
type: select
resource:
public: true
source: {{ kind: url, url: "https://x.example/list" }}
- name: body
type: textarea
bind:
field: {bind_field}
resource:
public: true
source: {{ kind: url, url: "https://x.example/item/{{picker}}" }}
"#
))
.unwrap();
std::collections::HashMap::from([(question.id.clone(), question)])
}
#[test]
fn bind_to_sibling_passes() {
assert!(validate_questions(&question_with_bind("picker"), &Default::default()).is_ok());
}
#[test]
fn bind_to_missing_sibling_is_rejected() {
let err =
validate_questions(&question_with_bind("bogus"), &Default::default()).unwrap_err();
assert!(err.to_string().contains("not another requirement"));
}
#[test]
fn bind_to_itself_is_rejected() {
let err = validate_questions(&question_with_bind("body"), &Default::default()).unwrap_err();
assert!(err.to_string().contains("not another requirement"));
}
fn question_with_requirement(req_yaml: &str) -> std::collections::HashMap<String, Question> {
let question: Question = serde_yaml::from_str(&format!(
"id: /g\nname: G\nalternatives:\n - name: A\n features:\n - name: \"\"\n requirements:\n{req_yaml}\n"
))
.unwrap();
std::collections::HashMap::from([(question.id.clone(), question)])
}
#[test]
fn gesture_with_wss_relay_passes() {
let questions = question_with_requirement(
" - { name: curve, type: gesture, relay: \"wss://relay.redoal.com\", optional: true }",
);
assert!(validate_questions(&questions, &Default::default()).is_ok());
}
#[test]
fn gesture_without_relay_passes_offline() {
let questions =
question_with_requirement(" - { name: curve, type: gesture, optional: true }");
assert!(validate_questions(&questions, &Default::default()).is_ok());
}
#[test]
fn relay_on_non_gesture_kind_is_rejected() {
let questions = question_with_requirement(
" - { name: email, type: email, relay: \"wss://relay.redoal.com\" }",
);
let err = validate_questions(&questions, &Default::default()).unwrap_err();
assert!(err.to_string().contains("relay only makes sense on type: gesture"));
}
#[test]
fn https_relay_is_rejected() {
let questions = question_with_requirement(
" - { name: curve, type: gesture, relay: \"https://relay.redoal.com\" }",
);
let err = validate_questions(&questions, &Default::default()).unwrap_err();
assert!(err.to_string().contains("ws:// or wss://"));
}
#[test]
fn site_config_defaults_to_the_plain_hero() {
let site = SiteConfig::default();
assert_eq!(site.hero.kind, "plain");
assert!(site.validate().is_ok());
// And an empty file parses to the same thing.
let parsed: SiteConfig = serde_yaml::from_str("{}").unwrap();
assert_eq!(parsed, site);
}
#[test]
fn site_config_rejects_unknown_hero_kind() {
let site: SiteConfig = serde_yaml::from_str("hero: { kind: fireworks }").unwrap();
let err = site.validate().unwrap_err();
assert!(err.to_string().contains("fireworks"));
}
#[test]
fn site_config_module_hero_needs_a_safe_path() {
let missing: SiteConfig = serde_yaml::from_str("hero: { kind: module }").unwrap();
assert!(missing.validate().is_err());
let traversal: SiteConfig =
serde_yaml::from_str("hero: { kind: module, module: ../etc/passwd }").unwrap();
assert!(traversal.validate().is_err());
let absolute: SiteConfig =
serde_yaml::from_str("hero: { kind: module, module: https://x/y.js }").unwrap();
assert!(absolute.validate().is_err());
let ok: SiteConfig = serde_yaml::from_str("hero: { kind: module, module: hero.js }").unwrap();
assert!(ok.validate().is_ok());
}
#[test]
fn redoal_site_yaml_shape_parses() {
let site: SiteConfig = serde_yaml::from_str(
"title: redoal\nwordmark: https://project.uhhm.no/redoal/questions/raw/branch/main/wordmark.svg\nhero:\n kind: module\n module: hero.js\n",
)
.unwrap();
assert!(site.validate().is_ok());
assert_eq!(site.title.as_deref(), Some("redoal"));
assert_eq!(site.hero.module.as_deref(), Some("hero.js"));
}
#[test]
fn routes_derive_from_paths() {
assert_eq!(route_from_path("index.yaml"), "/");
assert_eq!(route_from_path("applied.yaml"), "/applied");
assert_eq!(route_from_path("develop/index.yaml"), "/develop");
assert_eq!(route_from_path("develop/proposal.yaml"), "/develop/proposal");
assert_eq!(route_from_path("review/[record].yaml"), "/review/[record]");
}
#[test]
fn relative_refs_resolve_against_the_file_dir() {
assert_eq!(resolve_ref("/develop", "proposed"), "/develop/proposed");
assert_eq!(resolve_ref("/develop", "/subscribed"), "/subscribed");
assert_eq!(resolve_ref("/develop", "../applied"), "/applied");
assert_eq!(resolve_ref("/", "applied"), "/applied");
assert_eq!(resolve_ref("/", ".."), "/");
}
#[test]
fn dynamic_patterns_capture_segments() {
assert_eq!(path_matches("/review/[record]", "/review/abc"),
Some(vec![("record".into(), "abc".into())]));
assert_eq!(path_matches("/review/[record]", "/review"), None);
assert_eq!(path_matches("/review/[record]", "/other/abc"), None);
assert_eq!(path_matches("/review", "/review"), Some(vec![]));
}
#[test]
fn tree_becomes_router_with_inference_and_sections() {
let files = vec![
("index.yaml".to_string(), "name: Home\nalternatives:\n - name: go\n action: applied\n".to_string()),
("applied.yaml".to_string(), "name: Applied\nfollowup: true\n".to_string()),
("develop/index.yaml".to_string(), "name: Develop\nalternatives:\n - name: propose\n action: proposal\n".to_string()),
("develop/proposal.yaml".to_string(), "name: Proposal\nalternatives:\n - name: send\n action: proposed\n".to_string()),
("develop/proposed.yaml".to_string(), "name: Proposed\n".to_string()),
("review/_section.yaml".to_string(), "qualifies: portal_owners\n".to_string()),
("review/index.yaml".to_string(), "name: Review\n".to_string()),
("review/_draft.yaml".to_string(), "not even valid yaml: [\n".to_string()),
];
let questions = build_questions(&files).unwrap();
// Derived ids and resolved relative actions.
assert_eq!(questions["/"].alternatives[0].action.as_deref(), Some("/applied"));
assert_eq!(
questions["/develop"].alternatives[0].action.as_deref(),
Some("/develop/proposal")
);
assert_eq!(
questions["/develop/proposal"].alternatives[0].action.as_deref(),
Some("/develop/proposed")
);
// Followup inference: nested non-index files are followups,
// index files and top-level files are not (explicit wins).
assert!(!questions["/"].is_followup());
assert!(questions["/applied"].is_followup());
assert!(!questions["/develop"].is_followup());
assert!(questions["/develop/proposal"].is_followup());
// Section inheritance gates the directory; drafts are skipped.
assert_eq!(questions["/review"].qualifies.as_deref(), Some("portal_owners"));
assert_eq!(questions["/"].qualifies, None);
assert!(!questions.contains_key("/review/_draft"));
}
#[test]
fn followups_surface_by_reach_not_by_carrying_any_chain() {
use std::collections::HashSet;
let files = vec![
// Front door with three outcomes, one of them templated onto
// a dynamic page.
("index.yaml".to_string(), "name: Home\nalternatives:\n - name: apply\n action: applied\n record_as: applicants\n - name: subscribe\n action: subscribed\n record_as: subscribers\n - name: draw\n action: /shape/{curve.key}\n record_as: gestures\n".to_string()),
("applied.yaml".to_string(), "name: Applied\nfollowup: true\n".to_string()),
("subscribed.yaml".to_string(), "name: Subscribed\nfollowup: true\nalternatives:\n - name: back\n action: /\n".to_string()),
// Nested -> followup by inference; leads on to /subscribed.
("shape/[key].yaml".to_string(), "name: Shape\nalternatives:\n - name: watch\n action: /subscribed\n record_as: subscribers\n - name: back\n action: /\n".to_string()),
// Reached only by an out-of-band link: nothing points here.
("watching.yaml".to_string(), "name: Watching\nfollowup: true\n".to_string()),
// A second, unrelated path with its own outcome.
("kontakt.yaml".to_string(), "name: Kontakt\nalternatives:\n - name: send\n action: takk\n record_as: inquiries\n".to_string()),
("takk.yaml".to_string(), "name: Takk\nfollowup: true\nalternatives:\n - name: back\n action: /\n".to_string()),
];
let questions = build_questions(&files).unwrap();
let is_outcome = |q: &Question| q.is_followup();
let set = |ids: &[&str]| ids.iter().map(|s| s.to_string()).collect::<HashSet<_>>();
let earned = |current: &str, seeds: &[&str]| {
let seeds: Vec<String> = seeds.iter().map(|s| s.to_string()).collect();
earned_followups(&questions, current, &seeds, &is_outcome)
};
// Templated actions resolve to the dynamic page's pattern.
assert_eq!(action_target_id(&questions, "/shape/{curve.key}").as_deref(), Some("/shape/[key]"));
assert_eq!(action_target_id(&questions, "/nowhere"), None);
// No chain, no followups: standing on the front door earns none
// of the pages its answers lead to, and standing on a followup
// one typed in earns nothing either.
assert_eq!(earned("/", &[]), set(&[]));
assert_eq!(earned("/kontakt", &[]), set(&[]));
assert_eq!(earned("/applied", &[]), set(&[]));
// A verified answer earns exactly where it sent the visitor.
assert_eq!(unlocked_by(&questions, "/", Some("apply")), vec!["/applied"]);
assert_eq!(unlocked_by(&questions, "/", Some("draw")), vec!["/shape/[key]"]);
assert_eq!(unlocked_by(&questions, "/kontakt", Some("send")), vec!["/takk"]);
assert_eq!(earned("/applied", &["/applied"]), set(&["/applied"]));
// An old node without the alternative: the answered question's
// recording alternatives, and nothing beyond that question.
let old: HashSet<String> = unlocked_by(&questions, "/", None).into_iter().collect();
assert_eq!(old, set(&["/applied", "/subscribed", "/shape/[key]"]));
assert!(!old.contains("/takk"));
// From an earned page, only links that ask nothing carry on:
// "watch" records an answer, so /subscribed is not earned by
// having drawn a shape; "back" leads to the front door, which
// is never a followup and ends the walk.
assert_eq!(earned("/shape/abc", &["/shape/[key]"]), set(&["/shape/[key]"]));
assert_eq!(earned("/takk", &["/takk"]), set(&["/takk"]));
// The email-link page is earned by nothing on the site.
assert!(!earned("/", &["/applied"]).contains("/watching"));
}
#[test]
fn declared_id_wins_over_path() {
let files = vec![(
"legacy.yaml".to_string(),
"id: /somewhere-else\nname: Legacy\n".to_string(),
)];
let questions = build_questions(&files).unwrap();
assert!(questions.contains_key("/somewhere-else"));
}
#[test]
fn colliding_ids_and_ambiguous_dynamics_are_rejected() {
let collision = vec![
("a.yaml".to_string(), "name: A\n".to_string()),
("b.yaml".to_string(), "id: /a\nname: B\n".to_string()),
];
assert!(build_questions(&collision).is_err());
let ambiguous = vec![
("review/[a].yaml".to_string(), "name: A\n".to_string()),
("review/[b].yaml".to_string(), "name: B\n".to_string()),
];
assert!(build_questions(&ambiguous).is_err());
}
#[test]
fn dynamic_pages_resolve_with_key_substitution() {
let files = vec![(
"review/[record].yaml".to_string(),
"name: Record\nalternatives:\n - name: view\n features:\n - name: detail\n resource:\n public: true\n key: \"{record}\"\n source:\n kind: kv\n bucket: applicants\n".to_string(),
)];
let questions = build_questions(&files).unwrap();
let page = resolve_question(&questions, "/review/abc123").unwrap();
assert_eq!(page.id, "/review/abc123");
assert_eq!(
page.alternatives[0].features[0].resource.as_ref().unwrap().key.as_deref(),
Some("abc123")
);
assert!(resolve_question(&questions, "/review").is_none());
// The pattern itself still resolves exactly (it IS an id).
assert!(resolve_question(&questions, "/review/[record]").is_some());
}
#[test]
fn requires_chain_resolves_and_validates() {
let files = vec![
("shape.yaml".to_string(), "name: Shape\n".to_string()),
(
"shaped.yaml".to_string(),
"name: Shaped\nrequires_chain: shape\n".to_string(),
),
];
let questions = build_questions(&files).unwrap();
assert_eq!(questions["/shaped"].requires_chain.as_deref(), Some("/shape"));
assert!(validate_questions(&questions, &Default::default()).is_ok());
let dangling = vec![(
"shaped.yaml".to_string(),
"name: Shaped\nrequires_chain: /nowhere\n".to_string(),
)];
let questions = build_questions(&dangling).unwrap();
assert!(validate_questions(&questions, &Default::default()).is_err());
}
#[test]
fn recorded_buckets_must_be_attended() {
let write_only = vec![(
"index.yaml".to_string(),
"name: Home\nalternatives:\n - name: send\n record_as: black_hole\n".to_string(),
)];
let questions = build_questions(&write_only).unwrap();
let err = validate_questions(&questions, &Default::default()).unwrap_err();
assert!(err.to_string().contains("unattended"), "got: {err}");
// A desk (any Kv resource over the bucket, anywhere in the
// repo) attends it.
let with_desk = vec![
(
"index.yaml".to_string(),
"name: Home\nalternatives:\n - name: send\n record_as: inbox\n".to_string(),
),
(
"review/index.yaml".to_string(),
"name: Desk\nalternatives:\n - name: Inbox\n features:\n - name: \"\"\n resource:\n requires_group: owners\n source:\n kind: kv\n bucket: inbox\n".to_string(),
),
];
let questions = build_questions(&with_desk).unwrap();
assert!(validate_questions(&questions, &Default::default()).is_ok());
// ..or an explicit attended_by annotation in aggregates.yaml.
let aggregates = crate::aggregates::parse_aggregates_yaml(
"aggregates:\n - bucket: black_hole\n initial: open\n attended_by: n8n nightly digest\n states:\n open: { event: submitted }\n",
)
.unwrap();
let questions = build_questions(&write_only).unwrap();
assert!(validate_questions(&questions, &aggregates).is_ok());
}
#[test]
fn actions_may_not_target_dynamic_pages() {
let files = vec![
(
"index.yaml".to_string(),
"name: Home\nalternatives:\n - name: go\n action: /review/[record]\n".to_string(),
),
("review/[record].yaml".to_string(), "name: Record\n".to_string()),
];
let questions = build_questions(&files).unwrap();
assert!(validate_questions(&questions, &Default::default()).is_err());
}
// ── events (announced pages) ─────────────────────────────────────────
#[test]
fn duration_parses_whole_units() {
assert_eq!(parse_duration_ms("3h").unwrap(), 3 * 3_600_000);
assert_eq!(parse_duration_ms("90m").unwrap(), 90 * 60_000);
assert_eq!(parse_duration_ms("1d 6h").unwrap(), 30 * 3_600_000);
assert!(parse_duration_ms("0h").is_err());
assert!(parse_duration_ms("3 hours").is_err());
assert!(parse_duration_ms("").is_err());
}
#[test]
fn event_window_and_liveness() {
let q: Question = serde_yaml::from_str(
"id: /opening\nname: Will you be there?\nevent:\n starts: 2026-09-12T18:00:00+02:00\n duration: 3h\n",
)
.unwrap();
let (starts, ends) = q.event.as_ref().unwrap().window_ms().unwrap();
assert_eq!(ends - starts, 3 * 3_600_000);
assert!(q.event_live_at(starts - 1));
assert!(q.event_live_at(ends - 1));
assert!(!q.event_live_at(ends));
assert!(q.event_ended_at(ends));
assert!(!q.event_ended_at(starts));
let plain: Question = serde_yaml::from_str("id: /x\nname: X\n").unwrap();
assert!(!plain.event_live_at(0) && !plain.event_ended_at(i64::MAX));
}
#[test]
fn event_validation() {
let bad: Question = serde_yaml::from_str(
"id: /e\nname: E\nevent:\n starts: next friday\n duration: 3h\n",
)
.unwrap();
let mut qs = std::collections::HashMap::new();
qs.insert(bad.id.clone(), bad);
let err = validate_questions(&qs, &Default::default()).unwrap_err().to_string();
assert!(err.contains("bad starts"), "{err}");
let dynamic: Question = serde_yaml::from_str(
"id: /e/[slot]\nname: E\nevent:\n starts: 2026-09-12T18:00:00Z\n duration: 3h\n",
)
.unwrap();
let mut qs = std::collections::HashMap::new();
qs.insert(dynamic.id.clone(), dynamic);
let err = validate_questions(&qs, &Default::default()).unwrap_err().to_string();
assert!(err.contains("dynamic page can't carry an event"), "{err}");
}
#[test]
fn builtin_events_schema_yields_to_content() {
let merged = with_builtin_aggregates(Default::default());
let schema = &merged[EVENTS_BUCKET];
assert_eq!(schema.initial, "announced");
assert_eq!(schema.allowed("announced"), ["awaiting_summary", "summarized"]);
assert_eq!(schema.allowed("awaiting_summary"), ["summarized"]);
let content = crate::aggregates::parse_aggregates_yaml(
"aggregates:\n - bucket: portal_events\n initial: mine\n states:\n mine: { event: mine }\n",
)
.unwrap();
assert_eq!(with_builtin_aggregates(content)[EVENTS_BUCKET].initial, "mine");
}
#[test]
fn bucket_is_read_sees_kv_resources() {
let qs = question_with_transitions(" - { to: middle, label: Go }");
assert!(bucket_is_read(&qs, "things"));
assert!(!bucket_is_read(&qs, EVENTS_BUCKET));
}
// ── inline markdown ──────────────────────────────────────────────────
#[test]
fn markdown_links_and_emphasis() {
assert_eq!(
render_inline_markdown("See [the programme](https://attac.no/x) *soon*."),
"See <a href=\"https://attac.no/x\">the programme</a> <em>soon</em>."
);
assert_eq!(render_inline_markdown("plain text"), "plain text");
assert_eq!(render_inline_markdown("a\nb"), "a b");
}
#[test]
fn markdown_drops_html_and_unsafe_links() {
assert_eq!(render_inline_markdown("x <script>y</script> z"), "x y z");
assert_eq!(render_inline_markdown("[bad](javascript:alert(1))"), "bad");
2026-09-01 21:48:25 +02:00
assert_eq!(
render_inline_markdown("[ring](tel:+4791180485)"),
"<a href=\"tel:+4791180485\">ring</a>"
);
assert_eq!(
render_inline_markdown("![site](https://x.no/a.jpg)"),
"<img src=\"https://x.no/a.jpg\" alt=\"site\" />"
);
assert_eq!(render_inline_markdown("![x](data:image/png;base64,AA)"), "");
assert_eq!(
render_inline_markdown("![local](/images/a.jpg)"),
"<img src=\"/images/a.jpg\" alt=\"local\" />"
);
2026-09-01 21:36:57 +02:00
// Image title hints: float + max-width, title dropped.
assert_eq!(
render_inline_markdown("![J](https://x.no/j.jpg \"right 9rem\")"),
"<img class=\"md-float-right\" style=\"max-width:9rem\" src=\"https://x.no/j.jpg\" alt=\"J\" />"
);
assert_eq!(
render_inline_markdown("![J](https://x.no/j.jpg \"12\")"),
"<img style=\"max-width:12rem\" src=\"https://x.no/j.jpg\" alt=\"J\" />"
);
// Unknown hint tokens are ignored; a safe image with no title
// is untouched.
assert_eq!(
render_inline_markdown("![J](https://x.no/j.jpg \"wat\")"),
"<img src=\"https://x.no/j.jpg\" alt=\"J\" />"
);
assert_eq!(render_inline_markdown("[ok](/shape)"), "<a href=\"/shape\">ok</a>");
assert_eq!(render_inline_markdown("[mail](mailto:bl@uhhm.no)"), "<a href=\"mailto:bl@uhhm.no\">mail</a>");
}
#[test]
fn templated_action_validates_against_the_dynamic_page() {
let landing: Question = serde_yaml::from_str(
"id: /\nname: L\nalternatives:\n - name: A\n action: /shape/{curve.key}\n",
)
.unwrap();
let place: Question = serde_yaml::from_str("id: /shape/[key]\nname: P\n").unwrap();
let mut qs = std::collections::HashMap::new();
qs.insert(landing.id.clone(), landing.clone());
qs.insert(place.id.clone(), place);
validate_questions(&qs, &Default::default()).unwrap();
let mut only_landing = std::collections::HashMap::new();
only_landing.insert(landing.id.clone(), landing);
assert!(validate_questions(&only_landing, &Default::default()).is_err());
}
#[test]
fn action_templates_from_responses() {
let r = serde_json::json!({"curve": {"key": "20aa98", "points": [[0,0]]}, "n": 3});
assert_eq!(template_action("/shape/{curve.key}", &r).as_deref(), Some("/shape/20aa98"));
assert_eq!(template_action("/x/{n}/y", &r).as_deref(), Some("/x/3/y"));
assert_eq!(template_action("/shape", &r).as_deref(), Some("/shape"));
assert!(template_action("/shape/{curve.missing}", &r).is_none());
assert!(template_action("/shape/{curve.points}", &r).is_none());
let odd = serde_json::json!({"k": "a/b c"});
assert_eq!(template_action("/p/{k}", &odd).as_deref(), Some("/p/a-b-c"));
}
#[test]
fn dynamic_page_fills_requirement_values() {
let q: Question = serde_yaml::from_str(
"id: /shape/[key]\nname: P\nalternatives:\n - name: A\n features:\n - name: F\n requirements:\n - name: key\n type: hidden\n value: \"{key}\"\n",
)
.unwrap();
let mut qs = std::collections::HashMap::new();
qs.insert(q.id.clone(), q);
let page = resolve_question(&qs, "/shape/20aa98").unwrap();
assert_eq!(page.alternatives[0].features[0].requirements[0].value.as_deref(), Some("20aa98"));
let q: Question = serde_yaml::from_str(
"id: /shape/[key]\nname: P\nalternatives:\n - name: A\n features:\n - name: F\n resource:\n source: { kind: url, url: \"https://relay.example/place/{key}\" }\n public: true\n",
)
.unwrap();
let mut qs = std::collections::HashMap::new();
qs.insert(q.id.clone(), q);
let page = resolve_question(&qs, "/shape/20aa98").unwrap();
match &page.alternatives[0].features[0].resource.as_ref().unwrap().source {
ResourceSource::Url { url } => assert_eq!(url, "https://relay.example/place/20aa98"),
_ => panic!(),
}
}
}