use std::{path::Path, sync::Arc};
use futures::stream::{FuturesUnordered, StreamExt};
use miette::{IntoDiagnostic, Result, miette};
use node_semver::Version;
use serde_json::{Map, Value};
use tracing::{debug, warn};
use bestool_tamanu::{config::TamanuConfig, server_info::get_or_create_server_id};
use crate::doctor::{
check::{Check, OverallResult},
checks::{self, CheckContext},
progress::{DoctorEvent, ProgressSender},
server_info::{self, ServerFacts},
};
pub struct SweepResult {
pub server_id: Option<String>,
pub results: Vec<(Check, bool)>,
pub overall: OverallResult,
pub payload: Value,
pub pg_version: Option<String>,
}
#[expect(
clippy::too_many_arguments,
reason = "each argument is a distinct knob the CLI and daemon callers need to thread through"
)]
pub async fn perform_sweep(
binary_version: &str,
version: &Version,
root: &Path,
config: Arc<TamanuConfig>,
database_url: &str,
http_client: reqwest::Client,
selected_names: &[String],
skip_names: &[String],
cached_pg_version: Option<String>,
progress: Option<ProgressSender>,
) -> Result<SweepResult> {
let db = match bestool_postgres::pool::connect_one(database_url, "bestool-tamanu-doctor").await
{
Ok(client) => Some(Arc::new(client)),
Err(err) => {
warn!(%err, "doctor could not open Tamanu DB; DB-dependent checks will skip");
None
}
};
let kind = bestool_tamanu::detect_kind(&config, db.as_deref()).await;
debug!(?kind, "detected Tamanu server kind for doctor sweep");
let check_ctx = CheckContext {
tamanu_version: version.clone(),
tamanu_root: root.to_path_buf(),
config: config.clone(),
kind,
database_url: database_url.to_owned(),
db: db.clone(),
http_client,
};
let registry = checks::all();
let known: Vec<&str> = registry.iter().map(|e| e.name).collect();
if let Some(unknown) = selected_names.iter().find(|n| !known.contains(&n.as_str())) {
return Err(miette!(
"unknown check name `{unknown}`; known checks: {}",
known.join(", ")
));
}
if let Some(unknown) = skip_names.iter().find(|n| !known.contains(&n.as_str())) {
return Err(miette!(
"unknown check name `{unknown}` in --skip; known checks: {}",
known.join(", ")
));
}
let selected: Vec<(usize, &checks::CheckEntry)> = registry
.iter()
.enumerate()
.filter(|(_, e)| selected_names.is_empty() || selected_names.iter().any(|n| n == e.name))
.filter(|(_, e)| !skip_names.iter().any(|n| n == e.name))
.collect();
let mut pending = FuturesUnordered::new();
for (idx, entry) in &selected {
let ctx = check_ctx.clone();
let on_wire = entry.on_wire;
let idx = *idx;
let fut = (entry.run)(ctx);
pending.push(async move {
let result = fut.await;
(idx, on_wire, result)
});
}
let mut completed: Vec<(usize, Check, bool)> = Vec::with_capacity(selected.len());
while let Some((idx, on_wire, check)) = pending.next().await {
if let Some(tx) = progress.as_ref() {
let _ = tx.send(DoctorEvent::Completed(check.clone()));
}
completed.push((idx, check, on_wire));
}
completed.sort_by_key(|(idx, _, _)| *idx);
let results: Vec<(Check, bool)> = completed.into_iter().map(|(_, c, w)| (c, w)).collect();
let server_id = match get_or_create_server_id(db.as_deref()).await {
Ok(id) => Some(id),
Err(err) => {
warn!("could not resolve metaServerId: {err}");
None
}
};
let facts = collect_server_facts(&config, db.as_deref(), cached_pg_version).await;
let pg_version = facts.pg_version.clone();
let info = server_info::gather(binary_version, &version.to_string(), facts).await;
let info_value = serde_json::to_value(&info).into_diagnostic()?;
let overall =
OverallResult::from_checks(&results.iter().map(|(c, _)| c.clone()).collect::<Vec<_>>());
let payload = build_payload(&info_value, &results, overall);
Ok(SweepResult {
server_id,
results,
overall,
payload,
pg_version,
})
}
async fn collect_server_facts(
config: &TamanuConfig,
db: Option<&tokio_postgres::Client>,
cached_pg_version: Option<String>,
) -> ServerFacts {
let mut facts = ServerFacts {
canonical_url: config.canonical_url().map(|u| u.to_string()),
timezone: config.primary_time_zone().map(|s| s.to_string()),
pg_version: cached_pg_version,
..Default::default()
};
let Some(client) = db else {
return facts;
};
if facts.pg_version.is_none() {
match client.query_one("SELECT version()", &[]).await {
Ok(row) => match row.try_get::<_, String>(0) {
Ok(v) => facts.pg_version = Some(v),
Err(err) => warn!("decoding pg_version: {err}"),
},
Err(err) => warn!("SELECT version() failed: {err}"),
}
}
match client
.query_opt(
"SELECT value FROM local_system_facts WHERE key = 'currentSyncTick'",
&[],
)
.await
{
Ok(Some(row)) => match row.try_get::<_, String>(0) {
Ok(tick) => facts.current_sync_tick = Some(tick),
Err(err) => warn!("decoding currentSyncTick: {err}"),
},
Ok(None) => {}
Err(err) => warn!("querying currentSyncTick: {err}"),
}
facts
}
pub fn overall_from_payload(payload: &Value) -> OverallResult {
let healthy = payload
.get("healthy")
.and_then(Value::as_bool)
.unwrap_or(true);
if !healthy {
return OverallResult::Failing;
}
let degraded = payload
.get("health")
.and_then(Value::as_array)
.map(|arr| {
arr.iter().any(|c| {
c.get("healthy") == Some(&Value::Bool(false))
&& c.get("skipped") != Some(&Value::Bool(true))
})
})
.unwrap_or(false);
if degraded {
OverallResult::Degraded
} else {
OverallResult::Healthy
}
}
fn build_payload(info: &Value, results: &[(Check, bool)], overall: OverallResult) -> Value {
let mut payload: Map<String, Value> = match info {
Value::Object(o) => o.clone(),
_ => Map::new(),
};
for (check, _) in results {
for (k, v) in &check.payload_extras {
payload.insert(k.clone(), v.clone());
}
}
let health: Vec<Value> = results
.iter()
.filter(|(_, on_wire)| *on_wire)
.map(|(c, _)| c.to_wire())
.collect();
payload.insert("healthy".into(), overall.is_healthy_top_level().into());
payload.insert("health".into(), Value::Array(health));
Value::Object(payload)
}
#[cfg(test)]
mod tests {
use super::*;
fn pass(name: &'static str) -> (Check, bool) {
(Check::pass(name, "ok"), true)
}
fn warn(name: &'static str) -> (Check, bool) {
(Check::warning(name, "deg", "reason"), true)
}
fn fail(name: &'static str) -> (Check, bool) {
(Check::fail(name, "bad", "reason"), true)
}
fn skip(name: &'static str) -> (Check, bool) {
(Check::skip(name, "not run", "reason"), true)
}
#[test]
fn payload_all_pass_is_healthy() {
let results = vec![pass("a"), pass("b")];
let overall =
OverallResult::from_checks(&results.iter().map(|(c, _)| c.clone()).collect::<Vec<_>>());
let payload = build_payload(&Value::Object(Default::default()), &results, overall);
assert_eq!(payload["healthy"], true);
assert_eq!(payload["health"].as_array().unwrap().len(), 2);
assert!(payload["health"][0]["healthy"].as_bool().unwrap());
}
#[test]
fn payload_warning_keeps_top_healthy_but_check_unhealthy() {
let results = vec![pass("a"), warn("b")];
let overall =
OverallResult::from_checks(&results.iter().map(|(c, _)| c.clone()).collect::<Vec<_>>());
let payload = build_payload(&Value::Object(Default::default()), &results, overall);
assert_eq!(payload["healthy"], true);
assert_eq!(payload["health"][1]["healthy"], false);
}
#[test]
fn payload_fail_flips_top_level() {
let results = vec![pass("a"), warn("b"), fail("c")];
let overall =
OverallResult::from_checks(&results.iter().map(|(c, _)| c.clone()).collect::<Vec<_>>());
let payload = build_payload(&Value::Object(Default::default()), &results, overall);
assert_eq!(payload["healthy"], false);
}
#[test]
fn payload_lifts_payload_extras_into_top_level() {
let mut info = serde_json::Map::new();
info.insert("osTimezone".into(), "Pacific/Auckland".into());
let info_value = Value::Object(info);
let check = Check::pass("svc", "ok")
.with_detail("supervisor", "systemd")
.with_payload_extra(
"services",
serde_json::json!({"supervisor": "systemd", "expectations": []}),
);
let results = vec![(check, true)];
let overall =
OverallResult::from_checks(&results.iter().map(|(c, _)| c.clone()).collect::<Vec<_>>());
let payload = build_payload(&info_value, &results, overall);
assert_eq!(payload["osTimezone"], "Pacific/Auckland");
assert_eq!(payload["services"]["supervisor"], "systemd");
assert!(payload["health"][0].get("services").is_none());
assert_eq!(payload["health"][0]["supervisor"], "systemd");
}
#[test]
fn off_wire_checks_skipped_in_health_array() {
let results = vec![
(Check::pass("on", "ok"), true),
(Check::pass("off", "ok"), false),
];
let overall =
OverallResult::from_checks(&results.iter().map(|(c, _)| c.clone()).collect::<Vec<_>>());
let payload = build_payload(&Value::Object(Default::default()), &results, overall);
let names: Vec<&str> = payload["health"]
.as_array()
.unwrap()
.iter()
.map(|v| v["check"].as_str().unwrap())
.collect();
assert_eq!(names, vec!["on"]);
}
#[test]
fn payload_skip_is_healthy_on_wire() {
let results = vec![pass("a"), skip("b")];
let overall =
OverallResult::from_checks(&results.iter().map(|(c, _)| c.clone()).collect::<Vec<_>>());
let payload = build_payload(&Value::Object(Default::default()), &results, overall);
assert_eq!(payload["healthy"], true);
assert_eq!(payload["health"][1]["healthy"], true);
assert_eq!(payload["health"][1]["skipped"], true);
}
}