fix(#3412): swarm-controller answers errors as RFC 9457 problem+json

Its three error paths returned a bare string with a status code, which forces
a caller to treat the whole body as prose. hive-c0re converted some time ago,
so swarm-controller was the last backend on the old shape -- and it is the one
behind the hive status page's 503, where the body is frequently the entire
diagnosis rather than a summary.

Adds the commitment to docs/conventions.md, since it was implied by the code
in one daemon and written down nowhere: an endpoint of ours answering with a
bare string is a bug to file, not something callers work around.

The test asserts the rendered response -- media type plus an addressable
detail -- rather than the problem_details value, because a handler that built
the value correctly and then returned it as a string would satisfy a test
written against the type alone.

swarm-controller/Cargo.toml

@@ -27,6 +27,10 @@ forgejo-api.workspace = true
 # raw bytes.
 base64.workspace = true
 futures-util.workspace = true
+# RFC 9457 `application/problem+json` error bodies. Same version + `axum`
+# feature as hive-c0re: the two daemons answer the same operator UIs, so a
+# reader that handles one's failures has to handle the other's.
+problem_details = { version = "0.9.0", features = ["axum"] }
 # The graph itself, held directly rather than behind a c0re-style wrapper
 # module — that layering (`hive-c0re::job_queue`) is partially legacy (predates
 # `hive-jobq`'s extraction into its own crate) and this daemon does not need it

swarm-controller/src/main.rs

@@ -428,14 +428,29 @@ async fn get_links(State(state): State<AppState>) -> Json<Vec<ServiceLink>> {
 /// body because a bare 503 on an operator-facing diagnostic is how a
 /// misconfiguration costs an afternoon; it is a queue/JetStream error
 /// string, and this surface is already behind the swarm's SSO.
+///
+/// It travels in `detail` of an RFC 9457 `application/problem+json` body
+/// rather than as a bare string, so the cause is an addressable field
+/// instead of the whole payload — see `error_problem` below.
 struct StatusUnavailable(String);
 
 impl axum::response::IntoResponse for StatusUnavailable {
     fn into_response(self) -> axum::response::Response {
-        (axum::http::StatusCode::SERVICE_UNAVAILABLE, self.0).into_response()
+        error_problem(axum::http::StatusCode::SERVICE_UNAVAILABLE, &self.0).into_response()
     }
 }
 
+/// Every error this daemon returns, in one shape.
+///
+/// RFC 9457 `application/problem+json` is the hive-wide contract for HTTP
+/// error bodies (`docs/conventions.md`), and the operator UIs read `detail`
+/// for display. A bare string forces the reader to treat the entire body as
+/// the message, which is the difference between a UI that can offer "copy the
+/// cause" and one that can only dump a response.
+fn error_problem(status: axum::http::StatusCode, detail: &str) -> problem_details::ProblemDetails {
+    problem_details::ProblemDetails::from_status_code(status).with_detail(detail)
+}
+
 /// What each hive last said about itself, read from the swarm queue at
 /// request time.
 ///
@@ -522,17 +537,17 @@ struct CreateAgentResponse {
     request_body = CreateAgentRequest,
     responses(
         (status = 200, description = "job chain queued", body = CreateAgentResponse),
-        (status = 400, description = "`name` is not a valid identifier", body = String),
-        (status = 500, description = "the job chain could not be queued", body = String),
+        (status = 400, description = "`name` is not a valid identifier (problem+json)", body = String),
+        (status = 500, description = "the job chain could not be queued (problem+json)", body = String),
     ),
     tag = "agents"
 )]
 async fn create_agent(
     State(state): State<AppState>,
     Json(req): Json<CreateAgentRequest>,
-) -> Result<Json<CreateAgentResponse>, (axum::http::StatusCode, String)> {
+) -> Result<Json<CreateAgentResponse>, problem_details::ProblemDetails> {
     let agent = hive_types::Ident::parse(&req.name)
-        .map_err(|reason| (axum::http::StatusCode::BAD_REQUEST, reason.to_owned()))?
+        .map_err(|reason| error_problem(axum::http::StatusCode::BAD_REQUEST, reason))?
         .into_string();
     let repo = agent.clone();
 
@@ -562,7 +577,12 @@ async fn create_agent(
                 .after_ok(create_repo);
             vec![create_identity.guid()]
         })
-        .map_err(|e| (axum::http::StatusCode::INTERNAL_SERVER_ERROR, e.to_string()))?;
+        .map_err(|e| {
+            error_problem(
+                axum::http::StatusCode::INTERNAL_SERVER_ERROR,
+                &e.to_string(),
+            )
+        })?;
     let [id] = ids[..] else {
         unreachable!("exactly one handle was asked for");
     };
@@ -770,11 +790,46 @@ async fn main() -> Result<()> {
 #[cfg(test)]
 mod tests {
     use super::{
-        DEFAULT_SOCKET, HIVES_ENV, HiveEntry, LINKS_ENV, ServiceLink, SwarmNodeKind, WorkerDeps,
-        load_hives, load_links, run_swarm_node,
+        DEFAULT_SOCKET, HIVES_ENV, HiveEntry, LINKS_ENV, ServiceLink, StatusUnavailable,
+        SwarmNodeKind, WorkerDeps, load_hives, load_links, run_swarm_node,
     };
     use std::path::Path;
 
+    /// The 503 this route returns is what the operator UIs' shared error
+    /// component renders, so assert the RENDERED response rather than the
+    /// `problem_details` crate: the contract a UI depends on is the content
+    /// type plus a `detail` it can address, and a handler that built the
+    /// value and returned it as a bare string would satisfy any test
+    /// written against the type alone.
+    #[tokio::test]
+    async fn status_unavailable_renders_problem_json_with_the_cause_in_detail() {
+        use axum::response::IntoResponse as _;
+
+        let cause = "listing status bucket keys: timed out";
+        let resp = StatusUnavailable(cause.to_owned()).into_response();
+
+        assert_eq!(resp.status(), axum::http::StatusCode::SERVICE_UNAVAILABLE);
+        let ct = resp
+            .headers()
+            .get(axum::http::header::CONTENT_TYPE)
+            .and_then(|v| v.to_str().ok())
+            .unwrap_or_default()
+            .to_owned();
+        assert!(
+            ct.starts_with("application/problem+json"),
+            "RFC 9457 media type, got {ct:?}"
+        );
+
+        let bytes = axum::body::to_bytes(resp.into_body(), 64 * 1024)
+            .await
+            .expect("body reads");
+        let v: serde_json::Value = serde_json::from_slice(&bytes).expect("problem+json parses");
+        assert_eq!(v["status"], 503);
+        // The cause is an addressable field, not the entire payload — that
+        // distinction is the point of the change, so it is what is asserted.
+        assert_eq!(v["detail"], cause);
+    }
+
     /// Drives `SwarmNodeKind::CreateRepo` through the real
     /// `hive_jobq::scheduler::Scheduler` claim → run → complete path,
     /// rather than only through `create_agent`'s endpoint test (there