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: [6d04afc2] refactor Side A — unified diff (full patch): diff --git a/Cargo.lock b/Cargo.lock index 2cea973082716e761ef6f5dd5886acc08ff9aac0..8c43fb75c472b102e6e1d3b837dce3355be898f2 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -17,6 +17,28 @@ version = "1.0.102" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "7f202df86484c868dbad7eaa557ef785d5c66295e41b460ef922eca0723b842c" +[[package]] +name = "async-stream" +version = "0.3.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0b5a71a6f37880a80d1d7f19efd781e4b5de42c88f0722cc13bcb6cc2cfe8476" +dependencies = [ + "async-stream-impl", + "futures-core", + "pin-project-lite", +] + +[[package]] +name = "async-stream-impl" +version = "0.3.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c7c24de15d275a1ecfd47a380fb4d5ec9bfe0933f309ed5e705b775596a3574d" +dependencies = [ + "proc-macro2", + "quote", + "syn", +] + [[package]] name = "async-trait" version = "0.1.89" @@ -1242,9 +1264,11 @@ dependencies = [ name = "sorter2-server" version = "0.0.1" dependencies = [ + "async-stream", "axum", "axum-extra", "dotenvy", + "futures-util", "maud", "reqwest", "serde", diff --git a/server/Cargo.toml b/server/Cargo.toml index bd600138b613bd0f546bdec217a5334cdcb20aa5..c940acb687fb141d21760a3d6656172013cf6f41 100644 --- a/server/Cargo.toml +++ b/server/Cargo.toml @@ -18,6 +18,8 @@ tracing = "0.1" tracing-subscriber = { version = "0.3", features = ["env-filter"] } reqwest = { version = "0.12", features = ["json"] } dotenvy = "0.15" +async-stream = "0.3" +futures-util = { version = "0.3", default-features = false, features = ["std"] } [dev-dependencies] reqwest = { version = "0.12", features = ["json"] } diff --git a/server/src/api/ui_html.rs b/server/src/api/ui_html.rs index b33a84e8bb5e817b26592868d88090e6d664d950..7af6527d03c483f33f3469ce6766c01a554c5fe3 100644 --- a/server/src/api/ui_html.rs +++ b/server/src/api/ui_html.rs @@ -6,7 +6,8 @@ use axum::{ use std::collections::HashMap; use crate::{ - html::{entity_section, input_panel, js_string_literal, ranking_panel, JsBuilder}, + fetch, + html::{input_panel, js_string_literal, ranking_panel, JsBuilder}, parser::parse_reddit_url, path_types::ItemId, reddit::ensure_partial_tree, @@ -89,18 +90,8 @@ pub async fn post_ui_html( }, HtmlUiAction::FetchEntity { item } => { let id = parse_item_param(&item); - if id.is_root() { - return ui_js_warn("nothing to fetch for the root").into_response(); - } - state.queue_entity_fetch(id.clone()); - let tree = state.tree.read().await; - let empty = crate::reducer::NodeState::default(); - let node = tree.get(&id).unwrap_or(&empty); - let panel = entity_section(&id, node, true); - JsBuilder::new() - .morph_selector("#entity-section", panel) - .into_response() - }, + fetch::fetch_entity_stream(state, id).into_response() + } } } diff --git a/server/src/fetch/html.rs b/server/src/fetch/html.rs new file mode 100644 index 0000000000000000000000000000000000000000..63634508496e224c38b9ec0308b7a6086462f925 --- /dev/null +++ b/server/src/fetch/html.rs @@ -0,0 +1,67 @@ +//! Markup for entity import / “Fetch from Reddit” (`POST /ui`, SSE response). + +use maud::{html, Markup}; + +use crate::{ + form_template::template_json_compact, + path_types::ItemId, + reddit::is_fetchable, + reducer::NodeState, + ui_action::UI_RPC_FIELD, +}; + +fn entity_panel(node: &NodeState) -> Markup { + html! { + @if let Some(data) = &node.data { + div id="entity-panel" class="entity-card" { + h2 { (data.title) } + @if let Some(author) = &data.author { + p class="muted small" { "by " (author) } + } + @if let Some(body) = &data.body_html { + div class="entity-body" { (maud::PreEscaped(body)) } + } + } + } + } +} + +/// Reddit/API import — `POST /ui` with `fetch_entity` returns an SSE stream. +pub fn fetch_entity_panel(item: &ItemId, has_data: bool, fetching: bool) -> Markup { + if !is_fetchable(item) { + return html! {}; + } + let label = if fetching { + "Fetching…" + } else if has_data { + "Fetch more" + } else { + "Fetch from Reddit" + }; + let rpc = template_json_compact(&serde_json::json!({ + "action": "fetch_entity", + "item": item.as_str(), + })) + .expect("fetch_entity rpc template"); + html! { + form method="post" action="/ui" id="fetch-entity-form" class="fetch-entity-form" { + input type="hidden" name=(UI_RPC_FIELD) value=(rpc); + @if fetching { + button type="submit" class="btn-secondary" disabled { (label) } + } @else { + button type="submit" class="btn-secondary" { (label) } + } + } + } +} + +/// Entity card + fetch control (target `#entity-section` for Idiomorph / SSE). +pub fn entity_section(item: &ItemId, node: &NodeState, fetching: bool) -> Markup { + let has_data = node.data.is_some(); + html! { + section id="entity-section" class="demo-panel" { + (entity_panel(node)) + (fetch_entity_panel(item, has_data, fetching)) + } + } +} diff --git a/server/src/fetch/mod.rs b/server/src/fetch/mod.rs new file mode 100644 index 0000000000000000000000000000000000000000..2290f9d3a0f1cbf1806c6339f82a4515c11cc3d3 --- /dev/null +++ b/server/src/fetch/mod.rs @@ -0,0 +1,115 @@ +//! Entity import over `POST /ui` as SSE (Reddit worker in [`crate::reddit`]). + +pub mod html; + +use std::convert::Infallible; +use std::time::Duration; + +use async_stream::stream; +use axum::response::sse::{Event, KeepAlive, Sse}; +use futures_util::Stream; +use serde::Serialize; +use tokio::sync::oneshot; + +use crate::{ + path_types::ItemId, + reddit::FetchJobResult, + reducer::NodeState, + state::AppState, +}; + +pub fn now_ms() -> i64 { + let t = std::time::SystemTime::now() + .duration_since(std::time::UNIX_EPOCH) + .unwrap_or_default(); + t.as_millis() as i64 +} + +#[derive(Serialize)] +struct SseMorphPayload { + selector: &'static str, + html: String, +} + +fn morph_complete_event(html: maud::Markup) -> Event { + let payload = SseMorphPayload { + selector: "#entity-section", + html: html.into_string(), + }; + let data = serde_json::to_string(&payload).unwrap_or_else(|_| "{}".into()); + Event::default().event("complete").data(data) +} + +/// Stream `fetching` → `complete` / `error` for [`crate::ui_action::HtmlUiAction::FetchEntity`]. +pub fn fetch_entity_stream( + state: AppState, + id: ItemId, +) -> Sse>> { + tracing::debug!(item = %id, "fetch entity stream opened"); + + let stream = stream! { + if id.is_root() { + yield Ok(Event::default().event("error").data("{\"message\":\"nothing to fetch for the root\"}")); + return; + } + + if !crate::reddit::is_fetchable(&id) { + tracing::debug!(item = %id, "fetch stream: not fetchable"); + yield Ok(Event::default().event("error").data("{\"message\":\"this page cannot be fetched from Reddit\"}")); + return; + } + + let fetching_html = { + let tree = state.tree.read().await; + let empty = NodeState::default(); + let node = tree.get(&id).unwrap_or(&empty); + html::entity_section(&id, node, true).into_string() + }; + let fetching_payload = serde_json::json!({ + "selector": "#entity-section", + "html": fetching_html, + }); + yield Ok(Event::default().event("fetching").data(fetching_payload.to_string())); + + let (tx, rx) = oneshot::channel(); + state.reddit.request_fetch(id.clone(), true, Some(tx)); + tracing::debug!(item = %id, "fetch stream: queued reddit job"); + + let result = match rx.await { + Ok(r) => r, + Err(_) => { + tracing::warn!(item = %id, "fetch stream: worker dropped oneshot"); + FetchJobResult::Failed("reddit worker stopped".into()) + } + }; + + tracing::debug!(item = %id, ?result, "fetch stream: job finished"); + + match result { + FetchJobResult::Imported | FetchJobResult::NotFound => { + let tree = state.tree.read().await; + let empty = NodeState::default(); + let node = tree.get(&id).unwrap_or(&empty); + yield Ok(morph_complete_event(html::entity_section(&id, node, false))); + } + FetchJobResult::SkippedCached | FetchJobResult::SkippedDuplicate => { + let tree = state.tree.read().await; + let empty = NodeState::default(); + let node = tree.get(&id).unwrap_or(&empty); + yield Ok(morph_complete_event(html::entity_section(&id, node, false))); + } + FetchJobResult::RateLimited { reset_secs } => { + yield Ok(Event::default().event("error").data( + serde_json::json!({"message": format!("Reddit rate limit — retry in {reset_secs}s")}).to_string(), + )); + } + FetchJobResult::Failed(msg) => { + yield Ok(Event::default().event("error").data( + serde_json::json!({"message": msg}).to_string(), + )); + } + } + }; + + Sse::new(stream).keep_alive(KeepAlive::new().interval(Duration::from_secs(15))) +} diff --git a/server/src/html/mod.rs b/server/src/html/mod.rs index db5b4c7f06b0be64603981166835cde268234f67..9314a7556306ddab969b896dbf4126b542a46722 100644 --- a/server/src/html/mod.rs +++ b/server/src/html/mod.rs @@ -7,10 +7,10 @@ use axum::{ use maud::{html, Markup, DOCTYPE}; use crate::{ + fetch::html::entity_section, form_template::template_json_compact, path_types::ItemId, ranking::{top_bottom, RankedItem}, - reddit::is_fetchable, reducer::{GroupState, NodeState}, state::AppState, ui_action::UI_RPC_FIELD, @@ -149,62 +149,6 @@ pub fn breadcrumb_path(item: &ItemId) -> Markup { } } -fn entity_panel(node: &NodeState) -> Markup { - html! { - @if let Some(data) = &node.data { - div id="entity-panel" class="entity-card" { - h2 { (data.title) } - @if let Some(author) = &data.author { - p class="muted small" { "by " (author) } - } - @if let Some(body) = &data.body_html { - div class="entity-body" { (maud::PreEscaped(body)) } - } - } - } - } -} - -/// Reddit/API import control — only shown on fetchable pages; never auto-fires. -pub fn fetch_entity_panel(item: &ItemId, has_data: bool, fetching: bool) -> Markup { - if !is_fetchable(item) { - return html! {}; - } - let label = if fetching { - "Fetching…" - } else if has_data { - "Fetch more" - } else { - "Fetch from Reddit" - }; - let rpc = template_json_compact(&serde_json::json!({ - "action": "fetch_entity", - "item": item.as_str(), - })) - .expect("fetch_entity rpc template"); - html! { - form method="post" action="/ui" id="fetch-entity-form" class="fetch-entity-form" { - input type="hidden" name=(UI_RPC_FIELD) value=(rpc); - @if fetching { - button type="submit" class="btn-secondary" disabled { (label) } - } @else { - button type="submit" class="btn-secondary" { (label) } - } - } - } -} - -/// Entity card + explicit fetch control (morphed as `#entity-section`). -pub fn entity_section(item: &ItemId, node: &NodeState, fetching: bool) -> Markup { - let has_data = node.data.is_some(); - html! { - section id="entity-section" class="demo-panel" { - (entity_panel(node)) - (fetch_entity_panel(item, has_data, fetching)) - } - } -} - fn rank_list(label: &str, items: &[RankedItem], start_rank: usize) -> Markup { html! { @if !items.is_empty() { diff --git a/server/src/lib.rs b/server/src/lib.rs index 79b173f391a96ae5d0d96fd656e1e8d2dd070d09..0677363e0ed21d244bfa065f7ec728549ddd9e50 100644 --- a/server/src/lib.rs +++ b/server/src/lib.rs @@ -1,6 +1,7 @@ pub mod api; pub mod event_log; pub mod events; +pub mod fetch; pub mod form_template; pub mod html; pub mod parser; diff --git a/server/src/reddit.rs b/server/src/reddit.rs index ff0f01e57b18af878eb5be3efc47204a7673589d..0e6ce32720951a58456852b67fb76a85dd9f4aad 100644 --- a/server/src/reddit.rs +++ b/server/src/reddit.rs @@ -7,12 +7,12 @@ use std::time::{Duration, Instant}; use reqwest::{header, Client, StatusCode}; use serde::Deserialize; use serde_json::Value; -use tokio::sync::{mpsc, RwLock}; +use tokio::sync::{mpsc, oneshot, RwLock}; use crate::{ event_log::EventLog, events::Event, - html::now_ms, + fetch::now_ms, path_types::ItemId, reducer::GlobalTree, }; @@ -22,10 +22,21 @@ pub fn ensure_partial_tree(tree: &mut GlobalTree, id: &ItemId) { tree.ensure_path(id); } +#[derive(Debug, Clone, PartialEq, Eq)] +pub enum FetchJobResult { + Imported, + NotFound, + SkippedDuplicate, + SkippedCached, + RateLimited { reset_secs: u64 }, + Failed(String), +} + pub struct RedditCommand { pub id: ItemId, /// User-initiated fetch bypasses the in-memory "recently fetched" cache. pub force: bool, + pub done: Option>, } #[derive(Clone)] @@ -72,14 +83,29 @@ impl RedditBroker { .build() .expect("reqwest client"); + tracing::debug!( + api_base = %config.api_base, + oauth_base = %config.oauth_base, + oauth = config.creds.is_some(), + "reddit worker started" + ); + tokio::spawn(reddit_worker(rx, tree, event_log, client, config)); Self { tx } } /// Queue a fetch; drops when the channel is full (backpressure). - pub fn request_fetch(&self, id: ItemId, force: bool) { - let _ = self.tx.try_send(RedditCommand { id, force }); + pub fn request_fetch( + &self, + id: ItemId, + force: bool, + done: Option>, + ) { + match self.tx.try_send(RedditCommand { id: id.clone(), force, done }) { + Ok(()) => tracing::debug!(item = %id, force, "reddit fetch queued"), + Err(_) => tracing::warn!(item = %id, "reddit fetch queue full, dropped"), + } } } @@ -95,8 +121,6 @@ impl RedditApiConfig { } impl RedditCredentials { - /// Reddit's OAuth docs call these "client id" and "client secret"; the app - /// registration UI often labels them "app id" / "app secret" — same values. fn from_env() -> Option { let client_id = std::env::var("REDDIT_CLIENT_ID") .or_else(|_| std::env::var("REDDIT_APP_ID")) @@ -128,12 +152,10 @@ pub fn default_user_agent() -> String { }) } -/// True when this node can be loaded from the Reddit JSON API. pub fn is_fetchable(id: &ItemId) -> bool { !map_item_to_reddit_api(id, "https://example.com").is_empty() } -/// Derive UI-facing fields from a stored payload (Reddit-specific when under reddit.com). pub fn entity_view_from_payload(id: &ItemId, payload: &Value) -> Option { if id.as_str().starts_with("reddit.com") { return parse_reddit_view(id, payload); @@ -141,12 +163,17 @@ pub fn entity_view_from_payload(id: &ItemId, payload: &Value) -> Option>, result: FetchJobResult) { + if let Some(tx) = done { + let _ = tx.send(result); + } +} + async fn reddit_worker( mut rx: mpsc::Receiver, tree: Arc>, @@ -168,15 +195,25 @@ async fn reddit_worker( recently_fetched.retain(|_, t| now.duration_since(*t) < cache_ttl); if in_flight.contains(&cmd.id) { + tracing::debug!(item = %cmd.id, "reddit fetch skipped: already in flight"); + notify(cmd.done, FetchJobResult::SkippedDuplicate); continue; } if !cmd.force && recently_fetched.contains_key(&cmd.id) { + tracing::debug!(item = %cmd.id, "reddit fetch skipped: recently fetched cache"); + notify(cmd.done, FetchJobResult::SkippedCached); continue; } in_flight.insert(cmd.id.clone()); let fetch_id = cmd.id.clone(); + let done = cmd.done; + tracing::debug!( + item = %fetch_id, + delay_ms = current_delay.as_millis(), + "reddit fetch starting after delay" + ); tokio::time::sleep(current_delay).await; if let Some(c) = &creds { @@ -184,8 +221,18 @@ async fn reddit_worker( } let token = oauth.as_ref().map(|t| t.access_token.as_str()); + if token.is_some() { + tracing::debug!(item = %fetch_id, "reddit fetch using OAuth bearer"); + } + + let fetch_base = if token.is_some() { + &oauth_base + } else { + &api_base + }; + let outcome = do_fetch(&client, fetch_base, &fetch_id, token).await; - match do_fetch(&client, &api_base, &fetch_id, token).await { + match outcome { Ok(FetchOutcome::Payload(payload)) => { let ts = now_ms(); let event = Event::EntityImported { @@ -193,30 +240,49 @@ async fn reddit_worker( ts, payload: payload.clone(), }; - if let Err(e) = event_log.append(&event).await { - tracing::warn!("event log append failed for {}: {}", fetch_id, e); - } else { - apply_entity_import(&mut *tree.write().await, &fetch_id, payload); - recently_fetched.insert(fetch_id.clone(), Instant::now()); - current_delay = Duration::from_millis(600); + tracing::debug!( + item = %fetch_id, + ts, + payload_keys = ?payload.as_object().map(|o| o.len()), + "reddit fetch got JSON payload, appending event" + ); + match event_log.append(&event).await { + Err(e) => { + tracing::warn!( + item = %fetch_id, + err = %e, + "reddit event log append failed" + ); + notify(done, FetchJobResult::Failed(e.to_string())); + } + Ok(()) => { + apply_entity_import(&mut *tree.write().await, &fetch_id, payload); + recently_fetched.insert(fetch_id.clone(), Instant::now()); + current_delay = Duration::from_millis(600); + tracing::info!(item = %fetch_id, "reddit entity imported"); + notify(done, FetchJobResult::Imported); + } } } Ok(FetchOutcome::NotFound) => { + tracing::debug!(item = %fetch_id, "reddit fetch: not found (no event written)"); recently_fetched.insert(fetch_id.clone(), Instant::now()); + notify(done, FetchJobResult::NotFound); } Ok(FetchOutcome::RateLimited { reset_secs }) => { - let wait = Duration::from_secs(reset_secs.max(1)); tracing::warn!( - "Reddit rate limit for {}; sleeping {}s", - fetch_id, - wait.as_secs() + item = %fetch_id, + reset_secs, + "reddit rate limited" ); - tokio::time::sleep(wait).await; + tokio::time::sleep(Duration::from_secs(reset_secs.max(1))).await; current_delay = (current_delay * 2).min(Duration::from_secs(60)); + notify(done, FetchJobResult::RateLimited { reset_secs }); } Err(e) => { - tracing::warn!("Reddit fetch failed for {}: {}", fetch_id, e); + tracing::warn!(item = %fetch_id, err = %e, "reddit fetch failed"); current_delay = (current_delay * 2).min(Duration::from_secs(60)); + notify(done, FetchJobResult::Failed(e)); } } @@ -238,6 +304,7 @@ async fn ensure_oauth_token( ) -> Option { if let Some(t) = existing { if Instant::now() < t.expires_at - Duration::from_secs(60) { + tracing::debug!("reddit OAuth token still valid"); return Some(t); } } @@ -246,6 +313,7 @@ async fn ensure_oauth_token( "{}/api/v1/access_token", oauth_base.trim_end_matches('/') ); + tracing::debug!(%url, "reddit OAuth token request"); let resp = client .post(&url) @@ -257,13 +325,13 @@ async fn ensure_oauth_token( let resp = match resp { Ok(r) => r, Err(e) => { - tracing::warn!("Reddit OAuth token request failed: {e}"); + tracing::warn!("reddit OAuth token request failed: {e}"); return None; } }; if !resp.status().is_success() { - tracing::warn!("Reddit OAuth token HTTP {}", resp.status()); + tracing::warn!("reddit OAuth token HTTP {}", resp.status()); return None; } @@ -276,11 +344,12 @@ async fn ensure_oauth_token( let body: TokenResponse = match resp.json().await { Ok(b) => b, Err(e) => { - tracing::warn!("Reddit OAuth token parse failed: {e}"); + tracing::warn!("reddit OAuth token parse failed: {e}"); return None; } }; + tracing::debug!(expires_in = body.expires_in, "reddit OAuth token acquired"); Some(OAuthToken { access_token: body.access_token, expires_at: Instant::now() + Duration::from_secs(body.expires_in), @@ -295,35 +364,72 @@ async fn do_fetch( ) -> Result { let url = map_item_to_reddit_api(id, api_base); if url.is_empty() { + tracing::debug!(item = %id, "reddit do_fetch: no API URL for item"); return Ok(FetchOutcome::NotFound); } + tracing::debug!(item = %id, %url, bearer = bearer.is_some(), "reddit HTTP GET"); + let mut req = client.get(&url); if let Some(token) = bearer { req = req.bearer_auth(token); } - let resp = req.send().await.map_err(|e| e.to_string())?; + let resp = req.send().await.map_err(|e| { + tracing::debug!(item = %id, %url, err = %e, "reddit HTTP transport error"); + e.to_string() + })?; + + let status = resp.status(); + tracing::debug!( + item = %id, + %url, + %status, + remaining = ?rate_limit_remaining(&resp), + reset = ?rate_limit_reset_secs(&resp), + "reddit HTTP response" + ); - if resp.status() == StatusCode::TOO_MANY_REQUESTS { + if status == StatusCode::TOO_MANY_REQUESTS { let reset = rate_limit_reset_secs(&resp); return Ok(FetchOutcome::RateLimited { reset_secs: reset }); } - if resp.status() == StatusCode::SERVICE_UNAVAILABLE { - return Err("Reddit unavailable (503)".to_string()); + if status == StatusCode::SERVICE_UNAVAILABLE { + return Err("Reddit unavailable (503)".into()); } - if !resp.status().is_success() { + if !status.is_success() { + let body = resp.text().await.unwrap_or_default(); + tracing::debug!( + item = %id, + %status, + body_len = body.len(), + body_prefix = %body.chars().take(240).collect::(), + "reddit non-success body" + ); return Ok(FetchOutcome::NotFound); } if rate_limit_remaining(&resp) == Some(0) { let reset = rate_limit_reset_secs(&resp); + tracing::debug!(item = %id, reset_secs = reset, "reddit headers: rate limit exhausted"); return Ok(FetchOutcome::RateLimited { reset_secs: reset }); } - let payload: Value = resp.json().await.map_err(|e| e.to_string())?; + let text = resp.text().await.map_err(|e| e.to_string())?; + tracing::debug!(item = %id, bytes = text.len(), "reddit response body received"); + + let payload: Value = serde_json::from_str(&text).map_err(|e| { + tracing::debug!( + item = %id, + err = %e, + body_prefix = %text.chars().take(240).collect::(), + "reddit JSON parse failed" + ); + format!("invalid JSON: {e}") + })?; + Ok(FetchOutcome::Payload(payload)) } @@ -344,7 +450,6 @@ fn rate_limit_reset_secs(resp: &reqwest::Response) -> u64 { .unwrap_or(5) } -/// Map canonical item id to a Reddit JSON API URL under `api_base`. pub fn map_item_to_reddit_api(id: &ItemId, api_base: &str) -> String { let path = id.as_str(); if !path.starts_with("reddit.com/") && path != "reddit.com" { @@ -445,26 +550,6 @@ mod tests { map_item_to_reddit_api(&id, "https://www.reddit.com"), "https://www.reddit.com/r/rust/about.json?raw_json=1" ); - assert_eq!( - map_item_to_reddit_api(&id, "http://127.0.0.1:9999"), - "http://127.0.0.1:9999/r/rust/about.json?raw_json=1" - ); - } - - #[test] - fn map_post_url() { - let id = ItemId::parse("reddit.com/r/amitheasshole/comments/1trnvdl").unwrap(); - assert_eq!( - map_item_to_reddit_api(&id, "https://www.reddit.com"), - "https://www.reddit.com/r/amitheasshole/comments/1trnvdl.json?raw_json=1" - ); - } - - #[test] - fn is_fetchable_reddit_sub() { - let id = ItemId::parse("reddit.com/r/rust").unwrap(); - assert!(is_fetchable(&id)); - assert!(!is_fetchable(&ItemId::opaque("example.com/x"))); } #[test] @@ -477,19 +562,5 @@ mod tests { ) .unwrap(); assert_eq!(entity.title, "The Rust Programming Language"); - assert!(entity.body_html.as_ref().is_some_and(|b| b.contains("Rust"))); - } - - #[test] - fn parse_post_fixture() { - let json = r#"[{"kind":"Listing","data":{"children":[{"kind":"t3","data":{"title":"AITA","author":"op","selftext_html":"<p>hi</p>","thumbnail":"https://b.thumbs.redditmedia.com/x.jpg"}}]}}]"#; - let v: Value = serde_json::from_str(json).unwrap(); - let entity = entity_view_from_payload( - &ItemId::parse("reddit.com/r/x/comments/abc").unwrap(), - &v, - ) - .unwrap(); - assert_eq!(entity.title, "AITA"); - assert_eq!(entity.author.as_deref(), Some("op")); } } diff --git a/server/src/state.rs b/server/src/state.rs index d71d1079a8f486cdab15795384aef0b81b32544d..e7ff9f663e45b5e168d6a3869948e3bd890966d4 100644 --- a/server/src/state.rs +++ b/server/src/state.rs @@ -143,9 +143,9 @@ impl AppState { Ok(()) } - /// User-initiated Reddit/API import (via "Fetch more" — never on paste or navigate). - pub fn queue_entity_fetch(&self, id: ItemId) { - self.reddit.request_fetch(id, true); + /// User-initiated Reddit/API import (SSE / fetch module only). + pub fn queue_entity_fetch(&self, id: ItemId, done: Option>) { + self.reddit.request_fetch(id, true, done); } pub async fn record_vote( diff --git a/server/src/ui_action.rs b/server/src/ui_action.rs index 3d6a49a2a3fb950752827efe1f5a049308f09baf..ef9ac873fc0442e0b960f144309c8e91124d7884 100644 --- a/server/src/ui_action.rs +++ b/server/src/ui_action.rs @@ -26,7 +26,7 @@ pub enum HtmlUiAction { ParseQuery { query: String, }, - /// Fetch upstream entity data for the current page (explicit user action only). + /// Import entity data; `POST /ui` responds with `text/event-stream` (not JS). FetchEntity { item: String, }, diff --git a/server/static/sorter_ui.js b/server/static/sorter_ui.js index d9b016f197547f37ca4b2bcdd7ee6b673d0fb3f0..fe7bfc657c0fccae5c596d005b0e807abefec677 100644 --- a/server/static/sorter_ui.js +++ b/server/static/sorter_ui.js @@ -1,5 +1,5 @@ /** - * sorter2 web UI: fetch/eval for POST /ui. No product logic here. + * sorter2 web UI: POST /ui returns JS (morph) or SSE (entity fetch). */ (function () { function evalJs(js) { @@ -8,15 +8,98 @@ } } + function morphSelector(selector, html) { + var el = document.querySelector(selector); + if (el && typeof Idiomorph !== 'undefined') { + Idiomorph.morph(el, html); + } + } + + function handleSseEvent(eventType, data, form) { + if (eventType === 'fetching' || eventType === 'complete') { + try { + var msg = JSON.parse(data); + morphSelector(msg.selector || '#entity-section', msg.html); + } catch (err) { + console.warn('fetch morph parse', err); + } + } + if (eventType === 'complete' || eventType === 'error') { + var btn = form && form.querySelector('button[type="submit"]'); + if (btn) btn.disabled = false; + } + if (eventType === 'error') { + try { + var err = JSON.parse(data); + console.warn('fetch error:', err.message || data); + } catch (_e) { + console.warn('fetch error:', data); + } + } + } + + function consumeSseStream(response, form) { + var reader = response.body.getReader(); + var decoder = new TextDecoder(); + var buffer = ''; + var eventType = ''; + var dataLines = []; + + function dispatch() { + if (!eventType && dataLines.length === 0) return; + handleSseEvent(eventType || 'message', dataLines.join('\n'), form); + eventType = ''; + dataLines = []; + } + + function pump() { + return reader.read().then(function (chunk) { + if (chunk.done) { + dispatch(); + return; + } + buffer += decoder.decode(chunk.value, { stream: true }); + var parts = buffer.split('\n'); + buffer = parts.pop() || ''; + for (var i = 0; i < parts.length; i++) { + var line = parts[i].replace(/\r$/, ''); + if (line === '') { + dispatch(); + } else if (line.indexOf('event:') === 0) { + eventType = line.slice(6).trim(); + } else if (line.indexOf('data:') === 0) { + dataLines.push(line.slice(5).trim()); + } + } + return pump(); + }); + } + + return pump(); + } + function postUiForm(form) { + var btn = form.querySelector('button[type="submit"]'); + if (form.id === 'fetch-entity-form' && btn) { + btn.disabled = true; + } return fetch(form.action, { method: 'POST', body: new URLSearchParams(new FormData(form)), headers: { 'Content-Type': 'application/x-www-form-urlencoded' }, credentials: 'same-origin', }).then(function (resp) { - return resp.text(); - }).then(evalJs); + var ct = resp.headers.get('content-type') || ''; + if (ct.indexOf('text/event-stream') !== -1) { + return consumeSseStream(resp, form); + } + return resp.text().then(evalJs); + }).catch(function (err) { + if (form.id === 'fetch-entity-form' && btn) { + btn.disabled = false; + } + console.warn('POST /ui failed', err); + }); } function initSorterUi() { diff --git a/test/reddit_import.clj b/test/reddit_import.clj index 54edaedeef08718c8f184d6aa468d8e6415068c7..17f2ee39e1498b0b6bb6a9d8a7e35608b0bd1b32 100644 --- a/test/reddit_import.clj +++ b/test/reddit_import.clj @@ -44,10 +44,12 @@ (do (Thread/sleep 200) (recur)) false)))))) -(defn- curl-post-ui [base rpc-json] +(defn- curl-fetch-ui-sse [base item] (process/shell {:out :string :err :string} - "curl" "-sf" "-X" "POST" (str base "/ui") - "--data-urlencode" (str "__rpc__=" rpc-json))) + "curl" "-sfN" "--max-time" "20" + "-X" "POST" (str base "/ui") + "--data-urlencode" + (str "__rpc__={\"action\":\"fetch_entity\",\"item\":\"" item "\"}"))) (defn- wait-event-log [path ms] (let [deadline (+ (System/currentTimeMillis) ms)] @@ -98,11 +100,12 @@ "curl" "-sf" browse-url))] (is (str/includes? before "Fetch from Reddit")) (is (not (str/includes? before "The Rust Programming Language"))) - (let [rpc "{\"action\":\"fetch_entity\",\"item\":\"reddit.com/r/rust\"}" - post (curl-post-ui app-base rpc) - log-path (str data-dir "/events.jsonl")] - (is (zero? (:exit post)) "fetch_entity POST succeeds") - (is (wait-event-log log-path 10000) "event log written") + (let [log-path (str data-dir "/events.jsonl") + sse (curl-fetch-ui-sse app-base "reddit.com/r/rust")] + (is (zero? (:exit sse)) "POST /ui fetch_entity SSE succeeds") + (is (str/includes? (:out sse) "event: complete")) + (is (str/includes? (:out sse) "The Rust Programming Language")) + (is (wait-event-log log-path 2000) "event log written") (let [after (:out (process/shell {:out :string :err :string} "curl" "-sf" browse-url)) log (slurp (io/file log-path))] Side B — contributor: tommy-mor Side B — commit message: [c59951f5] fixed canonical item paths business Side B — unified diff (full patch): diff --git a/server/src/html/breadcrumb_path.rs b/server/src/html/breadcrumb_path.rs index 12ad2c84faf2fbb693015d4552e45b5c54d587b9..c8a3937923161a6ff248bd77e87eff0dc6fe9ab0 100644 --- a/server/src/html/breadcrumb_path.rs +++ b/server/src/html/breadcrumb_path.rs @@ -1,4 +1,4 @@ -use crate::path_types::CanonicalItemUrl; +use crate::path_types::{tilde_http_path_to_canonical, CanonicalItemUrl}; /// Semantic view of an ontology path for rendering and routing decisions. pub(super) struct OntologyPath { @@ -11,16 +11,7 @@ impl OntologyPath { /// Path is the `*path` segment from `/~/*path` (e.g. `topic/a`). Always treat it as under `~/` /// so it canonicalizes to `https://slug.social/~/…`, not the non-tilde site path. pub(super) fn from_input(path: &str) -> Self { - let p = path.trim_start_matches('/'); - let raw = if p.starts_with("http://") || p.starts_with("https://") { - p.to_string() - } else if p.is_empty() { - "~/".to_string() - } else { - format!("~/{}", p) - }; - let canonical = CanonicalItemUrl::parse(&raw) - .unwrap_or_else(|| CanonicalItemUrl::parse("~/").unwrap()); + let canonical = tilde_http_path_to_canonical(path); Self::from_canonical(canonical) } @@ -37,7 +28,7 @@ impl OntologyPath { } pub(super) fn root() -> Self { - Self::from_canonical(CanonicalItemUrl::parse("~/").unwrap()) + Self::from_canonical(CanonicalItemUrl::ontology_root()) } pub(super) fn is_root(&self) -> bool { diff --git a/server/src/html/garden.rs b/server/src/html/garden.rs index d58d9b46f575eb6b7e4971086b07dda75ca2f645..319feb15a6b68d2b5df98b4289fedbc9bdd048d3 100644 --- a/server/src/html/garden.rs +++ b/server/src/html/garden.rs @@ -459,6 +459,8 @@ struct ItemPageViewModel { item: String, body: Option, sibling_rank: Option, + /// False at the tilde ontology root (`~/`): sibling-rank footnote does not apply. + item_has_parent: bool, child_rankings: ChildrenRankings, rank_history: Vec, /// Forum threads that mention or vote on this item. @@ -470,11 +472,12 @@ fn build_sibling_rank( scope: &ScopeId, item: &CanonicalItemUrl, ) -> Option { + let item = item.clone().normalized_storage(); let content = reduced .content_for_scope(scope) .unwrap_or_else(|| reduced.public()); let group = &content.ranking_group; - let parent = item.parent()?; + let parent = item.parent()?.normalized_storage(); let siblings: Vec = content .item_children .get(&parent) @@ -492,7 +495,7 @@ fn build_sibling_rank( if scoped_idxs.is_empty() { return None; } - let current_idx = *group.item_to_idx.get(item)?; + let current_idx = *group.item_to_idx.get(&item)?; if !scoped_idxs.contains(¤t_idx) { return None; } @@ -520,7 +523,7 @@ fn build_sibling_rank( .filter_map(|li| local_to_global.get(*li).copied()) .collect(); let ranked = ranked_items_subset(group, &comp_global, 10000, 1e-8); - let position = ranked.iter().position(|r| &r.item == item)? + 1; + let position = ranked.iter().position(|r| r.item == item)? + 1; Some(SiblingRank { position, component_size: ranked.len(), @@ -597,7 +600,9 @@ fn build_item_page_view_model( .content_for_scope(scope) .unwrap_or_else(|| reduced.public()); let item_key = CanonicalItemUrl::parse(item) - .unwrap_or_else(|| CanonicalItemUrl::parse("~/").unwrap()); + .unwrap_or_else(|| CanonicalItemUrl::parse("~/").unwrap()) + .normalized_storage(); + let item_has_parent = item_key.parent().is_some(); let child_rankings = build_children_rankings(content, &item_key); let rank_history = build_rank_history(reduced, scope, item_key.as_str()); @@ -617,6 +622,7 @@ fn build_item_page_view_model( .cloned() .or_else(|| reduced.public().item_bodies.get(&item_key).cloned()), sibling_rank: build_sibling_rank(reduced, scope, &item_key), + item_has_parent, child_rankings, rank_history, threads, @@ -652,7 +658,7 @@ async fn render_scope_view( (format!("#{} of {}", rank.position, rank.component_size)) } span class="muted" { (format!("({} siblings)", rank.sibling_total)) } - } @else { + } @else if model.item_has_parent { span class="muted" { "unranked among siblings" } } } @@ -815,6 +821,18 @@ mod tests { })); } + fn apply_ingest_room(state: &mut ReducerState, ts: i64, room_id: &str, raw: &str) { + state.apply_event(Event::Ingest(Ingest { + ts, + id: format!("ing-{ts}"), + raw: raw.to_string(), + principal: "testuser".to_string(), + delegate: Some("00000000-0000-0000-0000-000000000000:test:local/test".to_string()), + room_id: room_id.to_string(), + thread_tag: String::new(), + })); + } + #[test] fn item_page_model_includes_body_and_unranked_without_votes() { let mut reduced = ReducerState::default(); @@ -885,4 +903,85 @@ mod tests { || model.child_rankings.unranked_items.contains(&CanonicalItemUrl("https://slug.social/~/topic/kid2".to_string())) ); } + + #[test] + fn item_page_room_scope_root_lists_top_level_children() { + let mut reduced = ReducerState::default(); + apply_ingest_room( + &mut reduced, + 1, + "9ab12cd/my-room", + "@00000000-0000-0000-0000-000000000000:test:local/test\n~/t1 {a}\n~/t2 {b}\n", + ); + use crate::path_types::CanonicalItemUrl; + let root = CanonicalItemUrl::ontology_root(); + let model = build_item_page_view_model( + &reduced, + &ScopeId::Room("9ab12cd/my-room".to_string()), + root.as_str(), + ); + assert!(!model.item_has_parent); + assert_eq!(model.child_rankings.unranked_items.len(), 2); + let set: std::collections::HashSet<&str> = model + .child_rankings + .unranked_items + .iter() + .map(|u| u.as_str()) + .collect(); + assert!(set.contains("https://slug.social/~/t1")); + assert!(set.contains("https://slug.social/~/t2")); + } + + /// Top-level `~/a` vs `~/b` votes form one ranked component under the ontology root. + #[test] + fn item_page_room_scope_root_shows_ranked_child_group() { + let mut reduced = ReducerState::default(); + apply_ingest_room( + &mut reduced, + 1, + "9ab12cd/my-room", + "@00000000-0000-0000-0000-000000000000:test:local/test\n\ + ~/a {a}\n~/b {b}\n~/a 2:1 ~/b {because}\n", + ); + use crate::path_types::CanonicalItemUrl; + let root = CanonicalItemUrl::ontology_root(); + let model = build_item_page_view_model( + &reduced, + &ScopeId::Room("9ab12cd/my-room".to_string()), + root.as_str(), + ); + assert_eq!(model.child_rankings.component_rankings.len(), 1); + assert_eq!(model.child_rankings.component_rankings[0].pairs, 1); + let names: Vec<&str> = model.child_rankings.component_rankings[0] + .ranked + .iter() + .map(|r| r.item.as_str()) + .collect(); + assert_eq!( + names, + vec!["https://slug.social/~/a", "https://slug.social/~/b"] + ); + assert!(model.child_rankings.unranked_items.is_empty()); + } + + /// Legacy `https://slug.social/~/` spelling still resolves children under the real root key. + #[test] + fn item_page_model_normalizes_legacy_tilde_root_storage_url() { + let mut reduced = ReducerState::default(); + apply_ingest( + &mut reduced, + 1, + "@00000000-0000-0000-0000-000000000000:test:local/test\n~/x {x}\n", + ); + let model = build_item_page_view_model( + &reduced, + &ScopeId::Public, + "https://slug.social/~/", + ); + assert_eq!(model.child_rankings.unranked_items.len(), 1); + assert_eq!( + model.child_rankings.unranked_items[0].as_str(), + "https://slug.social/~/x" + ); + } } diff --git a/server/src/path_types.rs b/server/src/path_types.rs index 4c8075bbd488f1b9a5eda9e03ced83f6238c6d5e..361a9d446c9043cbdea5f060db2e8633c2fd9bf9 100644 --- a/server/src/path_types.rs +++ b/server/src/path_types.rs @@ -1,3 +1,5 @@ //! Re-exports — implementations live in `slug-types` (`paths` module). -pub use slug_types::paths::{CanonicalItemUrl, RelativePath, TildePath}; +pub use slug_types::paths::{ + tilde_http_path_to_canonical, CanonicalItemUrl, RelativePath, TildeHttpPathTail, TildePath, +}; diff --git a/server/src/scope_rank.rs b/server/src/scope_rank.rs index dc640848232b7e79142bfeeea3003c9023f84854..d656b2f0a0a3623ca6b234b746beaaca8ae6017d 100644 --- a/server/src/scope_rank.rs +++ b/server/src/scope_rank.rs @@ -149,9 +149,10 @@ pub fn build_rankings_for_item_set(content: &ContentState, items_in_scope: &[Can /// Build connected-component rankings for direct children of parent_scope. /// Matches the HTML garden view: multiple components, isolates, no-vote items. pub fn build_children_rankings(content: &ContentState, parent: &CanonicalItemUrl) -> ChildrenRankings { + let parent = parent.clone().normalized_storage(); let items: Vec = content .item_children - .get(parent) + .get(&parent) .map(|s| s.iter().cloned().collect()) .unwrap_or_default(); build_rankings_for_item_set(content, &items) diff --git a/server/tests/integration.rs b/server/tests/integration.rs index f9c218378f6a173e56ae1cec797b3c492986eac0..d4c5bfe9c6f1c71dc61878bd8c5e729b1b7c69ef 100644 --- a/server/tests/integration.rs +++ b/server/tests/integration.rs @@ -704,6 +704,62 @@ async fn test_private_room_post_links_use_private_garden_routes() { assert!(garden_body.contains(&format!("/r/{room_short}/{room_slug}/t/garden-thread"))); } +#[tokio::test] +async fn test_private_room_garden_root_lists_top_level_tilde_children() { + let (addr, _tmp, _log, _handle) = create_test_server().await; + let client = reqwest::Client::builder() + .redirect(reqwest::redirect::Policy::none()) + .build() + .unwrap(); + let bearer = test_bearer(); + + let create = rpc_batch( + &client, + addr, + Some(&bearer), + serde_json::json!([{ + "RoomCreate": { "slug": "garden-root-list" } + }]), + ) + .await; + let room_id = create["results"][0]["result"]["RoomCreated"]["room_id"] + .as_str() + .unwrap() + .to_string(); + let (room_short, room_slug) = room_id.split_once('/').unwrap(); + + let rpc = ui_post_ingest_rpc( + &room_id, + "ing", + "~/test1 {wow}\n~/test2 {wow2}\n~/test1 2:1 ~/test2 {because}\n", + ); + let post = client + .post(format!("http://{addr}/ui")) + .header("Authorization", format!("Bearer {bearer}")) + .form(&[("__rpc__", rpc.as_str())]) + .send() + .await + .unwrap(); + assert_eq!(post.status(), reqwest::StatusCode::OK); + + let root_page = client + .get(format!("http://{addr}/r/{room_short}/{room_slug}/~")) + .header("Authorization", format!("Bearer {bearer}")) + .send() + .await + .unwrap(); + assert!(root_page.status().is_success()); + let body = root_page.text().await.unwrap(); + assert!( + body.contains("ranked child groups"), + "expected garden child panel: {}", + body.len() + ); + assert!(body.contains("~/test1")); + assert!(body.contains("~/test2")); + assert!(body.contains("ordering 1")); +} + #[tokio::test] async fn test_post_check_returns_targeted_js_error_for_missing_thread_tag() { let (addr, _tmp, _log, _handle) = create_test_server().await; diff --git a/test/browser_public_garden.clj b/test/browser_public_garden.clj new file mode 100644 index 0000000000000000000000000000000000000000..7bea08e1cf2c8f5b1a94b0640a46e9ba5607b19b --- /dev/null +++ b/test/browser_public_garden.clj @@ -0,0 +1,100 @@ +(ns test.browser-public-garden + "Regression: ingest ontology items in the public room via RPC, then open /~ in the browser + and assert ranked + unranked paths appear (HTML garden index — not JSON API)." + (:require [babashka.fs :as fs] + [cheshire.core :as json] + [clojure.string :as str] + [clojure.test :refer [deftest is]] + [com.blockether.spel.core :as core] + [com.blockether.spel.locator :as locator] + [com.blockether.spel.page :as page] + [test.common :as common] + [test.oauth :as oauth])) + +(defn- wait-for-text [pg selector expected timeout-ms] + (let [deadline (+ (System/currentTimeMillis) timeout-ms)] + (loop [] + (let [text (locator/text-content (page/locator pg selector))] + (if (and (string? text) (str/includes? text expected)) + true + (if (< (System/currentTimeMillis) deadline) + (do (Thread/sleep 200) (recur)) + false)))))) + +(defn public-garden-flow! [] + (println "\n━━━ browser public room garden index (RPC seed + GET /~) ━━━\n") + + (common/letlocals + (bind build (common/run-cargo-build-release! ["slugsocial-server"])) + (is (zero? (:exit build)) "cargo build succeeds") + (bind server-bin "target/release/slugsocial-server") + + (bind tmp-dir (str (fs/create-temp-dir {:prefix "slug-browser-pub-garden-"}))) + (bind slug-port (common/pick-port)) + (bind google-port (common/pick-port)) + (bind base-url (str "http://127.0.0.1:" slug-port)) + (bind google-url (str "http://127.0.0.1:" google-port)) + + (bind !server (atom nil)) + (bind !google (atom nil)) + (bind server-env (common/slug-server-env tmp-dir base-url google-url slug-port)) + (try + (reset! !google (oauth/start-mock-google google-port + :google-users ["google-user-alice"])) + (reset! !server (common/start-server server-bin server-env)) + (is (common/wait-for-server base-url 10000) "server responds to /healthz") + + (let [alice-token (oauth/fetch-bearer-token! base-url :username "alice") + thread-tag "browser-pub-garden" + ;; Ranked pair at root + one isolate so both panels are exercised. + raw (str "# " thread-tag "\n\n" + "~/br-pub-a {alpha}\n" + "~/br-pub-b {beta}\n" + "~/br-pub-c {gamma}\n" + "~/br-pub-a 2:1 ~/br-pub-b {browser regression vote}\n") + post-resp (oauth/http-post-json + (str base-url "/api/v0/rpc") + [{"Post" {"room" "public" + "thread_tag" thread-tag + "text" raw + "return_rank_diff" false}}] + :headers {"Authorization" (str "Bearer " alice-token)}) + post-json (json/parse-string (:body post-resp) false) + _ (is (true? (get-in post-json ["results" 0 "ok"])) "seed public post via rpc") + rank-resp (oauth/http-post-json + (str base-url "/api/v0/rpc") + [{"GetGardenRank" {"room" "public" + "parent_path" "~" + "depth" 1}}]) + rank-json (json/parse-string (:body rank-resp) false) + _ (is (true? (get-in rank-json ["results" 0 "ok"])) "GetGardenRank ok") + comps (get-in rank-json ["results" 0 "result" "GardenRank" "components"]) + _ (is (pos? (count comps)) "rank API reports at least one component")] + (core/with-playwright [pw] + (core/with-browser [browser (core/launch-chromium pw {:headless true :channel "chrome"})] + (core/with-context [ctx (core/new-context browser)] + (core/with-page [pg (core/new-page-from-context ctx)] + (page/navigate pg (str base-url "/login")) + (is (wait-for-text pg "body" "@alice" 15000) "alice session after login") + (page/navigate pg (str base-url "/~")) + (is (wait-for-text pg "body" "paths" 15000) "public garden index shows paths heading") + (is (wait-for-text pg "body" "ordering" 10000) + "ranked child group meta visible") + (is (wait-for-text pg "body" "~/br-pub-a" 10000) "ranked list shows ~/br-pub-a") + (is (wait-for-text pg "body" "~/br-pub-b" 10000) "ranked list shows ~/br-pub-b") + (is (wait-for-text pg "body" "unranked" 10000) "unranked section present") + (is (wait-for-text pg "body" "~/br-pub-c" 10000) + "unranked list shows ~/br-pub-c")))))) + + (finally + (when-some [s @!server] (common/kill-server s)) + (when-some [g @!google] ((:stop-fn g))) + (fs/delete-tree tmp-dir))) + + nil)) + +(defn public-garden-browser-test [& _args] + (public-garden-flow!)) + +(deftest browser-public-garden-index-check + (public-garden-flow!)) diff --git a/tests.edn b/tests.edn index 56fdfa4f29383ad305fd8068783e4efe2ed334a0..6e96432ba766461b4233c75dc48db2633483e5e0 100644 --- a/tests.edn +++ b/tests.edn @@ -16,7 +16,8 @@ :ns-patterns ["^test\\.browser-sse$" "^test\\.browser-ui-morph$" "^test\\.browser-post-redact$" - "^test\\.browser-room-delete$"] + "^test\\.browser-room-delete$" + "^test\\.browser-public-garden$"] :kaocha.filter/skip-meta [:skip] :parallel? false}] :plugins [:kaocha.plugin/junit-xml] diff --git a/types/src/lib.rs b/types/src/lib.rs index 8cea90238ef6207d65ecdb2903b8958fafb213d2..edbb923e4d7d41ad82dfc254c3bd697562383527 100644 --- a/types/src/lib.rs +++ b/types/src/lib.rs @@ -4,8 +4,9 @@ pub mod paths; pub mod timeago; pub use paths::{ - canonicalize_item, canonicalize_tag, item_parent_path, item_path_segments, CanonicalItemUrl, - ForumThreadUrl, GardenItemUrl, RelativePath, TildeOntologyPath, TildePath, + canonicalize_item, canonicalize_tag, item_parent_path, item_path_segments, normalize_slug_ontology_storage_url, + CanonicalItemUrl, ForumThreadUrl, GardenItemUrl, RelativePath, SLUG_TILDE_ONTOLOGY_ROOT, + TildeHttpPathTail, TildeOntologyPath, TildePath, tilde_http_path_to_canonical, }; /// Max characters returned for a garden item body unless `full=true` / `--full` (API + CLI). diff --git a/types/src/paths.rs b/types/src/paths.rs index 668323ed777f360f2838a0dfe6eae68905d1183b..8971f599a7ebcf399f60c306d35ee28d0f581194 100644 --- a/types/src/paths.rs +++ b/types/src/paths.rs @@ -1,5 +1,13 @@ //! Canonical paths, storage ids, and JSON href newtypes. All normalization and //! room-aware URL rules for items live here. +//! +//! ## String kinds (parse in this module only) +//! +//! - **[`canonicalize_item`] / [`CanonicalItemUrl`]** — graph storage key and DSL form; tilde +//! ontology root is always [`SLUG_TILDE_ONTOLOGY_ROOT`] (no `…/~/` trailing slash only). +//! - **[`TildeHttpPathTail`]** — capture from `GET /~/*path` or `…/r/…/~/…` (the `*path` segment). +//! - **`-/…` wire form** — external items; see [`canonicalize_item`] dash branch. +//! - **[`GardenItemUrl`], [`ForumThreadUrl`]** — JSON / browser href surfaces. use std::borrow::Borrow; use std::fmt; @@ -7,6 +15,23 @@ use std::ops::Deref; use serde::{Deserialize, Serialize}; +// --------------------------------------------------------------------------- +// Slug tilde ontology (single storage form for `~/`) +// --------------------------------------------------------------------------- + +/// Canonical absolute URL for the tilde ontology **root** (`~/` in UI). Used as the +/// `item_children` parent key for top-level items and must match [`CanonicalItemUrl::ontology_root`]. +pub const SLUG_TILDE_ONTOLOGY_ROOT: &str = "https://slug.social/~"; + +/// Collapse legacy or parser variants of the ontology root to [`SLUG_TILDE_ONTOLOGY_ROOT`]. +pub fn normalize_slug_ontology_storage_url(s: &str) -> String { + if s == "https://slug.social/~/" { + SLUG_TILDE_ONTOLOGY_ROOT.to_string() + } else { + s.to_string() + } +} + // --------------------------------------------------------------------------- // Normalization (moved from server `canonical_path`) // --------------------------------------------------------------------------- @@ -89,6 +114,9 @@ pub fn canonicalize_item(input: &str) -> String { .join("/"); if is_tilde { + if tail.is_empty() { + return SLUG_TILDE_ONTOLOGY_ROOT.to_string(); + } format!("https://slug.social/~/{}", tail) } else if tail.is_empty() { "https://slug.social".to_string() @@ -173,7 +201,7 @@ impl CanonicalItemUrl { if c.is_empty() { None } else { - Some(Self(c)) + Some(Self(normalize_slug_ontology_storage_url(&c))) } } @@ -181,8 +209,19 @@ impl CanonicalItemUrl { &self.0 } + /// Collapses legacy slug ontology root spellings so [`HashMap`] keys match the reducer graph. + pub fn normalized_storage(self) -> Self { + Self(normalize_slug_ontology_storage_url(self.as_str())) + } + pub fn tilde_tail(&self) -> Option<&str> { - self.0.strip_prefix("https://slug.social/~/") + if let Some(tail) = self.0.strip_prefix("https://slug.social/~/") { + return Some(tail); + } + if self.0 == SLUG_TILDE_ONTOLOGY_ROOT || self.0 == "https://slug.social/~/" { + return Some(""); + } + None } pub fn last_segment(&self) -> &str { @@ -193,7 +232,7 @@ impl CanonicalItemUrl { } pub fn ontology_root() -> Self { - Self("https://slug.social/~".to_string()) + Self(SLUG_TILDE_ONTOLOGY_ROOT.to_string()) } pub fn parent(&self) -> Option { @@ -234,9 +273,13 @@ impl CanonicalItemUrl { /// `-/` representation for external `https://…` items, `~/…` for slug ontology, else unchanged. pub fn display_path(&self) -> String { - if let Some(tail) = self.0.strip_prefix("https://slug.social/~/") { - format!("~/{}", tail) - } else if let Some(tail) = self.0.strip_prefix("https://") { + if let Some(tail) = self.tilde_tail() { + if tail.is_empty() { + return "~/".to_string(); + } + return format!("~/{}", tail); + } + if let Some(tail) = self.0.strip_prefix("https://") { if tail.starts_with("slug.social") { self.0.clone() } else { @@ -276,6 +319,37 @@ impl CanonicalItemUrl { } } +/// HTTP route capture: path segment after `~/` in `GET /~/*path` or `…/r/…/~/…` (empty = ontology root). +#[derive(Debug, Clone, PartialEq, Eq, Hash)] +pub struct TildeHttpPathTail(pub String); + +impl TildeHttpPathTail { + pub fn new(path_segment: &str) -> Self { + Self(path_segment.trim_start_matches('/').to_string()) + } + + pub fn as_str(&self) -> &str { + &self.0 + } + + pub fn to_canonical(&self) -> CanonicalItemUrl { + tilde_http_path_to_canonical(self.as_str()) + } +} + +/// Map the router's tilde tail (e.g. `topic/a`, or empty for root) to a [`CanonicalItemUrl`]. +pub fn tilde_http_path_to_canonical(path_segment: &str) -> CanonicalItemUrl { + let p = path_segment.trim_start_matches('/'); + let raw = if p.starts_with("http://") || p.starts_with("https://") { + p.to_string() + } else if p.is_empty() { + "~/".to_string() + } else { + format!("~/{}", p) + }; + CanonicalItemUrl::parse(&raw).unwrap_or_else(|| CanonicalItemUrl::ontology_root()) +} + impl fmt::Display for CanonicalItemUrl { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { self.0.fmt(f) @@ -557,6 +631,44 @@ mod tests { fn canonical_parent_root_is_none() { let root = CanonicalItemUrl::parse("~/").unwrap(); assert!(root.parent().is_none()); + assert_eq!(root.as_str(), SLUG_TILDE_ONTOLOGY_ROOT); + assert_eq!(root, CanonicalItemUrl::ontology_root()); + } + + #[test] + fn tilde_ontology_root_unifies_forms() { + assert_eq!(canonicalize_item("~/"), SLUG_TILDE_ONTOLOGY_ROOT); + assert_eq!( + normalize_slug_ontology_storage_url("https://slug.social/~/"), + SLUG_TILDE_ONTOLOGY_ROOT.to_string() + ); + assert_eq!( + CanonicalItemUrl::parse("https://slug.social/~/") + .unwrap() + .as_str(), + SLUG_TILDE_ONTOLOGY_ROOT + ); + let legacy = CanonicalItemUrl("https://slug.social/~/".to_string()); + assert_eq!(legacy.normalized_storage().as_str(), SLUG_TILDE_ONTOLOGY_ROOT); + } + + #[test] + fn tilde_http_path_tail_maps_router_segment() { + assert_eq!( + TildeHttpPathTail::new("").to_canonical(), + CanonicalItemUrl::ontology_root() + ); + assert_eq!( + tilde_http_path_to_canonical("topic/x").as_str(), + "https://slug.social/~/topic/x" + ); + } + + #[test] + fn display_path_slug_ontology_root() { + let r = CanonicalItemUrl::ontology_root(); + assert_eq!(r.display_path(), "~/"); + assert_eq!(r.tilde_tail(), Some("")); } #[test]