Skip to main content

comindly_engine/
web.rs

1//! Web UI (`comindly ui --web`): one embedded page over a small JSON API. Locally it answers on
2//! localhost to the link's token; in server mode members sign in. Ledger writes go to the index root.
3
4use std::collections::{BTreeMap, HashMap};
5use std::sync::Arc;
6
7use anyhow::{Context, Result};
8use axum::extract::{Query, State};
9use axum::http::{header, StatusCode};
10use axum::response::{IntoResponse, Response};
11use axum::routing::{get, post};
12use axum::{Json, Router};
13use serde_json::Value;
14use tokio::sync::{OnceCell, RwLock};
15
16use crate::api;
17use crate::graph::{Node, Zoom};
18use crate::ledger::{Entry, Provenance, Record, RelationKind, Status};
19use crate::view::Data;
20
21mod answers;
22mod auth;
23mod flows;
24mod jobs;
25mod prompts;
26mod repos;
27mod settings;
28mod team;
29
30/// Everything tied to one loaded index; replaced as a whole when the index changes.
31struct Session {
32    data: Data,
33    entries: RwLock<Vec<Entry>>,
34    /// When `entries` was last read from the ledger.
35    entries_read: tokio::sync::Mutex<std::time::Instant>,
36    manual: RwLock<Vec<crate::conventions::Manual>>,
37    /// Loaded on first use: LLM summaries and flows, and the search model.
38    extras: OnceCell<Extras>,
39    search: OnceCell<Option<Search>>,
40    /// The index's tables, held open so LanceDB caches their metadata and indexes.
41    tables: Option<crate::index::Tables>,
42    /// Org maps of earlier index versions, by position in `/api/versions`.
43    past: tokio::sync::Mutex<HashMap<usize, api::OrgMap>>,
44    /// Where flows start, ranked once per loaded index.
45    flow_list: OnceCell<Vec<api::FlowRow>>,
46    /// The org's teams, shared with the app; they weigh notes from outside a team.
47    teams: crate::mcp::Teams,
48}
49
50#[derive(Default)]
51struct Extras {
52    enrichment: crate::search::Enrichment,
53    flows: HashMap<String, (String, Vec<String>)>,
54}
55
56struct Search {
57    embedder: Arc<crate::embed::Embedder>,
58    by_id: HashMap<String, crate::model::Symbol>,
59}
60
61impl Session {
62    async fn extras(&self) -> &Extras {
63        self.extras
64            .get_or_init(|| async {
65                let Some(uri) = graph_uri(self) else {
66                    return Extras::default();
67                };
68                let enrichment = crate::index::read_enrichment(&uri).await.ok().flatten();
69                let flows = crate::index::read_flows(&uri).await.ok().flatten();
70                Extras {
71                    enrichment: enrichment
72                        .unwrap_or_default()
73                        .into_iter()
74                        .map(|(id, s, q)| (id.render(), (s, q)))
75                        .collect(),
76                    flows: flows
77                        .unwrap_or_default()
78                        .into_iter()
79                        .map(|(id, n, q)| (id.render(), (n, q)))
80                        .collect(),
81                }
82            })
83            .await
84    }
85
86    async fn search(&self) -> Option<&Search> {
87        self.search
88            .get_or_init(|| async {
89                let model = match &self.data.root {
90                    Some(root) => crate::config::index_settings(root).await.embed_model,
91                    None => crate::embed::DEFAULT_MODEL.to_string(),
92                };
93                let embedder =
94                    tokio::task::spawn_blocking(move || crate::embed::Embedder::shared(&model))
95                        .await
96                        .ok()?
97                        .ok()?;
98                let by_id = self
99                    .data
100                    .symbols
101                    .iter()
102                    .map(|s| (s.id.render(), s.clone()))
103                    .collect();
104                Some(Search { embedder, by_id })
105            })
106            .await
107            .as_ref()
108    }
109}
110
111struct AppState {
112    current: RwLock<Arc<Session>>,
113    jobs: crate::jobs::Jobs,
114    watch: tokio::sync::Mutex<api::WatchResult>,
115    /// Members, sign-in and stored secrets, in server mode.
116    server: Option<Arc<crate::server::Server>>,
117    /// The loaded index's shared settings.
118    team: crate::mcp::Teams,
119    /// `config.toml` as last read, with the file's modification time.
120    /// Your preferences as last read, and when; `None` reads them again.
121    config: std::sync::Mutex<(Arc<crate::config::Config>, Option<std::time::Instant>)>,
122    /// What agents reach at `/mcp` on a server.
123    mcp: Option<crate::mcp::Shared>,
124    mcp_generation: Arc<std::sync::atomic::AtomicU64>,
125}
126
127type Shared = Arc<AppState>;
128
129/// The session a request works on: the index loaded when it arrived.
130struct Cur(Arc<Session>);
131
132impl axum::extract::FromRequestParts<Shared> for Cur {
133    type Rejection = std::convert::Infallible;
134
135    async fn from_request_parts(
136        _: &mut axum::http::request::Parts,
137        app: &Shared,
138    ) -> std::result::Result<Self, Self::Rejection> {
139        Ok(Cur(app.current.read().await.clone()))
140    }
141}
142
143/// The server, in server mode.
144struct Srv(Option<Arc<crate::server::Server>>);
145
146impl axum::extract::FromRequestParts<Shared> for Srv {
147    type Rejection = std::convert::Infallible;
148
149    async fn from_request_parts(
150        _: &mut axum::http::request::Parts,
151        app: &Shared,
152    ) -> std::result::Result<Self, Self::Rejection> {
153        Ok(Srv(app.server.clone()))
154    }
155}
156
157impl Session {
158    /// Ledger entries, re-read when a few seconds old: agents and colleagues write records too.
159    async fn entries(&self) -> tokio::sync::RwLockReadGuard<'_, Vec<Entry>> {
160        // One request refreshes; the others read what is there without waiting on storage.
161        let due = {
162            let mut read = self.entries_read.lock().await;
163            let due = read.elapsed() > std::time::Duration::from_secs(15);
164            if due {
165                *read = std::time::Instant::now();
166            }
167            due
168        };
169        if let (true, Some(root)) = (due, self.data.root.clone()) {
170            let opened =
171                tokio::task::spawn_blocking(move || crate::ledger::Ledger::open(&root)).await;
172            if let Ok(Ok(ledger)) = opened {
173                if let Ok(records) = ledger.all().await {
174                    *self.entries.write().await = self.derive(&records);
175                }
176            }
177        }
178        self.entries.read().await
179    }
180
181    /// Status and trust of every record, with notes from outside a team weighed.
182    fn derive(&self, records: &[Record]) -> Vec<Entry> {
183        let mut entries = crate::ledger::derive(
184            records,
185            &self.data.symbols,
186            &crate::config::local_verifier(),
187        );
188        let teams = self.teams.read().unwrap_or_else(|e| e.into_inner());
189        crate::ledger::weigh_teams(&mut entries, records, &teams);
190        entries
191    }
192
193    async fn open(mut data: Data, fresh: std::time::Duration, teams: crate::mcp::Teams) -> Session {
194        let entries = std::mem::take(&mut data.entries);
195        let manual = std::mem::take(&mut data.manual);
196        let tables = match data.root.as_ref() {
197            Some(r) => {
198                let uri = format!("{}/_graph", r.trim_end_matches('/'));
199                crate::index::Tables::connect(&uri, fresh).await.ok()
200            }
201            None => None,
202        };
203        Session {
204            data,
205            entries: RwLock::new(entries),
206            // Read again on first use, so the teams weigh what the index loaded.
207            entries_read: tokio::sync::Mutex::new(
208                std::time::Instant::now()
209                    .checked_sub(std::time::Duration::from_secs(60))
210                    .unwrap_or_else(std::time::Instant::now),
211            ),
212            manual: RwLock::new(manual),
213            extras: OnceCell::new(),
214            search: OnceCell::new(),
215            tables,
216            past: Default::default(),
217            teams,
218            flow_list: OnceCell::new(),
219        }
220    }
221}
222
223impl AppState {
224    /// `config.toml`, read again only when the file changed.
225    /// Your preferences, read again every few seconds: the CLI may change them too.
226    fn config(&self) -> Arc<crate::config::Config> {
227        let mut c = self.config.lock().unwrap_or_else(|e| e.into_inner());
228        if c.1
229            .is_none_or(|t| t.elapsed() > std::time::Duration::from_secs(5))
230        {
231            *c = (
232                Arc::new(crate::config::Config::load()),
233                Some(std::time::Instant::now()),
234            );
235        }
236        c.0.clone()
237    }
238
239    /// After a change here: read the preferences again on next use.
240    fn config_changed(&self) {
241        self.config.lock().unwrap_or_else(|e| e.into_inner()).1 = None;
242    }
243
244    fn team(&self) -> crate::team::TeamSettings {
245        self.team.read().unwrap_or_else(|e| e.into_inner()).clone()
246    }
247
248    fn set_team(&self, team: crate::team::TeamSettings) {
249        *self.team.write().unwrap_or_else(|e| e.into_inner()) = team;
250    }
251
252    /// The settings the loaded index runs with here.
253    fn settings(&self) -> crate::context::Settings {
254        crate::context::Settings::resolve(&self.team(), crate::config::env)
255    }
256
257    /// The repositories this app indexes: the server's, else this machine's in `config.toml`.
258    fn repos(&self) -> Vec<crate::config::RepoEntry> {
259        match &self.server {
260            Some(s) => s.settings.repos(),
261            None => self.config().repos.clone(),
262        }
263    }
264
265    fn set_repos(&self, by: Option<&str>, list: &[crate::config::RepoEntry]) -> Result<()> {
266        match &self.server {
267            Some(s) => s.settings.set_repos(by.unwrap_or("admin"), list),
268            None => crate::config::set_repos(list).map(|()| self.config_changed()),
269        }
270    }
271
272    /// Load the index at `root` and make it the one every request sees.
273    async fn reload(&self, root: &str) -> Result<()> {
274        let owned = root.to_string();
275        let data = tokio::task::spawn_blocking(move || {
276            Data::load_or_empty(&owned, &crate::config::local_verifier())
277        })
278        .await?;
279        let fresh = self.config().fresh();
280        let team = crate::team::load(root).await.unwrap_or_default();
281        let repos: Vec<String> = data.graph.repos().into_iter().map(|(r, _)| r).collect();
282        let team = self.backfill_teams(root, team, &repos).await;
283        self.set_team(team);
284        *self.current.write().await = Arc::new(Session::open(data, fresh, self.team.clone()).await);
285        self.reload_mcp(root);
286        Ok(())
287    }
288
289    /// On a server whose teams were never set up: one team named after the org, holding every
290    /// indexed repository and every member and invitation.
291    async fn backfill_teams(
292        &self,
293        root: &str,
294        stored: crate::team::Stored,
295        repos: &[String],
296    ) -> crate::team::TeamSettings {
297        let Some(server) = self.server.as_ref() else {
298            return stored.settings;
299        };
300        let mut members: Vec<String> = server
301            .accounts
302            .members()
303            .unwrap_or_default()
304            .into_iter()
305            .map(|m| m.email)
306            .collect();
307        members.extend(
308            server
309                .accounts
310                .invites()
311                .unwrap_or_default()
312                .into_iter()
313                .map(|i| i.email),
314        );
315        let Some(next) = stored.settings.backfill(repos, &members) else {
316            return stored.settings;
317        };
318        match crate::team::save_as(root, &next, stored.version, "comindly upgrade").await {
319            Ok(_) => {
320                let t = &next.team_list()[0];
321                tracing::info!(
322                    "teams backfilled: {} with {} repositories and {} members",
323                    t.name,
324                    t.repos.len(),
325                    t.members.len()
326                );
327                next
328            }
329            Err(e) => {
330                tracing::warn!("teams not backfilled: {e:#}");
331                crate::team::load(root)
332                    .await
333                    .map(|t| t.settings)
334                    .unwrap_or(stored.settings)
335            }
336        }
337    }
338
339    /// Load the index at `root` for agents in the background, keeping the previous one until then.
340    fn reload_mcp(&self, root: &str) {
341        let Some(mcp) = self.mcp.clone() else {
342            return;
343        };
344        let uri = format!("{}/_graph", root.trim_end_matches('/'));
345        let generation = self
346            .mcp_generation
347            .fetch_add(1, std::sync::atomic::Ordering::SeqCst)
348            + 1;
349        let latest = self.mcp_generation.clone();
350        let (fresh, markdown) = (self.config().fresh(), self.settings().format != "json");
351        let teams = self.team.clone();
352        tokio::spawn(async move {
353            match crate::mcp::load(&uri, markdown, fresh).await {
354                // A slower, older load never replaces a newer one.
355                Ok(mut server)
356                    if latest.load(std::sync::atomic::Ordering::SeqCst) == generation =>
357                {
358                    server.teams = teams;
359                    if let Ok(mut m) = mcp.write() {
360                        *m = Some(server);
361                    }
362                }
363                Ok(_) => {}
364                Err(e) => {
365                    crate::ui::warn(&format!("agents cannot use {uri} yet: {}", error_text(&e)))
366                }
367            }
368        });
369    }
370}
371
372/// Who the UI lets in: whoever holds the local link's token, or signed-in members of a server.
373pub enum Access {
374    Local(String),
375    Server(Arc<crate::server::Server>),
376}
377
378/// Serve the UI on `listener` until the process ends.
379pub fn serve(data: Data, listener: std::net::TcpListener, access: Access) -> Result<()> {
380    let rt = crate::rt::shared();
381    let root = data.root.clone();
382    let server = match &access {
383        Access::Server(s) => Some(s.clone()),
384        Access::Local(_) => None,
385    };
386    let cfg = Arc::new(crate::config::Config::load());
387    let team: crate::mcp::Teams = Arc::new(std::sync::RwLock::new(match &root {
388        Some(r) => rt
389            .block_on(crate::team::load(r))
390            .map(|t| t.settings)
391            .unwrap_or_default(),
392        None => Default::default(),
393    }));
394    let state = Arc::new(AppState {
395        team: team.clone(),
396        current: RwLock::new(Arc::new(rt.block_on(Session::open(
397            data,
398            cfg.fresh(),
399            team,
400        )))),
401        config: std::sync::Mutex::new((cfg, Some(std::time::Instant::now()))),
402        jobs: crate::jobs::Jobs::new(
403            match &server {
404                Some(s) => s.jobs.clone(),
405                None => Arc::new(crate::jobs::MemoryJobs::default()),
406            },
407            Arc::new(crate::ui::Terminal::new()),
408        ),
409        watch: Default::default(),
410        mcp: Some(Default::default()),
411        server,
412        mcp_generation: Default::default(),
413    });
414    if let Some(root) = root {
415        let _guard = rt.enter();
416        state.reload_mcp(&root);
417        let s = state.clone();
418        rt.block_on(async move {
419            let stored = crate::team::load(&root).await.unwrap_or_default();
420            let repos: Vec<String> = s
421                .current
422                .read()
423                .await
424                .data
425                .graph
426                .repos()
427                .into_iter()
428                .map(|(r, _)| r)
429                .collect();
430            let team = s.backfill_teams(&root, stored, &repos).await;
431            s.set_team(team);
432        });
433    }
434    rt.spawn(repos::watch(state.clone()));
435    if state.server.is_some() {
436        rt.spawn(repos::carry_on(state.clone()));
437    }
438    if let Some(s) = state.server.clone() {
439        rt.spawn(async move {
440            loop {
441                tokio::time::sleep(std::time::Duration::from_secs(6 * 3600)).await;
442                let s = s.clone();
443                let _ = tokio::task::spawn_blocking(move || s.accounts.tidy()).await;
444            }
445        });
446    }
447    let app = Router::new()
448        .route("/api/v1/overview", get(overview))
449        .route("/api/v1/orgmap", get(orgmap))
450        .route("/api/v1/versions", get(versions))
451        .route("/api/v1/contracts", get(contracts))
452        .route("/api/v1/ledger", get(ledger))
453        .route(
454            "/api/v1/view",
455            get(view).layer(tower_http::compression::CompressionLayer::new()),
456        )
457        .route(
458            "/api/v1/conventions",
459            get(conventions).post(change_convention),
460        )
461        .route("/api/v1/find", get(find))
462        .route("/api/v1/node", get(node))
463        .route("/api/v1/search", get(search))
464        .route("/api/v1/context", get(context))
465        .route("/api/v1/agent", get(agent_view))
466        .route("/api/v1/packages", get(packages))
467        .route("/api/v1/flows", get(flows::list))
468        .route("/api/v1/flow", get(flows::one))
469        .route("/api/v1/source", get(flows::source))
470        .route("/api/v1/setup", get(setup))
471        .route("/api/v1/review", post(review))
472        .route("/api/v1/erase", post(erase))
473        .route("/api/v1/remember", post(remember))
474        .route("/api/v1/settings", get(settings::get).post(settings::save))
475        .route("/api/v1/settings/test", post(settings::test))
476        .route(
477            "/api/v1/logging",
478            get(settings::logging).post(settings::set_logging),
479        )
480        .route("/api/v1/repos", get(repos::list).post(repos::change))
481        .route("/api/v1/repos/scan", post(repos::scan))
482        .route("/api/v1/repos/remote/list", post(repos::remote_list))
483        .route("/api/v1/repos/remote/add", post(repos::remote_add))
484        .route("/api/v1/index", get(repos::job).post(repos::start))
485        .route("/api/v1/index/cancel", post(repos::cancel))
486        .route("/api/v1/index/watch", get(repos::watch_state))
487        .route("/api/v1/answer/find", get(answers::find))
488        .route("/api/v1/answer/search", get(answers::search))
489        .route("/api/v1/answer/why", get(answers::why))
490        .route("/api/v1/answer/ledger", get(answers::ledger))
491        .route("/api/v1/answer/flow", get(answers::flow))
492        .route("/api/v1/answer/contracts", get(answers::contracts))
493        .route("/api/v1/answer/explore", get(answers::explore))
494        .route("/api/v1/answer/stats", get(answers::stats))
495        .route("/api/v1/answer/hook", get(answers::hook))
496        .route("/api/v1/answer/guide", get(answers::guide))
497        .route("/api/v1/answer/packages", get(answers::packages))
498        .route("/api/v1/answer/preflight", post(answers::preflight))
499        .route("/api/v1/answer/conventions", get(answers::conventions))
500        .route("/api/v1/jobs", get(jobs::list))
501        .route("/api/v1/jobs/{id}", get(jobs::one))
502        .route("/api/v1/jobs/{id}/events", get(jobs::events))
503        .route("/api/v1/jobs/{id}/cancel", post(jobs::cancel))
504        .route("/api/v1/team", get(team::get).post(team::save))
505        .route("/api/v1/team/key", post(team::key))
506        .route("/api/v1/prompts", get(prompts::get).post(prompts::change))
507        .route("/api/v1/prompts/try", post(prompts::try_draft))
508        .route("/api/v1/join", post(team::join))
509        .route("/api/v1/team/create", post(team::create))
510        .route("/api/v1/teams", post(team::save_teams))
511        .route("/api/v1/repos/teams", post(team::label_repo))
512        .route("/api/v1/me/teams", post(team::my_teams))
513        .route("/api/v1/auth/me", get(auth::me))
514        .route("/health", get(health))
515        .route("/ready", get(ready))
516        .fallback(get(asset));
517    let local = matches!(access, Access::Local(_));
518    let app = match access {
519        Access::Local(token) => app
520            .merge({
521                let shared = state.mcp.clone().unwrap_or_default();
522                Router::new()
523                    .nest_service(
524                        "/mcp",
525                        crate::mcp::http(
526                            shared.clone(),
527                            vec!["127.0.0.1".into(), "localhost".into()],
528                        ),
529                    )
530                    .layer(axum::middleware::from_fn_with_state(shared, mcp_ready))
531            })
532            .layer(axum::middleware::from_fn_with_state(Arc::new(token), guard))
533            .layer(axum::middleware::from_fn(local_only)),
534        Access::Server(server) => app
535            .route("/api/v1/auth/link", post(auth::request_link))
536            .route("/api/v1/auth/redeem", post(auth::redeem))
537            .route("/api/v1/auth/code", post(auth::sign_in_code))
538            .route("/auth/oidc/start", get(auth::oidc_start))
539            .route(crate::oidc::CALLBACK, get(auth::oidc_callback))
540            .route("/api/v1/auth/reset-code", post(auth::reset_own_code))
541            .route("/api/v1/auth/signout", post(auth::sign_out))
542            .route(auth::SELF_REVOKE, post(auth::revoke_self))
543            .route("/api/v1/auth/device/start", post(auth::device_start))
544            .route("/api/v1/auth/device/token", post(auth::device_token))
545            .route("/api/v1/auth/device", get(auth::device_info))
546            .route("/api/v1/auth/device/approve", post(auth::device_approve))
547            .route("/api/v1/members", get(auth::members))
548            .route("/api/v1/members/invite", post(auth::invite))
549            .route("/api/v1/members/reset", post(auth::reset_code))
550            .route("/api/v1/members/role", post(auth::set_role))
551            .route("/api/v1/members/remove", post(auth::remove))
552            .route("/api/v1/members/revoke", post(auth::revoke_invite))
553            .route("/api/v1/tokens", get(auth::tokens).post(auth::create_token))
554            .route("/api/v1/tokens/revoke", post(auth::revoke_token))
555            .route("/api/v1/secrets", get(auth::secrets).post(auth::set_secret))
556            .route("/api/v1/audit", get(auth::audit))
557            .merge({
558                let shared = state.mcp.clone().unwrap_or_default();
559                Router::new()
560                    .nest_service(
561                        "/mcp",
562                        crate::mcp::http(shared.clone(), auth::hosts(&server.config)),
563                    )
564                    .layer(axum::middleware::from_fn_with_state(shared, mcp_ready))
565            })
566            .layer(axum::middleware::from_fn_with_state(server, auth::guard)),
567    }
568    .with_state(state.clone())
569    .layer(axum::middleware::from_fn_with_state(local, traced));
570    let stopping = state;
571    listener.set_nonblocking(true)?;
572    rt.block_on(async move {
573        let listener = tokio::net::TcpListener::from_std(listener)?;
574        axum::serve(
575            listener,
576            app.into_make_service_with_connect_info::<std::net::SocketAddr>(),
577        )
578        .with_graceful_shutdown(shutdown(stopping))
579        .await
580        .context("serve")
581    })
582}
583
584/// On Ctrl-C or SIGTERM: stop taking requests and let a running job stop at its next checkpoint.
585async fn shutdown(app: Shared) {
586    let term = async {
587        #[cfg(unix)]
588        if let Ok(mut s) = tokio::signal::unix::signal(tokio::signal::unix::SignalKind::terminate())
589        {
590            s.recv().await;
591            return;
592        }
593        std::future::pending::<()>().await
594    };
595    tokio::select! {
596        _ = tokio::signal::ctrl_c() => {}
597        _ = term => {}
598    }
599    crate::ui::note("stopping");
600    if let Some(job) = app.jobs.shutdown() {
601        job.cancel.cancel();
602        let _ = tokio::time::timeout(std::time::Duration::from_secs(20), job.wait()).await;
603    }
604    // Open event streams and agent sessions do not hold the process.
605    tokio::spawn(async {
606        tokio::time::sleep(std::time::Duration::from_secs(5)).await;
607        crate::telemetry::flush();
608        std::process::exit(0);
609    });
610}
611
612/// The id that ties a request's log lines, the job it starts and its trace together.
613#[derive(Clone)]
614pub(crate) struct RequestId(pub String);
615
616/// A caller's `X-Request-Id` is kept when it is a short token of letters, digits, `-`, `_`, `.`.
617fn safe_request_id(id: &str) -> bool {
618    (1..=64).contains(&id.len())
619        && id
620            .bytes()
621            .all(|b| b.is_ascii_alphanumeric() || matches!(b, b'-' | b'_' | b'.'))
622}
623
624/// Gives each request an id and a span, and logs one access line for it: method, path without
625/// the query, status, time and the member's email. Locally, and for health checks, at debug.
626async fn traced(
627    State(local): State<bool>,
628    mut req: axum::extract::Request,
629    next: axum::middleware::Next,
630) -> axum::response::Response {
631    use tracing::Instrument;
632    let id = req
633        .headers()
634        .get("x-request-id")
635        .and_then(|v| v.to_str().ok())
636        .filter(|v| safe_request_id(v))
637        .map(str::to_string)
638        .unwrap_or_else(new_token);
639    req.extensions_mut().insert(RequestId(id.clone()));
640    let method = req.method().clone();
641    let path = req.uri().path().to_string();
642    let route = req
643        .extensions()
644        .get::<axum::extract::MatchedPath>()
645        .map_or("/*", |m| m.as_str())
646        .to_string();
647    let span = tracing::info_span!(
648        "request",
649        otel.name = %format!("{method} {route}"),
650        otel.kind = "server",
651        otel.status_code = tracing::field::Empty,
652        request_id = %id,
653        http.request.method = %method,
654        http.route = %route,
655        url.path = %path,
656        http.response.status_code = tracing::field::Empty,
657    );
658    let start = std::time::Instant::now();
659    let mut res = next.run(req).instrument(span.clone()).await;
660    let status = res.status().as_u16();
661    span.record("http.response.status_code", status);
662    if status >= 500 {
663        span.record("otel.status_code", "ERROR");
664    }
665    let ms = start.elapsed().as_millis() as u64;
666    let email = res
667        .extensions()
668        .get::<crate::server::Who>()
669        .map(|w| w.email.clone());
670    span.in_scope(|| {
671        let quiet = local || path == "/health" || path == "/ready";
672        if !crate::telemetry::logs("access") {
673            return;
674        }
675        macro_rules! access {
676            ($l:expr) => {
677                tracing::event!(
678                    $l,
679                    kind = "access",
680                    method = %method,
681                    path = %path,
682                    status,
683                    duration_ms = ms,
684                    email = email.as_deref(),
685                    "{method} {path} {status} {ms} ms"
686                )
687            };
688        }
689        if quiet {
690            access!(tracing::Level::DEBUG)
691        } else {
692            access!(tracing::Level::INFO)
693        }
694    });
695    if let Ok(v) = header::HeaderValue::from_str(&id) {
696        res.headers_mut().insert("x-request-id", v);
697    }
698    res
699}
700
701/// The one error shape, `{"error": {"code", "message"}}`, with a status that means what it says.
702pub(crate) fn error_body(status: StatusCode, message: impl Into<String>) -> Response {
703    failure(status, message).into_response()
704}
705
706/// A failed request, answered as [`api::ErrorBody`].
707pub(crate) struct Failure(StatusCode, api::ErrorDetail);
708
709impl IntoResponse for Failure {
710    fn into_response(self) -> Response {
711        (self.0, Json(api::ErrorBody { error: self.1 })).into_response()
712    }
713}
714
715pub(crate) fn failure(status: StatusCode, message: impl Into<String>) -> Failure {
716    let code = match status {
717        StatusCode::BAD_REQUEST => "bad_request",
718        StatusCode::UNAUTHORIZED => "unauthorized",
719        StatusCode::FORBIDDEN => "forbidden",
720        StatusCode::NOT_FOUND => "not_found",
721        StatusCode::CONFLICT => "conflict",
722        StatusCode::GONE => "gone",
723        StatusCode::SERVICE_UNAVAILABLE => "unavailable",
724        _ => "error",
725    };
726    let error = api::ErrorDetail {
727        code: code.into(),
728        message: message.into(),
729        host: None,
730        username: None,
731    };
732    Failure(status, error)
733}
734
735/// A handler's answer: the typed body, or the error shape.
736pub(crate) type Reply<T> = std::result::Result<Json<T>, Failure>;
737
738/// A failed request's 400 with the error explained.
739pub(crate) fn bad(e: anyhow::Error) -> Failure {
740    failure(StatusCode::BAD_REQUEST, error_text(&e))
741}
742
743/// For load balancers and orchestrators: answers while the process serves requests.
744async fn health() -> Json<api::Health> {
745    Json(api::Health {
746        status: "ok".into(),
747        version: env!("CARGO_PKG_VERSION").into(),
748    })
749}
750
751/// For orchestrators: ready once an index is loaded and, on a server, the stores answer.
752async fn ready(State(app): State<Shared>) -> Response {
753    let loaded = app.current.read().await.data.root.is_some();
754    let stores = match app.server.clone() {
755        Some(s) => tokio::task::spawn_blocking(move || s.accounts.members().is_ok())
756            .await
757            .unwrap_or(false),
758        None => true,
759    };
760    let status = if loaded && stores {
761        StatusCode::OK
762    } else {
763        StatusCode::SERVICE_UNAVAILABLE
764    };
765    let ready = api::Ready {
766        ready: status == StatusCode::OK,
767        index: loaded,
768        stores,
769    };
770    (status, Json(ready)).into_response()
771}
772
773/// Agents get 503 with a reason until there is an index to answer from.
774async fn mcp_ready(
775    State(shared): State<crate::mcp::Shared>,
776    req: axum::extract::Request,
777    next: axum::middleware::Next,
778) -> axum::response::Response {
779    if shared.read().map(|s| s.is_none()).unwrap_or(true) {
780        let mut res = error_body(
781            StatusCode::SERVICE_UNAVAILABLE,
782            "no index yet: an admin indexes repositories first",
783        );
784        res.headers_mut()
785            .insert(header::RETRY_AFTER, header::HeaderValue::from_static("60"));
786        return res;
787    }
788    next.run(req).await
789}
790
791/// A random token for one UI session.
792pub fn new_token() -> String {
793    uuid::Uuid::new_v4().simple().to_string()
794}
795
796/// `?token=` on a page sets the session cookie and redirects to the clean URL; `/api/` requires it.
797async fn guard(
798    State(token): State<Arc<String>>,
799    req: axum::extract::Request,
800    next: axum::middleware::Next,
801) -> axum::response::Response {
802    let query = req.uri().query().unwrap_or("");
803    if query.split('&').any(|kv| kv == format!("token={token}")) {
804        let rest: Vec<&str> = query
805            .split('&')
806            .filter(|kv| !kv.starts_with("token="))
807            .collect();
808        let path = req.uri().path();
809        let to = if rest.is_empty() {
810            path.to_string()
811        } else {
812            format!("{path}?{}", rest.join("&"))
813        };
814        let cookie =
815            format!("comindly_token={token}; Path=/; HttpOnly; SameSite=Strict; Max-Age=31536000");
816        return (
817            StatusCode::SEE_OTHER,
818            [(header::LOCATION, to), (header::SET_COOKIE, cookie)],
819        )
820            .into_response();
821    }
822    // `/api/v1/auth/me` only says "local", so the page can always tell where it is.
823    let path = req.uri().path();
824    if (path.starts_with("/api/") && path != "/api/v1/auth/me") || path.starts_with("/mcp") {
825        let want = format!("comindly_token={token}");
826        let bearer = format!("Bearer {token}");
827        let ok = req
828            .headers()
829            .get_all(header::COOKIE)
830            .iter()
831            .filter_map(|v| v.to_str().ok())
832            .flat_map(|v| v.split(';'))
833            .any(|c| c.trim() == want)
834            || req
835                .headers()
836                .get(header::AUTHORIZATION)
837                .is_some_and(|v| v.as_bytes() == bearer.as_bytes());
838        if !ok {
839            let msg = "open comindly with `comindly app`, or ask it with the `comindly` command";
840            return error_body(StatusCode::FORBIDDEN, msg).into_response();
841        }
842    }
843    next.run(req).await
844}
845
846/// Reject requests whose `Host` is not loopback, so a DNS-rebinding page cannot read the API.
847async fn local_only(
848    req: axum::extract::Request,
849    next: axum::middleware::Next,
850) -> axum::response::Response {
851    let host = req
852        .headers()
853        .get(header::HOST)
854        .and_then(|h| h.to_str().ok())
855        .unwrap_or("");
856    let name = host.rsplit_once(':').map_or(host, |(h, _)| h);
857    if matches!(name, "127.0.0.1" | "localhost" | "[::1]") {
858        next.run(req).await
859    } else {
860        (
861            StatusCode::FORBIDDEN,
862            "comindly web UI answers on localhost only",
863        )
864            .into_response()
865    }
866}
867
868/// The embedded UI: a file by path, or `index.html` for client-side routes.
869async fn asset(uri: axum::http::Uri) -> impl IntoResponse {
870    let path = uri.path().trim_start_matches('/');
871    let find = |p: &str| {
872        comindly_ui::ASSETS
873            .iter()
874            .find(|(n, _)| *n == p)
875            .map(|(_, b)| *b)
876    };
877    let (name, body) = match find(path) {
878        Some(b) if !path.is_empty() => (path, b),
879        _ if path.starts_with("api/") => {
880            return error_body(StatusCode::NOT_FOUND, format!("no such endpoint: /{path}"))
881                .into_response();
882        }
883        _ if path.starts_with("assets/") => {
884            return (
885                StatusCode::NOT_FOUND,
886                [(header::CONTENT_TYPE, "text/plain")],
887                &b"not found"[..],
888            )
889                .into_response();
890        }
891        _ => ("index.html", find("index.html").unwrap_or_default()),
892    };
893    let mime = match name.rsplit('.').next() {
894        Some("html") => "text/html; charset=utf-8",
895        Some("js") => "text/javascript",
896        Some("css") => "text/css",
897        Some("svg") => "image/svg+xml",
898        Some("png") => "image/png",
899        Some("json") => "application/json",
900        Some("woff2") => "font/woff2",
901        _ => "application/octet-stream",
902    };
903    // Bundled assets carry a content hash in their name; the page itself must stay fresh.
904    let cache = if name.starts_with("assets/") {
905        "public, max-age=31536000, immutable"
906    } else {
907        "no-cache"
908    };
909    (
910        StatusCode::OK,
911        [(header::CONTENT_TYPE, mime), (header::CACHE_CONTROL, cache)],
912        body,
913    )
914        .into_response()
915}
916
917async fn overview(who: Member, Cur(s): Cur) -> Json<api::Overview> {
918    let d = &s.data;
919    let entries = s.entries().await;
920    let mut status: BTreeMap<String, usize> = BTreeMap::new();
921    for e in entries.iter() {
922        *status
923            .entry(format!("{:?}", e.status).to_lowercase())
924            .or_default() += 1;
925    }
926    let linked = d
927        .contracts
928        .iter()
929        .filter(|c| !c.providers.is_empty() && !c.consumers.is_empty())
930        .count();
931    let cross = d.edges.iter().filter(|e| e.cross_repo).count();
932    let skew = d
933        .deps
934        .iter()
935        .filter(|x| x.skewed())
936        .map(|x| api::Skew {
937            package: x.name.clone(),
938            publisher: x.publisher.clone(),
939            published: x.published.clone(),
940            consumer: x.consumer.clone(),
941            locked: x.locked.clone(),
942        })
943        .collect();
944    Json(api::Overview {
945        repos: d
946            .graph
947            .repos()
948            .into_iter()
949            .map(|(repo, symbols)| api::RepoSymbols { repo, symbols })
950            .collect(),
951        symbols: d.symbols.len(),
952        edges: d.edges.len(),
953        cross_repo_edges: cross,
954        contracts: d.contracts.len(),
955        linked_contracts: linked,
956        ledger: status,
957        skew,
958        // Viewers read only.
959        writable: d.root.is_some()
960            && who
961                .as_ref()
962                .is_none_or(|w| w.role.at_least(crate::server::Role::Member)),
963        root: d.root.clone(),
964        problem: d.problem.clone(),
965    })
966}
967
968/// An error for the UI: short, with S3 replies explained and credentials removed.
969pub(crate) fn error_text(e: &anyhow::Error) -> String {
970    crate::storage::explain(&format!("{e:#}"))
971}
972
973fn graph_uri(s: &Session) -> Option<String> {
974    s.data
975        .root
976        .as_ref()
977        .map(|r| format!("{}/_graph", r.trim_end_matches('/')))
978}
979
980/// When each index version was written, oldest first.
981async fn versions(Cur(s): Cur) -> Json<Vec<String>> {
982    let list = match &s.tables {
983        Some(t) => t.versions().await.unwrap_or_default(),
984        None => Vec::new(),
985    };
986    Json(list.into_iter().map(|(_, _, t)| t).collect())
987}
988
989async fn orgmap(Cur(s): Cur, Query(q): Query<api::AtQuery>) -> Reply<api::OrgMap> {
990    let d = &s.data;
991    let Some(i) = q.at else {
992        return Ok(Json(org(&d.graph, &d.symbols, &d.edges, &d.contracts)));
993    };
994    let past = async {
995        if let Some(v) = s.past.lock().await.get(&i) {
996            return anyhow::Ok(v.clone());
997        }
998        let tables = s
999            .tables
1000            .as_ref()
1001            .context("read-only UI has no index root")?;
1002        let list = tables.versions().await?;
1003        let (sv, ev, _) = *list.get(i).context("no such version")?;
1004        let (symbols, edges) = tables.graph_at((sv, ev)).await?;
1005        let graph = crate::graph::CodeGraph::build(&symbols, &edges);
1006        let contracts = graph.contracts(None, false);
1007        let v = org(&graph, &symbols, &edges, &contracts);
1008        s.past.lock().await.insert(i, v.clone());
1009        anyhow::Ok(v)
1010    };
1011    past.await.map(Json).map_err(bad)
1012}
1013
1014/// Repos as nodes; edges aggregate cross-repo code dependencies and contract links.
1015fn org(
1016    graph: &crate::graph::CodeGraph,
1017    symbols: &[crate::model::Symbol],
1018    edges: &[crate::model::Edge],
1019    contracts: &[crate::graph::ContractView],
1020) -> api::OrgMap {
1021    let repo_of: std::collections::HashMap<String, &str> = symbols
1022        .iter()
1023        .map(|x| (x.id.render(), x.repo.0.as_str()))
1024        .collect();
1025    // Per (user, provider, kind): how many links, and the contracts they go through.
1026    let mut links: BTreeMap<(String, String, &str), (usize, std::collections::BTreeSet<String>)> =
1027        BTreeMap::new();
1028    for e in edges.iter().filter(|e| e.cross_repo) {
1029        if let (Some(a), Some(b)) = (repo_of.get(&e.src.render()), repo_of.get(&e.dst.render())) {
1030            if *a != crate::resolve::CONTRACTS && *b != crate::resolve::CONTRACTS && a != b {
1031                links
1032                    .entry((a.to_string(), b.to_string(), "code"))
1033                    .or_default()
1034                    .0 += 1;
1035            }
1036        }
1037    }
1038    let real = |n: &&Node| n.repo != crate::resolve::CONTRACTS;
1039    // A queue subscribed to a topic is a contract consuming a contract: its own consumers are
1040    // the topic's consumers too.
1041    let by_id: std::collections::HashMap<&str, &crate::graph::ContractView> = contracts
1042        .iter()
1043        .map(|c| (c.contract.id.as_str(), c))
1044        .collect();
1045    for c in contracts {
1046        let mut consumers: Vec<&Node> = c.consumers.iter().filter(real).collect();
1047        for via in c.consumers.iter().filter(|n| !real(n)) {
1048            if let Some(q) = by_id.get(via.id.as_str()) {
1049                consumers.extend(q.consumers.iter().filter(real));
1050            }
1051        }
1052        // Tables and buckets are data both sides share, not a call from one to the other.
1053        let kind = if c.contract.name.starts_with("table:") || c.contract.name.starts_with("s3:") {
1054            "data"
1055        } else {
1056            "contract"
1057        };
1058        for u in consumers {
1059            for p in c.providers.iter().filter(real).filter(|p| p.repo != u.repo) {
1060                let link = links
1061                    .entry((u.repo.clone(), p.repo.clone(), kind))
1062                    .or_default();
1063                link.0 += 1;
1064                link.1.insert(c.contract.name.clone());
1065            }
1066        }
1067    }
1068    let nodes = graph
1069        .repos()
1070        .into_iter()
1071        .map(|(r, n)| api::OrgNode {
1072            id: r.clone(),
1073            name: format!("{r} ({n})"),
1074            repo: r,
1075            location: String::new(),
1076        })
1077        .collect();
1078    let edges = links
1079        .into_iter()
1080        .map(|((src, dst, kind), (weight, via))| api::OrgEdge {
1081            src,
1082            dst,
1083            kind: kind.into(),
1084            weight,
1085            via: via.into_iter().collect(),
1086        })
1087        .collect();
1088    api::OrgMap { nodes, edges }
1089}
1090
1091async fn contracts(Cur(s): Cur) -> Json<Vec<api::ContractView>> {
1092    Json(s.data.contracts.clone())
1093}
1094
1095async fn ledger(Cur(s): Cur) -> Json<Vec<Entry>> {
1096    let entries = s.entries().await;
1097    let mut v: Vec<&Entry> = entries.iter().collect();
1098    v.sort_by(|a, b| b.record.created.cmp(&a.record.created));
1099    Json(named(&s, &v))
1100}
1101
1102/// What the terminal UI shows, for `comindly ui` against this server.
1103/// The whole view a client rebuilds its data from, tagged with its hash: a client that already
1104/// holds that tag gets `304 Not Modified` instead of the graph again.
1105async fn view(Cur(s): Cur, headers: axum::http::HeaderMap) -> Response {
1106    let packages = match graph_uri(&s) {
1107        Some(u) => crate::index::read_packages(&u).await.unwrap_or_default(),
1108        None => Vec::new(),
1109    };
1110    let mut entries = s.entries().await.clone();
1111    let findings = crate::checks::run(&entries, &s.data.symbols, &s.data.edges, &packages);
1112    crate::checks::promote(&mut entries, &findings);
1113    let manual = s.manual.read().await.clone();
1114    let body = match serde_json::to_vec(&api::View {
1115        symbols: (&s.data.symbols[..]).into(),
1116        edges: (&s.data.edges[..]).into(),
1117        entries: entries.into(),
1118        conventions: (&s.data.conventions[..]).into(),
1119        manual: manual.into(),
1120        deps: (&s.data.deps[..]).into(),
1121        problem: s.data.problem.clone(),
1122    }) {
1123        Ok(b) => b,
1124        Err(e) => return failure(StatusCode::INTERNAL_SERVER_ERROR, e.to_string()).into_response(),
1125    };
1126    let tag = format!("\"{}\"", &blake3::hash(&body).to_hex()[..32]);
1127    if headers
1128        .get(header::IF_NONE_MATCH)
1129        .and_then(|v| v.to_str().ok())
1130        .is_some_and(|v| v.split(',').any(|t| t.trim() == tag))
1131    {
1132        return (StatusCode::NOT_MODIFIED, [(header::ETAG, tag)]).into_response();
1133    }
1134    (
1135        [
1136            (header::CONTENT_TYPE, "application/json".to_string()),
1137            (header::ETAG, tag),
1138        ],
1139        body,
1140    )
1141        .into_response()
1142}
1143
1144/// Entries with each anchor named as the graph shows it (`Class.method`).
1145fn named(s: &Session, entries: &[&Entry]) -> Vec<Entry> {
1146    let mut out: Vec<Entry> = entries.iter().map(|e| (*e).clone()).collect();
1147    for a in out.iter_mut().flat_map(|e| e.record.anchors.iter_mut()) {
1148        if let Some(i) = s.data.graph.lookup(&a.symbol) {
1149            a.name = s.data.graph.node(i).name;
1150        }
1151    }
1152    out
1153}
1154
1155async fn conventions(Cur(s): Cur, Query(q): Query<api::RepoQuery>) -> Json<api::Conventions> {
1156    let manual = s.manual.read().await;
1157    let mine = |r: &str| q.repo.as_deref().is_none_or(|q| r == q);
1158    let conventions = crate::conventions::apply(s.data.conventions.clone(), &manual)
1159        .into_iter()
1160        .filter(|c| mine(&c.repo))
1161        .map(|c| api::ShownConvention {
1162            id: c.id(),
1163            strength: c.strength().map(String::from),
1164            evidence: c.evidence(),
1165            few: c.few(),
1166            convention: c,
1167        })
1168        .collect();
1169    let hidden = manual
1170        .iter()
1171        .filter(|m| m.hidden && mine(&m.repo))
1172        .cloned()
1173        .collect();
1174    let repos = match graph_uri(&s) {
1175        Some(u) => crate::index::read_indexed_repos(&u)
1176            .await
1177            .unwrap_or_default(),
1178        None => Vec::new(),
1179    };
1180    let commit_urls = repos
1181        .into_iter()
1182        .filter_map(|r| {
1183            Some((
1184                r.name,
1185                crate::hosting::commit_link(r.remote.as_deref()?, "")?,
1186            ))
1187        })
1188        .collect();
1189    Json(api::Conventions {
1190        conventions,
1191        hidden,
1192        commit_urls,
1193    })
1194}
1195
1196async fn change_convention(
1197    who: Member,
1198    Cur(s): Cur,
1199    Json(b): Json<api::ConventionChange>,
1200) -> Reply<api::Done> {
1201    match apply_convention(&s, b, &identity(who.as_deref()).actor).await {
1202        Ok(msg) => Ok(Json(api::Done::new(msg))),
1203        Err(e) => Err(bad(e)),
1204    }
1205}
1206
1207async fn apply_convention(s: &Session, b: api::ConventionChange, actor: &str) -> Result<String> {
1208    use crate::conventions::{change, Change, Manual, Write, ORG};
1209    let root = s.data.root.as_deref().context("read-only UI")?;
1210    let mut manual = s.manual.write().await;
1211    let w = if b.action == "add" {
1212        let dimension = b.dimension.as_deref().unwrap_or("team");
1213        Write::Put(Manual::new(
1214            b.repo.as_deref().unwrap_or(ORG),
1215            dimension,
1216            &b.rule,
1217            actor,
1218        ))
1219    } else {
1220        let what = match b.action.as_str() {
1221            "edit" => Change::Edit(b.rule),
1222            "hide" => Change::Hide,
1223            "restore" => Change::Restore,
1224            other => anyhow::bail!("unknown action {other}"),
1225        };
1226        let current = crate::conventions::apply(s.data.conventions.clone(), &manual);
1227        change(&current, &manual, &b.id, what, actor)?
1228    };
1229    crate::conventions::Store::open(root)?.write(&w).await?;
1230    Ok(match w {
1231        Write::Put(m) => {
1232            let id = m.id.clone();
1233            manual.retain(|x| x.id != id);
1234            let verb = if m.hidden { "hid" } else { "saved" };
1235            manual.push(m);
1236            format!("{verb} {id}")
1237        }
1238        Write::Delete(id) => {
1239            manual.retain(|x| x.id != id);
1240            format!("removed {id}")
1241        }
1242    })
1243}
1244
1245async fn find(Cur(s): Cur, Query(q): Query<api::FindQuery>) -> Json<Vec<Node>> {
1246    Json(s.data.graph.find(&q.q, 40))
1247}
1248
1249async fn node(Cur(s): Cur, Query(q): Query<api::FocusQuery>) -> Reply<api::NodeDetail> {
1250    let g = &s.data.graph;
1251    let Some(idx) = g.lookup(&q.focus) else {
1252        return Err(failure(StatusCode::NOT_FOUND, "no such symbol"));
1253    };
1254    let z = g.zoom(idx);
1255    let ripple = g.ripple(idx, 4);
1256    let mut repos: BTreeMap<String, usize> = BTreeMap::new();
1257    for h in &ripple {
1258        *repos.entry(h.node.repo.clone()).or_default() += 1;
1259    }
1260    let mut ids = vec![q.focus.clone()];
1261    if let Some(f) = &z.focus {
1262        ids.push(f.id.clone());
1263        if let Some((_, scope)) = g.scope_of(&f.id) {
1264            ids.extend(scope);
1265        }
1266    }
1267    let extras = s.extras().await;
1268    let fid = z.focus.as_ref().map(|f| f.id.clone()).unwrap_or_default();
1269    let summary = extras.enrichment.get(&fid).map(|(s, _)| s.clone());
1270    let flow = extras.flows.get(&fid).map(|(n, q)| api::Narration {
1271        narration: n.clone(),
1272        questions: q.clone(),
1273    });
1274    let entries = s.entries().await;
1275    let about: Vec<&Entry> = crate::ledger::about(&entries, &ids);
1276    Ok(Json(api::NodeDetail {
1277        graph: neighbourhood(&z),
1278        zoom: z,
1279        ripple: api::Ripple {
1280            total: ripple.len(),
1281            repos,
1282        },
1283        ledger: named(&s, &about),
1284        summary,
1285        flow,
1286    }))
1287}
1288
1289/// Hybrid code search (BM25, vectors, centrality), as `comindly search` and the MCP tool.
1290async fn search(Cur(s): Cur, Query(q): Query<api::SearchQuery>) -> Reply<Vec<api::SearchHit>> {
1291    let run = async {
1292        let tables = s.tables.as_ref().context("no index root")?;
1293        let engine = s
1294            .search()
1295            .await
1296            .context("the embedding model could not be loaded")?;
1297        let extras = s.extras().await;
1298        let limit = if q.repo.is_some() { 60 } else { 20 };
1299        let mut hits = crate::search::hybrid(
1300            tables,
1301            &engine.by_id,
1302            &s.data.graph,
1303            &extras.enrichment,
1304            &engine.embedder,
1305            &q.q,
1306            limit,
1307        )
1308        .await
1309        .map_err(|e| match format!("{e:#}").contains("was not found") {
1310            true => {
1311                anyhow::anyhow!("this index has no search table: rebuild it without --no-embed")
1312            }
1313            false => e.context("hybrid search failed"),
1314        })?;
1315        if let Some(r) = &q.repo {
1316            hits.retain(|h| &h.repo == r);
1317            hits.truncate(20);
1318        }
1319        anyhow::Ok(
1320            hits.into_iter()
1321                .map(|h| api::SearchHit {
1322                    id: h.id,
1323                    name: h.name,
1324                    kind: h.kind,
1325                    repo: h.repo,
1326                    location: h.location,
1327                    signature: h.signature,
1328                    summary: h.summary,
1329                    dependents: h.deps,
1330                })
1331                .collect(),
1332        )
1333    };
1334    run.await.map(Json).map_err(bad)
1335}
1336
1337/// What a read-only MCP tool answers an agent, as markdown; plain text, not JSON.
1338async fn agent_view(
1339    State(app): State<Shared>,
1340    Cur(s): Cur,
1341    Query(q): Query<api::AgentQuery>,
1342) -> std::result::Result<String, Failure> {
1343    let args = match q.args.as_deref().filter(|a| !a.is_empty()) {
1344        Some(a) => serde_json::from_str(a).map_err(|e| bad(e.into()))?,
1345        None => serde_json::json!({}),
1346    };
1347    let slot = app.mcp.clone().unwrap_or_default();
1348    let loaded = slot.read().ok().and_then(|m| m.clone());
1349    let server = match loaded {
1350        Some(server) => server,
1351        None => {
1352            let root = s.data.root.clone().unwrap_or_default();
1353            let uri = format!("{}/_graph", root.trim_end_matches('/'));
1354            let mut server = crate::mcp::load(&uri, true, app.config().fresh())
1355                .await
1356                .map_err(|e| failure(StatusCode::SERVICE_UNAVAILABLE, error_text(&e)))?;
1357            server.teams = app.team.clone();
1358            if let Ok(mut m) = slot.write() {
1359                m.get_or_insert_with(|| server.clone());
1360            }
1361            server
1362        }
1363    };
1364    server.as_agent(&q.tool, args).await.map_err(bad)
1365}
1366
1367/// The context pack for a symbol as markdown, ready to paste into an agent; plain text, not JSON.
1368async fn context(Cur(s): Cur, Query(q): Query<api::FocusQuery>) -> impl IntoResponse {
1369    let g = &s.data.graph;
1370    let Some(idx) = g.lookup(&q.focus) else {
1371        return (StatusCode::NOT_FOUND, "no such symbol".to_string());
1372    };
1373    let extras = s.extras().await;
1374    let focus = g.node(idx);
1375    let pack = g.context_pack(idx, q.budget.unwrap_or(1500));
1376    let mut o = format!(
1377        "## Context for changing `{}` ({} · {})\n\nRead these first:\n\n",
1378        focus.name, focus.repo, focus.location
1379    );
1380    for (n, _) in pack.iter().filter(|(n, _)| n.id != focus.id) {
1381        o.push_str(&format!("- `{}` ({} · {})", n.name, n.repo, n.location));
1382        if let Some((sum, _)) = extras.enrichment.get(&n.id) {
1383            o.push_str(&format!(": {sum}"));
1384        }
1385        o.push('\n');
1386    }
1387    let mut ids: Vec<String> = pack.iter().map(|(n, _)| n.id.clone()).collect();
1388    ids.push(focus.id.clone());
1389    let entries = s.entries().await;
1390    let known: Vec<String> = crate::ledger::about(&entries, &ids)
1391        .into_iter()
1392        .filter(|e| e.trust >= crate::ledger::Trust::T2)
1393        .filter(|e| !matches!(e.status, Status::Superseded | Status::Retracted))
1394        .take(6)
1395        .map(crate::ledger::line)
1396        .collect();
1397    if !known.is_empty() {
1398        o.push_str("\nRecorded by the team:\n\n");
1399        for k in known {
1400            o.push_str(&format!("- {k}\n"));
1401        }
1402    }
1403    (StatusCode::OK, o)
1404}
1405
1406async fn packages(Cur(s): Cur) -> Json<Vec<api::Package>> {
1407    Json(
1408        s.data
1409            .deps
1410            .iter()
1411            .map(|d| api::Package {
1412                ecosystem: d.ecosystem.clone(),
1413                name: d.name.clone(),
1414                publisher: d.publisher.clone(),
1415                published: d.published.clone(),
1416                consumer: d.consumer.clone(),
1417                requirement: d.requirement.clone(),
1418                locked: d.locked.clone(),
1419                skewed: d.skewed(),
1420            })
1421            .collect(),
1422    )
1423}
1424
1425/// Setup status and how to connect agents: index location, checks, MCP tools.
1426async fn setup(State(app): State<Shared>, Cur(s): Cur) -> Json<api::Setup> {
1427    let (server, team) = (app.server.clone(), app.team());
1428    let root = s.data.root.clone().unwrap_or_default();
1429    let checks = {
1430        let (root, server) = (root.clone(), server.clone());
1431        tokio::task::spawn_blocking(move || crate::doctor::run(&team, server.as_deref(), &root))
1432            .await
1433            .unwrap_or_default()
1434    };
1435    let tools = crate::mcp::tools()
1436        .into_iter()
1437        .map(|(name, description)| api::Tool { name, description })
1438        .collect();
1439    let agents = match server {
1440        Some(_) => Vec::new(),
1441        None => crate::doctor::agents()
1442            .into_iter()
1443            .map(String::from)
1444            .collect(),
1445    };
1446    Json(api::Setup {
1447        remote: crate::cache::is_remote(&root),
1448        index: root,
1449        version: env!("CARGO_PKG_VERSION").into(),
1450        checks,
1451        tools,
1452        agents,
1453        agents_md: crate::agents::agents_md(),
1454        skill: crate::agents::skill(),
1455    })
1456}
1457
1458/// Nodes and labelled edges around the focus, for the canvas graph.
1459fn neighbourhood(z: &Zoom) -> api::Neighbourhood {
1460    let Some(f) = &z.focus else {
1461        return api::Neighbourhood::default();
1462    };
1463    let mut nodes: BTreeMap<&str, &Node> = BTreeMap::from([(f.id.as_str(), f)]);
1464    let mut edges: Vec<api::GraphEdge> = Vec::new();
1465    let mut add = |a: &Node, b: &Node, kind: &str| {
1466        edges.push(api::GraphEdge {
1467            src: a.id.clone(),
1468            dst: b.id.clone(),
1469            kind: kind.into(),
1470        });
1471    };
1472    const CAP: usize = 40;
1473    let groups: [(&[Node], bool, &str); 5] = [
1474        (&z.callers, false, "calls"),
1475        (&z.callees, true, "calls"),
1476        (&z.importers, false, "imports"),
1477        (&z.members, true, "contains"),
1478        (&z.consumers, false, "consumes"),
1479    ];
1480    for (list, outgoing, kind) in groups {
1481        for n in list.iter().take(CAP) {
1482            nodes.insert(&n.id, n);
1483            if outgoing {
1484                add(f, n, kind);
1485            } else {
1486                add(n, f, kind);
1487            }
1488        }
1489    }
1490    for p in z.providers.iter().take(CAP) {
1491        nodes.insert(&p.id, p);
1492        add(p, f, "provides");
1493    }
1494    if let Some(c) = &z.container {
1495        nodes.insert(&c.id, c);
1496        add(c, f, "contains");
1497    }
1498    for r in &z.contracts {
1499        nodes.insert(&r.contract.id, &r.contract);
1500        add(f, &r.contract, r.role.as_str());
1501        for c in r.counterparts.iter().take(CAP) {
1502            nodes.insert(&c.id, c);
1503            add(c, &r.contract, "counterpart");
1504        }
1505    }
1506    api::Neighbourhood {
1507        nodes: nodes.into_values().cloned().collect(),
1508        edges,
1509        focus: Some(f.id.clone()),
1510    }
1511}
1512
1513/// Provenance for a write from the UI: the signed-in member on a server, else this machine's user.
1514fn provenance(who: Option<&crate::server::Who>, s: &Session) -> Provenance {
1515    let mut p = Provenance::human("comindly-web", &identity(who));
1516    if let Some(w) = who {
1517        let teams = s.teams.read().unwrap_or_else(|e| e.into_inner());
1518        p.teams = teams.teams_of_member(&w.email);
1519    }
1520    p
1521}
1522
1523/// The signed-in member on a server, else this machine's user.
1524fn identity(who: Option<&crate::server::Who>) -> crate::ledger::Identity {
1525    match who {
1526        Some(w) => crate::ledger::Identity {
1527            actor: format!("actor-{}", &blake3::hash(w.email.as_bytes()).to_hex()[..10]),
1528            name: Some(w.email.clone()),
1529        },
1530        None => crate::config::local_identity(),
1531    }
1532}
1533
1534type Member = Option<axum::Extension<crate::server::Who>>;
1535
1536/// Records written here are signed with this machine's key in local mode; a server does not sign.
1537fn signer(who: Option<&crate::server::Who>) -> Option<std::path::PathBuf> {
1538    who.is_none()
1539        .then(crate::config::local_signing_key)
1540        .flatten()
1541}
1542
1543async fn review(who: Member, Cur(s): Cur, Json(b): Json<api::ReviewRequest>) -> Reply<api::Done> {
1544    let signer = signer(who.as_deref());
1545    match apply_review(&s, &b, provenance(who.as_deref(), &s), signer).await {
1546        Ok(msg) => Ok(Json(api::Done::new(msg))),
1547        Err(e) => Err(bad(e)),
1548    }
1549}
1550
1551async fn apply_review(
1552    s: &Session,
1553    b: &api::ReviewRequest,
1554    prov: Provenance,
1555    signer: Option<std::path::PathBuf>,
1556) -> Result<String> {
1557    let root = s.data.root.as_deref().context("read-only UI")?;
1558    let (kind, _) = crate::ledger::review_action(&b.action).context("unknown action")?;
1559    let ledger = crate::ledger::Ledger::open(root)?.signed_by(signer);
1560    let target = {
1561        let entries = s.entries().await;
1562        let exact = entries.iter().find(|e| e.record.id == b.id);
1563        let prefixed: Vec<_> = entries
1564            .iter()
1565            .filter(|e| e.record.id.starts_with(&b.id))
1566            .collect();
1567        match (exact, prefixed.as_slice()) {
1568            (Some(e), _) | (None, &[e]) => e.record.clone(),
1569            (None, []) => anyhow::bail!("no ledger record `{}`", b.id),
1570            (None, _) => anyhow::bail!("`{}` matches several records; give more of the id", b.id),
1571        }
1572    };
1573    if matches!(kind, RelationKind::Retracts) && target.kind == crate::ledger::Kind::Relation {
1574        anyhow::bail!("relations cannot be retracted");
1575    }
1576    let commits = match graph_uri(s) {
1577        Some(u) => crate::index::read_repo_commits(&u)
1578            .await
1579            .unwrap_or_default(),
1580        None => Default::default(),
1581    };
1582    let rec = Record::review(&target, &b.action, &b.reason, prov)?.vouching(&target, |id| {
1583        let sym = s.data.symbols.iter().find(|x| x.id.render() == id)?;
1584        Some(crate::ledger::Anchor::of(sym).at(&commits))
1585    });
1586    ledger.put(&rec).await?;
1587    let records = ledger.all().await?;
1588    let fresh = s.derive(&records);
1589    let status = fresh
1590        .iter()
1591        .find(|e| e.record.id == target.id)
1592        .map_or(Status::Active, |e| e.status);
1593    *s.entries.write().await = fresh;
1594    Ok(format!("{} → {:?}", target.title, status))
1595}
1596
1597/// A record written by the person using the UI.
1598async fn remember(
1599    who: Member,
1600    Cur(s): Cur,
1601    Json(b): Json<api::RememberRequest>,
1602) -> Reply<api::Remembered> {
1603    let run = async {
1604        let root = s.data.root.as_deref().context("read-only UI")?;
1605        let kind = crate::ledger::Kind::parse(&b.kind).context("unknown kind")?;
1606        let g = &s.data.graph;
1607        let commits = match graph_uri(&s) {
1608            Some(u) => crate::index::read_repo_commits(&u)
1609                .await
1610                .unwrap_or_default(),
1611            None => Default::default(),
1612        };
1613        let mut anchors = Vec::new();
1614        for focus in &b.on {
1615            let id = g
1616                .lookup(focus)
1617                .map(|i| g.node(i).id)
1618                .with_context(|| format!("no symbol matches `{focus}`"))?;
1619            let sym = s.data.symbols.iter().find(|x| x.id.render() == id);
1620            anchors.push(crate::ledger::Anchor::of(sym.context("symbol not loaded")?).at(&commits));
1621        }
1622        let commit = anchors.first().and_then(|a| a.commit.clone());
1623        let mut rec = Record::new(kind, &b.title, anchors, provenance(who.as_deref(), &s));
1624        let repos: Vec<&str> = rec.anchors.iter().map(|a| a.repo.as_str()).collect();
1625        s.teams
1626            .read()
1627            .unwrap_or_else(|e| e.into_inner())
1628            .accepts(&rec.provenance.teams, &repos)?;
1629        rec.body = b.body.trim().to_string();
1630        rec.trigger = b.trigger.filter(|t| !t.trim().is_empty());
1631        rec.evidence = b
1632            .evidence
1633            .into_iter()
1634            .filter(|e| !e.trim().is_empty())
1635            .collect();
1636        for (k, v) in b.fields.into_iter().filter(|(_, v)| !v.trim().is_empty()) {
1637            rec.fields.insert(k, Value::String(v));
1638        }
1639        rec.snippets = b
1640            .snippets
1641            .into_iter()
1642            .filter(|s| !s.code.trim().is_empty())
1643            .map(|mut s| {
1644                s.commit = s.commit.or_else(|| commit.clone());
1645                s
1646            })
1647            .collect();
1648        let ledger = crate::ledger::Ledger::open(root)?.signed_by(signer(who.as_deref()));
1649        ledger.put(&rec).await?;
1650        let records = ledger.all().await?;
1651        *s.entries.write().await = s.derive(&records);
1652        anyhow::Ok(rec.id)
1653    };
1654    match run.await {
1655        Ok(id) => Ok(Json(api::Remembered { ok: true, id })),
1656        Err(e) => Err(bad(e)),
1657    }
1658}
1659
1660/// Permanently delete a record and the reviews about it.
1661async fn erase(Cur(s): Cur, Json(b): Json<api::IdRequest>) -> Reply<api::Done> {
1662    let run = async {
1663        let root = s.data.root.as_deref().context("read-only UI")?;
1664        let ledger = crate::ledger::Ledger::open(root)?;
1665        let gone = ledger.erase(|r| r.id == b.id, true).await?;
1666        anyhow::ensure!(!gone.is_empty(), "no such record");
1667        let records = ledger.all().await?;
1668        *s.entries.write().await = s.derive(&records);
1669        anyhow::Ok(format!(
1670            "deleted {}",
1671            crate::doctor::plural(gone.len(), "record")
1672        ))
1673    };
1674    match run.await {
1675        Ok(msg) => Ok(Json(api::Done::new(msg))),
1676        Err(e) => Err(bad(e)),
1677    }
1678}
1679
1680#[cfg(test)]
1681mod tests {
1682    use super::*;
1683
1684    #[test]
1685    fn shared_tables_are_data_and_routes_are_contracts() {
1686        let node = |id: &str, repo: &str| Node {
1687            id: id.into(),
1688            name: id.into(),
1689            kind: "function".into(),
1690            repo: repo.into(),
1691            location: String::new(),
1692            signature: None,
1693        };
1694        let view = |name: &str, provider: &str, consumer: &str| crate::graph::ContractView {
1695            contract: node(name, crate::resolve::CONTRACTS),
1696            providers: vec![node("p", provider)],
1697            consumers: vec![node("c", consumer)],
1698        };
1699        let graph = crate::graph::CodeGraph::build(&[], &[]);
1700        let map = org(
1701            &graph,
1702            &[],
1703            &[],
1704            &[
1705                view("table:customer", "service", "library"),
1706                view("http:POST /chat", "agent", "service"),
1707            ],
1708        );
1709        let kind = |src: &str| {
1710            map.edges
1711                .iter()
1712                .find(|e| e.src == src)
1713                .unwrap()
1714                .kind
1715                .clone()
1716        };
1717        assert_eq!(kind("library"), "data");
1718        assert_eq!(kind("service"), "contract");
1719    }
1720
1721    /// A router behind `traced` whose log lines, as JSON, land in the returned buffer.
1722    fn traced_app() -> (Router, Arc<std::sync::Mutex<Vec<String>>>) {
1723        let lines: Arc<std::sync::Mutex<Vec<String>>> = Default::default();
1724        let app = Router::new()
1725            .route(
1726                "/api/v1/thing",
1727                get(|rid: axum::Extension<RequestId>| async move {
1728                    crate::ui::warn("something odd");
1729                    let mut res = rid.0 .0.into_response();
1730                    res.extensions_mut().insert(crate::server::Who {
1731                        email: "member@example.com".into(),
1732                        role: crate::server::Role::Member,
1733                    });
1734                    res
1735                }),
1736            )
1737            .layer(axum::middleware::from_fn_with_state(false, traced));
1738        (app, lines)
1739    }
1740
1741    async fn call(app: Router, req: axum::http::Request<axum::body::Body>) -> (String, String) {
1742        use tower::ServiceExt;
1743        let res = app.oneshot(req).await.unwrap();
1744        let id = res.headers()["x-request-id"].to_str().unwrap().to_string();
1745        let body = axum::body::to_bytes(res.into_body(), 1 << 16)
1746            .await
1747            .unwrap();
1748        (id, String::from_utf8_lossy(&body).into_owned())
1749    }
1750
1751    #[tokio::test]
1752    async fn requests_get_an_id_and_one_access_line_without_credentials() {
1753        use tracing_subscriber::layer::SubscriberExt;
1754        let (app, lines) = traced_app();
1755        let out = lines.clone();
1756        let sub = tracing_subscriber::registry()
1757            .with(crate::telemetry::Lines::to(true, move |l| {
1758                out.lock().unwrap().push(l.to_string())
1759            }));
1760        let _g = tracing::subscriber::set_default(sub);
1761
1762        let req = axum::http::Request::get("/api/v1/thing?token=query-secret")
1763            .header("x-request-id", "abc-123.x_y")
1764            .header(header::AUTHORIZATION, "Bearer bearer-secret")
1765            .header(header::COOKIE, "comindly_session=cookie-secret")
1766            .body(axum::body::Body::empty())
1767            .unwrap();
1768        let (id, seen) = call(app.clone(), req).await;
1769        assert_eq!(id, "abc-123.x_y");
1770        assert_eq!(seen, id, "the handler sees the same id");
1771
1772        let lines = lines.lock().unwrap().clone();
1773        let all = lines.join("\n");
1774        for secret in ["query-secret", "bearer-secret", "cookie-secret", "token="] {
1775            assert!(!all.contains(secret), "{secret} leaked: {all}");
1776        }
1777        let parsed: Vec<Value> = lines
1778            .iter()
1779            .map(|l| serde_json::from_str(l).unwrap())
1780            .collect();
1781        let warn = parsed.iter().find(|v| v["kind"] == "warning").unwrap();
1782        assert_eq!(warn["request_id"], "abc-123.x_y");
1783        let access: Vec<&Value> = parsed.iter().filter(|v| v["kind"] == "access").collect();
1784        assert_eq!(access.len(), 1);
1785        let a = access[0];
1786        assert_eq!(a["level"], "info");
1787        assert_eq!(a["method"], "GET");
1788        assert_eq!(a["path"], "/api/v1/thing");
1789        assert_eq!(a["status"], 200);
1790        assert_eq!(a["request_id"], "abc-123.x_y");
1791        assert_eq!(a["email"], "member@example.com");
1792        assert!(a["duration_ms"].is_u64());
1793
1794        for bad in ["has space", "semi;colon", &"x".repeat(65)] {
1795            let req = axum::http::Request::get("/api/v1/thing")
1796                .header("x-request-id", bad)
1797                .body(axum::body::Body::empty())
1798                .unwrap();
1799            let (id, _) = call(app.clone(), req).await;
1800            assert_ne!(id, bad);
1801            assert!(safe_request_id(&id));
1802        }
1803        let req = axum::http::Request::get("/api/v1/thing")
1804            .body(axum::body::Body::empty())
1805            .unwrap();
1806        let (id, _) = call(app, req).await;
1807        assert!(safe_request_id(&id));
1808    }
1809
1810    fn n(id: &str, repo: &str) -> Node {
1811        Node {
1812            id: id.into(),
1813            name: id.into(),
1814            kind: "function".into(),
1815            repo: repo.into(),
1816            location: String::new(),
1817            signature: None,
1818        }
1819    }
1820
1821    #[test]
1822    fn neighbourhood_links_focus_both_ways() {
1823        let z = Zoom {
1824            focus: Some(n("f", "a")),
1825            callers: vec![n("caller", "b")],
1826            callees: vec![n("callee", "a")],
1827            ..Default::default()
1828        };
1829        let g = neighbourhood(&z);
1830        assert_eq!(g.nodes.len(), 3);
1831        let edges: Vec<(String, String)> = g
1832            .edges
1833            .iter()
1834            .map(|e| (e.src.clone(), e.dst.clone()))
1835            .collect();
1836        assert!(edges.contains(&("caller".into(), "f".into())));
1837        assert!(edges.contains(&("f".into(), "callee".into())));
1838    }
1839}