Files
Kigi-CLI/crates/codegen/kigi-shell/tests/test_subagent_orphan_reconcile.rs
ZacharyZhang-NY a02b555e66 docs(comments): rewrite comments across all crates to the guidelines
Sweep every first-party crate source (1956 .rs files) to the project comment
guidelines: delete redundant restatements, decorative banners, change
narration, and end-of-line comments; keep and tighten the crucial ones
(invariants, bug rationale, SAFETY blocks, ported-source attribution).

No functional code changed. Every edit is proven comment-only against the
prior tree by a comment-stripping lexer (string/char/raw-string aware) plus a
separate doctest-fence check. Where removing a comment made rustfmt or clippy
want to re-lay-out adjacent code, the minimal triggering comment is restored so
code tokens stay byte-identical.

Gates green: cargo fmt --all --check (0 diffs), cargo check and cargo clippy
--workspace --all-targets (0 warnings).

Adds scripts/check_codegen_comment_guidelines.py — the enforcement gate for
these guidelines (flags banners, end-of-line comments, change narration, and
commented-out code).
2026-07-23 16:55:39 -04:00

112 lines
4.2 KiB
Rust

//! End-to-end test for subagent orphan reconciliation on session resume.
//!
//! When a process dies mid-subagent, the subagent's `meta.json` is left
//! `status: "running"` with no `SubagentFinished` — so on resume the client
//! shows it Running forever. `MvpAgent::load_session` heals this: it scans the
//! session's `subagents/` dir and flips any stale `running` meta (not tracked by
//! the live coordinator) to `cancelled` (mechanism A, the meta pass).
//!
//! This test spawns a real `kigi agent stdio` process, seeds an orphaned
//! `running` meta on disk, resumes the session, and asserts the meta was
//! reconciled to `cancelled`.
//!
//! Run locally (needs a pre-built binary):
//! ```bash
//! cargo test -p kigi-shell --test test_subagent_orphan_reconcile -- --ignored
//! ```
use std::future::Future;
use std::path::{Path, PathBuf};
use kigi_test_support::*;
async fn with_local_set<F, Fut>(f: F)
where
F: FnOnce() -> Fut,
Fut: Future<Output = ()>,
{
tokio::task::LocalSet::new().run_until(f()).await;
}
/// Find `<home>/sessions/<enc-cwd>/<id>` without depending on the internal cwd
/// encoder: scan the one level of cwd dirs for a child named `<id>`.
fn locate_session_dir(home: &Path, id: &str) -> PathBuf {
let sessions = home.join("sessions");
for entry in std::fs::read_dir(&sessions)
.expect("read sessions dir")
.flatten()
{
let candidate = entry.path().join(id);
if candidate.is_dir() {
return candidate;
}
}
panic!(
"session dir for {id} not found under {}",
sessions.display()
);
}
// requires pre-built binary
#[tokio::test]
#[ignore]
async fn resume_reconciles_orphaned_running_subagent() {
with_local_set(|| async {
let server = MockInferenceServer::start()
.await
.expect("start mock server");
let workdir = git_workdir();
// Phase 1: create a real session, then take its home so we can seed it.
let mut writer = KigiStdioClient::spawn(&server, workdir.path()).await;
writer.initialize_with_timeout().await;
let session_id = writer.create_session_with_timeout(workdir.path()).await;
let shared_home = writer.take_home();
drop(writer);
// Simulate a crash: inject a subagent meta left `running` on disk (no
// terminal write, no SubagentFinished) — exactly what a dead process
// leaves behind.
// KigiStdioClient sets HOME=<temp>; the binary uses <HOME>/.kigi as KIGI_SHARE_DIR.
let kigi_home = shared_home.path().join(".kigi");
let session_dir = locate_session_dir(&kigi_home, session_id.0.as_ref());
let sub_id = "sa-orphan";
let meta_path = session_dir.join("subagents").join(sub_id).join("meta.json");
std::fs::create_dir_all(meta_path.parent().unwrap()).unwrap();
std::fs::write(
&meta_path,
serde_json::json!({
"subagent_id": sub_id,
"parent_session_id": session_id.0.as_ref(),
"child_session_id": "child-orphan",
"subagent_type": "general-purpose",
"description": "stuck task",
"prompt": "do work",
"status": "running",
"started_at": chrono::Utc::now().to_rfc3339(),
})
.to_string(),
)
.unwrap();
// Phase 2: resume in a fresh process. `load_session` runs the reconcile.
let reader = KigiStdioClient::spawn_with_home(&server, workdir.path(), shared_home).await;
reader.initialize_with_timeout().await;
let _ = reader
.load_session_with_timeout(&session_id, workdir.path())
.await;
// The orphan's on-disk meta must now be terminal (cancelled), not running.
let reread: serde_json::Value =
serde_json::from_str(&std::fs::read_to_string(&meta_path).expect("read orphan meta"))
.expect("parse orphan meta");
assert_eq!(
reread.get("status").and_then(|s| s.as_str()),
Some("cancelled"),
"resume must reconcile the orphaned running subagent to cancelled\nstderr:\n{}",
stderr_tail(&reader.stderr(), 2000)
);
})
.await;
}