use std::collections::HashMap;
#[derive(Debug)]
pub struct HealthArgs<'a> {
pub mem: Option<&'a str>,
pub include: &'a [String],
pub limit: Option<usize>,
pub target_schema: Option<&'a str>,
pub include_config: bool,
}
#[derive(Debug, Clone)]
pub struct HealthConfig {
pub mutations: serde_json::Value,
pub plugin: serde_json::Value,
}
#[allow(clippy::large_enum_variant)]
#[derive(Debug, thiserror::Error)]
pub enum ComposeHealthError {
#[error("unknown mem: \"{name}\"")]
UnknownMem {
name: String,
writable_mems: Vec<String>,
},
#[error("mem \"{0}\" is quarantined")]
MemQuarantined(String),
#[error("invalid target_schema {raw:?}: {reason}")]
InvalidTargetSchema { raw: String, reason: String },
#[error(transparent)]
Engine(#[from] memstead_base::EngineError),
}
pub fn compose_health(
engine: &mut memstead_base::Engine,
args: &HealthArgs,
drift_warnings: Vec<memstead_base::WarningHint>,
config: &HealthConfig,
) -> Result<serde_json::Value, ComposeHealthError> {
let health = engine.health();
let stats = engine.status();
let include = args.include;
const HEALTH_LIMIT_MAX: usize = 100;
let requested_limit = args.limit.unwrap_or(10);
let limit = requested_limit.min(HEALTH_LIMIT_MAX);
let mut warnings: Vec<memstead_base::WarningHint> = drift_warnings;
warnings.extend(health.warnings.clone());
if requested_limit > HEALTH_LIMIT_MAX {
warnings.push(memstead_base::WarningHint::LimitClamped {
requested: requested_limit,
actual: HEALTH_LIMIT_MAX,
});
}
for key in include {
if !memstead_base::ops::health::HEALTH_INCLUDE_KEYS.contains(&key.as_str()) {
warnings.push(memstead_base::WarningHint::UnknownIncludeKey {
key: key.clone(),
allowed: memstead_base::ops::health::HEALTH_INCLUDE_KEYS
.iter()
.map(|s| s.to_string())
.collect(),
});
}
}
let mem_filter: Option<String> = match args.mem {
Some(v) if engine.mem_router().is_writable(v) => Some(v.to_string()),
Some(v) if engine.quarantine_reason(v).is_some() => {
return Err(ComposeHealthError::MemQuarantined(v.to_string()));
}
Some(v) => {
let mut names: Vec<String> = engine
.mem_router()
.writable_mems()
.iter()
.cloned()
.collect();
names.sort();
return Err(ComposeHealthError::UnknownMem {
name: v.to_string(),
writable_mems: names,
});
}
None => None,
};
let vf = mem_filter.as_deref();
if let Some(v) = vf {
warnings.retain(|w| w.source_mem().is_none_or(|wv| wv == v));
}
let in_mem = |e: &memstead_base::Entity| -> bool {
match vf {
Some(v) => e.mem == v,
None => true,
}
};
let real_count = engine
.store()
.all_entities()
.filter(|e| !e.stub && in_mem(e))
.count();
let stub_count = engine
.store()
.all_entities()
.filter(|e| e.stub && in_mem(e))
.count();
let total_count = real_count + stub_count;
let orphan_ids: Vec<memstead_base::EntityId> = engine
.orphans()
.into_iter()
.filter(|id| match vf {
Some(v) => engine.store().get(id).map(|e| e.mem == v).unwrap_or(false),
None => true,
})
.collect();
let stub_pairs: Vec<(memstead_base::EntityId, Vec<memstead_base::EntityId>)> = engine
.stubs()
.into_iter()
.filter(|(id, _)| match vf {
Some(v) => engine.store().get(id).map(|e| e.mem == v).unwrap_or(false),
None => true,
})
.collect();
let community_count = match vf {
Some(v) => memstead_base::graph::community::clusters_in_mem(
engine.store(),
engine.communities(),
v,
)
.len(),
None => engine.communities().count,
};
let (edge_count, edge_types) = {
if let Some(v) = vf {
let mut counts: HashMap<String, usize> = HashMap::new();
let mut total: usize = 0;
for id in engine.store().all_ids() {
let source_mem = engine.store().get(id).map(|e| e.mem.clone());
if let Some(source) = source_mem.as_deref()
&& source != v
{
continue;
}
for edge in engine.store().outgoing(id) {
*counts.entry(edge.rel_type.clone()).or_insert(0) += 1;
total += 1;
}
}
let mut pairs: Vec<_> = counts.into_iter().collect();
pairs.sort_by_key(|p| std::cmp::Reverse(p.1));
let arr: Vec<serde_json::Value> = pairs
.into_iter()
.map(|(t, c)| serde_json::json!({"type": t, "count": c}))
.collect();
(total, arr)
} else {
let mut pairs: Vec<_> = stats.edge_types.iter().collect();
pairs.sort_by(|a, b| b.1.cmp(a.1));
let arr: Vec<serde_json::Value> = pairs
.into_iter()
.map(|(t, c)| serde_json::json!({"type": t, "count": c}))
.collect();
(stats.edge_count, arr)
}
};
let type_distribution: Vec<serde_json::Value> = {
let mut counts: std::collections::HashMap<&str, usize> = std::collections::HashMap::new();
for e in engine
.store()
.all_entities()
.filter(|e| !e.stub && in_mem(e))
{
*counts.entry(&e.entity_type).or_default() += 1;
}
let mut pairs: Vec<_> = counts.into_iter().collect();
pairs.sort_by_key(|p| std::cmp::Reverse(p.1));
pairs
.into_iter()
.map(|(s, c)| serde_json::json!({"type": s, "count": c}))
.collect()
};
let writable_mems: Vec<String> = {
let mut names: Vec<String> = engine
.mem_router()
.writable_mems()
.iter()
.cloned()
.collect();
names.sort();
names
};
let default_writable_mem: Option<String> = engine.default_writable_mem().map(|s| s.to_string());
let read_mems: Vec<String> = {
let writable_set: std::collections::HashSet<&String> =
engine.mem_router().writable_mems().iter().collect();
let mut names: Vec<String> = engine
.mem_router()
.visible_mems()
.iter()
.filter(|n| !writable_set.contains(*n))
.cloned()
.collect();
names.sort();
names
};
let mem_schemas: Vec<serde_json::Value> = {
let mut entries: Vec<serde_json::Value> = Vec::new();
let writable_set: std::collections::HashSet<&String> = writable_mems.iter().collect();
for name in writable_mems.iter().chain(read_mems.iter()) {
if let Some(v) = vf
&& name != v
{
continue;
}
if let Some(m) = engine.mount(name) {
let schema_ref = m
.schema
.as_ref()
.map(|s| s.as_display())
.unwrap_or_default();
let mut entry = serde_json::json!({
"mem": name,
"schema": schema_ref,
"writable": writable_set.contains(name),
});
if let Some(target) = &m.migration_target {
entry["migration_target"] = serde_json::json!(target.as_display());
}
entries.push(entry);
}
}
entries
};
let orphans_by_schema = engine.orphans_by_schema(&orphan_ids);
let scope_mems: Vec<String> = match vf {
Some(v) => vec![v.to_string()],
None => writable_mems
.iter()
.chain(read_mems.iter())
.cloned()
.collect(),
};
let communities_by_schema = engine.communities_by_schema(&scope_mems);
let mut result = serde_json::json!({
"mem": mem_filter,
"summary": {
"total_entities": real_count,
"total_orphans": orphan_ids.len(),
"total_stubs": stub_pairs.len(),
"total_stale": health.stale_entities.iter().filter(|e| match vf {
Some(v) => engine.store().get(&e.id).map(|ent| ent.mem == v).unwrap_or(false),
None => true,
}).count(),
"total_missing_fields": health.missing_fields.iter().filter(|h| match vf {
Some(v) => engine.store().get(&h.id).map(|ent| ent.mem == v).unwrap_or(false),
None => true,
}).count(),
"total_communities": community_count,
"orphans_by_schema": orphans_by_schema,
"communities_by_schema": communities_by_schema,
},
"total_nodes": total_count,
"real_nodes": real_count,
"stub_nodes": stub_count,
"total_edges": edge_count,
"edge_types": edge_types,
"type_distribution": type_distribution,
"writable_mems": writable_mems,
"default_writable_mem": default_writable_mem,
"read_mems": read_mems,
"mem_schemas": mem_schemas,
});
let obj = result.as_object_mut().unwrap();
if !warnings.is_empty() {
obj.insert("warnings".into(), serde_json::json!(warnings));
}
if !health.quarantined.is_empty() {
obj.insert(
"quarantined".into(),
serde_json::to_value(&health.quarantined).unwrap_or_default(),
);
}
if let Some(diag) = &health.boot_diagnosis {
obj.insert("boot_diagnosis".into(), diag.clone());
}
if !health.leaf_entities_by_type.is_empty() {
obj.insert(
"leaf_entities_by_type".into(),
serde_json::to_value(&health.leaf_entities_by_type).unwrap_or_default(),
);
}
if include.iter().any(|s| s == "orphans") {
let orphans_list: Vec<serde_json::Value> = orphan_ids
.into_iter()
.map(|id| {
let title = engine
.get_entity(&id)
.map(|e| e.title.clone())
.unwrap_or_default();
serde_json::json!({"id": id.to_string(), "title": title})
})
.collect();
obj.insert("orphans".into(), serde_json::json!(orphans_list));
}
if include.iter().any(|s| s == "stubs") {
let stubs_list: Vec<serde_json::Value> = stub_pairs
.into_iter()
.map(|(id, refs)| {
serde_json::json!({
"id": id.to_string(),
"referenced_by": refs.iter().map(|r| r.to_string()).collect::<Vec<_>>(),
})
})
.collect();
obj.insert("stubs".into(), serde_json::json!(stubs_list));
}
if include.iter().any(|s| s == "most_connected") {
use memstead_base::graph::query::{Connectivity, cmp_by_dependency, connectivity_for};
let to_json = |c: Connectivity| {
let title = engine
.get_entity(&c.id)
.map(|e| e.title.clone())
.unwrap_or_default();
serde_json::json!({
"id": c.id.to_string(),
"title": title,
"total": c.total,
"incoming": c.incoming,
"outgoing": c.outgoing,
"typed_total": c.typed_total,
"typed_incoming": c.typed_incoming,
"typed_outgoing": c.typed_outgoing,
})
};
let connected: Vec<serde_json::Value> = if let Some(v) = vf {
let mut entries: Vec<Connectivity> = engine
.store()
.all_entities()
.filter(|e| !e.stub && e.mem == v)
.map(|e| connectivity_for(engine.store(), &e.id, |in_edge| in_edge.from.mem() == v))
.collect();
entries.sort_by(cmp_by_dependency);
entries.truncate(limit);
entries.into_iter().map(to_json).collect()
} else {
engine
.most_connected(limit)
.into_iter()
.map(to_json)
.collect()
};
obj.insert("most_connected".into(), serde_json::json!(connected));
}
if include.iter().any(|s| s == "missing_fields") {
let missing_fields: Vec<serde_json::Value> = health
.missing_fields
.iter()
.filter(|h| match vf {
Some(v) => engine
.store()
.get(&h.id)
.map(|e| e.mem == v)
.unwrap_or(false),
None => true,
})
.map(|h| {
let missing: Vec<&str> = h.issues.iter().map(|i| i.field.as_str()).collect();
let issues: Vec<serde_json::Value> = h
.issues
.iter()
.map(|i| {
serde_json::json!({
"field": i.field,
"code": i.code,
"message": i.message,
})
})
.collect();
serde_json::json!({
"id": h.id.to_string(),
"title": h.title,
"missing": missing,
"issues": issues,
})
})
.collect();
obj.insert("missing_fields".into(), serde_json::json!(missing_fields));
}
if include.iter().any(|s| s == "stale") {
let stale: Vec<serde_json::Value> = health
.stale_entities
.iter()
.filter(|e| match vf {
Some(v) => engine
.store()
.get(&e.id)
.map(|ent| ent.mem == v)
.unwrap_or(false),
None => true,
})
.map(|e| {
serde_json::json!({
"id": e.id.to_string(),
"title": e.title,
"days_since_modified": e.days_since_modified,
})
})
.collect();
obj.insert("stale".into(), serde_json::json!(stale));
}
if include.iter().any(|s| s == "dangling_links") {
let dangling = memstead_base::ops::health::collect_dangling_links(engine.store(), vf);
let arr: Vec<serde_json::Value> = dangling
.into_iter()
.map(|dl| serde_json::to_value(&dl).unwrap())
.collect();
obj.insert("dangling_links".into(), serde_json::json!(arr));
}
if include.iter().any(|s| s == "anchors") {
obj.insert(
"anchors".into(),
memstead_base::ops::health::health_anchors_axis(engine),
);
}
if include.iter().any(|s| s == "stale_derivations") {
obj.insert(
"stale_derivations".into(),
memstead_base::ops::health::health_stale_derivations_axis(engine, args.mem),
);
}
if include.iter().any(|s| s == "checks") {
obj.insert(
"checks".into(),
memstead_base::ops::health::health_checks_axis(engine, args.mem),
);
}
if include.iter().any(|s| s == "open_questions") {
obj.insert(
"open_questions".into(),
memstead_base::ops::health::health_open_questions_axis(engine, args.mem),
);
}
if include.iter().any(|s| s == "friction") {
let summary = match engine.workspace_root() {
Some(root) => memstead_base::friction::FrictionLedger::for_workspace(root).summarize(),
None => serde_json::json!({
"total": 0,
"by_code": {},
"by_verb": {},
"recent_24h": { "total": 0, "by_code": {} },
"ledger_bytes": 0,
}),
};
obj.insert("friction".into(), summary);
}
if include.iter().any(|s| s == "missing_required_outgoing") {
let reports = engine.missing_required_outgoing(vf);
let arr: Vec<serde_json::Value> = reports
.into_iter()
.map(|r| serde_json::to_value(&r).unwrap())
.collect();
obj.insert("missing_required_outgoing".into(), serde_json::json!(arr));
}
if include.iter().any(|s| s == "constraints") {
let reports = engine.constraint_findings(vf);
let arr: Vec<serde_json::Value> = reports
.into_iter()
.map(|r| serde_json::to_value(&r).unwrap())
.collect();
obj.insert("constraints".into(), serde_json::json!(arr));
let defects = engine.schema_format_defects();
if !defects.is_empty() {
obj.insert(
"schema_format_defects".into(),
serde_json::to_value(&defects).unwrap(),
);
}
}
if include.iter().any(|s| s == "tags") {
let (distribution, folded, untagged) =
memstead_base::ops::health::collect_tag_distribution(engine.store(), vf, limit);
obj.insert(
"tag_distribution".into(),
serde_json::to_value(&distribution).unwrap(),
);
obj.insert(
"tag_distribution_folded".into(),
serde_json::to_value(&folded).unwrap(),
);
obj.insert(
"untagged_entities".into(),
serde_json::to_value(&untagged).unwrap(),
);
}
let wants_conformance = include
.iter()
.any(|s| s == "conformance" || s == "integrity");
if wants_conformance {
let wants_consistency = include.iter().any(|s| s == "integrity");
let target: Option<memstead_schema::SchemaRef> = match args.target_schema {
None => None,
Some(raw) => match raw.parse::<memstead_schema::SchemaRef>() {
Ok(r) => Some(r),
Err(reason) => {
return Err(ComposeHealthError::InvalidTargetSchema {
raw: raw.to_string(),
reason,
});
}
},
};
let scan_mems: Vec<String> = match vf {
Some(v) => vec![v.to_string()],
None => {
let mut all = writable_mems.clone();
all.sort();
all
}
};
let mut findings = Vec::new();
for v in &scan_mems {
findings.extend(engine.conformance_findings(v, target.as_ref())?);
if wants_consistency {
findings.extend(engine.consistency_findings(v)?);
}
}
obj.insert("findings".into(), serde_json::to_value(&findings).unwrap());
}
if args.include_config || include.iter().any(|s| s == "config") {
let entries = memstead_base::ops::health::config_projection(
engine,
&writable_mems,
config.mutations.clone(),
config.plugin.clone(),
);
for (k, v) in entries {
obj.insert(k, v);
}
}
Ok(result)
}
pub fn render_health_markdown(v: &serde_json::Value) -> String {
use std::fmt::Write as _;
let mut s = String::new();
let _ = writeln!(s, "# Graph health");
if let Some(mem) = v.get("mem").and_then(|x| x.as_str()) {
let _ = writeln!(s, "\nMem filter: `{mem}`");
}
if let Some(sum) = v.get("summary").and_then(|x| x.as_object()) {
let _ = writeln!(s, "\n## Summary");
for key in [
"total_entities",
"total_orphans",
"total_stubs",
"total_stale",
"total_missing_fields",
"total_communities",
] {
if let Some(n) = sum.get(key).and_then(|x| x.as_u64()) {
let _ = writeln!(s, "- {}: {n}", key.replace('_', " "));
}
}
render_count_map(&mut s, sum.get("orphans_by_schema"), "Orphans by schema");
render_count_map(
&mut s,
sum.get("communities_by_schema"),
"Communities by schema",
);
}
for key in ["total_nodes", "real_nodes", "stub_nodes", "total_edges"] {
if let Some(n) = v.get(key).and_then(|x| x.as_u64()) {
let _ = writeln!(s, "- {}: {n}", key.replace('_', " "));
}
}
for (key, title) in [
("orphans", "Orphans"),
("stubs", "Stubs"),
("most_connected", "Most connected"),
("missing_fields", "Missing fields"),
("stale", "Stale"),
("dangling_links", "Dangling links"),
("missing_required_outgoing", "Missing required outgoing"),
("constraints", "Constraint violations"),
("findings", "Findings"),
] {
if let Some(arr) = v.get(key).and_then(|x| x.as_array()) {
let _ = writeln!(s, "\n## {title} ({})", arr.len());
for item in arr {
let _ = writeln!(s, "- {}", summarize_health_item(item));
}
}
}
if let Some(obj) = v.get("anchors").and_then(|x| x.as_object()) {
let _ = writeln!(s, "\n## Anchors ({} mems)", obj.len());
for (mem, counts) in obj {
let _ = writeln!(
s,
"- `{mem}`: resolved {}, drifted {}, recheck {}, unresolvable {}",
counts["resolved"].as_u64().unwrap_or(0),
counts["drifted"].as_u64().unwrap_or(0),
counts["recheck"].as_u64().unwrap_or(0),
counts["unresolvable"].as_u64().unwrap_or(0),
);
}
}
if let Some(obj) = v.get("checks").and_then(|x| x.as_object()) {
let _ = writeln!(s, "\n## Checks ({} mems)", obj.len());
for (mem, c) in obj {
let count = |key: &str| c.get(key).and_then(|x| x.as_u64()).unwrap_or(0);
let gate = |key: &str| {
c.get("independence")
.and_then(|g| g.get(key))
.and_then(|e| e.get("count"))
.and_then(|x| x.as_u64())
.unwrap_or(0)
};
let _ = writeln!(
s,
"- `{mem}`: never_checked {}, checked_ok {}, check_failed {}, \
check_stale {}; independence: self_checked {}, \
confirmed_independent {}, unconfirmable {}",
count("never_checked"),
count("checked_ok"),
count("check_failed"),
count("check_stale"),
gate("self_checked"),
gate("confirmed_independent"),
gate("unconfirmable"),
);
}
}
if let Some(obj) = v.get("stale_derivations").and_then(|x| x.as_object()) {
let total: usize = obj
.values()
.filter_map(|a| a.as_array().map(|a| a.len()))
.sum();
let _ = writeln!(s, "\n## Stale derivations ({total} findings)");
for (mem, findings) in obj {
for f in findings.as_array().into_iter().flatten() {
let _ = writeln!(
s,
"- `{mem}`: {} -[{}]-> {} ({})",
f.get("source").and_then(|x| x.as_str()).unwrap_or(""),
f.get("rel_type").and_then(|x| x.as_str()).unwrap_or(""),
f.get("target").and_then(|x| x.as_str()).unwrap_or(""),
f.get("state").and_then(|x| x.as_str()).unwrap_or(""),
);
}
}
}
if let Some(arr) = v.get("quarantined").and_then(|x| x.as_array()) {
let _ = writeln!(s, "\n## Quarantined mems ({})", arr.len());
for q in arr {
let _ = writeln!(
s,
"- `{}` [{}] {}",
q.get("mem").and_then(|x| x.as_str()).unwrap_or(""),
q.get("reason_code").and_then(|x| x.as_str()).unwrap_or(""),
q.get("reason_message")
.and_then(|x| x.as_str())
.unwrap_or(""),
);
}
}
if let Some(arr) = v.get("warnings").and_then(|x| x.as_array())
&& !arr.is_empty()
{
let _ = writeln!(s, "\n## Warnings ({})", arr.len());
for w in arr {
let code = w.get("code").and_then(|x| x.as_str()).unwrap_or("");
let msg = w.get("message").and_then(|x| x.as_str()).unwrap_or("");
let _ = writeln!(s, "- [{code}] {msg}");
}
}
s
}
fn render_count_map(s: &mut String, val: Option<&serde_json::Value>, title: &str) {
use std::fmt::Write as _;
let Some(map) = val.and_then(|x| x.as_object()) else {
return;
};
if map.is_empty() {
return;
}
let _ = writeln!(s, "- {title}:");
for (k, n) in map {
let label = if k.is_empty() {
"(unpinned)"
} else {
k.as_str()
};
let _ = writeln!(s, " - {label}: {}", n.as_u64().unwrap_or(0));
}
}
fn summarize_health_item(item: &serde_json::Value) -> String {
if let Some(id) = item.get("id").and_then(|x| x.as_str()) {
match item.get("title").and_then(|x| x.as_str()) {
Some(t) if !t.is_empty() => format!("{id} — {t}"),
_ => id.to_string(),
}
} else if let Some(from) = item.get("from").and_then(|x| x.as_str()) {
let target = item.get("target_id").and_then(|x| x.as_str()).unwrap_or("");
format!("{from} → {target}")
} else {
serde_json::to_string(item).unwrap_or_default()
}
}
#[cfg(test)]
mod tests {
use super::render_health_markdown;
use serde_json::json;
fn base_payload() -> serde_json::Value {
json!({
"summary": { "total_entities": 1 },
"total_nodes": 1,
})
}
#[test]
fn render_health_markdown_covers_checks_derivations_and_quarantine() {
let mut v = base_payload();
v["checks"] = json!({
"specs": {
"never_checked": 2, "checked_ok": 1,
"check_failed": 0, "check_stale": 0,
"independence": {
"self_checked": { "count": 0, "items": [] },
"confirmed_independent": { "count": 0, "items": [] },
"unconfirmable": { "count": 1, "items": ["specs--a"] },
},
}
});
v["stale_derivations"] = json!({
"specs": [{
"source": "specs--a", "rel_type": "DERIVES_FROM",
"target": "specs--b", "state": "stale",
"baseline": "aaa", "current": "bbb",
}]
});
v["quarantined"] = json!([{
"mem": "broken",
"reason_code": "SCHEMA_NOT_FOUND",
"reason_message": "no schema; repair via memstead mem set-schema",
}]);
let md = render_health_markdown(&v);
assert!(md.contains("## Checks (1 mems)"), "{md}");
assert!(
md.contains(
"- `specs`: never_checked 2, checked_ok 1, check_failed 0, \
check_stale 0; independence: self_checked 0, \
confirmed_independent 0, unconfirmable 1"
),
"{md}"
);
assert!(md.contains("## Stale derivations (1 findings)"), "{md}");
assert!(
md.contains("- `specs`: specs--a -[DERIVES_FROM]-> specs--b (stale)"),
"{md}"
);
assert!(md.contains("## Quarantined mems (1)"), "{md}");
assert!(
md.contains(
"- `broken` [SCHEMA_NOT_FOUND] no schema; repair via memstead mem set-schema"
),
"{md}"
);
let mut empty = base_payload();
empty["checks"] = json!({});
empty["stale_derivations"] = json!({ "specs": [] });
let md = render_health_markdown(&empty);
assert!(md.contains("## Checks (0 mems)"), "{md}");
assert!(md.contains("## Stale derivations (0 findings)"), "{md}");
let base_md = render_health_markdown(&base_payload());
for heading in ["## Checks", "## Stale derivations", "## Quarantined mems"] {
assert!(
!base_md.contains(heading),
"absent key must render nothing: {base_md}"
);
}
let appended = render_health_markdown(&v);
assert!(
appended.starts_with(&base_md),
"sections append; the base output stays byte-identical"
);
}
}