mirror of
https://github.com/openai/codex.git
synced 2026-11-07 20:30:33 +00:00
- add `PreToolUse` hook for bash-like tool execution only at first - block shell execution before dispatch with deny-only hook behavior - introduces common.rs matcher framework for matching when hooks are run example run: ``` › run three parallel echo commands, and the second one should echo "[block-pre-tool-use]" as a test • Running the three echo commands in parallel now and I’ll report the output directly. • Running PreToolUse hook: name for demo pre tool use hook • Running PreToolUse hook: name for demo pre tool use hook • Running PreToolUse hook: name for demo pre tool use hook PreToolUse hook (completed) warning: wizard-tower PreToolUse demo inspected Bash: echo "first parallel echo" PreToolUse hook (blocked) warning: wizard-tower PreToolUse demo blocked a Bash command on purpose. feedback: PreToolUse demo blocked the command. Remove [block-pre-tool-use] to continue. PreToolUse hook (completed) warning: wizard-tower PreToolUse demo inspected Bash: echo "third parallel echo" • Ran echo "first parallel echo" └ first parallel echo • Ran echo "third parallel echo" └ third parallel echo • Three little waves went out in parallel. 1. printed first parallel echo 2. was blocked before execution because it contained the exact test string [block-pre-tool-use] 3. printed third parallel echo There was also an unrelated macOS defaults warning around the successful commands, but the echoes themselves worked fine. If you want, I can rerun the second one with a slightly modified string so it passes cleanly. ```
181 lines
5.3 KiB
Rust
181 lines
5.3 KiB
Rust
use codex_protocol::protocol::HookCompletedEvent;
|
|
use codex_protocol::protocol::HookEventName;
|
|
use codex_protocol::protocol::HookOutputEntry;
|
|
use codex_protocol::protocol::HookOutputEntryKind;
|
|
use codex_protocol::protocol::HookRunStatus;
|
|
|
|
use crate::engine::ConfiguredHandler;
|
|
use crate::engine::dispatcher;
|
|
|
|
pub(crate) fn join_text_chunks(chunks: Vec<String>) -> Option<String> {
|
|
if chunks.is_empty() {
|
|
None
|
|
} else {
|
|
Some(chunks.join("\n\n"))
|
|
}
|
|
}
|
|
|
|
pub(crate) fn trimmed_non_empty(text: &str) -> Option<String> {
|
|
let trimmed = text.trim();
|
|
if trimmed.is_empty() {
|
|
None
|
|
} else {
|
|
Some(trimmed.to_string())
|
|
}
|
|
}
|
|
|
|
pub(crate) fn append_additional_context(
|
|
entries: &mut Vec<HookOutputEntry>,
|
|
additional_contexts_for_model: &mut Vec<String>,
|
|
additional_context: String,
|
|
) {
|
|
entries.push(HookOutputEntry {
|
|
kind: HookOutputEntryKind::Context,
|
|
text: additional_context.clone(),
|
|
});
|
|
additional_contexts_for_model.push(additional_context);
|
|
}
|
|
|
|
pub(crate) fn flatten_additional_contexts<'a>(
|
|
additional_contexts: impl IntoIterator<Item = &'a [String]>,
|
|
) -> Vec<String> {
|
|
additional_contexts
|
|
.into_iter()
|
|
.flat_map(|chunk| chunk.iter().cloned())
|
|
.collect()
|
|
}
|
|
|
|
pub(crate) fn serialization_failure_hook_events(
|
|
handlers: Vec<ConfiguredHandler>,
|
|
turn_id: Option<String>,
|
|
error_message: String,
|
|
) -> Vec<HookCompletedEvent> {
|
|
handlers
|
|
.into_iter()
|
|
.map(|handler| {
|
|
let mut run = dispatcher::running_summary(&handler);
|
|
run.status = HookRunStatus::Failed;
|
|
run.completed_at = Some(run.started_at);
|
|
run.duration_ms = Some(0);
|
|
run.entries = vec![HookOutputEntry {
|
|
kind: HookOutputEntryKind::Error,
|
|
text: error_message.clone(),
|
|
}];
|
|
HookCompletedEvent {
|
|
turn_id: turn_id.clone(),
|
|
run,
|
|
}
|
|
})
|
|
.collect()
|
|
}
|
|
|
|
pub(crate) fn matcher_pattern_for_event(
|
|
event_name: HookEventName,
|
|
matcher: Option<&str>,
|
|
) -> Option<&str> {
|
|
match event_name {
|
|
HookEventName::PreToolUse | HookEventName::SessionStart => matcher,
|
|
HookEventName::UserPromptSubmit | HookEventName::Stop => None,
|
|
}
|
|
}
|
|
|
|
pub(crate) fn validate_matcher_pattern(matcher: &str) -> Result<(), regex::Error> {
|
|
if is_match_all_matcher(matcher) {
|
|
return Ok(());
|
|
}
|
|
regex::Regex::new(matcher).map(|_| ())
|
|
}
|
|
|
|
pub(crate) fn matches_matcher(matcher: Option<&str>, input: Option<&str>) -> bool {
|
|
match matcher {
|
|
None => true,
|
|
Some(matcher) if is_match_all_matcher(matcher) => true,
|
|
Some(matcher) => input
|
|
.and_then(|input| {
|
|
regex::Regex::new(matcher)
|
|
.ok()
|
|
.map(|regex| regex.is_match(input))
|
|
})
|
|
.unwrap_or(false),
|
|
}
|
|
}
|
|
|
|
fn is_match_all_matcher(matcher: &str) -> bool {
|
|
matcher.is_empty() || matcher == "*"
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use codex_protocol::protocol::HookEventName;
|
|
use pretty_assertions::assert_eq;
|
|
|
|
use super::matcher_pattern_for_event;
|
|
use super::matches_matcher;
|
|
use super::validate_matcher_pattern;
|
|
|
|
#[test]
|
|
fn matcher_omitted_matches_all_occurrences() {
|
|
assert!(matches_matcher(None, Some("Bash")));
|
|
assert!(matches_matcher(None, Some("Write")));
|
|
}
|
|
|
|
#[test]
|
|
fn matcher_star_matches_all_occurrences() {
|
|
assert!(matches_matcher(Some("*"), Some("Bash")));
|
|
assert!(matches_matcher(Some("*"), Some("Edit")));
|
|
assert_eq!(validate_matcher_pattern("*"), Ok(()));
|
|
}
|
|
|
|
#[test]
|
|
fn matcher_empty_string_matches_all_occurrences() {
|
|
assert!(matches_matcher(Some(""), Some("Bash")));
|
|
assert!(matches_matcher(Some(""), Some("SessionStart")));
|
|
assert_eq!(validate_matcher_pattern(""), Ok(()));
|
|
}
|
|
|
|
#[test]
|
|
fn matcher_uses_regex_matching() {
|
|
assert!(matches_matcher(Some("Edit|Write"), Some("Edit")));
|
|
assert!(matches_matcher(Some("Edit|Write"), Some("Write")));
|
|
assert!(!matches_matcher(Some("Edit|Write"), Some("Bash")));
|
|
assert_eq!(validate_matcher_pattern("Edit|Write"), Ok(()));
|
|
}
|
|
|
|
#[test]
|
|
fn matcher_supports_anchored_regexes() {
|
|
assert!(matches_matcher(Some("^Bash$"), Some("Bash")));
|
|
assert!(!matches_matcher(Some("^Bash$"), Some("BashOutput")));
|
|
assert_eq!(validate_matcher_pattern("^Bash$"), Ok(()));
|
|
}
|
|
|
|
#[test]
|
|
fn invalid_regex_is_rejected() {
|
|
assert!(validate_matcher_pattern("[").is_err());
|
|
assert!(!matches_matcher(Some("["), Some("Bash")));
|
|
}
|
|
|
|
#[test]
|
|
fn unsupported_events_ignore_matchers() {
|
|
assert_eq!(
|
|
matcher_pattern_for_event(HookEventName::UserPromptSubmit, Some("^hello")),
|
|
None
|
|
);
|
|
assert_eq!(
|
|
matcher_pattern_for_event(HookEventName::Stop, Some("^done$")),
|
|
None
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn supported_events_keep_matchers() {
|
|
assert_eq!(
|
|
matcher_pattern_for_event(HookEventName::PreToolUse, Some("Bash")),
|
|
Some("Bash")
|
|
);
|
|
assert_eq!(
|
|
matcher_pattern_for_event(HookEventName::SessionStart, Some("startup|resume")),
|
|
Some("startup|resume")
|
|
);
|
|
}
|
|
}
|