mirror of
https://github.com/openai/codex.git
synced 2026-11-17 22:10:37 +00:00
# What <img width="1792" height="1024" alt="image" src="https://github.com/user-attachments/assets/8f81d232-5813-4994-a61d-e42a05a93a3e" /> `SubagentStop` runs when a thread-spawned subagent turn is about to finish. Thread-spawned subagents use `SubagentStop` instead of the normal root-agent `Stop` hook. Configured handlers match on `agent_type`. Hook input includes the normal stop fields plus: - `agent_id`: the child thread id. - `agent_type`: the resolved subagent type. - `agent_transcript_path`: the child subagent transcript path. - `transcript_path`: the parent thread transcript path. - `last_assistant_message`: the final assistant message from the child turn, when available. - `stop_hook_active`: `true` when the child is already continuing because an earlier stop-like hook blocked completion. `SubagentStop` shares the same completion-control semantics as `Stop`, scoped to the child turn: - No decision allows the child turn to finish. - `decision: "block"` with a non-empty `reason` records that reason as hook feedback and continues the child with that prompt. - `continue: false` stops the child turn. If `stopReason` is present, Codex surfaces it as the stop reason. # Lifecycle Scope Only thread-spawned subagents run `SubagentStop`. Internal/system subagents such as Review, Compact, MemoryConsolidation, and Other do not run normal `Stop` hooks and do not run `SubagentStop`. This avoids exposing synthetic matcher labels for internal implementation paths. # Stack 1. #22782: add `SubagentStart`. 2. This PR: add `SubagentStop`. 3. #22882: add subagent identity to normal hook inputs.
151 lines
7.0 KiB
Rust
151 lines
7.0 KiB
Rust
use std::sync::OnceLock;
|
|
|
|
use serde_json::Value;
|
|
|
|
#[allow(dead_code)]
|
|
pub(crate) struct GeneratedHookSchemas {
|
|
pub post_tool_use_command_input: Value,
|
|
pub post_tool_use_command_output: Value,
|
|
pub permission_request_command_input: Value,
|
|
pub permission_request_command_output: Value,
|
|
pub post_compact_command_input: Value,
|
|
pub post_compact_command_output: Value,
|
|
pub pre_tool_use_command_input: Value,
|
|
pub pre_tool_use_command_output: Value,
|
|
pub pre_compact_command_input: Value,
|
|
pub pre_compact_command_output: Value,
|
|
pub session_start_command_input: Value,
|
|
pub session_start_command_output: Value,
|
|
pub subagent_start_command_input: Value,
|
|
pub subagent_start_command_output: Value,
|
|
pub subagent_stop_command_input: Value,
|
|
pub subagent_stop_command_output: Value,
|
|
pub user_prompt_submit_command_input: Value,
|
|
pub user_prompt_submit_command_output: Value,
|
|
pub stop_command_input: Value,
|
|
pub stop_command_output: Value,
|
|
}
|
|
|
|
pub(crate) fn generated_hook_schemas() -> &'static GeneratedHookSchemas {
|
|
static SCHEMAS: OnceLock<GeneratedHookSchemas> = OnceLock::new();
|
|
SCHEMAS.get_or_init(|| GeneratedHookSchemas {
|
|
post_tool_use_command_input: parse_json_schema(
|
|
"post-tool-use.command.input",
|
|
include_str!("../../schema/generated/post-tool-use.command.input.schema.json"),
|
|
),
|
|
post_tool_use_command_output: parse_json_schema(
|
|
"post-tool-use.command.output",
|
|
include_str!("../../schema/generated/post-tool-use.command.output.schema.json"),
|
|
),
|
|
permission_request_command_input: parse_json_schema(
|
|
"permission-request.command.input",
|
|
include_str!("../../schema/generated/permission-request.command.input.schema.json"),
|
|
),
|
|
permission_request_command_output: parse_json_schema(
|
|
"permission-request.command.output",
|
|
include_str!("../../schema/generated/permission-request.command.output.schema.json"),
|
|
),
|
|
post_compact_command_input: parse_json_schema(
|
|
"post-compact.command.input",
|
|
include_str!("../../schema/generated/post-compact.command.input.schema.json"),
|
|
),
|
|
post_compact_command_output: parse_json_schema(
|
|
"post-compact.command.output",
|
|
include_str!("../../schema/generated/post-compact.command.output.schema.json"),
|
|
),
|
|
pre_tool_use_command_input: parse_json_schema(
|
|
"pre-tool-use.command.input",
|
|
include_str!("../../schema/generated/pre-tool-use.command.input.schema.json"),
|
|
),
|
|
pre_tool_use_command_output: parse_json_schema(
|
|
"pre-tool-use.command.output",
|
|
include_str!("../../schema/generated/pre-tool-use.command.output.schema.json"),
|
|
),
|
|
pre_compact_command_input: parse_json_schema(
|
|
"pre-compact.command.input",
|
|
include_str!("../../schema/generated/pre-compact.command.input.schema.json"),
|
|
),
|
|
pre_compact_command_output: parse_json_schema(
|
|
"pre-compact.command.output",
|
|
include_str!("../../schema/generated/pre-compact.command.output.schema.json"),
|
|
),
|
|
session_start_command_input: parse_json_schema(
|
|
"session-start.command.input",
|
|
include_str!("../../schema/generated/session-start.command.input.schema.json"),
|
|
),
|
|
session_start_command_output: parse_json_schema(
|
|
"session-start.command.output",
|
|
include_str!("../../schema/generated/session-start.command.output.schema.json"),
|
|
),
|
|
subagent_start_command_input: parse_json_schema(
|
|
"subagent-start.command.input",
|
|
include_str!("../../schema/generated/subagent-start.command.input.schema.json"),
|
|
),
|
|
subagent_start_command_output: parse_json_schema(
|
|
"subagent-start.command.output",
|
|
include_str!("../../schema/generated/subagent-start.command.output.schema.json"),
|
|
),
|
|
subagent_stop_command_input: parse_json_schema(
|
|
"subagent-stop.command.input",
|
|
include_str!("../../schema/generated/subagent-stop.command.input.schema.json"),
|
|
),
|
|
subagent_stop_command_output: parse_json_schema(
|
|
"subagent-stop.command.output",
|
|
include_str!("../../schema/generated/subagent-stop.command.output.schema.json"),
|
|
),
|
|
user_prompt_submit_command_input: parse_json_schema(
|
|
"user-prompt-submit.command.input",
|
|
include_str!("../../schema/generated/user-prompt-submit.command.input.schema.json"),
|
|
),
|
|
user_prompt_submit_command_output: parse_json_schema(
|
|
"user-prompt-submit.command.output",
|
|
include_str!("../../schema/generated/user-prompt-submit.command.output.schema.json"),
|
|
),
|
|
stop_command_input: parse_json_schema(
|
|
"stop.command.input",
|
|
include_str!("../../schema/generated/stop.command.input.schema.json"),
|
|
),
|
|
stop_command_output: parse_json_schema(
|
|
"stop.command.output",
|
|
include_str!("../../schema/generated/stop.command.output.schema.json"),
|
|
),
|
|
})
|
|
}
|
|
|
|
fn parse_json_schema(name: &str, schema: &str) -> Value {
|
|
serde_json::from_str(schema)
|
|
.unwrap_or_else(|err| panic!("invalid generated hooks schema {name}: {err}"))
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::generated_hook_schemas;
|
|
use pretty_assertions::assert_eq;
|
|
|
|
#[test]
|
|
fn loads_generated_hook_schemas() {
|
|
let schemas = generated_hook_schemas();
|
|
|
|
assert_eq!(schemas.post_tool_use_command_input["type"], "object");
|
|
assert_eq!(schemas.post_tool_use_command_output["type"], "object");
|
|
assert_eq!(schemas.permission_request_command_input["type"], "object");
|
|
assert_eq!(schemas.permission_request_command_output["type"], "object");
|
|
assert_eq!(schemas.post_compact_command_input["type"], "object");
|
|
assert_eq!(schemas.post_compact_command_output["type"], "object");
|
|
assert_eq!(schemas.pre_tool_use_command_input["type"], "object");
|
|
assert_eq!(schemas.pre_tool_use_command_output["type"], "object");
|
|
assert_eq!(schemas.pre_compact_command_input["type"], "object");
|
|
assert_eq!(schemas.pre_compact_command_output["type"], "object");
|
|
assert_eq!(schemas.session_start_command_input["type"], "object");
|
|
assert_eq!(schemas.session_start_command_output["type"], "object");
|
|
assert_eq!(schemas.subagent_start_command_input["type"], "object");
|
|
assert_eq!(schemas.subagent_start_command_output["type"], "object");
|
|
assert_eq!(schemas.subagent_stop_command_input["type"], "object");
|
|
assert_eq!(schemas.subagent_stop_command_output["type"], "object");
|
|
assert_eq!(schemas.user_prompt_submit_command_input["type"], "object");
|
|
assert_eq!(schemas.user_prompt_submit_command_output["type"], "object");
|
|
assert_eq!(schemas.stop_command_input["type"], "object");
|
|
assert_eq!(schemas.stop_command_output["type"], "object");
|
|
}
|
|
}
|