openai/codex
1
0
Fork 0
mirror of https://github.com/openai/codex.git synced 2026-11-05 20:10:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add hooks for interrupted turns (#40511)

Browse Source 
## What changed

- Add an `Interrupt` hook event that runs for an active top-level turn before its
  interrupted abort event is emitted.
- Flush the turn transcript before invoking the hook and provide the session,
  turn, transcript, working directory, model, and permission mode in its input.
- Support command and MCP handlers, including asynchronous commands, with a
  one-second default timeout and a three-second maximum.
- Expose the event through hook configuration, managed requirements, app-server
  notifications, generated schemas, analytics, and the TUI hook views.

## Testing

- Cover handler discovery, timeout normalization, output parsing, protocol
  compatibility, TUI rendering, and interrupt execution ordering.

GitOrigin-RevId: 163fa7c098d94ac2775f6d137f8e916f8ea9b6eb
This commit is contained in:
Andrei Eternal
2026-08-25 01:27:18 +00:00
committed by copyberry
parent 9b2ef38f54
commit cbfd999db7
49 changed files with 1393 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files
codex-rs/app-server-protocol/schema/json/ServerNotification.json
Generated
+2 -1
View File
@@ -2098,7 +2098,8 @@
"userPromptSubmit",
"subagentStart",
"subagentStop",
"stop"
"stop",
"interrupt"
],
"type": "string"
},
codex-rs/app-server-protocol/schema/json/codex_app_server_protocol.schemas.json
Generated
+9 -1
View File
@@ -12463,7 +12463,8 @@
"userPromptSubmit",
"subagentStart",
"subagentStop",
"stop"
"stop",
"interrupt"
],
"type": "string"
},
@@ -13586,6 +13587,13 @@
},
"ManagedHooksRequirements": {
"properties": {
"Interrupt": {
"default": [],
"items": {
"$ref": "#/definitions/v2/ConfiguredHookMatcherGroup"
},
"type": "array"
},
"PermissionRequest": {
"items": {
"$ref": "#/definitions/v2/ConfiguredHookMatcherGroup"
codex-rs/app-server-protocol/schema/json/codex_app_server_protocol.v2.schemas.json
Generated
+9 -1
View File
@@ -8552,7 +8552,8 @@
"userPromptSubmit",
"subagentStart",
"subagentStop",
"stop"
"stop",
"interrupt"
],
"type": "string"
},
@@ -9736,6 +9737,13 @@
},
"ManagedHooksRequirements": {
"properties": {
"Interrupt": {
"default": [],
"items": {
"$ref": "#/definitions/ConfiguredHookMatcherGroup"
},
"type": "array"
},
"PermissionRequest": {
"items": {
"$ref": "#/definitions/ConfiguredHookMatcherGroup"
codex-rs/app-server-protocol/schema/json/v2/ConfigRequirementsReadResponse.json
Generated
+7
View File
@@ -720,6 +720,13 @@
},
"ManagedHooksRequirements": {
"properties": {
"Interrupt": {
"default": [],
"items": {
"$ref": "#/definitions/ConfiguredHookMatcherGroup"
},
"type": "array"
},
"PermissionRequest": {
"items": {
"$ref": "#/definitions/ConfiguredHookMatcherGroup"
codex-rs/app-server-protocol/schema/json/v2/HookCompletedNotification.json
Generated
+2 -1
View File
@@ -17,7 +17,8 @@
"userPromptSubmit",
"subagentStart",
"subagentStop",
"stop"
"stop",
"interrupt"
],
"type": "string"
},
codex-rs/app-server-protocol/schema/json/v2/HookStartedNotification.json
Generated
+2 -1
View File
@@ -17,7 +17,8 @@
"userPromptSubmit",
"subagentStart",
"subagentStop",
"stop"
"stop",
"interrupt"
],
"type": "string"
},
codex-rs/app-server-protocol/schema/json/v2/HooksListResponse.json
Generated
+2 -1
View File
@@ -32,7 +32,8 @@
"userPromptSubmit",
"subagentStart",
"subagentStop",
"stop"
"stop",
"interrupt"
],
"type": "string"
},
codex-rs/app-server-protocol/schema/json/v2/PluginReadResponse.json
Generated
+2 -1
View File
@@ -120,7 +120,8 @@
"userPromptSubmit",
"subagentStart",
"subagentStop",
"stop"
"stop",
"interrupt"
],
"type": "string"
},
codex-rs/app-server-protocol/schema/precomputed/app-server-exports-experimental.json.zst
Generated
BIN
View File
Binary file not shown.
codex-rs/app-server-protocol/schema/precomputed/app-server-exports-stable.json.zst
Generated
BIN
View File
Binary file not shown.
codex-rs/app-server-protocol/schema/typescript/v2/HookEventName.ts
Generated
+1 -1
View File
@@ -2,4 +2,4 @@
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
export type HookEventName = "preToolUse" | "permissionRequest" | "postToolUse" | "preCompact" | "postCompact" | "sessionStart" | "sessionEnd" | "userPromptSubmit" | "subagentStart" | "subagentStop" | "stop";
export type HookEventName = "preToolUse" | "permissionRequest" | "postToolUse" | "preCompact" | "postCompact" | "sessionStart" | "sessionEnd" | "userPromptSubmit" | "subagentStart" | "subagentStop" | "stop" | "interrupt";
codex-rs/app-server-protocol/schema/typescript/v2/ManagedHooksRequirements.ts
Generated
+1 -1
View File
@@ -3,4 +3,4 @@
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
import type { ConfiguredHookMatcherGroup } from "./ConfiguredHookMatcherGroup";
export type ManagedHooksRequirements = { managedDir: string | null, windowsManagedDir: string | null, PreToolUse: Array<ConfiguredHookMatcherGroup>, PermissionRequest: Array<ConfiguredHookMatcherGroup>, PostToolUse: Array<ConfiguredHookMatcherGroup>, PreCompact: Array<ConfiguredHookMatcherGroup>, PostCompact: Array<ConfiguredHookMatcherGroup>, SessionStart: Array<ConfiguredHookMatcherGroup>, SessionEnd: Array<ConfiguredHookMatcherGroup>, UserPromptSubmit: Array<ConfiguredHookMatcherGroup>, SubagentStart: Array<ConfiguredHookMatcherGroup>, SubagentStop: Array<ConfiguredHookMatcherGroup>, Stop: Array<ConfiguredHookMatcherGroup>, };
export type ManagedHooksRequirements = { managedDir: string | null, windowsManagedDir: string | null, PreToolUse: Array<ConfiguredHookMatcherGroup>, PermissionRequest: Array<ConfiguredHookMatcherGroup>, PostToolUse: Array<ConfiguredHookMatcherGroup>, PreCompact: Array<ConfiguredHookMatcherGroup>, PostCompact: Array<ConfiguredHookMatcherGroup>, SessionStart: Array<ConfiguredHookMatcherGroup>, SessionEnd: Array<ConfiguredHookMatcherGroup>, UserPromptSubmit: Array<ConfiguredHookMatcherGroup>, SubagentStart: Array<ConfiguredHookMatcherGroup>, SubagentStop: Array<ConfiguredHookMatcherGroup>, Stop: Array<ConfiguredHookMatcherGroup>, Interrupt: Array<ConfiguredHookMatcherGroup>, };
codex-rs/app-server-protocol/src/protocol/v2/config.rs
+3
View File
@@ -589,6 +589,9 @@ pub struct ManagedHooksRequirements {
#[serde(rename = "Stop")]
#[ts(rename = "Stop")]
pub stop: Vec<ConfiguredHookMatcherGroup>,
#[serde(rename = "Interrupt", default)]
#[ts(rename = "Interrupt")]
pub interrupt: Vec<ConfiguredHookMatcherGroup>,
}
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, JsonSchema, TS)]
codex-rs/app-server-protocol/src/protocol/v2/hook.rs
+1 -1
View File
@@ -17,7 +17,7 @@ use serde::Serialize;
v2_enum_from_core!(
pub enum HookEventName from CoreHookEventName {
PreToolUse, PermissionRequest, PostToolUse, PreCompact, PostCompact, SessionStart, SessionEnd, UserPromptSubmit, SubagentStart, SubagentStop, Stop
PreToolUse, PermissionRequest, PostToolUse, PreCompact, PostCompact, SessionStart, SessionEnd, UserPromptSubmit, SubagentStart, SubagentStop, Stop, Interrupt
}
);
codex-rs/app-server-protocol/src/protocol/v2/tests.rs
+24
View File
@@ -72,6 +72,30 @@ fn test_absolute_path() -> AbsolutePathBuf {
absolute_path("readable")
}
#[test]
fn managed_hooks_requirements_default_interrupt_to_empty() {
let value = json!({
"managedDir": null,
"windowsManagedDir": null,
"PreToolUse": [],
"PermissionRequest": [],
"PostToolUse": [],
"PreCompact": [],
"PostCompact": [],
"SessionStart": [],
"SessionEnd": [],
"UserPromptSubmit": [],
"SubagentStart": [],
"SubagentStop": [],
"Stop": []
});
let parsed: ManagedHooksRequirements =
serde_json::from_value(value).expect("deserialize managed hooks requirements");
assert_eq!(parsed.interrupt, Vec::new());
}
#[test]
fn external_agent_config_detect_response_defaults_connectors_for_older_servers() {
let response = serde_json::from_value::<ExternalAgentConfigDetectResponse>(json!({