mirror of
https://github.com/openai/codex.git
synced 2026-10-21 17:48:44 +00:00
Andrei EternalandVincent Koc
527d52df03
Based on work from Vincent K - https://github.com/openai/codex/pull/19060 <img width="1836" height="642" alt="CleanShot 2026-04-29 at 20 47 40@2x" src="https://github.com/user-attachments/assets/b647bb89-65fe-40c8-80b0-7a6b7c984634" /> ## Why Compaction rewrites the conversation context that future model turns receive, but hooks currently have no deterministic lifecycle point around that rewrite. This adds compact lifecycle hooks so users can audit manual and automatic compaction, surface hook messages in the UI, and run post-compaction follow-up without overloading tool or prompt hooks. ## What Changed - Added `PreCompact` and `PostCompact` hook events across hook config, discovery, dispatch, generated schemas, app-server notifications, analytics, and TUI hook rendering. - Added trigger matching for compact hooks with the documented `manual` and `auto` matcher values. - Wired `PreCompact` before both local and remote compaction, and `PostCompact` after successful local or remote compaction. - Kept compact hook command input to lifecycle metadata: session id, Codex turn id, transcript path, cwd, hook event name, model, and trigger. - Made compact stdout handling consistent with other hooks: plain stdout is ignored as debug output, while malformed JSON-looking stdout is reported as failed hook output. - Added integration coverage for compact hook dispatch, trigger matching, post-compact execution, and the audited behavior that `decision:"block"` does not block compaction. ## Out of Scope - Hook-specific compaction blocking is not implemented; `decision:"block"` and exit-code-2 blocking semantics are intentionally unsupported for `PreCompact`. - Custom compaction instructions are not exposed to compact hooks in this PR. - Compact summaries, summary character counts, and summary previews are not exposed to compact hooks in this PR. ## Verification - `cargo test -p codex-hooks` - `cargo test -p codex-core manual_pre_compact_block_decision_does_not_block_compaction` - `cargo test -p codex-app-server hooks_list` - `cargo test -p codex-core config_schema_matches_fixture` - `cargo test -p codex-tui hooks_browser` ## Docs The developer documentation for Codex hooks should be updated alongside this feature to document `PreCompact` and `PostCompact`, the `manual`/`auto` matcher values, and the compact hook payload fields. --------- Co-authored-by: Vincent Koc <vincentkoc@ieee.org>
73 lines
2.3 KiB
Rust
73 lines
2.3 KiB
Rust
mod config_rules;
|
|
mod engine;
|
|
pub(crate) mod events;
|
|
mod legacy_notify;
|
|
mod output_spill;
|
|
mod registry;
|
|
mod schema;
|
|
mod types;
|
|
|
|
pub use engine::HookListEntry;
|
|
/// Hook event names as they appear in hooks JSON and config files.
|
|
pub const HOOK_EVENT_NAMES: [&str; 8] = [
|
|
"PreToolUse",
|
|
"PermissionRequest",
|
|
"PostToolUse",
|
|
"PreCompact",
|
|
"PostCompact",
|
|
"SessionStart",
|
|
"UserPromptSubmit",
|
|
"Stop",
|
|
];
|
|
|
|
/// Hook event names whose matcher fields are meaningful during dispatch.
|
|
///
|
|
/// Other events can appear in hooks JSON, but Codex ignores their matcher
|
|
/// fields because those events do not dispatch against a tool, compaction
|
|
/// trigger, or session-start source.
|
|
pub const HOOK_EVENT_NAMES_WITH_MATCHERS: [&str; 6] = [
|
|
"PreToolUse",
|
|
"PermissionRequest",
|
|
"PostToolUse",
|
|
"PreCompact",
|
|
"PostCompact",
|
|
"SessionStart",
|
|
];
|
|
|
|
pub use events::compact::PostCompactRequest;
|
|
pub use events::compact::PreCompactOutcome;
|
|
pub use events::compact::PreCompactRequest;
|
|
pub use events::compact::StatelessHookOutcome;
|
|
pub use events::permission_request::PermissionRequestDecision;
|
|
pub use events::permission_request::PermissionRequestOutcome;
|
|
pub use events::permission_request::PermissionRequestRequest;
|
|
pub use events::post_tool_use::PostToolUseOutcome;
|
|
pub use events::post_tool_use::PostToolUseRequest;
|
|
pub use events::pre_tool_use::PreToolUseOutcome;
|
|
pub use events::pre_tool_use::PreToolUseRequest;
|
|
pub use events::session_start::SessionStartOutcome;
|
|
pub use events::session_start::SessionStartRequest;
|
|
pub use events::session_start::SessionStartSource;
|
|
pub use events::stop::StopOutcome;
|
|
pub use events::stop::StopRequest;
|
|
pub use events::user_prompt_submit::UserPromptSubmitOutcome;
|
|
pub use events::user_prompt_submit::UserPromptSubmitRequest;
|
|
pub use legacy_notify::legacy_notify_json;
|
|
pub use legacy_notify::notify_hook;
|
|
pub use registry::HookListOutcome;
|
|
pub use registry::Hooks;
|
|
pub use registry::HooksConfig;
|
|
pub use registry::command_from_argv;
|
|
pub use registry::list_hooks;
|
|
pub use schema::write_schema_fixtures;
|
|
pub use types::Hook;
|
|
pub use types::HookEvent;
|
|
pub use types::HookEventAfterAgent;
|
|
pub use types::HookEventAfterToolUse;
|
|
pub use types::HookPayload;
|
|
pub use types::HookResponse;
|
|
pub use types::HookResult;
|
|
pub use types::HookToolInput;
|
|
pub use types::HookToolInputLocalShell;
|
|
pub use types::HookToolKind;
|