use super::super::{
ensure_codex_hooks_enabled as shared_ensure_codex_hooks_enabled,
install_codex_instruction_docs, mcp_server_quiet_mode, resolve_binary_path,
upsert_lean_ctx_codex_hook_entries, write_file,
};
pub fn install_codex_hook() {
let Some(codex_dir) = crate::core::home::resolve_codex_dir() else {
tracing::error!("Cannot resolve codex directory");
return;
};
let _ = std::fs::create_dir_all(&codex_dir);
let hook_config_changed = install_codex_hook_config(&codex_dir);
let installed_docs = install_codex_instruction_docs(&codex_dir);
if !mcp_server_quiet_mode() {
if hook_config_changed {
eprintln!(
"Installed Codex-compatible SessionStart/PreToolUse hooks at {}",
codex_dir.display()
);
}
if installed_docs {
eprintln!("Installed Codex instructions at {}", codex_dir.display());
} else {
eprintln!("Codex AGENTS.md already configured.");
}
}
}
fn install_codex_hook_config(codex_dir: &std::path::Path) -> bool {
let binary = resolve_binary_path();
let session_start_cmd = format!("{binary} hook codex-session-start");
let pre_tool_use_cmd = format!("{binary} hook codex-pretooluse");
let hooks_json_path = codex_dir.join("hooks.json");
let mut changed = false;
let mut root = if hooks_json_path.exists() {
if let Some(parsed) = std::fs::read_to_string(&hooks_json_path)
.ok()
.and_then(|content| crate::core::jsonc::parse_jsonc(&content).ok())
{
parsed
} else {
changed = true;
serde_json::json!({ "hooks": {} })
}
} else {
changed = true;
serde_json::json!({ "hooks": {} })
};
if upsert_lean_ctx_codex_hook_entries(&mut root, &session_start_cmd, &pre_tool_use_cmd) {
changed = true;
}
let observe_cmd = format!("{binary} hook observe");
if ensure_codex_observe_hooks(&mut root, &observe_cmd) {
changed = true;
}
if changed {
write_file(
&hooks_json_path,
&serde_json::to_string_pretty(&root).unwrap_or_default(),
);
}
let rewrite_path = codex_dir.join("hooks").join("lean-ctx-rewrite-codex.sh");
if rewrite_path.exists() && std::fs::remove_file(&rewrite_path).is_ok() {
changed = true;
}
let config_toml_path = codex_dir.join("config.toml");
let config_content = std::fs::read_to_string(&config_toml_path).unwrap_or_default();
let mcp_updated = ensure_codex_mcp_server(
&config_content,
&binary,
&super::super::mcp_server_env_pairs(),
);
let hooks_updated =
ensure_codex_hooks_enabled(mcp_updated.as_deref().unwrap_or(&config_content));
let final_content = hooks_updated
.or(mcp_updated)
.unwrap_or_else(|| config_content.clone());
if final_content != config_content {
write_file(&config_toml_path, &final_content);
changed = true;
if !mcp_server_quiet_mode() {
eprintln!(
"Updated Codex config (MCP server + hooks) in {}",
config_toml_path.display()
);
}
}
changed
}
fn ensure_codex_observe_hooks(root: &mut serde_json::Value, observe_cmd: &str) -> bool {
let original = root.clone();
let Some(hooks_obj) = root
.as_object_mut()
.and_then(|r| r.get_mut("hooks"))
.and_then(|h| h.as_object_mut())
else {
return false;
};
let observe_events = ["PostToolUse", "SessionStart", "SessionEnd"];
for event in observe_events {
let arr = hooks_obj
.entry(event.to_string())
.or_insert_with(|| serde_json::json!([]));
let Some(entries) = arr.as_array_mut() else {
continue;
};
let already = entries.iter().any(|e| {
e.get("hooks")
.and_then(|h| h.as_array())
.is_some_and(|hooks| {
hooks.iter().any(|hook| {
hook.get("command")
.and_then(|c| c.as_str())
.is_some_and(|c| c.contains("hook observe"))
})
})
});
if !already {
entries.push(serde_json::json!({
"matcher": ".*",
"hooks": [{ "type": "command", "command": observe_cmd, "timeout": 5 }]
}));
}
}
*root != original
}
fn ensure_codex_mcp_server(
config_content: &str,
binary: &str,
env_pairs: &[(String, String)],
) -> Option<String> {
let mut doc = config_content.parse::<toml_edit::DocumentMut>().ok()?;
let original = doc.to_string();
let servers = doc["mcp_servers"].or_insert(toml_edit::table());
if let Some(t) = servers.as_table_mut() {
t.set_implicit(true);
}
let lean = servers["lean-ctx"].or_insert(toml_edit::table());
let lean_tbl = lean.as_table_mut()?;
lean_tbl.set_implicit(false);
if !lean_tbl.contains_key("command") {
lean_tbl["command"] = toml_edit::value(binary);
}
if !lean_tbl.contains_key("args") {
lean_tbl["args"] = toml_edit::value(toml_edit::Array::new());
}
let env = lean_tbl["env"].or_insert(toml_edit::table());
if let Some(env_tbl) = env.as_table_mut() {
for (key, val) in env_pairs {
let key = key.as_str();
if env_tbl.get(key).and_then(toml_edit::Item::as_str) != Some(val.as_str()) {
env_tbl[key] = toml_edit::value(val.as_str());
}
}
}
let updated = doc.to_string();
(updated != original).then_some(updated)
}
fn ensure_codex_hooks_enabled(config_content: &str) -> Option<String> {
shared_ensure_codex_hooks_enabled(config_content)
}
#[cfg(test)]
mod tests {
use super::{
ensure_codex_hooks_enabled, ensure_codex_mcp_server, upsert_lean_ctx_codex_hook_entries,
};
use serde_json::json;
fn data_dir_pairs() -> Vec<(String, String)> {
vec![(
"LEAN_CTX_DATA_DIR".to_string(),
"/Users/user/.lean-ctx".to_string(),
)]
}
#[test]
fn upsert_replaces_legacy_codex_rewrite_but_keeps_custom_hooks() {
let mut input = json!({
"hooks": {
"PreToolUse": [
{
"matcher": "Bash",
"hooks": [{
"type": "command",
"command": "/opt/homebrew/bin/lean-ctx hook rewrite",
"timeout": 15
}]
},
{
"matcher": "Bash",
"hooks": [{
"type": "command",
"command": "echo keep-me",
"timeout": 5
}]
}
],
"SessionStart": [
{
"matcher": "startup|resume|clear",
"hooks": [{
"type": "command",
"command": "lean-ctx hook codex-session-start",
"timeout": 15
}]
}
],
"PostToolUse": [
{
"matcher": "Bash",
"hooks": [{
"type": "command",
"command": "echo keep-post",
"timeout": 5
}]
}
]
}
});
let changed = upsert_lean_ctx_codex_hook_entries(
&mut input,
"lean-ctx hook codex-session-start",
"lean-ctx hook codex-pretooluse",
);
assert!(changed, "legacy hooks should be migrated");
let pre_tool_use = input["hooks"]["PreToolUse"]
.as_array()
.expect("PreToolUse array should remain");
assert_eq!(pre_tool_use.len(), 2, "custom hook should be preserved");
assert_eq!(
pre_tool_use[0]["hooks"][0]["command"].as_str(),
Some("echo keep-me")
);
assert_eq!(
pre_tool_use[1]["hooks"][0]["command"].as_str(),
Some("lean-ctx hook codex-pretooluse")
);
assert_eq!(
input["hooks"]["SessionStart"][0]["hooks"][0]["command"].as_str(),
Some("lean-ctx hook codex-session-start")
);
assert_eq!(
input["hooks"]["PostToolUse"][0]["hooks"][0]["command"].as_str(),
Some("echo keep-post")
);
}
#[test]
fn ignores_non_lean_ctx_codex_entries() {
let custom = json!({
"matcher": "Bash",
"hooks": [{
"type": "command",
"command": "echo keep-me",
"timeout": 5
}]
});
assert!(
!crate::hooks::support::is_lean_ctx_codex_managed_entry("PreToolUse", &custom),
"custom Codex hooks must be preserved"
);
}
#[test]
fn detects_managed_codex_session_start_entry() {
let managed = json!({
"matcher": "startup|resume|clear",
"hooks": [{
"type": "command",
"command": "/opt/homebrew/bin/lean-ctx hook codex-session-start",
"timeout": 15
}]
});
assert!(crate::hooks::support::is_lean_ctx_codex_managed_entry(
"SessionStart",
&managed
));
}
#[test]
fn ensure_codex_hooks_enabled_updates_existing_features_flag() {
let input = "\
[features]
other = true
codex_hooks = false
[mcp_servers.other]
command = \"other\"
";
let output =
ensure_codex_hooks_enabled(input).expect("codex_hooks=false should be migrated");
assert!(output.contains("[features]\nother = true\nhooks = true\n"));
assert!(!output.contains("codex_hooks = false"));
}
#[test]
fn ensure_codex_hooks_enabled_moves_stray_assignment_into_features_section() {
let input = "\
[features]
other = true
[mcp_servers.lean-ctx]
command = \"lean-ctx\"
codex_hooks = true
";
let output = ensure_codex_hooks_enabled(input)
.expect("stray codex_hooks assignment should be normalized");
assert!(output.contains("[features]\nother = true\nhooks = true\n"));
assert_eq!(output.matches("hooks = true").count(), 1);
assert!(!output.contains("[mcp_servers.lean-ctx]\ncommand = \"lean-ctx\"\nhooks = true"));
}
#[test]
fn ensure_codex_hooks_enabled_adds_features_section_when_missing() {
let input = "\
[mcp_servers.lean-ctx]
command = \"lean-ctx\"
";
let output =
ensure_codex_hooks_enabled(input).expect("missing features section should be added");
assert!(output.ends_with("\n[features]\nhooks = true\n"));
}
#[test]
fn codex_docs_steer_to_reliable_mcp_path_without_false_hook_claim() {
let tmp = std::env::temp_dir().join("lean-ctx-test-codex-desktop-note");
let _ = std::fs::remove_dir_all(&tmp);
std::fs::create_dir_all(&tmp).unwrap();
crate::hooks::support::install_codex_instruction_docs(&tmp);
let lean_ctx_md = std::fs::read_to_string(tmp.join("LEAN-CTX.md")).unwrap();
assert!(
lean_ctx_md.contains("ctx_shell") && lean_ctx_md.contains("ctx_read"),
"LEAN-CTX.md must steer the agent to the MCP tools"
);
let normalized = lean_ctx_md.replace('\n', " ");
assert!(
!normalized.contains("hooks do not run")
&& !normalized.contains("no automatic compression"),
"LEAN-CTX.md must not make the false blanket claim that Codex Desktop hooks never run (#350)"
);
let agents_md = std::fs::read_to_string(tmp.join("AGENTS.md")).unwrap();
assert!(
agents_md.contains("ctx_shell") && agents_md.contains("ctx_search"),
"AGENTS.md block must steer to the reliable MCP tools"
);
let agents_norm = agents_md.replace('\n', " ");
assert!(
!agents_norm.contains("hooks do not run"),
"AGENTS.md must not claim Codex hooks never run (#350)"
);
let _ = std::fs::remove_dir_all(&tmp);
}
#[test]
fn install_codex_docs_preserves_existing_user_instructions() {
let tmp = std::env::temp_dir().join("lean-ctx-test-codex-preserve");
let _ = std::fs::remove_dir_all(&tmp);
std::fs::create_dir_all(&tmp).unwrap();
let agents_md = tmp.join("AGENTS.md");
let user_content = "# My Custom Instructions\n\nDo not change my codebase style.\n\n## Rules\n- Always use tabs\n- No semicolons\n";
std::fs::write(&agents_md, user_content).unwrap();
crate::hooks::support::install_codex_instruction_docs(&tmp);
let result = std::fs::read_to_string(&agents_md).unwrap();
assert!(
result.contains("My Custom Instructions"),
"user content must be preserved"
);
assert!(
result.contains("Always use tabs"),
"user rules must be preserved"
);
assert!(
result.contains(crate::core::rules_canonical::AGENTS_BLOCK_START),
"lean-ctx block must be appended"
);
let expected_ref = tmp.join("LEAN-CTX.md").display().to_string();
assert!(
result.contains(&expected_ref),
"lean-ctx reference must use codex_dir path"
);
let _ = std::fs::remove_dir_all(&tmp);
}
#[test]
fn install_codex_docs_updates_only_marked_block() {
let tmp = std::env::temp_dir().join("lean-ctx-test-codex-marked");
let _ = std::fs::remove_dir_all(&tmp);
std::fs::create_dir_all(&tmp).unwrap();
let agents_md = tmp.join("AGENTS.md");
let content_with_block = format!(
"# My Instructions\n\nCustom rule here.\n\n{}\n## lean-ctx\n\n@OLD-LEAN-CTX.md\n{}\n\n## Other Section\nKeep this.\n",
crate::core::rules_canonical::AGENTS_BLOCK_START,
crate::core::rules_canonical::AGENTS_BLOCK_END,
);
std::fs::write(&agents_md, content_with_block).unwrap();
crate::hooks::support::install_codex_instruction_docs(&tmp);
let result = std::fs::read_to_string(&agents_md).unwrap();
assert!(
result.contains("Custom rule here."),
"user content before block preserved"
);
assert!(
result.contains("Other Section"),
"user content after block preserved"
);
let expected_ref = tmp.join("LEAN-CTX.md").display().to_string();
assert!(
result.contains(&expected_ref),
"block updated to current reference"
);
assert!(
!result.contains("OLD-LEAN-CTX"),
"old block content replaced"
);
let _ = std::fs::remove_dir_all(&tmp);
}
#[test]
fn ensure_mcp_server_adds_section_when_missing() {
let input = "[features]\ncodex_hooks = true\n";
let result = ensure_codex_mcp_server(input, "lean-ctx", &data_dir_pairs())
.expect("should add MCP section");
assert!(result.contains("[mcp_servers.lean-ctx]"));
assert!(result.contains("command = \"lean-ctx\""));
assert!(result.contains("args = []"));
assert!(result.contains("[features]\ncodex_hooks = true\n"));
}
#[test]
fn ensure_mcp_server_noop_when_already_complete() {
let input = "[mcp_servers.lean-ctx]\ncommand = \"lean-ctx\"\nargs = []\n\n\
[mcp_servers.lean-ctx.env]\nLEAN_CTX_DATA_DIR = \"/Users/user/.lean-ctx\"\n";
assert!(
ensure_codex_mcp_server(input, "lean-ctx", &data_dir_pairs()).is_none(),
"should not modify config when MCP section already has all keys"
);
}
#[test]
fn ensure_mcp_server_preserves_existing_sections() {
let input = "[mcp_servers.other]\ncommand = \"other\"\n";
let result = ensure_codex_mcp_server(input, "/usr/bin/lean-ctx", &data_dir_pairs())
.expect("should add lean-ctx section");
assert!(result.contains("[mcp_servers.other]"));
assert!(result.contains("[mcp_servers.lean-ctx]"));
assert!(result.contains("command = \"/usr/bin/lean-ctx\""));
}
#[test]
fn ensure_mcp_server_inserts_before_orphaned_env_subtable() {
let input = "\
[mcp_servers.lean-ctx.env]
LEAN_CTX_DATA_DIR = \"/Users/user/.lean-ctx\"
";
let result = ensure_codex_mcp_server(input, "/usr/local/bin/lean-ctx", &data_dir_pairs())
.expect("should insert parent section before orphaned env");
let parent_pos = result
.find("[mcp_servers.lean-ctx]")
.expect("parent section must exist");
let env_pos = result
.find("[mcp_servers.lean-ctx.env]")
.expect("env sub-table must be preserved");
assert!(
parent_pos < env_pos,
"parent section must come before env sub-table"
);
assert!(result.contains("command = \"/usr/local/bin/lean-ctx\""));
assert!(result.contains("LEAN_CTX_DATA_DIR"));
assert_eq!(
result.matches("[mcp_servers.lean-ctx.env]").count(),
1,
"must not duplicate the env table (would be invalid TOML)"
);
}
#[test]
fn ensure_mcp_server_handles_issue_189_scenario() {
let input = "\
source = \"/Users/user/.cache/codex-runtimes/codex-primary-runtime/plugins/openai-primary-runtime\"
source_type = \"local\"
[mcp_servers.lean-ctx.env]
LEAN_CTX_DATA_DIR = \"/Users/user/.lean-ctx\"
";
let result = ensure_codex_mcp_server(input, "/usr/local/bin/lean-ctx", &data_dir_pairs())
.expect("should fix orphaned config from issue #189");
assert!(result.contains("[mcp_servers.lean-ctx]\n"));
assert!(result.contains("command = \"/usr/local/bin/lean-ctx\""));
assert!(result.contains("[mcp_servers.lean-ctx.env]"));
assert!(result.contains("LEAN_CTX_DATA_DIR"));
let parent_pos = result.find("[mcp_servers.lean-ctx]\n").unwrap();
let env_pos = result.find("[mcp_servers.lean-ctx.env]").unwrap();
assert!(parent_pos < env_pos);
assert_eq!(
result.matches("[mcp_servers.lean-ctx.env]").count(),
1,
"issue #189 fix must merge into one env table, not duplicate it"
);
assert!(result.contains("source_type = \"local\""));
}
#[test]
fn ensure_mcp_server_quotes_windows_backslash_paths() {
let input = "[features]\ncodex_hooks = true\n";
let win_path = r"C:\Users\Foo\AppData\Roaming\npm\lean-ctx.cmd";
let result = ensure_codex_mcp_server(input, win_path, &data_dir_pairs())
.expect("should add MCP section");
let doc = result
.parse::<toml_edit::DocumentMut>()
.expect("output must be valid TOML");
assert_eq!(
doc["mcp_servers"]["lean-ctx"]["command"].as_str(),
Some(win_path),
"Windows backslash path must round-trip exactly: {result}"
);
}
#[test]
fn ensure_mcp_server_does_not_match_similarly_named_section() {
let input = "\
[mcp_servers.lean-ctx-other]
command = \"other\"
";
let result = ensure_codex_mcp_server(input, "lean-ctx", &data_dir_pairs())
.expect("should add lean-ctx section despite similarly-named section");
assert!(result.contains("[mcp_servers.lean-ctx]\n"));
assert!(result.contains("[mcp_servers.lean-ctx-other]"));
}
#[test]
fn ensure_mcp_server_writes_project_and_extra_roots() {
let pairs = vec![
(
"LEAN_CTX_DATA_DIR".to_string(),
"/home/u/.lean-ctx".to_string(),
),
(
"LEAN_CTX_PROJECT_ROOT".to_string(),
"/work/main".to_string(),
),
(
"LEAN_CTX_EXTRA_ROOTS".to_string(),
"/work/wt-a:/work/wt-b".to_string(),
),
];
let result =
ensure_codex_mcp_server("", "lean-ctx", &pairs).expect("fresh config must be created");
let doc = result
.parse::<toml_edit::DocumentMut>()
.expect("output must be valid TOML");
let env = &doc["mcp_servers"]["lean-ctx"]["env"];
assert_eq!(env["LEAN_CTX_PROJECT_ROOT"].as_str(), Some("/work/main"));
assert_eq!(
env["LEAN_CTX_EXTRA_ROOTS"].as_str(),
Some("/work/wt-a:/work/wt-b")
);
assert_eq!(env["LEAN_CTX_DATA_DIR"].as_str(), Some("/home/u/.lean-ctx"));
}
#[test]
fn ensure_mcp_server_upserts_missing_keys_into_existing_env() {
let input = "[mcp_servers.lean-ctx]\ncommand = \"lean-ctx\"\nargs = []\n\n\
[mcp_servers.lean-ctx.env]\nLEAN_CTX_DATA_DIR = \"/home/u/.lean-ctx\"\n";
let pairs = vec![
(
"LEAN_CTX_DATA_DIR".to_string(),
"/home/u/.lean-ctx".to_string(),
),
(
"LEAN_CTX_PROJECT_ROOT".to_string(),
"/work/main".to_string(),
),
];
let result = ensure_codex_mcp_server(input, "lean-ctx", &pairs)
.expect("should upsert the missing project root");
assert_eq!(
result.matches("[mcp_servers.lean-ctx]").count(),
1,
"must not duplicate the parent section"
);
let doc = result
.parse::<toml_edit::DocumentMut>()
.expect("output must be valid TOML");
assert_eq!(
doc["mcp_servers"]["lean-ctx"]["env"]["LEAN_CTX_PROJECT_ROOT"].as_str(),
Some("/work/main")
);
assert!(
ensure_codex_mcp_server(&result, "lean-ctx", &pairs).is_none(),
"upsert must be idempotent"
);
}
}