You are a constitutional council ranking individual git commits for ownership allocation. Compare these two commits. Decide which contributed more lasting value to the project. Judge substance, not spectacle: - Prefer correct, lasting design and real bugfixes over churn, formatting, renames, or generated noise. - Prefer clarity and necessity over sheer line count. A small precise change can beat a large diffuse one. - Do not favor a side merely because its patch is longer or noisier. - Weight what the change does for the project, not the contributor's name. Return ONLY a JSON object: {"winner": "A" or "B", "ratio": "N:M", "explanation": "..."} The explanation must cite concrete differences in the patches (1-3 sentences). Side A — contributor: tommy-mor Side A — commit message: [3f35edab] progress Side A — unified diff (full patch): diff --git a/server/src/api/mod.rs b/server/src/api/mod.rs index a10ce662105cff8fad949c6b83f7035ce79bed18..a986f706ea4b261cbaf004c02b4cf84184b41371 100644 --- a/server/src/api/mod.rs +++ b/server/src/api/mod.rs @@ -3,6 +3,7 @@ mod helpers; mod rpc; mod stream; mod validate; +mod ui_html; mod web_post; pub use auth::{ @@ -33,6 +34,7 @@ pub use stream::{get_html_stream, get_stream}; pub use validate::{normalize_room_and_thread, validate_ingest_document, ValidatedIngest}; +pub use ui_html::post_ui_html; pub use web_post::{check_web_ingest, post_web_ingest, post_web_redact}; #[cfg(test)] diff --git a/server/src/api/ui_html.rs b/server/src/api/ui_html.rs new file mode 100644 index 0000000000000000000000000000000000000000..2b40a72059981d558768f73d189b991f3448c257 --- /dev/null +++ b/server/src/api/ui_html.rs @@ -0,0 +1,139 @@ +//! Single `POST /ui` entry for browser [`crate::html::ui_action::HtmlUiAction`] (JSON in `__rpc__` + holes). + +use axum::{ + body::Body, + extract::State, + http::{header, HeaderMap, StatusCode}, + response::{IntoResponse, Response}, + Form, +}; +use axum_extra::extract::cookie::CookieJar; +use std::collections::HashMap; + +use crate::{ + api::{ + auth::optional_principal, + web_post::{run_check_web_ingest, run_post_web_ingest, run_post_web_redact, WebPostForm, WebRedactForm}, + }, + html::{ + fragment_public_new_thread_form, fragment_room_new_thread_form, login_to_post_hint_markup, + parse_html_ui_from_form, user_can_post_room, user_can_view_room, HtmlUiAction, JsBuilder, + ThreadNav, + }, + state::AppState, +}; + +pub async fn post_ui_html( + State(state): State, + headers: HeaderMap, + jar: CookieJar, + Form(form): Form>, +) -> impl IntoResponse { + let action = match parse_html_ui_from_form(&form) { + Ok(a) => a, + Err(e) => return ui_js_warn(&e.to_string()).into_response(), + }; + + match action { + HtmlUiAction::PostIngest { + room, + thread_tag, + text, + error_target, + form_id, + } => { + run_post_web_ingest( + &state, + &headers, + &jar, + WebPostForm { + room, + thread_tag, + text, + error_target, + form_id, + }, + ) + .await + } + HtmlUiAction::CheckIngest { + room, + thread_tag, + text, + error_target, + form_id, + } => { + run_check_web_ingest( + &state, + &headers, + &jar, + WebPostForm { + room, + thread_tag, + text, + error_target, + form_id, + }, + ) + .await + } + HtmlUiAction::RedactPost { post_id } => { + run_post_web_redact(&state, &headers, &jar, WebRedactForm { post_id }).await + } + HtmlUiAction::ExpandPublicNewThreadForm => { + let reduced = state.reduced.read().await; + let user = optional_principal(&headers, &jar, &reduced); + drop(reduced); + let markup = if user.is_some() { + fragment_public_new_thread_form(true) + } else { + login_to_post_hint_markup() + }; + JsBuilder::new() + .morph_selector("#public-new-thread-ui-slot", markup) + .into_response() + } + HtmlUiAction::ExpandRoomNewThreadForm { room_wire } => { + let room_wire = room_wire.trim().to_string(); + if room_wire.is_empty() { + return ui_js_warn("missing room").into_response(); + } + let reduced = state.reduced.read().await; + let user = optional_principal(&headers, &jar, &reduced); + if !reduced.rooms.contains(&room_wire) { + drop(reduced); + return ui_js_warn("room not found").into_response(); + } + if !user_can_view_room(&reduced, &room_wire, user.as_deref()) { + drop(reduced); + return ui_js_warn("forbidden").into_response(); + } + let can_post = user + .as_ref() + .map(|u| user_can_post_room(&reduced, &room_wire, u)) + .unwrap_or(false); + drop(reduced); + let Some(nav) = ThreadNav::from_room_id(&room_wire) else { + return ui_js_warn("bad room").into_response(); + }; + let markup = if can_post { + fragment_room_new_thread_form(&nav, true) + } else { + login_to_post_hint_markup() + }; + JsBuilder::new() + .morph_selector("#room-new-thread-ui-slot", markup) + .into_response() + } + } +} + +fn ui_js_warn(msg: &str) -> Response { + use crate::html::js_string_literal; + let js = format!("console.warn({});", js_string_literal(msg)); + Response::builder() + .status(StatusCode::OK) + .header(header::CONTENT_TYPE, "text/javascript; charset=utf-8") + .body(Body::from(js)) + .unwrap() +} diff --git a/server/src/api/web_post.rs b/server/src/api/web_post.rs index a64010e382d3039821c836a5529adad0fe67cce5..265025f41ff1548d05b2d2d5d84202245388053f 100644 --- a/server/src/api/web_post.rs +++ b/server/src/api/web_post.rs @@ -222,8 +222,18 @@ pub async fn post_web_redact( jar: CookieJar, Form(form): Form, ) -> impl IntoResponse { + run_post_web_redact(&state, &headers, &jar, form).await +} + +/// Shared with [`crate::api::ui_html::post_ui_html`]. +pub(crate) async fn run_post_web_redact( + state: &AppState, + headers: &HeaderMap, + jar: &CookieJar, + form: WebRedactForm, +) -> Response { let reduced = state.reduced.read().await; - let Some(_username) = optional_principal(&headers, &jar, &reduced) else { + let Some(_username) = optional_principal(headers, jar, &reduced) else { drop(reduced); return js_redirect("/login").into_response(); }; @@ -239,8 +249,8 @@ pub async fn post_web_redact( return js_redirect("/login").into_response(); }; - match rpc_post_redact(&state, &headers, form.post_id).await { - Ok(RpcResult::RedactPostOk {}) => redact_success_response(&state).await.into_response(), + match rpc_post_redact(state, headers, form.post_id).await { + Ok(RpcResult::RedactPostOk {}) => redact_success_response(state).await.into_response(), Ok(_) => (StatusCode::BAD_REQUEST, "unexpected response").into_response(), Err((msg, hint)) => { let detail = hint.as_deref().unwrap_or(""); @@ -255,8 +265,18 @@ pub async fn post_web_ingest( jar: CookieJar, Form(form): Form, ) -> impl IntoResponse { + run_post_web_ingest(&state, &headers, &jar, form).await +} + +/// Shared with [`crate::api::ui_html::post_ui_html`] (`POST /ui`). +pub(crate) async fn run_post_web_ingest( + state: &AppState, + headers: &HeaderMap, + jar: &CookieJar, + form: WebPostForm, +) -> Response { let reduced = state.reduced.read().await; - let Some(_username) = optional_principal(&headers, &jar, &reduced) else { + let Some(_username) = optional_principal(headers, jar, &reduced) else { drop(reduced); return js_redirect("/login").into_response(); }; @@ -282,8 +302,8 @@ pub async fn post_web_ingest( .into_response(); } - match rpc_post_with_bearer(&state, &bearer, room.clone(), thread_tag.clone(), text).await { - Ok(RpcResult::PostOk { .. }) => post_success_response(&state, &form, &headers, &jar) + match rpc_post_with_bearer(state, &bearer, room.clone(), thread_tag.clone(), text).await { + Ok(RpcResult::PostOk { .. }) => post_success_response(state, &form, headers, jar) .await .into_response(), Ok(_) => form_js_error(&form, "unexpected response", "Post did not return PostOk.").into_response(), @@ -297,8 +317,18 @@ pub async fn check_web_ingest( jar: CookieJar, Form(form): Form, ) -> impl IntoResponse { + run_check_web_ingest(&state, &headers, &jar, form).await +} + +/// Shared with [`crate::api::ui_html::post_ui_html`] (`POST /ui`). +pub(crate) async fn run_check_web_ingest( + state: &AppState, + headers: &HeaderMap, + jar: &CookieJar, + form: WebPostForm, +) -> Response { let reduced = state.reduced.read().await; - let Some(_username) = optional_principal(&headers, &jar, &reduced) else { + let Some(_username) = optional_principal(headers, jar, &reduced) else { drop(reduced); return js_redirect("/login").into_response(); }; @@ -324,7 +354,7 @@ pub async fn check_web_ingest( return js_clear_errors(&form_error_target(&form)).into_response(); } - match rpc_check_with_bearer(&state, &bearer, room, form.text.clone()).await { + match rpc_check_with_bearer(state, &bearer, room, form.text.clone()).await { Ok(RpcResult::CheckOk { .. }) => js_clear_errors(&form_error_target(&form)).into_response(), Ok(_) => form_js_error(&form, "unexpected response", "Check did not return CheckOk.").into_response(), Err((msg, hint)) => form_js_error(&form, &msg, hint.as_deref().unwrap_or("")).into_response(), diff --git a/server/src/form_template.rs b/server/src/form_template.rs new file mode 100644 index 0000000000000000000000000000000000000000..3709c2c09a859da006e4af173413d5d235bc19be --- /dev/null +++ b/server/src/form_template.rs @@ -0,0 +1,142 @@ +//! Plan2-style JSON templates with `{"$form": "field_name"}` holes, filled from +//! `application/x-www-form-urlencoded` (or any `String` → `String` map) **before** +//! deserializing into a typed struct. +//! +//! # Wire format +//! +//! Templates are **compact JSON** (`serde_json::to_string`): one line, no pretty +//! printing, strings escaped per JSON rules (`\"`, `\n`, etc.). Embed that string +//! in HTML attributes or text nodes with normal HTML escaping (e.g. maud), not +//! bespoke encodings. +//! +//! # Power vs flat hidden fields +//! +//! A form is always a string→string map. You can fake depth with dotted keys (`a.b.c`), +//! but one structured blob (`__rpc__` = compact JSON) gives you nested objects, +//! arrays, and optional fields without inventing a new naming scheme each time. +//! +//! # Security +//! +//! Substitution runs **before** `serde` into your command type. It does not fix +//! authorization: if the client can replace the hidden `__rpc__` value, they can +//! change the command shape unless you validate (signed blob, server-side session +//! context, or treat the blob as hints only). Same threat model as any hidden field. + +use serde::Serialize; +use serde_json::Value; +use std::collections::HashMap; + +/// Serialize a value to compact JSON for a hidden `__rpc__` (or similar) field. +pub fn template_json_compact(v: &T) -> serde_json::Result { + serde_json::to_string(v) +} + +/// Recursively walk the JSON AST and replace `{"$form": "key"}` with the submitted +/// string for `key` (empty if missing). Other keys are unchanged. +pub fn substitute_form_vars(val: &mut Value, form_data: &HashMap) { + match val { + Value::Object(map) => { + if map.len() == 1 { + if let Some(Value::String(field_name)) = map.get("$form") { + let submitted = form_data + .get(field_name.as_str()) + .map(|s| s.as_str()) + .unwrap_or(""); + *val = Value::String(submitted.to_string()); + return; + } + } + for v in map.values_mut() { + substitute_form_vars(v, form_data); + } + } + Value::Array(arr) => { + for v in arr.iter_mut() { + substitute_form_vars(v, form_data); + } + } + _ => {} + } +} + +/// Parse JSON, apply [`substitute_form_vars`], return the mutated value. +pub fn fill_template_from_form( + template_json: &str, + form_data: &HashMap, +) -> Result { + let mut v: Value = serde_json::from_str(template_json)?; + substitute_form_vars(&mut v, form_data); + Ok(v) +} + +#[cfg(test)] +mod tests { + use super::*; + use serde::Deserialize; + + #[derive(Debug, Deserialize, PartialEq, Eq)] + struct Demo { + room: String, + thread_tag: String, + nested: Nested, + } + + #[derive(Debug, Deserialize, PartialEq, Eq)] + struct Nested { + text: String, + } + + #[test] + fn holes_become_strings() { + let json = r#"{ + "room": "public", + "thread_tag": {"$form": "tag"}, + "nested": {"text": {"$form": "body"}} + }"#; + let mut form = HashMap::new(); + form.insert("tag".into(), "foo".into()); + form.insert("body".into(), "hello\nworld".into()); + + let v = fill_template_from_form(json, &form).unwrap(); + let d: Demo = serde_json::from_value(v).unwrap(); + assert_eq!( + d, + Demo { + room: "public".into(), + thread_tag: "foo".into(), + nested: Nested { + text: "hello\nworld".into(), + }, + } + ); + } + + #[test] + fn missing_form_key_is_empty_string() { + let json = r#"{"x": {"$form": "nope"}}"#; + let mut form = HashMap::new(); + form.insert("other".into(), "y".into()); + let v = fill_template_from_form(json, &form).unwrap(); + assert_eq!(v["x"], ""); + } + + #[test] + fn array_of_holes() { + let json = r#"{"items": [{"$form": "a"}, {"$form": "b"}]}"#; + let mut form = HashMap::new(); + form.insert("a".into(), "1".into()); + form.insert("b".into(), "2".into()); + let v = fill_template_from_form(json, &form).unwrap(); + assert_eq!(v["items"], serde_json::json!(["1", "2"])); + } + + #[test] + fn template_json_compact_escapes_and_single_line() { + let s = template_json_compact(&serde_json::json!({ + "x": "quote\"and\nnewline" + })) + .unwrap(); + assert!(!s.contains('\n')); + assert!(s.contains("\\\"") || s.contains("\\n")); + } +} diff --git a/server/src/html/forum.rs b/server/src/html/forum.rs index f789e347dc136f8ffd356f4492f0bd76cea04bf0..b1c037f3dd93c7bb96d6624cab6019228432c501 100644 --- a/server/src/html/forum.rs +++ b/server/src/html/forum.rs @@ -11,12 +11,15 @@ use crate::{ api::optional_principal, canonical_path::{canonicalize_item, canonicalize_tag}, events::ThreadCapability, + form_template::template_json_compact, identity::parse_username, reducer::{scope_from_room_wire, ReducerState, ScopeId}, state::AppState, timeago, }; +use super::ui_action::{HtmlUiAction, UI_RPC_FIELD}; + use super::{ bc_segment, bc_threads, cli_panel, layout, now_ms, profile_href, recency_class, render_linkified_with_embeds_in_scope, theme_from_jar, theme_next_from_uri, JsBuilder, @@ -289,7 +292,7 @@ fn rooms_for_user(reduced: &ReducerState, username: &str) -> Vec { v } -fn user_can_view_room(reduced: &ReducerState, room_id: &str, username: Option<&str>) -> bool { +pub(crate) fn user_can_view_room(reduced: &ReducerState, room_id: &str, username: Option<&str>) -> bool { if !reduced.rooms.contains(room_id) { return false; } @@ -299,7 +302,7 @@ fn user_can_view_room(reduced: &ReducerState, room_id: &str, username: Option<&s reduced.user_has_cap(room_id, u, ThreadCapability::View) } -fn user_can_post_room(reduced: &ReducerState, room_id: &str, username: &str) -> bool { +pub(crate) fn user_can_post_room(reduced: &ReducerState, room_id: &str, username: &str) -> bool { reduced.user_has_cap(room_id, username, ThreadCapability::Post) } @@ -591,7 +594,6 @@ pub async fn home( let nav = ThreadNav::public(); let reduced_read = state.reduced.read().await; let strip = auth_strip(&headers, &jar, &reduced_read); - let show_forms = user.is_some(); drop(reduced_read); let page = layout( @@ -617,8 +619,14 @@ pub async fn home( } } p class="muted" { "dark = time-ordered · light = vote-ranked" } + div class="thread-feed-toolbar" { + form method="POST" action="/ui" { + input type="hidden" name=(UI_RPC_FIELD) value=(expand_public_new_thread_rpc_value()); + button type="submit" class="section-add-btn" { "+" } + } + } + div id="public-new-thread-ui-slot" {} (render_thread_feed(Some(&nav), "thread-feed", &public_rows, now)) - (new_thread_form_public(show_forms)) (cli_panel("npx slugsocial public forum list")) }, None, @@ -901,7 +909,13 @@ pub async fn room_page( h3 { "threads" } (render_thread_feed(Some(&nav), "room-thread-feed", &rows, now)) @if show_new { - (new_thread_form_for_room(&nav, show_new)) + div class="thread-feed-toolbar" { + form method="POST" action="/ui" { + input type="hidden" name=(UI_RPC_FIELD) value=(expand_room_new_thread_rpc_value(&nav)); + button type="submit" class="section-add-btn" { "+" } + } + } + div id="room-new-thread-ui-slot" {} } (cli_panel(&forum_cli)) (cli_panel(&garden_cli)) @@ -945,6 +959,31 @@ fn new_thread_form_for_room(nav: &ThreadNav, show: bool) -> Markup { } } +pub(crate) fn expand_public_new_thread_rpc_value() -> String { + template_json_compact(&HtmlUiAction::ExpandPublicNewThreadForm).expect("static json") +} + +pub(crate) fn expand_room_new_thread_rpc_value(nav: &ThreadNav) -> String { + template_json_compact(&HtmlUiAction::ExpandRoomNewThreadForm { + room_wire: nav.room_wire.clone(), + }) + .expect("static json") +} + +pub(crate) fn login_to_post_hint_markup() -> Markup { + html! { + p class="muted" { "log in to post" } + } +} + +pub(crate) fn fragment_public_new_thread_form(show: bool) -> Markup { + new_thread_form_public(show) +} + +pub(crate) fn fragment_room_new_thread_form(nav: &ThreadNav, show: bool) -> Markup { + new_thread_form_for_room(nav, show) +} + async fn thread_post_view_inner( state: AppState, tag: String, diff --git a/server/src/html/mod.rs b/server/src/html/mod.rs index 53041a0cf0b30e6f20749c92ecc15a4e9ac56e09..a4fd2dd60ac283f7eb9b2e64522501b21d1e27e9 100644 --- a/server/src/html/mod.rs +++ b/server/src/html/mod.rs @@ -16,6 +16,7 @@ mod editor; mod forum; mod garden; mod search; +pub mod ui_action; use breadcrumb_path::OntologyPath; pub use auth::{auth_complete_page, auth_signed_in_fragment, choose_username_error_fragment, choose_username_page}; @@ -27,9 +28,15 @@ pub use forum::{ thread_post_collapse_deleted, thread_post_expand, thread_post_expand_deleted, thread_post_view, thread_view, ThreadNav, }; + +pub(crate) use forum::{ + fragment_public_new_thread_form, fragment_room_new_thread_form, login_to_post_hint_markup, + user_can_post_room, user_can_view_room, +}; pub use garden::{garden_index, ontology_path, room_garden_index, room_ontology_path}; pub use search::{search_page, search_results_fragment}; pub use forum::user_profile_page; +pub use ui_action::{parse_html_ui_from_form, HtmlUiAction, HtmlUiParseError, UI_RPC_FIELD}; /// Public profile URL path for a stored username (no `@`). pub(crate) fn profile_href(username: &str) -> String { diff --git a/server/src/html/ui_action.rs b/server/src/html/ui_action.rs new file mode 100644 index 0000000000000000000000000000000000000000..3bc69ecbb7e16a59d2d393b2d59f9cd3fedb12b1 --- /dev/null +++ b/server/src/html/ui_action.rs @@ -0,0 +1,116 @@ +//! Browser-only UI commands: JSON in hidden `__rpc__` plus hole fill ([`crate::form_template`]). +//! Not part of [`slug_types::RpcCommand`] (CLI / JSON API). + +use crate::form_template::fill_template_from_form; +use serde::{Deserialize, Serialize}; +use serde_json::Value; +use std::collections::HashMap; +use thiserror::Error; + +/// Form field name for the compact JSON template (possibly with `{"$form":"…"}` holes). +pub const UI_RPC_FIELD: &str = "__rpc__"; + +/// HTML form / fetch `POST /ui` payload after template fill and deserialization. +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)] +#[serde(tag = "action", rename_all = "snake_case")] +pub enum HtmlUiAction { + /// Same semantics as `POST /post` (forum ingest). + PostIngest { + room: String, + thread_tag: String, + text: String, + #[serde(default)] + error_target: Option, + #[serde(default)] + form_id: Option, + }, + /// Same as `POST /post/check`. + CheckIngest { + room: String, + thread_tag: String, + text: String, + #[serde(default)] + error_target: Option, + #[serde(default)] + form_id: Option, + }, + /// Same as `POST /post/redact`. + RedactPost { + post_id: String, + }, + /// Morph `#public-new-thread-ui-slot` to the new-thread form (or login hint). + ExpandPublicNewThreadForm, + /// Morph `#room-new-thread-ui-slot` for the given room wire id. + ExpandRoomNewThreadForm { + room_wire: String, + }, +} + +#[derive(Debug, Error)] +pub enum HtmlUiParseError { + #[error("missing __rpc__ field")] + MissingRpc, + #[error("invalid template json: {0}")] + Template(serde_json::Error), + #[error("invalid ui action: {0}")] + Action(serde_json::Error), +} + +/// Parse `__rpc__` JSON, apply `$form` holes from the rest of the form map, deserialize. +pub fn parse_html_ui_from_form(form: &HashMap) -> Result { + let template = form + .get(UI_RPC_FIELD) + .ok_or(HtmlUiParseError::MissingRpc)?; + let mut hole_map = form.clone(); + hole_map.remove(UI_RPC_FIELD); + let v: Value = fill_template_from_form(template, &hole_map).map_err(HtmlUiParseError::Template)?; + serde_json::from_value(v).map_err(HtmlUiParseError::Action) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn round_trip_post_ingest_with_holes() { + let template = serde_json::json!({ + "action": "post_ingest", + "room": "public", + "thread_tag": {"$form": "thread_tag"}, + "text": {"$form": "text"}, + "error_target": "e", + "form_id": "f", + }); + let mut form = HashMap::new(); + form.insert( + UI_RPC_FIELD.to_string(), + serde_json::to_string(&template).unwrap(), + ); + form.insert("thread_tag".into(), "x".into()); + form.insert("text".into(), "body".into()); + + let a = parse_html_ui_from_form(&form).unwrap(); + assert_eq!( + a, + HtmlUiAction::PostIngest { + room: "public".into(), + thread_tag: "x".into(), + text: "body".into(), + error_target: Some("e".into()), + form_id: Some("f".into()), + } + ); + } + + #[test] + fn expand_public_unit_variant() { + let template = serde_json::json!({ "action": "expand_public_new_thread_form" }); + let mut form = HashMap::new(); + form.insert( + UI_RPC_FIELD.to_string(), + serde_json::to_string(&template).unwrap(), + ); + let a = parse_html_ui_from_form(&form).unwrap(); + assert_eq!(a, HtmlUiAction::ExpandPublicNewThreadForm); + } +} diff --git a/server/src/lib.rs b/server/src/lib.rs index b9d4b79791ba8dd3a3c26ff777943a2548092de5..5f5b6b0f01b29350c7415e5801ec5caa74f0b452 100644 --- a/server/src/lib.rs +++ b/server/src/lib.rs @@ -3,6 +3,7 @@ pub mod paths; pub mod api; pub mod canonical_path; pub mod dsl; +pub mod form_template; pub mod html; pub mod event_log; pub mod events; @@ -33,6 +34,7 @@ pub fn create_app(state: AppState) -> Router { .route("/post", post(api::post_web_ingest)) .route("/post/redact", post(api::post_web_redact)) .route("/post/check", post(api::check_web_ingest)) + .route("/ui", post(api::post_ui_html)) .route("/theme", post(crate::html::post_theme)) .route("/sse", get(api::get_html_stream)) .route("/stream", get(api::get_stream)) Side B — contributor: tommy-mor Side B — commit message: [9e20d06c] Add sorterc dev tool for offline DSL compile and JSONL lint. Introduce a workspace-only binary that validates .sorter files into ranking JSON and scans events.jsonl for corrupt or unreplayable ingests. Co-authored-by: Cursor Side B — unified diff (full patch): diff --git a/Cargo.lock b/Cargo.lock index bf8153d9c723af97122c9ffdd4a7cfe82e853bb6..a07734f089b466440c3ae6fc1087ce85fc24ce62 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1826,6 +1826,17 @@ dependencies = [ "windows-sys 0.60.2", ] +[[package]] +name = "sorterc" +version = "0.0.1" +dependencies = [ + "anyhow", + "clap", + "serde", + "serde_json", + "slugsocial-server", +] + [[package]] name = "spin" version = "0.9.8" diff --git a/Cargo.toml b/Cargo.toml index 149cbf07901eab57c593184ff8719a75d530f1da..25337acdd61e44b20f354c78fed4a88caf896280 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,5 +1,5 @@ [workspace] -members = ["server", "cli"] +members = ["server", "cli", "sorterc"] resolver = "2" diff --git a/agents.md b/agents.md index d8b801e454fdf37e7ac6038b91a69f83b0746d59..ce646ed3cd7123be4732dccec4a6800467e651e7 100644 --- a/agents.md +++ b/agents.md @@ -93,6 +93,17 @@ SLUG_GOOGLE_CLIENT_SECRET=mock After OAuth completes, the pending-session poll returns a `slug_…` bearer token for API calls. +### Dev-only offline tooling + +**`sorterc`** — workspace binary, not published via npm. Compiles `.sorter` files and lints `events.jsonl` without a server: + +``` +cargo run -p sorterc -- compile path/to/doc.sorter [--base events.jsonl] [--room public] [--pretty] +cargo run -p sorterc -- scan path/to/events.jsonl [--pretty] +``` + +`compile` validates DSL, simulates ingest against empty (or `--base`) reducer state, and prints JSON rankings. `scan` reports corrupt JSONL lines and ingests that fail DSL replay. + ### Testing - **Rust tests:** `cargo nextest run --workspace` (163 tests; requires `cargo-nextest`) diff --git a/server/src/lib.rs b/server/src/lib.rs index c1d477d21aea03aff00e6f0689b0b4379d0d68d2..ad8e31099c807fb5844acb16cd5086a2f19327a7 100644 --- a/server/src/lib.rs +++ b/server/src/lib.rs @@ -10,6 +10,7 @@ pub mod form_template; pub mod html; pub mod identity; pub mod middleware; +pub mod offline; pub mod path_types; pub mod ranking; pub mod reducer; diff --git a/server/src/offline.rs b/server/src/offline.rs new file mode 100644 index 0000000000000000000000000000000000000000..54ad0ded096a305ef8454ab2cdd1c3af71b14f5d --- /dev/null +++ b/server/src/offline.rs @@ -0,0 +1,333 @@ +//! Offline `.sorter` compilation and JSONL diagnostics (no network, no auth). + +use std::collections::HashSet; +use std::path::Path; + +use serde::Serialize; +use slug_types::{CheckScopeRanking, RankComponent, RankRow, paths::GardenItemUrl}; + +use crate::{ + api::{resolve_item, validate_ingest_document}, + dsl, + events::{Event, Ingest}, + path_types::ItemId, + reducer::{ReducerState, ScopeId, scope_from_room_wire}, + scope_rank::build_children_rankings, +}; + +#[derive(Debug, Clone, Serialize)] +pub struct CompileStats { + pub items: usize, + pub votes: usize, + pub prose_blocks: usize, +} + +#[derive(Debug, Serialize)] +pub struct CompileResult { + pub ok: bool, + pub threads: Vec, + pub rankings: Vec, + pub stats: CompileStats, +} + +#[derive(Debug, Clone, Serialize)] +pub struct CompileError { + pub ok: bool, + pub error: String, + #[serde(skip_serializing_if = "Option::is_none")] + pub hint: Option, +} + +#[derive(Debug, Clone, Serialize)] +pub struct BadJsonLine { + pub line: usize, + pub message: String, +} + +#[derive(Debug, Clone, Serialize)] +pub struct MalformedIngest { + pub line: usize, + pub id: String, + pub room_id: String, + pub thread_tag: String, + pub reason: String, +} + +#[derive(Debug, Clone, Serialize)] +pub struct ScanResult { + pub ok: bool, + pub path: String, + pub total_lines: usize, + pub parsed_events: usize, + pub bad_json_lines: Vec, + pub malformed_ingests: Vec, + pub skipped_ingests: usize, +} + +fn document_stats(doc: &dsl::Document) -> CompileStats { + let mut items = 0usize; + let mut votes = 0usize; + let mut prose_blocks = 0usize; + for stmt in &doc.statements { + match stmt { + dsl::Stmt::Item { .. } => items += 1, + dsl::Stmt::Vote { .. } => votes += 1, + dsl::Stmt::Prose { .. } => prose_blocks += 1, + } + } + CompileStats { + items, + votes, + prose_blocks, + } +} + +fn threads_in_document(text: &str) -> Vec { + let mut out = HashSet::new(); + for line in text.lines() { + let trimmed = line.trim(); + if !trimmed.starts_with('#') { + continue; + } + let rest = trimmed.trim_start_matches('#').trim(); + if rest.is_empty() { + continue; + } + let tag = rest.split_whitespace().next().unwrap_or(rest); + let tag = tag.split(':').next().unwrap_or(tag).trim(); + if tag.is_empty() { + continue; + } + out.insert(format!("#{}", crate::canonical_path::canonicalize_tag(tag))); + } + let mut tags: Vec = out.into_iter().collect(); + tags.sort(); + tags +} + +fn voted_parent_scopes(doc: &dsl::Document) -> Vec { + let mut parents = HashSet::new(); + for stmt in &doc.statements { + if let dsl::Stmt::Vote { item1, item2, .. } = stmt { + if let (Ok(a), Ok(b)) = (resolve_item(item1), resolve_item(item2)) { + if let Some(p) = a.parent() { + parents.insert(p); + } + if let Some(p) = b.parent() { + parents.insert(p); + } + } + } + } + let mut out: Vec = parents.into_iter().collect(); + out.sort(); + out +} + +fn rankings_for_simulated( + simulated: &ReducerState, + scope: &ScopeId, + room_wire: &str, + doc: &dsl::Document, +) -> Vec { + voted_parent_scopes(doc) + .iter() + .map(|parent| { + let scoped_content = simulated + .content_for_scope(&scope) + .unwrap_or_else(|| simulated.public()); + let scoped = build_children_rankings(scoped_content, parent); + let components: Vec = scoped + .component_rankings + .into_iter() + .map(|comp| RankComponent { + pairs: comp.pairs, + ranking: comp + .ranked + .into_iter() + .map(|r| RankRow { + item: GardenItemUrl::from_stored(&r.item, room_wire), + score: r.score, + percent: None, + }) + .collect(), + }) + .collect(); + CheckScopeRanking { + parent: GardenItemUrl::from_stored(parent, room_wire).into_inner(), + components, + unranked_items: scoped + .unranked_items + .into_iter() + .map(|it| GardenItemUrl::from_stored(&it, room_wire)) + .collect(), + } + }) + .collect() +} + +/// Validate and simulate one `.sorter` document against optional base reducer state. +pub fn compile_document( + base: &ReducerState, + room: &str, + text: &str, +) -> Result { + let room_key = room.trim(); + let scope = scope_from_room_wire(room_key); + let validated = validate_ingest_document(base, text, &scope).map_err(|(_, message, hint)| { + CompileError { + ok: false, + error: message, + hint, + } + })?; + + let event = Event::Ingest(Ingest { + ts: validated.ts, + id: uuid::Uuid::new_v4().to_string(), + raw: validated.raw_text.clone(), + principal: "offline".to_string(), + delegate: None, + room_id: room_key.to_string(), + thread_tag: "offline".to_string(), + }); + + let mut simulated = base.clone(); + simulated.apply_event(event); + + Ok(CompileResult { + ok: true, + threads: threads_in_document(text), + rankings: rankings_for_simulated(&simulated, &scope, room_key, &validated.doc), + stats: document_stats(&validated.doc), + }) +} + +fn ingest_parse_error(raw: &str) -> Option { + dsl::parse_full(raw).err().map(|e| e.to_string()) +} + +fn load_events_from_jsonl(path: &Path) -> Result<(Vec<(usize, Event)>, Vec), std::io::Error> { + let text = std::fs::read_to_string(path)?; + let mut events = Vec::new(); + let mut bad_json_lines = Vec::new(); + for (idx, line) in text.lines().enumerate() { + let line_no = idx + 1; + let trimmed = line.trim(); + if trimmed.is_empty() { + continue; + } + match serde_json::from_str::(trimmed) { + Ok(ev) => events.push((line_no, ev)), + Err(e) => bad_json_lines.push(BadJsonLine { + line: line_no, + message: e.to_string(), + }), + } + } + Ok((events, bad_json_lines)) +} + +/// Replay a JSONL event log into reducer state (same rules as server boot). +pub fn load_reducer_from_jsonl(path: &Path) -> Result<(ReducerState, Vec), std::io::Error> { + let (events, bad_json_lines) = load_events_from_jsonl(path)?; + let mut state = ReducerState::default(); + for (_line_no, ev) in events { + state.apply_event(ev); + } + Ok((state, bad_json_lines)) +} + +/// Scan an events.jsonl for corrupt JSON lines and ingests that fail DSL replay. +pub fn scan_jsonl(path: &Path) -> Result { + let text = std::fs::read_to_string(path)?; + let total_lines = text.lines().count(); + let (events, bad_json_lines) = load_events_from_jsonl(path)?; + + let mut malformed_ingests = Vec::new(); + let mut skipped_ingests = 0usize; + let mut state = ReducerState::default(); + let parsed_events = events.len(); + + for (line_no, ev) in events { + if let Event::Ingest(ref ing) = ev { + if let Some(reason) = ingest_parse_error(&ing.raw) { + malformed_ingests.push(MalformedIngest { + line: line_no, + id: ing.id.clone(), + room_id: ing.room_id.clone(), + thread_tag: ing.thread_tag.clone(), + reason, + }); + } + let before = state.ingests_by_id.len(); + state.apply_event(ev); + if state.ingests_by_id.len() == before { + skipped_ingests += 1; + } + } else { + state.apply_event(ev); + } + } + + let ok = bad_json_lines.is_empty() && malformed_ingests.is_empty() && skipped_ingests == 0; + + Ok(ScanResult { + ok, + path: path.display().to_string(), + total_lines, + parsed_events, + bad_json_lines, + malformed_ingests, + skipped_ingests, + }) +} + +#[cfg(test)] +mod tests { + use super::*; + + const TUTORIAL: &str = include_str!("../tests/fixtures/tutorial.sorter"); + + #[test] + fn compile_tutorial_fixture_emits_rankings() { + let result = compile_document(&ReducerState::default(), "public", TUTORIAL).unwrap(); + assert!(result.ok); + assert!(!result.threads.is_empty()); + assert!(result.stats.items >= 6); + assert!(result.stats.votes >= 6); + assert!(!result.rankings.is_empty()); + } + + #[test] + fn compile_rejects_vote_on_missing_item() { + let err = compile_document( + &ReducerState::default(), + "public", + "{ reason }\n~/missing/a 2:1 ~/missing/b", + ) + .unwrap_err(); + assert!(!err.ok); + assert!(err.error.contains("undefined")); + } + + #[test] + fn scan_empty_jsonl_is_ok() { + let dir = tempfile::tempdir().unwrap(); + let path = dir.path().join("events.jsonl"); + std::fs::write(&path, "").unwrap(); + let report = scan_jsonl(&path).unwrap(); + assert!(report.ok); + assert!(report.bad_json_lines.is_empty()); + } + + #[test] + fn scan_reports_bad_json_line() { + let dir = tempfile::tempdir().unwrap(); + let path = dir.path().join("events.jsonl"); + std::fs::write(&path, "{not json}\n").unwrap(); + let report = scan_jsonl(&path).unwrap(); + assert!(!report.ok); + assert_eq!(report.bad_json_lines.len(), 1); + } +} diff --git a/sorterc/Cargo.toml b/sorterc/Cargo.toml new file mode 100644 index 0000000000000000000000000000000000000000..92d477aff9b53291fb1a266db83065c1c800791d --- /dev/null +++ b/sorterc/Cargo.toml @@ -0,0 +1,18 @@ +[package] +name = "sorterc" +version = "0.0.1" +edition = "2021" +license = "MIT" +publish = false +description = "Offline .sorter compiler and events.jsonl linter (dev only)" + +[[bin]] +name = "sorterc" +path = "src/main.rs" + +[dependencies] +anyhow = "1" +clap = { version = "4", features = ["derive"] } +serde = { version = "1", features = ["derive"] } +serde_json = "1" +slugsocial-server = { path = "../server" } diff --git a/sorterc/readme.md b/sorterc/readme.md new file mode 100644 index 0000000000000000000000000000000000000000..1ebcc3fc935541ea9e47e0458ec67a750fe19fff --- /dev/null +++ b/sorterc/readme.md @@ -0,0 +1,92 @@ +# sorterc + +Dev-only offline tooling for the slug `.sorter` DSL and `events.jsonl` event log. + +`sorterc` is **not** published via npm and does not talk to slug.social. It reuses the same parser, validator, and ranking code as the server, but runs entirely on local files. + +## Build + +From the repo root: + +```bash +cargo build -p sorterc +cargo run -p sorterc -- --help +``` + +## Commands + +### `compile` — evaluate a `.sorter` document + +Reads a `.sorter` file (or `-` for stdin), validates the DSL, simulates one ingest against reducer state, and prints JSON rankings to stdout. + +```bash +cargo run -p sorterc -- compile path/to/doc.sorter +cargo run -p sorterc -- compile path/to/doc.sorter --pretty +cargo run -p sorterc -- compile - --pretty # stdin +cargo run -p sorterc -- compile doc.sorter --base events.jsonl # seed garden from log +cargo run -p sorterc -- compile doc.sorter --room public # default room +``` + +**Flags** + +| Flag | Description | +|------|-------------| +| `--base PATH` | Replay an `events.jsonl` first, then compile against that garden state | +| `--room ID` | Room wire id (`public` or private room id). Default: `public` | +| `--pretty` | Pretty-print JSON | + +**Success output** (shape): + +```json +{ + "ok": true, + "threads": ["#my-thread"], + "rankings": [ … ], + "stats": { "items": 3, "votes": 2, "prose_blocks": 5 } +} +``` + +Rankings use the same structure as the server's dry-run check: parent scope, connected components, scores, unranked items. + +**Error output** exits with code 1: + +```json +{ + "ok": false, + "error": "parse error", + "hint": "…" +} +``` + +### `scan` — lint an `events.jsonl` + +Reads a JSONL event log and reports problems without starting a server. + +```bash +cargo run -p sorterc -- scan events.jsonl +cargo run -p sorterc -- scan events.jsonl --pretty +``` + +Reports: + +- **bad JSON lines** — lines that are not valid JSON +- **malformed ingests** — ingest events whose `raw` DSL fails to parse +- **skipped ingests** — ingests dropped during replay (same behavior as server boot) + +Exits 0 when clean, 1 when any issue is found. + +## Typical uses + +- Iterate on `.sorter` files in an editor and pipe through `compile` to see rankings instantly +- Verify a downloaded or edited `events.jsonl` before uploading to Fly +- Debug "malformed ingest" warnings from production boot logs +- CI or pre-commit checks on fixture docs (no OAuth, no network) + +## What it does not do + +- Post to slug.social or append to a live log +- Authenticate users or bind agents +- Run browser/UI tests +- Replace `slugsocial public check` for operators who want the full RPC path against a running server + +For live server dry-run against current garden state, use `npx slugsocial public check` or `POST /try/check` in the browser. diff --git a/sorterc/src/main.rs b/sorterc/src/main.rs new file mode 100644 index 0000000000000000000000000000000000000000..71382c180085cb0ad71043c852f8db5d3a48a284 --- /dev/null +++ b/sorterc/src/main.rs @@ -0,0 +1,117 @@ +use std::path::{Path, PathBuf}; + +use anyhow::{bail, Context, Result}; +use clap::{Parser, Subcommand}; +use slugsocial_server::{ + offline::{self, CompileError, CompileResult, ScanResult}, + reducer::ReducerState, +}; + +#[derive(Parser)] +#[command( + name = "sorterc", + about = "Offline .sorter compiler and events.jsonl linter (dev only)", + version +)] +struct Cli { + #[command(subcommand)] + cmd: Command, +} + +#[derive(Subcommand)] +enum Command { + /// Parse and simulate a .sorter document; emit ranking JSON to stdout. + Compile { + /// `.sorter` file, or `-` for stdin. + file: PathBuf, + /// Room wire id (`public` or private room id). + #[arg(long, default_value = "public")] + room: String, + /// Optional events.jsonl to replay before compiling (seed garden state). + #[arg(long)] + base: Option, + /// Pretty-print JSON. + #[arg(long)] + pretty: bool, + }, + /// Scan an events.jsonl for corrupt JSON lines and malformed ingests. + Scan { + file: PathBuf, + #[arg(long)] + pretty: bool, + }, +} + +fn read_input(path: &Path) -> Result { + if path.as_os_str() == "-" { + use std::io::Read; + let mut buf = String::new(); + std::io::stdin().read_to_string(&mut buf)?; + Ok(buf) + } else { + std::fs::read_to_string(path) + .with_context(|| format!("read {}", path.display())) + } +} + +fn load_base_state(base: Option<&Path>) -> Result { + let Some(path) = base else { + return Ok(ReducerState::default()); + }; + let (state, bad_lines) = offline::load_reducer_from_jsonl(path) + .with_context(|| format!("load base jsonl {}", path.display()))?; + if !bad_lines.is_empty() { + bail!( + "base jsonl has {} corrupt line(s); fix or omit --base", + bad_lines.len() + ); + } + Ok(state) +} + +fn print_json(value: &T, pretty: bool) -> Result<()> { + if pretty { + println!("{}", serde_json::to_string_pretty(value)?); + } else { + println!("{}", serde_json::to_string(value)?); + } + Ok(()) +} + +fn run_compile(file: PathBuf, room: String, base: Option, pretty: bool) -> Result<()> { + let text = read_input(&file)?; + let base_state = load_base_state(base.as_deref())?; + match offline::compile_document(&base_state, &room, &text) { + Ok(result) => { + print_json::(&result, pretty)?; + Ok(()) + } + Err(err) => { + print_json::(&err, pretty)?; + std::process::exit(1); + } + } +} + +fn run_scan(file: PathBuf, pretty: bool) -> Result<()> { + let report = offline::scan_jsonl(&file) + .with_context(|| format!("scan {}", file.display()))?; + print_json::(&report, pretty)?; + if !report.ok { + std::process::exit(1); + } + Ok(()) +} + +fn main() -> Result<()> { + let cli = Cli::parse(); + match cli.cmd { + Command::Compile { + file, + room, + base, + pretty, + } => run_compile(file, room, base, pretty), + Command::Scan { file, pretty } => run_scan(file, pretty), + } +}