WS-E: REST API handlers, SSE follow, healthz, tests

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01YShymaPrXmc3KYRUg2HMSs
This commit is contained in:
ariandClaude Sonnet 5.5 committed 2026-10-15 18:32:52 -04:00
1 parent 2d57fb1a78
commit 6130e01b92
6 files changed
+537 -22

No files matched your search

+214 -2
View File
@@ -1,3 +1,215 @@
//! GET /api/v1/docker/* handlers (WS-E)
//!
//! Placeholder created in P0 so the owning workstream only edits its own files.
use axum::extract::rejection::QueryRejection;
use axum::extract::{Path, Query, State};
use axum::response::sse::Event;
use axum::response::{IntoResponse, Response};
use axum::routing::get;
use axum::{Json, Router};
use jiff::Timestamp;
use serde::Deserialize;
use super::{query, sse_from};
use crate::error::AppError;
use crate::sources::{ContainerStatus, ContainerSummary, LogLine, LogOptions, LogStream};
use crate::state::AppState;
pub fn routes() -> Router<AppState> {
Router::new()
.route("/docker/ps", get(ps))
.route("/docker/containers/{name}", get(container))
.route("/docker/containers/{name}/logs", get(logs))
}
#[derive(Deserialize)]
struct PsParams {
all: Option<String>,
}
/// Accepts `1|0|true|false`.
fn parse_bool(name: &str, v: Option<&str>) -> Result<bool, AppError> {
match v {
None => Ok(false),
Some("1" | "true") => Ok(true),
Some("0" | "false") => Ok(false),
Some(o) => Err(AppError::BadRequest(format!(
"{name} must be 0, 1, true or false, got '{o}'"
))),
}
}
async fn ps(
State(st): State<AppState>,
q: Result<Query<PsParams>, QueryRejection>,
) -> Result<Json<Vec<ContainerSummary>>, AppError> {
let all = parse_bool("all", query(q)?.all.as_deref())?;
Ok(Json(st.docker.ps(all).await?))
}
async fn container(
State(st): State<AppState>,
Path(name): Path<String>,
) -> Result<Json<ContainerStatus>, AppError> {
Ok(Json(st.docker.container_status(&name).await?))
}
#[derive(Deserialize)]
struct LogParams {
tail: Option<usize>,
since: Option<Timestamp>,
follow: Option<String>,
}
async fn logs(
State(st): State<AppState>,
Path(name): Path<String>,
q: Result<Query<LogParams>, QueryRejection>,
) -> Result<Response, AppError> {
let p = query(q)?;
let follow = parse_bool("follow", p.follow.as_deref())?;
if p.tail == Some(0) {
return Err(AppError::BadRequest("tail must be at least 1".into()));
}
let opts = LogOptions {
tail: p.tail.map(|n| n.min(st.config.limits.max_tail)),
since: p.since,
};
if !follow {
return Ok(Json(st.docker.logs(&name, &opts).await?).into_response());
}
let rx = st.docker.follow_logs(&name, &opts).await?;
Ok(sse_from(
rx,
st.shutdown.clone(),
st.config.limits.max_follow_secs,
|l: &LogLine| {
let ev = match l.stream {
LogStream::Stdout => "stdout",
LogStream::Stderr => "stderr",
};
Event::default()
.event(ev)
.json_data(l)
.unwrap_or_else(|_| Event::default().comment("serialize error"))
},
)
.into_response())
}
#[cfg(test)]
mod tests {
use std::sync::Arc;
use async_trait::async_trait;
use axum::http::StatusCode;
use tokio::sync::mpsc;
use crate::api::router;
use crate::api::testutil::{get, json};
use crate::config::Config;
use crate::error::AppError;
use crate::sources::fake::fake_state;
use crate::sources::{ContainerStatus, ContainerSummary, DockerSource, LogLine, LogOptions};
fn app() -> axum::Router {
router(fake_state(Config::default()))
}
#[tokio::test]
async fn ps_and_detail() {
let (s, b) = get(&app(), "/docker/ps").await;
assert_eq!(s, StatusCode::OK);
assert_eq!(json(&b).as_array().unwrap().len(), 2);
let (_, b) = get(&app(), "/docker/ps?all=1").await;
assert_eq!(json(&b).as_array().unwrap().len(), 3);
let (s, b) = get(&app(), "/docker/containers/web").await;
assert_eq!(s, StatusCode::OK);
assert_eq!(json(&b)["health"], "healthy");
}
#[tokio::test]
async fn errors_400_404() {
let (s, _) = get(&app(), "/docker/containers/nope").await;
assert_eq!(s, StatusCode::NOT_FOUND);
let (s, _) = get(&app(), "/docker/containers/nope/logs").await;
assert_eq!(s, StatusCode::NOT_FOUND);
for u in [
"/docker/ps?all=maybe",
"/docker/containers/web/logs?tail=abc",
"/docker/containers/web/logs?tail=0",
"/docker/containers/web/logs?follow=2",
"/docker/containers/web/logs?since=nonsense",
] {
let (s, b) = get(&app(), u).await;
assert_eq!(s, StatusCode::BAD_REQUEST, "{u}");
assert_eq!(json(&b)["error"]["code"], "bad_request");
}
}
#[tokio::test]
async fn logs_json() {
let (s, b) = get(&app(), "/docker/containers/web/logs?follow=0").await;
assert_eq!(s, StatusCode::OK);
assert_eq!(json(&b).as_array().unwrap().len(), 2);
let (_, b) = get(&app(), "/docker/containers/web/logs?tail=1").await;
assert_eq!(json(&b)[0]["stream"], "stderr");
}
#[tokio::test]
async fn logs_sse_ends_on_shutdown() {
let st = fake_state(Config::default());
let token = st.shutdown.clone();
let app = router(st);
tokio::spawn(async move {
tokio::time::sleep(std::time::Duration::from_millis(200)).await;
token.cancel();
});
let (s, b) = get(&app, "/docker/containers/web/logs?follow=1").await;
assert_eq!(s, StatusCode::OK);
assert!(b.contains("event: stdout"), "{b}");
assert!(b.contains("event: stderr"), "{b}");
}
struct Down;
#[async_trait]
impl DockerSource for Down {
async fn ps(&self, _: bool) -> Result<Vec<ContainerSummary>, AppError> {
Err(AppError::Unavailable("docker socket".into()))
}
async fn container_status(&self, _: &str) -> Result<ContainerStatus, AppError> {
Err(AppError::Unavailable("docker socket".into()))
}
async fn logs(&self, _: &str, _: &LogOptions) -> Result<Vec<LogLine>, AppError> {
Err(AppError::Unavailable("docker socket".into()))
}
async fn follow_logs(
&self,
_: &str,
_: &LogOptions,
) -> Result<mpsc::Receiver<LogLine>, AppError> {
Err(AppError::Unavailable("docker socket".into()))
}
}
#[tokio::test]
async fn docker_unavailable_isolated() {
let mut st = fake_state(Config::default());
st.docker = Arc::new(Down);
let app = router(st);
for u in [
"/docker/ps",
"/docker/containers/web",
"/docker/containers/web/logs",
"/docker/containers/web/logs?follow=1",
] {
let (s, b) = get(&app, u).await;
assert_eq!(s, StatusCode::SERVICE_UNAVAILABLE, "{u}");
assert_eq!(json(&b)["error"]["code"], "unavailable");
}
for u in ["/systemd/units", "/systemd/timers", "/journal"] {
let (s, _) = get(&app, u).await;
assert_eq!(s, StatusCode::OK, "{u}");
}
}
}