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