Skip to main content

datumesh_http/
http.rs

1//! The endpoints: an axum router over a [`Mesh`].
2
3use std::net::{IpAddr, Ipv4Addr, SocketAddr};
4use std::sync::{Arc, Mutex};
5use std::time::{Duration, Instant};
6
7use axum::body::{Body, Bytes};
8use axum::extract::{ConnectInfo, MatchedPath, Path, Query, Request, State};
9use axum::http::{header, HeaderMap, HeaderValue, StatusCode, Uri};
10use axum::middleware::{self, Next};
11use axum::response::{IntoResponse, Response};
12use axum::routing::{get, post};
13use axum::Router;
14use datumesh_core::json::{self, Value};
15use datumesh_core::{lexical, ErrorCode, Pending, Request as CoreRequest};
16use tracing::Instrument;
17use utoipa::OpenApi;
18
19use crate::apikeys::Principal;
20use crate::envelope::{self, Cache, Reply, JSON};
21use crate::jobs::Poll;
22use crate::limit::Client;
23use crate::mesh::{Inner, Memo, Mesh};
24
25/// The principal of a request, for the access log.
26#[derive(Clone)]
27struct Who(Option<String>);
28
29fn to_response(r: Reply) -> Response {
30    let mut resp = Response::new(Body::from(r.body));
31    *resp.status_mut() = StatusCode::from_u16(r.status).unwrap_or(StatusCode::INTERNAL_SERVER_ERROR);
32    let h = resp.headers_mut();
33    h.insert(header::CONTENT_TYPE, HeaderValue::from_static(r.content_type));
34    if let Ok(v) = HeaderValue::from_str(&r.cache.header()) {
35        h.insert(header::CACHE_CONTROL, v);
36    }
37    if let Some(c) = r.canonical {
38        if let Ok(v) = HeaderValue::from_str(&format!("<{c}>; rel=\"canonical\"")) {
39            h.insert(header::LINK, v);
40        }
41    }
42    if let Some(s) = r.retry_after {
43        h.insert(header::RETRY_AFTER, HeaderValue::from(s));
44    }
45    resp
46}
47
48fn plain_json(status: u16, v: Value, cache: Cache) -> Response {
49    to_response(Reply::json(status, v.to_jcs(), cache))
50}
51
52fn not_found(what: &str) -> Response {
53    plain_json(404, Value::Object(vec![("error".into(), Value::String(format!("no such {what}")))]), Cache::Public(60))
54}
55
56/// The client: its IP and, with a valid API key, its principal. An `Authorization` header
57/// that is not a key of this mesh is answered `unlicensed`.
58fn who(inner: &Inner, headers: &HeaderMap, peer: IpAddr) -> Result<(Client, Option<Principal>), Reply> {
59    let ip = client_ip(inner, headers, peer);
60    match headers.get(header::AUTHORIZATION) {
61        None => Ok((Client::Ip(ip), None)),
62        Some(v) => {
63            let p = v
64                .to_str()
65                .ok()
66                .and_then(|s| s.strip_prefix("Bearer "))
67                .and_then(|k| inner.config.api_keys.principal(k.trim()));
68            match p {
69                Some(p) => Ok((Client::Key(p.id.clone(), p.per_minute), Some(p.clone()))),
70                None => Err(Reply::json(403, envelope::unlicensed(), Cache::Private)),
71            }
72        }
73    }
74}
75
76fn client_ip(inner: &Inner, headers: &HeaderMap, peer: IpAddr) -> IpAddr {
77    if inner.config.trust_proxy {
78        if let Some(ip) = headers
79            .get("x-forwarded-for")
80            .and_then(|v| v.to_str().ok())
81            .and_then(|s| s.rsplit(',').next())
82            .and_then(|s| s.trim().parse::<IpAddr>().ok())
83        {
84            return ip;
85        }
86    }
87    peer
88}
89
90fn peer_of(req: &Request) -> IpAddr {
91    req.extensions().get::<ConnectInfo<SocketAddr>>().map(|c| c.0.ip()).unwrap_or(IpAddr::V4(Ipv4Addr::UNSPECIFIED))
92}
93
94/// `rest` of a `/<prefix>/<rest>` request, query included, as received.
95fn rest_of(uri: &Uri, prefix: &str) -> String {
96    let path = uri.path().strip_prefix(prefix).unwrap_or("");
97    match uri.query() {
98        Some(q) => format!("{path}?{q}"),
99        None => path.to_string(),
100    }
101}
102
103/// Runs `f` on the pool within the request's budget: its reply, or, past the budget, a
104/// `pending` envelope whose job gets the reply when `f` finishes. `f` reports the request
105/// description as soon as it knows it.
106async fn within_budget(
107    inner: Arc<Inner>,
108    f: impl FnOnce(&Inner, &mut dyn FnMut(&crate::call::Target)) -> Reply + Send + 'static,
109) -> Reply {
110    let deadline = tokio::time::Instant::now() + inner.config.budget;
111    let (tx, mut rx) = tokio::sync::watch::channel::<Option<CoreRequest>>(None);
112    let pool = inner.pool.clone();
113    let i2 = inner.clone();
114    let mut task = tokio::spawn(async move {
115        pool.run(move || {
116            let mut on = |t: &crate::call::Target| {
117                if let Some(r) = request_of(t) {
118                    let _ = tx.send(Some(r));
119                }
120            };
121            f(&i2, &mut on)
122        })
123        .await
124    });
125    match tokio::time::timeout_at(deadline, &mut task).await {
126        Ok(Ok(Some(r))) => r,
127        Ok(_) => envelope::error_reply(ErrorCode::EvalUnavailable),
128        Err(_) => {
129            let request = rx.borrow_and_update().clone();
130            let Some(request) = request else {
131                // Past the budget before the request was even resolved (the store or another
132                // mesh is slow): the mesh cannot say what it is computing.
133                return envelope::error_reply(ErrorCode::EvalUnavailable);
134            };
135            pend(inner, request, task)
136        }
137    }
138}
139
140/// The request description of a target: its cell id, asof and pin (spec-0.4.2).
141fn request_of(t: &crate::call::Target) -> Option<CoreRequest> {
142    let r = CoreRequest::new(t.cell_id(), t.asof()).ok()?;
143    match &t.pin {
144        Some(p) => r.with_pin(p).ok(),
145        None => Some(r),
146    }
147}
148
149/// A job for a request still running in `task`.
150fn pend(inner: Arc<Inner>, request: CoreRequest, task: tokio::task::JoinHandle<Option<Reply>>) -> Reply {
151    let Some(id) = inner.jobs.create(request.clone()) else {
152        return envelope::error_reply(ErrorCode::EvalUnavailable);
153    };
154    let poll = format!("{}/jobs/{id}", inner.config.origin());
155    let est = inner.jobs.estimate(inner.config.budget.as_secs());
156    let i2 = inner.clone();
157    let id2 = id.clone();
158    tokio::spawn(async move {
159        let r = match task.await {
160            Ok(Some(r)) if r.status != 202 => r,
161            _ => envelope::error_reply(ErrorCode::EvalUnavailable),
162        };
163        let mut r = r;
164        r.cache = Cache::NoStore;
165        r.canonical = None;
166        i2.jobs.complete(&id2, r);
167    });
168    match Pending::new(&id, est, &poll, request) {
169        Ok(p) => Reply::json(202, envelope::pending(&p), Cache::NoStore),
170        Err(_) => envelope::error_reply(ErrorCode::EvalUnavailable),
171    }
172}
173
174fn admit(inner: &Inner, client: &Client, cost: u32) -> Result<(), Reply> {
175    inner.limiter.admit(client, cost).map_err(envelope::rate_limited_reply)
176}
177
178#[derive(OpenApi)]
179#[openapi(
180    info(
181        title = "datumesh-mesh",
182        description = "The Datumesh engine behind HTTPS (spec-0.4.1): cell envelopes (SPEC 5.5), batches, slices, receipts, descriptors, manifests, blobs, lineage, search, verification, jobs, key and mesh documents (SPEC 9.2, 9.6), bindings (SPEC 9.7).",
183        license(name = "Apache-2.0")
184    ),
185    paths(
186        cell,
187        cells,
188        slice,
189        versions,
190        receipt,
191        descriptor,
192        manifest,
193        blob,
194        explain,
195        find,
196        verify_receipt,
197        job,
198        key_document,
199        mesh_document,
200        bindings,
201        describe,
202        whatif,
203        health,
204        metrics,
205        openapi_json
206    )
207)]
208struct ApiDoc;
209
210/// The OpenAPI document (generated from the handlers' annotations).
211pub fn openapi() -> utoipa::openapi::OpenApi {
212    ApiDoc::openapi()
213}
214
215/// The envelope of a cell.
216#[utoipa::path(get, path = "/cell/{cell}",
217    params(("cell" = String, Path, description = "A cell URI's rest (SPEC 5.3), byte for byte, `asof` included; or a call (SPEC 15.3's read syntax, URL-encoded) with an optional `?asof=`.")),
218    responses(
219        (status = 200, description = "`ok` or `stale`", content_type = "application/json"),
220        (status = 202, description = "`pending`: poll the job (SPEC 5.5)", content_type = "application/json"),
221        (status = 400, description = "`bad_request`", content_type = "application/json"),
222        (status = 402, description = "`payment_required`", content_type = "application/json"),
223        (status = 403, description = "`unlicensed`", content_type = "application/json"),
224        (status = 404, description = "`not_covered` (with `fault` when the evaluation faulted)", content_type = "application/json"),
225        (status = 406, description = "the Accept header excludes JSON"),
226        (status = 429, description = "`rate_limited`, with `Retry-After`", content_type = "application/json"),
227        (status = 500, description = "`error`", content_type = "application/json"),
228        (status = 503, description = "`error`: the store or another mesh is unavailable", content_type = "application/json"),
229    ))]
230async fn cell(State(mesh): State<Mesh>, uri: Uri, headers: HeaderMap, req: Request) -> Response {
231    let inner = mesh.inner.clone();
232    let (client, principal) = match who(&inner, &headers, peer_of(&req)) {
233        Ok(x) => x,
234        Err(r) => return to_response(r),
235    };
236    let mut resp = match admit(&inner, &client, 1) {
237        Err(r) => to_response(r),
238        Ok(()) => {
239            let rest = rest_of(&uri, "/cell/");
240            let p = principal.clone();
241            let r = within_budget(inner.clone(), move |i, on| {
242                let now = i.now();
243                i.answer(&rest, p.as_ref(), i, &now, on)
244            })
245            .await;
246            if let Some(o) = r.outcome() {
247                inner.metrics.outcome("/cell/{cell}", &o);
248            }
249            to_response(r)
250        }
251    };
252    resp.extensions_mut().insert(Who(principal.map(|p| p.id)));
253    resp
254}
255
256/// A batch of cells.
257#[utoipa::path(post, path = "/cells",
258    request_body(content = String, description = "A JSON array of requests, each a call or a cell URI (`cell://...`) as a string, or `{\"cell\": <that>}`; at most the configured bound (1,000).", content_type = "application/json"),
259    responses(
260        (status = 200, description = "A JSON array of envelopes, in order; each has the HTTP status its outcome has (`error`: 500)", content_type = "application/json"),
261        (status = 400, description = "Not such an array, or too long", content_type = "application/json"),
262        (status = 429, description = "`rate_limited` (a batch of n cells counts as n / 50 requests)", content_type = "application/json"),
263    ))]
264async fn cells(State(mesh): State<Mesh>, headers: HeaderMap, req: Request) -> Response {
265    let inner = mesh.inner.clone();
266    let peer = peer_of(&req);
267    let (client, principal) = match who(&inner, &headers, peer) {
268        Ok(x) => x,
269        Err(r) => return to_response(r),
270    };
271    let body = match axum::body::to_bytes(req.into_body(), 64 << 20).await {
272        Ok(b) => b,
273        Err(_) => return to_response(envelope::bad_request_reply(ErrorCode::CanonLimit)),
274    };
275    let items = match parse_batch(&body, inner.config.batch_max) {
276        Ok(i) => i,
277        // A refusal of the whole batch (5.7): one envelope.
278        Err((code, detail)) => {
279            tracing::info!(target: "datumesh_http", detail = %detail, "batch refused");
280            return to_response(envelope::bad_request_reply(code));
281        }
282    };
283    if let Err(r) = admit(&inner, &client, inner.limiter.batch_cost(items.len())) {
284        return to_response(r);
285    }
286    let pieces = batch(inner.clone(), items, principal.clone()).await;
287    let mut counts: std::collections::BTreeMap<&str, u64> = std::collections::BTreeMap::new();
288    for w in &pieces {
289        for (o, k) in &w.outcomes {
290            *counts.entry(o).or_default() += k;
291        }
292    }
293    for (o, k) in counts {
294        inner.metrics.outcomes("/cells", o, k);
295    }
296    // 5.7: [{"envelope": <the envelope>, "status": <its status>}] in request order: the
297    // chunks' runs as they wrote them (the first opening the array).
298    let mut out = Vec::with_capacity(pieces.iter().map(|w| w.bytes.len()).sum::<usize>() + 2);
299    for w in &pieces {
300        out.extend_from_slice(&w.bytes);
301    }
302    out.extend_from_slice(if pieces.is_empty() { b"[]" } else { b"]" });
303    let mut resp =
304        to_response(Reply::json(200, out, if principal.is_some() { Cache::Private } else { Cache::NoStore }));
305    resp.extensions_mut().insert(Who(principal.map(|p| p.id)));
306    resp
307}
308
309fn batch_error(e: &str) -> Response {
310    plain_json(400, Value::Object(vec![("error".into(), Value::String(e.to_string()))]), Cache::NoStore)
311}
312
313/// The batch's requests, or the code of its refusal: `E_PARSE_URI` for a body that is not an
314/// array of requests, `E_CANON_LIMIT` for more than the mesh accepts (5.7).
315fn parse_batch(body: &[u8], max: usize) -> Result<Vec<String>, (ErrorCode, String)> {
316    let pu = |m: String| (ErrorCode::ParseUri, m);
317    // The body is a list of requests, not a protocol object: plain JSON.
318    let v: serde_json::Value = serde_json::from_slice(body).map_err(|e| pu(format!("not JSON: {e}")))?;
319    let serde_json::Value::Array(items) = v else { return Err(pu("not a JSON array".into())) };
320    if items.len() > max {
321        return Err((ErrorCode::CanonLimit, format!("{} requests: at most {max}", items.len())));
322    }
323    items
324        .into_iter()
325        .map(|i| {
326            let s = match i {
327                serde_json::Value::String(s) => s,
328                serde_json::Value::Object(mut o) => match o.remove("cell") {
329                    Some(serde_json::Value::String(s)) => s,
330                    _ => return Err(pu("an object without a string cell".to_string())),
331                },
332                _ => return Err(pu("an item that is neither a string nor an object".to_string())),
333            };
334            Ok(match s.strip_prefix("cell://") {
335                Some(r) => r.to_string(),
336                None => s,
337            })
338        })
339        .collect()
340}
341
342/// A run of a batch's answers as 5.7 writes them: the items
343/// `{"envelope": <the envelope>, "status": <its status>}` (JCS member order) joined by commas,
344/// and how many of each outcome they hold. Each chunk writes its own on the pool, in
345/// parallel: reading 1,000 envelopes (each a receipt, the function hash echoed) to copy and
346/// count them is the costliest part of a warm batch after the answers themselves.
347#[derive(Default)]
348struct Written {
349    bytes: Vec<u8>,
350    outcomes: Vec<(String, u64)>,
351}
352
353impl Written {
354    /// The run of `replies`, opening the array when `first`, else continuing it.
355    fn of<'a>(first: bool, replies: impl Iterator<Item = &'a Reply> + Clone) -> Written {
356        let mut w = Written {
357            bytes: Vec::with_capacity(replies.clone().map(|r| r.body.len() + 32).sum::<usize>() + 1),
358            outcomes: vec![],
359        };
360        w.bytes.push(if first { b'[' } else { b',' });
361        for (i, r) in replies.enumerate() {
362            if i > 0 {
363                w.bytes.push(b',');
364            }
365            w.push(r);
366        }
367        w
368    }
369
370    fn push(&mut self, r: &Reply) {
371        self.bytes.extend_from_slice(b"{\"envelope\":");
372        self.bytes.extend_from_slice(&r.body);
373        self.bytes.extend_from_slice(b",\"status\":");
374        push_u16(&mut self.bytes, r.status);
375        self.bytes.push(b'}');
376        if let Some(o) = r.outcome_str() {
377            match self.outcomes.iter_mut().find(|(x, _)| x == o) {
378                Some((_, k)) => *k += 1,
379                None => self.outcomes.push((o.to_string(), 1)),
380            }
381        }
382    }
383}
384
385/// Appends `n` in decimal (a JSON integer).
386fn push_u16(out: &mut Vec<u8>, n: u16) {
387    let mut buf = [0u8; 5];
388    let (mut i, mut n) = (buf.len(), n);
389    loop {
390        i -= 1;
391        buf[i] = b'0' + (n % 10) as u8;
392        n /= 10;
393        if n == 0 {
394            break;
395        }
396    }
397    out.extend_from_slice(&buf[i..]);
398}
399
400/// The machine's parallelism, read once: `available_parallelism` reads the cgroup files on
401/// Linux (hundreds of microseconds in a container), too slow to pay on every batch.
402fn cores() -> usize {
403    static CORES: std::sync::OnceLock<usize> = std::sync::OnceLock::new();
404    *CORES.get_or_init(|| std::thread::available_parallelism().map(|c| c.get()).unwrap_or(4))
405}
406
407/// Answers a batch within the budget: the requests are answered in chunks across the pool
408/// (one chunk per core; bindings looked up once per name and asof within the batch), each
409/// chunk writing its answers ([`Written`]). Those not answered within the budget become
410/// jobs: each is resolved again to the request it describes (a store read), and its chunk's
411/// answer completes the job. The runs are in request order.
412async fn batch(inner: Arc<Inner>, items: Vec<String>, principal: Option<Principal>) -> Vec<Written> {
413    let n = items.len();
414    let deadline = tokio::time::Instant::now() + inner.config.budget;
415    let chunks = n.div_ceil(64).clamp(1, inner.config.pool_size.min(cores()));
416    let per = n.div_ceil(chunks).max(1);
417    let ranges: Vec<(usize, usize)> =
418        (0..chunks).map(|c| (c * per, ((c + 1) * per).min(n))).take_while(|(lo, hi)| lo < hi).collect();
419    let now = inner.now();
420    let items = Arc::new(items);
421    // Each chunk's answers so far; once the budget has passed (`late`), its answers go to
422    // the channel instead, to complete their jobs. A chunk done within the budget leaves
423    // its answers written instead.
424    let shared: Slots = Arc::new(ranges.iter().map(|_| Mutex::new(Slot::default())).collect());
425    let (tx, mut rx) = tokio::sync::mpsc::unbounded_channel::<(usize, Reply)>();
426    let seen = Arc::new(crate::mesh::Seen::default());
427    let mut tasks = Vec::new();
428    for (c, &(lo, hi)) in ranges.iter().enumerate() {
429        let (i2, items, tx, p, now, shared) =
430            (inner.clone(), items.clone(), tx.clone(), principal.clone(), now.clone(), shared.clone());
431        let seen = seen.clone();
432        let pool = inner.pool.clone();
433        tasks.push(tokio::spawn(async move {
434            pool.run(move || {
435                let memo = Memo::shared(&i2, &seen);
436                for k in lo..hi {
437                    let reply = i2.answer_with(&items[k], p.as_ref(), &memo, &now, &mut |_| {}, false);
438                    let mut slot = shared[c].lock().unwrap_or_else(|p| p.into_inner());
439                    if slot.late {
440                        let _ = tx.send((k, reply));
441                    } else {
442                        slot.answers.push((k, reply));
443                    }
444                }
445                let mut slot = shared[c].lock().unwrap_or_else(|p| p.into_inner());
446                if !slot.late {
447                    let answers = std::mem::take(&mut slot.answers);
448                    slot.written = Some(Written::of(c == 0, answers.iter().map(|(_, r)| r)));
449                }
450            })
451            .await
452        }));
453    }
454    drop(tx);
455    let all = futures_join(&mut tasks, deadline).await;
456    let mut done: Vec<Option<Reply>> = vec![None; n];
457    let mut written: Vec<Option<Written>> = Vec::with_capacity(ranges.len());
458    for slot in shared.iter() {
459        let mut s = slot.lock().unwrap_or_else(|p| p.into_inner());
460        s.late = true;
461        for (k, r) in s.answers.drain(..) {
462            done[k] = Some(r);
463        }
464        written.push(s.written.take());
465    }
466    // A chunk's run: as it wrote it, else its answers (an error for any it has none of: its
467    // task panicked, or the answer completes a job).
468    let runs = |done: Vec<Option<Reply>>, written: Vec<Option<Written>>| -> Vec<Written> {
469        let error = envelope::error_reply(ErrorCode::EvalUnavailable);
470        ranges
471            .iter()
472            .zip(written)
473            .enumerate()
474            .map(|(c, (&(lo, hi), w))| {
475                w.unwrap_or_else(|| Written::of(c == 0, done[lo..hi].iter().map(|d| d.as_ref().unwrap_or(&error))))
476            })
477            .collect()
478    };
479    if all {
480        return runs(done, written);
481    }
482    // Past the budget: every request not answered yet becomes a job, resolved again to the
483    // request it describes.
484    let open: Vec<usize> = ranges
485        .iter()
486        .zip(&written)
487        .filter(|(_, w)| w.is_none())
488        .flat_map(|(&(lo, hi), _)| lo..hi)
489        .filter(|k| done[*k].is_none())
490        .collect();
491    let (i2, items2, open2, now2) = (inner.clone(), items.clone(), open.clone(), now.clone());
492    let requests: Vec<Option<CoreRequest>> = inner
493        .pool
494        .run(move || {
495            let memo = Memo::new(&i2);
496            open2
497                .iter()
498                .map(|k| {
499                    crate::call::resolve(&items2[*k], &now2, &i2.config.aliases, &memo, false)
500                        .ok()
501                        .and_then(|t| request_of(&t))
502                })
503                .collect()
504        })
505        .await
506        .unwrap_or_default();
507    let poll_base = format!("{}/jobs/", inner.config.origin());
508    let est = inner.jobs.estimate(inner.config.budget.as_secs());
509    let mut jobs: Vec<Option<String>> = vec![None; n];
510    for (i, k) in open.iter().enumerate() {
511        let reply = match requests.get(i).cloned().flatten() {
512            Some(req) => match inner.jobs.create(req.clone()) {
513                Some(id) => {
514                    let p = Pending::new(&id, est, &format!("{poll_base}{id}"), req);
515                    jobs[*k] = Some(id);
516                    match p {
517                        Ok(p) => Reply::json(202, envelope::pending(&p), Cache::NoStore),
518                        Err(_) => envelope::error_reply(ErrorCode::EvalUnavailable),
519                    }
520                }
521                None => envelope::error_reply(ErrorCode::EvalUnavailable),
522            },
523            None => envelope::error_reply(ErrorCode::EvalUnavailable),
524        };
525        done[*k] = Some(reply);
526    }
527    let i3 = inner.clone();
528    tokio::spawn(async move {
529        while let Some((k, mut reply)) = rx.recv().await {
530            if let Some(id) = &jobs[k] {
531                reply.cache = Cache::NoStore;
532                reply.canonical = None;
533                i3.jobs.complete(id, reply);
534            }
535        }
536        for t in tasks {
537            let _ = t.await;
538        }
539        // Jobs whose task ended without an answer (a panic) are given up.
540        for id in jobs.into_iter().flatten() {
541            if let Poll::Running(..) = i3.jobs.poll_peek(&id) {
542                i3.jobs.complete(&id, envelope::error_reply(ErrorCode::EvalUnavailable));
543            }
544        }
545    });
546    runs(done, written)
547}
548
549/// A batch chunk's state: whether the budget has passed, its answers so far, and its
550/// answers written once it is done within the budget.
551#[derive(Default)]
552struct Slot {
553    late: bool,
554    answers: Vec<(usize, Reply)>,
555    written: Option<Written>,
556}
557
558/// Each batch chunk's state.
559type Slots = Arc<Vec<Mutex<Slot>>>;
560
561/// Waits for every task until `deadline`: whether all finished.
562async fn futures_join(tasks: &mut [tokio::task::JoinHandle<Option<()>>], deadline: tokio::time::Instant) -> bool {
563    for t in tasks.iter_mut() {
564        if t.is_finished() {
565            continue;
566        }
567        if tokio::time::timeout_at(deadline, t).await.is_err() {
568            return false;
569        }
570    }
571    true
572}
573
574/// The versions of a stored cell (SPEC 9.8, spec-0.4.2).
575#[utoipa::path(get, path = "/versions/{cell}",
576    params(("cell" = String, Path, description = "A cell URI's rest without asof (a pin allowed), then optionally `from=` and `to=` (instants, inclusive bounds on tx) as its last parameters.")),
577    responses(
578        (status = 200, description = "`{\"cell\", \"versions\": [{\"asof\", \"receipt\", \"tx\"}], \"next\"?}` ascending by tx", content_type = "application/json"),
579        (status = 400, description = "`bad_request`", content_type = "application/json"),
580        (status = 404, description = "`not_covered` (with `E_NAME_UNBOUND` for an unbound name)", content_type = "application/json"),
581    ))]
582async fn versions(State(mesh): State<Mesh>, uri: Uri, headers: HeaderMap, req: Request) -> Response {
583    if let Some(r) = ip_admit(&mesh.inner, &headers, &req) {
584        return r;
585    }
586    let inner = mesh.inner.clone();
587    let rest = rest_of(&uri, "/versions/");
588    let r = inner
589        .pool
590        .clone()
591        .run(move || inner.versions(&rest))
592        .await
593        .unwrap_or_else(|| envelope::error_reply(ErrorCode::EvalUnavailable));
594    to_response(r)
595}
596
597/// The most versions in one answer of the versions endpoint.
598const VERSIONS_PAGE: usize = 1000;
599
600impl Inner {
601    fn versions(&self, rest: &str) -> Reply {
602        // `from=` and `to=` are the endpoint's, taken off the end of the query.
603        let (path, query) = match rest.split_once('?') {
604            Some((p, q)) => (p, q),
605            None => (rest, ""),
606        };
607        let mut ps: Vec<&str> = if query.is_empty() { vec![] } else { query.split('&').collect() };
608        let (mut from, mut to) = (None, None);
609        while let Some(last) = ps.last() {
610            if let Some(v) = last.strip_prefix("from=") {
611                from = Some(v.to_string());
612            } else if let Some(v) = last.strip_prefix("to=") {
613                to = Some(v.to_string());
614            } else {
615                break;
616            }
617            ps.pop();
618        }
619        for t in [&from, &to].into_iter().flatten() {
620            if lexical::check_instant(t, "$").is_err() {
621                return envelope::bad_request_reply(ErrorCode::CanonInstant);
622            }
623        }
624        let cell_rest = if ps.is_empty() { path.to_string() } else { format!("{path}?{}", ps.join("&")) };
625        let now = self.now();
626        let target = match crate::call::resolve(&cell_rest, &now, &self.config.aliases, self, false) {
627            Ok(t) => t,
628            Err(r) => return self.rejection(r, None),
629        };
630        if target.asof().is_some() {
631            return envelope::bad_request_reply(ErrorCode::ParseUri);
632        }
633        let lo = from.unwrap_or_else(|| "0001-01-01T00:00:00.000000Z".into());
634        let hi = to.clone().unwrap_or_else(|| "9999-12-31T23:59:59.999999Z".into());
635        let mut vs = match self.store.versions(target.cell_id(), &lo, &hi) {
636            Ok(v) => v,
637            Err(_) => return envelope::error_answer_reply(ErrorCode::InputUnavailable, Some(&target.bound.fn_hash)),
638        };
639        vs.sort_by(|a, b| (&a.tx, &a.receipt_hash).cmp(&(&b.tx, &b.receipt_hash)));
640        let more = vs.len() > VERSIONS_PAGE;
641        vs.truncate(VERSIONS_PAGE);
642        let list: Vec<Value> = vs
643            .iter()
644            .map(|v| {
645                Value::Object(vec![
646                    ("asof".into(), Value::String(v.asof.clone())),
647                    ("receipt".into(), Value::String(v.receipt_hash.clone())),
648                    ("tx".into(), Value::String(v.tx.clone())),
649                ])
650            })
651            .collect();
652        let mut body = vec![("cell".to_string(), target.cell.to_value()), ("versions".to_string(), Value::Array(list))];
653        if more {
654            if let Some(last) = vs.last() {
655                let us = datumesh_formula::calendar::parse_instant(&last.tx).unwrap_or(0) + 1;
656                let next_from = datumesh_formula::calendar::instant_text(us).unwrap_or_default();
657                let mut next = format!("{}/versions/{cell_rest}", self.config.origin());
658                next.push(if cell_rest.contains('?') { '&' } else { '?' });
659                next.push_str(&format!("from={next_from}"));
660                if let Some(t) = &to {
661                    next.push_str(&format!("&to={t}"));
662                }
663                body.push(("next".to_string(), Value::String(next)));
664            }
665        }
666        Reply::json(200, Value::Object(body).to_jcs(), Cache::Public(self.config.ttl.latest_max_age.as_secs()))
667    }
668}
669
670/// The members of a slice.
671#[utoipa::path(get, path = "/slice/{cell}",
672    params(
673        ("cell" = String, Path, description = "A slice: a cell URI's rest or a call with `*` for open arguments, of a stored function; `?asof=`, `limit=` (JSON, default 1,000, at most 10,000), `after=` (the cursor of the previous page)."),
674    ),
675    responses(
676        (status = 200, description = "JSON page of members, or with `Accept: application/vnd.apache.arrow.stream` an Arrow IPC stream", content_type = "application/json"),
677        (status = 400, description = "`bad_request`", content_type = "application/json"),
678        (status = 404, description = "`not_covered`", content_type = "application/json"),
679    ))]
680async fn slice(State(mesh): State<Mesh>, uri: Uri, headers: HeaderMap, req: Request) -> Response {
681    let inner = mesh.inner.clone();
682    let (client, _) = match who(&inner, &headers, peer_of(&req)) {
683        Ok(x) => x,
684        Err(r) => return to_response(r),
685    };
686    if let Err(r) = admit(&inner, &client, 1) {
687        return to_response(r);
688    }
689    // One manifest path since spec-0.4.2: /manifest/<slice id>/<members hash>.
690    let rest = rest_of(&uri, "/slice/");
691    let arrow = accepts(&headers, crate::slice::ARROW);
692    let r = inner
693        .pool
694        .clone()
695        .run(move || {
696            let now = inner.now();
697            inner.slice(&rest, &now, arrow)
698        })
699        .await
700        .unwrap_or_else(|| envelope::error_reply(ErrorCode::EvalUnavailable));
701    to_response(r)
702}
703
704fn accepts(headers: &HeaderMap, media: &str) -> bool {
705    headers
706        .get_all(header::ACCEPT)
707        .iter()
708        .filter_map(|v| v.to_str().ok())
709        .any(|v| v.split(',').any(|p| p.split(';').next().unwrap_or("").trim() == media))
710}
711
712/// Whether the client takes JSON (no `Accept`, `*/*`, `application/*` or
713/// `application/json`); for slices also Arrow.
714fn acceptable(headers: &HeaderMap, also: Option<&str>) -> bool {
715    let vals: Vec<&str> = headers.get_all(header::ACCEPT).iter().filter_map(|v| v.to_str().ok()).collect();
716    if vals.is_empty() {
717        return true;
718    }
719    vals.iter().flat_map(|v| v.split(',')).any(|p| {
720        let mut parts = p.split(';');
721        let m = parts.next().unwrap_or("").trim();
722        let q0 = parts.any(|x| {
723            let x = x.trim();
724            x == "q=0" || x == "q=0.0" || x == "q=0.00" || x == "q=0.000"
725        });
726        !q0 && (m == "*/*" || m == "application/*" || m == JSON || also == Some(m))
727    })
728}
729
730async fn object(
731    inner: Arc<Inner>,
732    what: &'static str,
733    f: impl FnOnce(&Inner) -> Option<Vec<u8>> + Send + 'static,
734) -> Response {
735    let i2 = inner.clone();
736    match inner.pool.run(move || f(&i2)).await.flatten() {
737        Some(bytes) => {
738            let ct = if what == "blob" { "application/octet-stream" } else { JSON };
739            to_response(Reply {
740                status: 200,
741                body: bytes.into(),
742                content_type: ct,
743                cache: Cache::Immutable,
744                canonical: None,
745                retry_after: None,
746            })
747        }
748        None => not_found(what),
749    }
750}
751
752/// The refusal of a request by its client's rate limit (or key), if it is refused.
753fn ip_admit(inner: &Inner, headers: &HeaderMap, req: &Request) -> Option<Response> {
754    let client = match who(inner, headers, peer_of(req)) {
755        Ok((c, _)) => c,
756        Err(r) => return Some(to_response(r)),
757    };
758    admit(inner, &client, 1).err().map(to_response)
759}
760
761/// A receipt by its hash (canonical bytes; gzip when asked).
762#[utoipa::path(get, path = "/receipt/{hash}", params(("hash" = String, Path, description = "The receipt hash (SPEC 8.3).")),
763    responses((status = 200, description = "The receipt's canonical JSON; immutable", content_type = "application/json"), (status = 404, description = "Not held")))]
764async fn receipt(State(mesh): State<Mesh>, Path(hash): Path<String>, headers: HeaderMap, req: Request) -> Response {
765    if let Some(r) = ip_admit(&mesh.inner, &headers, &req) {
766        return r;
767    }
768    if lexical::check_hex(&hash, 64, "$").is_err() {
769        return not_found("receipt");
770    }
771    object(mesh.inner.clone(), "receipt", move |i| i.store.receipt(&hash).map(|c| c.into_owned())).await
772}
773
774/// A descriptor by its function hash.
775#[utoipa::path(get, path = "/descriptor/{hash}", params(("hash" = String, Path, description = "The function hash.")),
776    responses((status = 200, description = "The descriptor's canonical JSON; immutable", content_type = "application/json"), (status = 404, description = "Not held")))]
777async fn descriptor(State(mesh): State<Mesh>, Path(hash): Path<String>, headers: HeaderMap, req: Request) -> Response {
778    if let Some(r) = ip_admit(&mesh.inner, &headers, &req) {
779        return r;
780    }
781    if lexical::check_hex(&hash, 64, "$").is_err() {
782        return not_found("descriptor");
783    }
784    object(mesh.inner.clone(), "descriptor", move |i| i.store.descriptor(&hash).map(|c| c.into_owned())).await
785}
786
787async fn manifest_of(inner: Arc<Inner>, entry: String) -> Response {
788    object(inner, "manifest", move |i| i.store.manifest(&entry).map(|c| c.into_owned())).await
789}
790
791/// A slice manifest (SPEC 15.13), by its entry's slice id and members hash.
792#[utoipa::path(get, path = "/manifest/{slice_id}/{members_hash}",
793    params(("slice_id" = String, Path, description = "The slice id."), ("members_hash" = String, Path, description = "The members hash.")),
794    responses((status = 200, description = "The manifest's canonical JSON; immutable", content_type = "application/json"), (status = 404, description = "Not held")))]
795async fn manifest(
796    State(mesh): State<Mesh>,
797    Path((slice_id, members)): Path<(String, String)>,
798    headers: HeaderMap,
799    req: Request,
800) -> Response {
801    if let Some(r) = ip_admit(&mesh.inner, &headers, &req) {
802        return r;
803    }
804    if lexical::check_hex(&slice_id, 64, "$").is_err() || lexical::check_hex(&members, 64, "$").is_err() {
805        return not_found("manifest");
806    }
807    manifest_of(mesh.inner.clone(), format!("slice:{slice_id}:{members}")).await
808}
809
810/// Blob content by SHA-256.
811#[utoipa::path(get, path = "/blob/{sha256}", params(("sha256" = String, Path, description = "The content's SHA-256.")),
812    responses((status = 200, description = "The bytes; immutable", content_type = "application/octet-stream"), (status = 404, description = "Not held")))]
813async fn blob(State(mesh): State<Mesh>, Path(sha): Path<String>, headers: HeaderMap, req: Request) -> Response {
814    if let Some(r) = ip_admit(&mesh.inner, &headers, &req) {
815        return r;
816    }
817    if lexical::check_hex(&sha, 64, "$").is_err() {
818        return not_found("blob");
819    }
820    object(mesh.inner.clone(), "blob", move |i| i.store.blob(&sha).ok().flatten().map(|c| c.into_owned())).await
821}
822
823/// A cell's lineage as nested envelopes.
824#[utoipa::path(get, path = "/explain/{cell}",
825    params(("cell" = String, Path, description = "As for /cell; `depth=` (default 4, at most 16) bounds the walk.")),
826    responses(
827        (status = 200, description = "`{\"envelope\", \"inputs\": [{\"entry\", \"envelope\", \"inputs\"} | {\"entry\", \"slice\", \"members\"}], \"truncated\"}`", content_type = "application/json"),
828        (status = 202, description = "`pending`: the cell is being computed; ask again", content_type = "application/json"),
829        (status = 400, description = "`bad_request`", content_type = "application/json"),
830        (status = 404, description = "`not_covered`", content_type = "application/json"),
831    ))]
832async fn explain(State(mesh): State<Mesh>, uri: Uri, headers: HeaderMap, req: Request) -> Response {
833    let inner = mesh.inner.clone();
834    let (client, principal) = match who(&inner, &headers, peer_of(&req)) {
835        Ok(x) => x,
836        Err(r) => return to_response(r),
837    };
838    if let Err(r) = admit(&inner, &client, 1) {
839        return to_response(r);
840    }
841    let mut rest = rest_of(&uri, "/explain/");
842    let mut depth = inner.config.explain_depth;
843    // `depth=` is the explain's own parameter: taken off the query.
844    if let Some((p, q)) = rest.clone().split_once('?') {
845        let kept: Vec<&str> = q.split('&').filter(|x| !x.starts_with("depth=")).collect();
846        if let Some(d) = q.split('&').find_map(|x| x.strip_prefix("depth=")) {
847            depth = d.parse::<usize>().unwrap_or(depth);
848        }
849        rest = if kept.is_empty() { p.to_string() } else { format!("{p}?{}", kept.join("&")) };
850    }
851    let depth = depth.min(16);
852    let r = within_budget(inner, move |i, on| {
853        let now = i.now();
854        let r = i.answer(&rest, principal.as_ref(), i, &now, on);
855        if r.status != 200 {
856            return r;
857        }
858        let env = json::parse(&r.body).unwrap_or(Value::Null);
859        let mut budget = 2_000usize;
860        let v = i.explain_node(env, depth, &mut budget);
861        Reply::json(200, v.to_jcs(), Cache::NoStore)
862    })
863    .await;
864    to_response(r)
865}
866
867impl Inner {
868    /// An envelope with its inputs' envelopes, `depth` levels down, at most `budget` nodes.
869    fn explain_node(&self, envelope: Value, depth: usize, budget: &mut usize) -> Value {
870        let inputs: Vec<String> = envelope
871            .get("receipt")
872            .and_then(|r| r.get("inputs"))
873            .and_then(|i| {
874                if let Value::Array(a) = i {
875                    Some(a.iter().filter_map(Value::as_str).map(str::to_string).collect())
876                } else {
877                    None
878                }
879            })
880            .unwrap_or_default();
881        let mut truncated = false;
882        let mut out = Vec::new();
883        for e in inputs {
884            if depth == 0 || *budget == 0 {
885                truncated = true;
886                break;
887            }
888            *budget -= 1;
889            if e.starts_with("slice:") {
890                let m = self.store.manifest(&e).and_then(|m| datumesh_core::Manifest::from_json(&m).ok());
891                let mut node = vec![("entry".to_string(), Value::String(e.clone()))];
892                if let Some(m) = m {
893                    node.push(("members".to_string(), envelope::num(m.members().len() as u64)));
894                    node.push(("slice".to_string(), m.slice().to_value()));
895                }
896                out.push(Value::Object(node));
897                continue;
898            }
899            let child = match self.receipt_info_by_hash(&e) {
900                Some(info) => self.explain_node(json::parse(&info.ok).unwrap_or(Value::Null), depth - 1, budget),
901                None => json::parse(&envelope::not_covered(None)).unwrap_or(Value::Null),
902            };
903            let mut node = vec![("entry".to_string(), Value::String(e.clone()))];
904            if let Value::Object(m) = child {
905                node.extend(m);
906            }
907            out.push(Value::Object(node));
908        }
909        let mut node = vec![("envelope".to_string(), envelope.clone()), ("inputs".to_string(), Value::Array(out))];
910        node.push(("truncated".to_string(), Value::Bool(truncated)));
911        Value::Object(node)
912    }
913}
914
915#[derive(serde::Deserialize)]
916struct FindQuery {
917    q: Option<String>,
918    limit: Option<usize>,
919    summary: Option<String>,
920}
921
922/// The hybrid `/find` (CONTRACT-build2-part2-read R3; see `crate::find`), and `/find?summary=1`.
923#[utoipa::path(get, path = "/find",
924    params(("q" = Option<String>, Query, description = "The query: words, a name, a label, an alias or a value, or a request such as `<book> <chapter>:<verse>`. Matching is case-insensitive after NFC."), ("limit" = Option<usize>, Query, description = "At most this many results (default 10, at most 50)."), ("summary" = Option<String>, Query, description = "`1`: the catalogue summary (`classes`, `functions`, with labels, cell counts and small dictionaries) instead of results.")),
925    responses((status = 200, description = "`{\"query\", \"vector\": bool, \"results\": [...], \"resolution\"?: {...}}`. Each result has `kind` (`function`, `method` or `class`), `name`, `label`, `description`, `call` (the template with typed placeholders, or the filled call of a resolved request), `match` (`exact`, `text` or `vector`), `score`, and the members of its kind (`descriptor`, `fn_hash`, `since`; a class has `class_hash` and `methods`; a method has `class`). `resolution` has `status` `exact` (`call`, `label`), `ambiguous` (`candidates`, `keys`) or `range` (`error`: `E_RANGE_REFUSED`).", content_type = "application/json")))]
926async fn find(State(mesh): State<Mesh>, Query(q): Query<FindQuery>, headers: HeaderMap, req: Request) -> Response {
927    if let Some(r) = ip_admit(&mesh.inner, &headers, &req) {
928        return r;
929    }
930    let inner = mesh.inner.clone();
931    let query = q.q.unwrap_or_default();
932    let limit = q.limit.unwrap_or(crate::find::DEFAULT_LIMIT).clamp(1, crate::find::MAX_LIMIT);
933    let summary = q.summary.as_deref() == Some("1");
934    let r = inner
935        .pool
936        .clone()
937        .run(move || if summary { crate::find::summary(&inner) } else { crate::find::answer(&inner, &query, limit) })
938        .await
939        .unwrap_or(Value::Null);
940    plain_json(200, r, Cache::Public(60))
941}
942
943#[derive(serde::Deserialize)]
944struct VerifyQuery {
945    level: Option<String>,
946    blob: Option<String>,
947    form: Option<String>,
948}
949
950/// Verification as a service: the core verifier on a submitted receipt, with this mesh's
951/// keys; free, unauthenticated, rate-limited per IP.
952#[utoipa::path(post, path = "/verify",
953    params(("level" = Option<String>, Query, description = "`recomputed` (default: recompute with the engine as the resolver) or `signed` (steps 1-6)."), ("blob" = Option<String>, Query, description = "Blob content for step 7.7, as hex (at most 1 MiB)."), ("form" = Option<String>, Query, description = "`offered`: the body is `{\"receipt\": <its JSON text>, \"recompute\"?: <SPEC 11's recompute object>, \"blob_hex\"?}` and step 7 uses what is offered instead of this mesh's engine.")),
954    request_body(content = String, description = "The receipt's JSON text, exactly as received (or the offered form).", content_type = "application/json"),
955    responses(
956        (status = 200, description = "`{\"ok\", \"level\", \"code\", \"hash\", \"computed_by\", \"path\", \"detail\", \"blob_checked\"}`", content_type = "application/json"),
957        (status = 429, description = "`rate_limited`", content_type = "application/json"),
958    ))]
959async fn verify_receipt(
960    State(mesh): State<Mesh>,
961    Query(q): Query<VerifyQuery>,
962    headers: HeaderMap,
963    req: Request,
964) -> Response {
965    let inner = mesh.inner.clone();
966    let ip = client_ip(&inner, &headers, peer_of(&req));
967    if let Err(s) = inner.limiter.admit_verify(ip) {
968        return to_response(envelope::rate_limited_reply(s));
969    }
970    let body: Bytes = match axum::body::to_bytes(req.into_body(), 4 << 20).await {
971        Ok(b) => b,
972        Err(_) => return batch_error("body too large"),
973    };
974    if q.form.as_deref() == Some("offered") {
975        let Ok(v) = json::parse(&body) else { return batch_error("form=offered: not strict JSON") };
976        let Some(receipt) = v.get("receipt").and_then(Value::as_str).map(|s| s.as_bytes().to_vec()) else {
977            return batch_error("form=offered: no receipt text");
978        };
979        let blob = match v.get("blob_hex").and_then(Value::as_str).map(hex) {
980            None => None,
981            Some(Some(b)) if b.len() <= 1 << 20 => Some(b),
982            Some(_) => return batch_error("blob_hex: hex of at most 1 MiB"),
983        };
984        let m = mesh.clone();
985        let rc = v.get("recompute").cloned();
986        let r = inner.pool.run(move || m.verify_offered(&receipt, rc.as_ref(), blob.as_deref())).await;
987        return match r {
988            Some(v) => to_response(Reply::json(200, v.body, Cache::NoStore)),
989            None => to_response(envelope::error_reply(ErrorCode::EvalUnavailable)),
990        };
991    }
992    let signed = q.level.as_deref() == Some("signed");
993    let blob = match q.blob.as_deref().map(hex) {
994        None => None,
995        Some(Some(b)) if b.len() <= 1 << 20 => Some(b),
996        Some(_) => return batch_error("blob: hex of at most 1 MiB"),
997    };
998    let m = mesh.clone();
999    let r = inner.pool.run(move || m.verify(&body, signed, blob.as_deref())).await;
1000    match r {
1001        Some(v) => to_response(Reply::json(200, v.body, Cache::NoStore)),
1002        None => to_response(envelope::error_reply(ErrorCode::EvalUnavailable)),
1003    }
1004}
1005
1006fn hex(s: &str) -> Option<Vec<u8>> {
1007    if !s.len().is_multiple_of(2) {
1008        return None;
1009    }
1010    (0..s.len()).step_by(2).map(|i| u8::from_str_radix(s.get(i..i + 2)?, 16).ok()).collect()
1011}
1012
1013/// A job: `pending` again while it runs, then the envelope of the original request.
1014#[utoipa::path(get, path = "/jobs/{job}", params(("job" = String, Path, description = "The job id of a `pending` envelope.")),
1015    responses(
1016        (status = 202, description = "`pending`, the same job and request", content_type = "application/json"),
1017        (status = 400, description = "`bad_request` with `E_JOB_UNKNOWN`: unknown or expired", content_type = "application/json"),
1018        (status = 200, description = "The completed envelope (any outcome but pending, with its status), bound to the original request", content_type = "application/json"),
1019    ))]
1020async fn job(State(mesh): State<Mesh>, Path(id): Path<String>, headers: HeaderMap, req: Request) -> Response {
1021    let inner = mesh.inner.clone();
1022    let (client, _) = match who(&inner, &headers, peer_of(&req)) {
1023        Ok(x) => x,
1024        Err(r) => return to_response(r),
1025    };
1026    if let Err(r) = admit(&inner, &client, 1) {
1027        return to_response(r);
1028    }
1029    let unknown = || to_response(Reply::json(400, envelope::bad_request(ErrorCode::JobUnknown), Cache::NoStore));
1030    let valid = (32..=64).contains(&id.len()) && id.bytes().all(|b| b.is_ascii_digit() || (b'a'..=b'f').contains(&b));
1031    if !valid {
1032        return unknown();
1033    }
1034    match inner.jobs.poll(&id) {
1035        Poll::Unknown => unknown(),
1036        Poll::Done(r) => to_response(r),
1037        Poll::Running(request, elapsed) => {
1038            let poll = format!("{}/jobs/{id}", inner.config.origin());
1039            match Pending::new(&id, inner.jobs.estimate(elapsed), &poll, request) {
1040                Ok(p) => to_response(Reply::json(202, envelope::pending(&p), Cache::NoStore)),
1041                Err(_) => to_response(envelope::error_reply(ErrorCode::EvalUnavailable)),
1042            }
1043        }
1044    }
1045}
1046
1047/// The key document (SPEC 9.2): the store's namespace record for this mesh's host.
1048#[utoipa::path(get, path = "/.well-known/datumesh.json", responses((status = 200, description = "The key document", content_type = "application/json"), (status = 404, description = "None stored")))]
1049async fn key_document(State(mesh): State<Mesh>) -> Response {
1050    let m = mesh.clone();
1051    match mesh.inner.pool.run(move || m.key_document()).await.flatten() {
1052        Some(doc) => to_response(Reply::json(200, doc, Cache::Public(300))),
1053        None => not_found("key document"),
1054    }
1055}
1056
1057/// The mesh document (SPEC 9.6).
1058#[utoipa::path(get, path = "/.well-known/datumesh-mesh.json", responses((status = 200, description = "The mesh document", content_type = "application/json")))]
1059async fn mesh_document(State(mesh): State<Mesh>) -> Response {
1060    to_response(Reply::json(200, mesh.mesh_document(), Cache::Public(300)))
1061}
1062
1063/// Which function each name denotes as of an instant (SPEC 9.7).
1064#[utoipa::path(get, path = "/bindings",
1065    params(("name" = String, Query, description = "A function name, percent-encoded as in SPEC 5.1; repeat for several."), ("asof" = Option<String>, Query, description = "An instant (default: now).")),
1066    responses((status = 200, description = "`{\"asof\", \"bindings\": {name: {\"fn_hash\", \"since\"}}}`", content_type = "application/json"), (status = 400, description = "A malformed name or asof", content_type = "application/json")))]
1067async fn bindings(State(mesh): State<Mesh>, uri: Uri, headers: HeaderMap, req: Request) -> Response {
1068    if let Some(r) = ip_admit(&mesh.inner, &headers, &req) {
1069        return r;
1070    }
1071    let inner = mesh.inner.clone();
1072    let mut names = Vec::new();
1073    let mut asof = None;
1074    for p in uri.query().unwrap_or("").split('&').filter(|p| !p.is_empty()) {
1075        let (k, v) = p.split_once('=').unwrap_or((p, ""));
1076        let Some(v) = pct_decode(v) else { return batch_error("percent-encoding (SPEC 5.1)") };
1077        match k {
1078            "name" if lexical::check_function_name(&v, "$").is_ok() => names.push(v),
1079            "asof" if lexical::check_instant(&v, "$").is_ok() && asof.is_none() => asof = Some(v),
1080            _ => return batch_error(&format!("parameter {k}")),
1081        }
1082    }
1083    let r = inner
1084        .pool
1085        .clone()
1086        .run(move || {
1087            let at = asof.unwrap_or_else(|| inner.now());
1088            let mut out = Vec::new();
1089            for n in names {
1090                if !inner.config.owns(crate::foreign::host_of(&n)) {
1091                    continue;
1092                }
1093                // A class name is answered with its class hash (9.7, spec-0.5.0); any other name
1094                // with the function it means.
1095                let found = match inner.store.resolve_class_binding(&n, &at) {
1096                    Ok(Some(c)) => ("class_hash", c.class_hash, c.tx),
1097                    Ok(None) => match inner.store.resolve_binding(&n, &at) {
1098                        Ok(Some(b)) => ("fn_hash", b.fn_hash, b.tx),
1099                        Ok(None) => continue,
1100                        Err(_) => return None,
1101                    },
1102                    Err(_) => return None,
1103                };
1104                out.push((
1105                    n,
1106                    Value::Object(vec![
1107                        (found.0.into(), Value::String(found.1)),
1108                        ("since".into(), Value::String(found.2)),
1109                    ]),
1110                ));
1111            }
1112            Some(Value::Object(vec![("asof".into(), Value::String(at)), ("bindings".into(), Value::Object(out))]))
1113        })
1114        .await
1115        .flatten();
1116    match r {
1117        Some(v) => plain_json(200, v, Cache::Public(inner_latest(&mesh))),
1118        None => to_response(envelope::error_reply(ErrorCode::InputUnavailable)),
1119    }
1120}
1121
1122fn inner_latest(mesh: &Mesh) -> u64 {
1123    mesh.inner.config.ttl.latest_max_age.as_secs()
1124}
1125
1126/// Strict percent-decoding (SPEC 5.1): literal characters as themselves, `%` and two
1127/// uppercase hex digits for other bytes, UTF-8.
1128fn pct_decode(s: &str) -> Option<String> {
1129    let b = s.as_bytes();
1130    let mut out = Vec::new();
1131    let mut i = 0;
1132    while i < b.len() {
1133        let c = b[i];
1134        if c == b'%' {
1135            let h = b.get(i + 1..i + 3)?;
1136            if !h.iter().all(|x| x.is_ascii_digit() || (b'A'..=b'F').contains(x)) {
1137                return None;
1138            }
1139            let v = u8::from_str_radix(std::str::from_utf8(h).ok()?, 16).ok()?;
1140            if v.is_ascii_alphanumeric() || matches!(v, b'-' | b'.' | b'_' | b'~' | b':') {
1141                return None;
1142            }
1143            out.push(v);
1144            i += 3;
1145        } else if c.is_ascii_alphanumeric() || matches!(c, b'-' | b'.' | b'_' | b'~' | b':') {
1146            out.push(c);
1147            i += 1;
1148        } else {
1149            return None;
1150        }
1151    }
1152    String::from_utf8(out).ok()
1153}
1154
1155/// Liveness and the store's health.
1156#[utoipa::path(get, path = "/health", responses((status = 200, description = "`{\"status\": \"ok\"}`", content_type = "application/json"), (status = 503, description = "The store does not answer", content_type = "application/json")))]
1157async fn health(State(mesh): State<Mesh>) -> Response {
1158    let m = mesh.clone();
1159    let ok = tokio::time::timeout(
1160        Duration::from_secs(5),
1161        mesh.inner.pool.run(move || m.inner.store.namespace(&m.inner.config.host).is_ok()),
1162    )
1163    .await
1164    .ok()
1165    .flatten()
1166    .unwrap_or(false);
1167    let v = Value::Object(vec![("status".into(), Value::String(if ok { "ok" } else { "store unavailable" }.into()))]);
1168    plain_json(if ok { 200 } else { 503 }, v, Cache::NoStore)
1169}
1170
1171/// Prometheus metrics.
1172#[utoipa::path(get, path = "/metrics", responses((status = 200, description = "Prometheus text", content_type = "text/plain")))]
1173async fn metrics(State(mesh): State<Mesh>) -> Response {
1174    let mut r = Reply::json(200, metrics_text(&mesh.inner).into_bytes(), Cache::NoStore);
1175    r.content_type = "text/plain; version=0.0.4";
1176    to_response(r)
1177}
1178
1179/// This document.
1180#[utoipa::path(get, path = "/openapi.json", responses((status = 200, description = "The OpenAPI document", content_type = "application/json")))]
1181async fn openapi_json() -> Response {
1182    let mut r = Reply::json(200, openapi().to_json().unwrap_or_default().into_bytes(), Cache::Public(300));
1183    r.content_type = JSON;
1184    to_response(r)
1185}
1186
1187pub(crate) fn metrics_text(inner: &Inner) -> String {
1188    use std::fmt::Write;
1189    use std::sync::atomic::Ordering::Relaxed;
1190    let mut out = String::new();
1191    inner.metrics.write(&mut out);
1192    let p = &inner.pool;
1193    let g = |out: &mut String, name: &str, help: &str, kind: &str, v: String| {
1194        let _ = writeln!(out, "# HELP {name} {help}\n# TYPE {name} {kind}\n{name} {v}");
1195    };
1196    g(&mut out, "datumesh_pool_size", "The blocking pool's size: the concurrency limit.", "gauge", p.size.to_string());
1197    g(&mut out, "datumesh_pool_in_use", "Pool threads busy now.", "gauge", p.in_use.load(Relaxed).to_string());
1198    g(&mut out, "datumesh_pool_peak", "The most pool threads busy at once.", "gauge", p.peak.load(Relaxed).to_string());
1199    g(&mut out, "datumesh_pool_runs_total", "Tasks run on the pool.", "counter", p.runs.load(Relaxed).to_string());
1200    g(
1201        &mut out,
1202        "datumesh_pool_waited_total",
1203        "Tasks that found the pool saturated and waited for a thread.",
1204        "counter",
1205        p.waited.load(Relaxed).to_string(),
1206    );
1207    let (held, running) = inner.jobs.counts();
1208    g(&mut out, "datumesh_jobs_held", "Jobs held (running or done).", "gauge", held.to_string());
1209    g(&mut out, "datumesh_jobs_running", "Jobs running.", "gauge", running.to_string());
1210    g(
1211        &mut out,
1212        "datumesh_jobs_created_total",
1213        "Requests answered pending.",
1214        "counter",
1215        inner.jobs.created.load(Relaxed).to_string(),
1216    );
1217    g(
1218        &mut out,
1219        "datumesh_rate_limited_total",
1220        "Requests refused by a rate limit.",
1221        "counter",
1222        inner.limiter.refused.load(Relaxed).to_string(),
1223    );
1224    g(
1225        &mut out,
1226        "datumesh_peer_fetches_total",
1227        "Requests to other meshes.",
1228        "counter",
1229        inner.foreign.fetches.load(Relaxed).to_string(),
1230    );
1231    g(
1232        &mut out,
1233        "datumesh_peer_failures_total",
1234        "Requests to other meshes that failed.",
1235        "counter",
1236        inner.foreign.failures.load(Relaxed).to_string(),
1237    );
1238    g(
1239        &mut out,
1240        "datumesh_peer_imported_total",
1241        "Foreign versions imported into the store.",
1242        "counter",
1243        inner.foreign.imported.load(Relaxed).to_string(),
1244    );
1245    let m = inner.engine.memo_stats();
1246    g(&mut out, "datumesh_memo_entries", "Engine memo entries.", "gauge", m.entries.to_string());
1247    g(&mut out, "datumesh_memo_bytes", "Engine memo size, approximately.", "gauge", m.approx_bytes.to_string());
1248    g(
1249        &mut out,
1250        "datumesh_uptime_seconds",
1251        "Seconds since the mesh started.",
1252        "gauge",
1253        inner.started.elapsed().as_secs().to_string(),
1254    );
1255    out
1256}
1257
1258/// Request ids, the access log, metrics and `Accept`.
1259async fn around(State(mesh): State<Mesh>, req: Request, next: Next) -> Response {
1260    let start = Instant::now();
1261    let route = req.extensions().get::<MatchedPath>().map(|m| m.as_str().to_string()).unwrap_or_else(|| "other".into());
1262    let route = match route.as_str() {
1263        "/cell/{*rest}" => "/cell/{cell}".to_string(),
1264        "/slice/{*rest}" => "/slice/{cell}".to_string(),
1265        "/explain/{*rest}" => "/explain/{cell}".to_string(),
1266        "/versions/{*rest}" => "/versions/{cell}".to_string(),
1267        "/fn/{*name}" => "/fn/{name}".to_string(),
1268        _ => route,
1269    };
1270    let id = req
1271        .headers()
1272        .get("x-request-id")
1273        .and_then(|v| v.to_str().ok())
1274        .filter(|s| !s.is_empty() && s.len() <= 64 && s.bytes().all(|b| b.is_ascii_alphanumeric() || b == b'-'))
1275        .map(str::to_string)
1276        .unwrap_or_else(|| {
1277            let mut b = [0u8; 8];
1278            let _ = getrandom::fill(&mut b);
1279            lexical::to_hex(&b)
1280        });
1281    let ip = client_ip(&mesh.inner, req.headers(), peer_of(&req));
1282    let method = req.method().clone();
1283    let also = if route == "/slice/{cell}" { Some(crate::slice::ARROW) } else { None };
1284    // The function page is HTML for people (Build 2 Part 4, P2) as well as JSON for agents.
1285    let html_ok = route == "/fn/{name}" && accepts(req.headers(), "text/html");
1286    let mut resp = if route != "/blob/{sha256}" && route != "/metrics" && !html_ok && !acceptable(req.headers(), also) {
1287        let mut r = Reply::json(
1288            406,
1289            Value::Object(vec![("error".into(), Value::String("not acceptable: application/json only".into()))])
1290                .to_jcs(),
1291            Cache::NoStore,
1292        );
1293        r.content_type = JSON;
1294        to_response(r)
1295    } else {
1296        next.run(req).instrument(tracing::info_span!("request", request_id = %id)).await
1297    };
1298    let elapsed = start.elapsed();
1299    let status = resp.status().as_u16();
1300    mesh.inner.metrics.record(&route, status, elapsed);
1301    let principal = resp.extensions().get::<Who>().and_then(|w| w.0.clone());
1302    tracing::info!(target: "datumesh_http::access", request_id = %id, %method, route = %route, status, ms = elapsed.as_secs_f64() * 1000.0, ip = %ip, principal = principal.as_deref().unwrap_or("-"), "request");
1303    if let Ok(v) = HeaderValue::from_str(&id) {
1304        resp.headers_mut().insert("x-request-id", v);
1305    }
1306    resp.headers_mut().insert(header::VARY, HeaderValue::from_static("Accept, Accept-Encoding, Authorization"));
1307    if let Ok(v) = HeaderValue::from_str(&format!("app;dur={:.3}", elapsed.as_secs_f64() * 1000.0)) {
1308        resp.headers_mut().insert("server-timing", v);
1309    }
1310    resp
1311}
1312
1313/// describe (SPEC 16.8): a class or an object, by class name, key encoding, object id, cell id or
1314/// short id (`{id}`, percent-encoded as a path). A class's method table gives each method its
1315/// `description` from the catalog entry `{class}/{method}` when that is 1 to 1,024 bytes.
1316/// `POST /whatif` (spec-0.6.0, 5.9): the scenario of a cell under overrides, labelled a scenario,
1317/// never a fact.
1318#[utoipa::path(post, path = "/whatif",
1319    request_body(content = String, description = "The JSON of 5.9: `cell`, `asof`?, `overrides`, `solve`?", content_type = "application/json"),
1320    responses(
1321        (status = 200, description = "`scenario`: `{asof, cell, overrides, type, value[, solved]}`, no receipt", content_type = "application/json"),
1322        (status = 400, description = "`bad_request`", content_type = "application/json"),
1323        (status = 404, description = "`not_covered`, with `fault` when the scenario faulted or has no solution", content_type = "application/json"),
1324        (status = 500, description = "`error`", content_type = "application/json"),
1325    ))]
1326async fn whatif(State(mesh): State<Mesh>, headers: HeaderMap, req: Request) -> Response {
1327    let inner = mesh.inner.clone();
1328    let peer = peer_of(&req);
1329    let (client, principal) = match who(&inner, &headers, peer) {
1330        Ok(x) => x,
1331        Err(r) => return to_response(r),
1332    };
1333    if let Err(r) = admit(&inner, &client, 1) {
1334        return to_response(r);
1335    }
1336    let body = match axum::body::to_bytes(req.into_body(), 1 << 20).await {
1337        Ok(b) => b,
1338        Err(_) => return to_response(envelope::bad_request_reply(ErrorCode::CanonLimit)),
1339    };
1340    let mesh2 = mesh.clone();
1341    match inner.pool.clone().run(move || mesh2.whatif(&body, principal.as_ref())).await {
1342        Some(r) => to_response(r),
1343        None => to_response(envelope::error_reply(ErrorCode::EvalUnavailable)),
1344    }
1345}
1346
1347#[utoipa::path(get, path = "/describe/{id}",
1348    params(("id" = String, Path, description = "A class name, an object's key encoding, an object id, a cell id or a short id (12 hex digits).")),
1349    responses((status = 200, description = "A describe-class or describe-object document (SPEC 16.8)", content_type = "application/json"), (status = 400, description = "`E_KEY_ENCODING`, `E_KEY_NORMALISATION` or `E_SHORT_ID_AMBIGUOUS`", content_type = "application/json"), (status = 404, description = "An id the mesh does not know", content_type = "application/json")))]
1350async fn describe(State(mesh): State<Mesh>, uri: Uri, headers: HeaderMap, req: Request) -> Response {
1351    if let Some(r) = ip_admit(&mesh.inner, &headers, &req) {
1352        return r;
1353    }
1354    let Some(id) = crate::call::url_decode(uri.path().strip_prefix("/describe/").unwrap_or("")) else {
1355        return to_response(envelope::bad_request_reply(ErrorCode::CanonPercent));
1356    };
1357    let inner = mesh.inner.clone();
1358    match inner.pool.clone().run(move || mesh.describe(&id)).await {
1359        Some(r) => {
1360            // A function's page is named by a `Link` header, not a member of the answer (16.8 is
1361            // checked strictly by core; Build 2 Part 4, P2).
1362            let link = function_describe_link(&inner, &r);
1363            let mut resp = to_response(r);
1364            if let Some(v) = link.and_then(|l| HeaderValue::from_str(&l).ok()) {
1365                resp.headers_mut().insert(header::LINK, v);
1366            }
1367            resp
1368        }
1369        None => to_response(envelope::error_reply(ErrorCode::EvalUnavailable)),
1370    }
1371}
1372
1373/// The `Link` header of a describe answer for a function: its page, `rel="describedby"`.
1374fn function_describe_link(inner: &Inner, r: &Reply) -> Option<String> {
1375    if r.status != 200 {
1376        return None;
1377    }
1378    let v = json::parse(&r.body).ok()?;
1379    if v.get("kind")?.as_str()? != "function" {
1380        return None;
1381    }
1382    let name = v.get("fn")?.as_str()?;
1383    Some(format!("<{}>; rel=\"describedby\"", crate::fnpage::page_url(inner, name)))
1384}
1385
1386/// `POST /bundles` (Build 2 Part 4, P1): a publisher's bundle, checked and imported (see `bundles`).
1387async fn bundles(State(mesh): State<Mesh>, req: Request) -> Response {
1388    to_response(crate::bundles::post(mesh.inner.clone(), req.into_body()).await)
1389}
1390
1391/// `GET /fn/<name>` (Build 2 Part 4, P2): the function page, HTML or, by `Accept` or `?format=json`,
1392/// the same data as JSON.
1393async fn function_page(
1394    State(mesh): State<Mesh>,
1395    Path(name): Path<String>,
1396    uri: Uri,
1397    headers: HeaderMap,
1398    req: Request,
1399) -> Response {
1400    if let Some(r) = ip_admit(&mesh.inner, &headers, &req) {
1401        return r;
1402    }
1403    let format_json = uri.query().is_some_and(|q| q.split('&').any(|p| p == "format=json"));
1404    let json_form = format_json || (accepts(&headers, JSON) && !accepts(&headers, "text/html"));
1405    let inner = mesh.inner.clone();
1406    match inner.pool.clone().run(move || crate::fnpage::respond(&mesh.inner, &name, json_form)).await {
1407        Some(r) => to_response(r),
1408        None => to_response(envelope::error_reply(ErrorCode::EvalUnavailable)),
1409    }
1410}
1411
1412async fn fallback() -> Response {
1413    not_found("endpoint")
1414}
1415
1416impl Mesh {
1417    /// The router of every endpoint. Serve it with
1418    /// `into_make_service_with_connect_info::<SocketAddr>()` (the client IP comes from it).
1419    pub fn router(&self) -> Router {
1420        Router::new()
1421            .route("/cell/{*rest}", get(cell))
1422            .route("/cells", post(cells))
1423            .route("/slice/{*rest}", get(slice))
1424            .route("/receipt/{hash}", get(receipt))
1425            .route("/descriptor/{hash}", get(descriptor))
1426            .route("/manifest/{slice_id}/{members_hash}", get(manifest))
1427            .route("/versions/{*rest}", get(versions))
1428            .route("/blob/{sha256}", get(blob))
1429            .route("/explain/{*rest}", get(explain))
1430            .route("/find", get(find))
1431            .route("/verify", post(verify_receipt))
1432            .route("/jobs/{job}", get(job))
1433            .route("/.well-known/datumesh.json", get(key_document))
1434            .route("/.well-known/datumesh-mesh.json", get(mesh_document))
1435            .route("/bindings", get(bindings))
1436            .route("/describe/{*id}", get(describe))
1437            .route("/fn/{*name}", get(function_page))
1438            .route("/bundles", post(bundles))
1439            .route("/whatif", post(whatif))
1440            .route("/health", get(health))
1441            .route("/metrics", get(metrics))
1442            .route("/openapi.json", get(openapi_json))
1443            .fallback(fallback)
1444            .layer(middleware::from_fn_with_state(self.clone(), around))
1445            .layer(tower_http::compression::CompressionLayer::new().gzip(true))
1446            .with_state(self.clone())
1447    }
1448
1449    /// Serves the router on `listener` until `shutdown` resolves.
1450    pub async fn serve(
1451        &self,
1452        listener: tokio::net::TcpListener,
1453        shutdown: impl std::future::Future<Output = ()> + Send + 'static,
1454    ) -> std::io::Result<()> {
1455        axum::serve(listener, self.router().into_make_service_with_connect_info::<SocketAddr>())
1456            .with_graceful_shutdown(shutdown)
1457            .await
1458    }
1459}
1460
1461impl IntoResponse for Reply {
1462    fn into_response(self) -> Response {
1463        to_response(self)
1464    }
1465}
1466
1467#[cfg(test)]
1468mod tests {
1469    use super::*;
1470
1471    fn reply(status: u16, body: &str) -> Reply {
1472        Reply::json(status, body.as_bytes().to_vec(), Cache::NoStore)
1473    }
1474
1475    /// The runs the chunks write, concatenated and closed, are the batch as 5.7 writes it, and
1476    /// count its outcomes.
1477    #[test]
1478    fn runs_make_the_batch() {
1479        let h = "a".repeat(64);
1480        let replies = [
1481            reply(200, &format!(r#"{{"fn_hash":"{h}","outcome":"ok","receipt":{{"value":"1"}},"trust":"primary"}}"#)),
1482            reply(400, r#"{"error":"E_CANON_NUMBER","outcome":"bad_request"}"#),
1483            reply(
1484                200,
1485                &format!(r#"{{"age_seconds":3,"fn_hash":"{h}","outcome":"stale","receipt":{{}},"trust":"computed"}}"#),
1486            ),
1487            reply(404, r#"{"error":"E_NAME_UNBOUND","outcome":"not_covered"}"#),
1488            reply(200, &format!(r#"{{"fn_hash":"{h}","outcome":"ok","receipt":{{"value":"2"}},"trust":"primary"}}"#)),
1489        ];
1490        let mut want = b"[".to_vec();
1491        for (i, r) in replies.iter().enumerate() {
1492            if i > 0 {
1493                want.push(b',');
1494            }
1495            want.extend_from_slice(b"{\"envelope\":");
1496            want.extend_from_slice(&r.body);
1497            want.extend_from_slice(format!(",\"status\":{}}}", r.status).as_bytes());
1498        }
1499        want.push(b']');
1500        for split in 1..replies.len() {
1501            let runs = [Written::of(true, replies[..split].iter()), Written::of(false, replies[split..].iter())];
1502            let mut got: Vec<u8> = runs.iter().flat_map(|w| w.bytes.iter().copied()).collect();
1503            got.push(b']');
1504            assert_eq!(String::from_utf8(got).unwrap(), String::from_utf8(want.clone()).unwrap());
1505            let mut counts = std::collections::BTreeMap::new();
1506            for (o, k) in runs.iter().flat_map(|w| w.outcomes.iter()) {
1507                *counts.entry(o.as_str()).or_insert(0) += k;
1508            }
1509            let want_counts: std::collections::BTreeMap<&str, u64> =
1510                [("bad_request", 1), ("not_covered", 1), ("ok", 2), ("stale", 1)].into_iter().collect();
1511            assert_eq!(counts, want_counts);
1512        }
1513        for (n, s) in [(0u16, "0"), (7, "7"), (200, "200"), (404, "404"), (65535, "65535")] {
1514            let mut out = Vec::new();
1515            push_u16(&mut out, n);
1516            assert_eq!(out, s.as_bytes());
1517        }
1518    }
1519
1520    /// The outcome of each envelope, whatever members come before it.
1521    #[test]
1522    fn outcomes() {
1523        let h = "0".repeat(64);
1524        for (body, want) in [
1525            (format!(r#"{{"fn_hash":"{h}","outcome":"ok","receipt":{{"outcome":"x"}}}}"#), Some("ok")),
1526            (r#"{"age_seconds":12,"outcome":"stale"}"#.to_string(), Some("stale")),
1527            (r#"{"error":"E_PARSE_URI","outcome":"bad_request"}"#.to_string(), Some("bad_request")),
1528            (r#"{"outcome":"pending","poll":"https://a.example/jobs/1"}"#.to_string(), Some("pending")),
1529            (r#"{"error":"no such endpoint"}"#.to_string(), None),
1530            (r#"{"outcome""#.to_string(), None),
1531        ] {
1532            assert_eq!(reply(200, &body).outcome_str(), want, "{body}");
1533            assert_eq!(reply(200, &body).outcome(), want.map(str::to_string), "{body}");
1534        }
1535        let mut arrow = reply(200, r#"{"outcome":"ok"}"#);
1536        arrow.content_type = "application/vnd.apache.arrow.stream";
1537        assert_eq!(arrow.outcome(), None);
1538    }
1539}