xz-agent-hooks 0.1.0

Lifecycle hook contract, ordered registry, and wire parsers for agent extension hosts
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
//! Ordered hook registration and firing.

use crate::contract::{
    merge_outcomes, HookEvent, HookEventKind, HookOutcome, MergeMode, MergedEffect,
};
use async_trait::async_trait;
use std::time::Duration;

/// One registered hook handler.
#[async_trait]
pub trait HookHandler: Send + Sync {
    /// Stable name for logging.
    fn name(&self) -> &str;

    /// Event kinds this handler listens to. Empty = all kinds.
    fn event_kinds(&self) -> &[HookEventKind];

    /// Optional tool-name matcher (`*`, `?`, `|` alternation). `None` = all tools.
    fn tool_matcher(&self) -> Option<&str> {
        None
    }

    /// Whether this handler should run for `event`.
    fn matches(&self, event: &HookEvent) -> bool {
        let kinds = self.event_kinds();
        if !kinds.is_empty() && !kinds.contains(&event.kind) {
            return false;
        }
        if let Some(pat) = self.tool_matcher() {
            match event.tool.as_deref() {
                Some(tool) => {
                    if !glob_match(pat, tool) {
                        return false;
                    }
                }
                None => {
                    if matches!(
                        event.kind,
                        HookEventKind::PreTool
                            | HookEventKind::PostTool
                            | HookEventKind::PermissionRequest
                    ) {
                        return false;
                    }
                }
            }
        }
        true
    }

    /// Run the handler.
    async fn on_event(&self, event: &HookEvent) -> Result<Vec<HookOutcome>, String>;
}

/// Aggregated result of firing all matching handlers.
#[derive(Debug, Clone)]
pub struct HookFireResult {
    /// Outcomes in registration order (before merge).
    pub outcomes: Vec<HookOutcome>,
    /// Merged typed effect for the requested mode.
    pub effect: MergedEffect,
    /// Handler errors (fail-open); product may log.
    pub errors: Vec<String>,
}

impl Default for HookFireResult {
    fn default() -> Self {
        Self {
            outcomes: Vec::new(),
            effect: MergedEffect::Inject(Default::default()),
            errors: Vec::new(),
        }
    }
}

/// Ordered registry of hook handlers.
///
/// Registration order is preserved for deterministic mutate chains.
pub struct HookRegistry {
    handlers: Vec<Box<dyn HookHandler>>,
    /// Default timeout hint for products spawning external work (not enforced here).
    pub default_timeout: Duration,
}

impl Default for HookRegistry {
    fn default() -> Self {
        Self::new()
    }
}

impl HookRegistry {
    /// Empty registry.
    pub fn new() -> Self {
        Self {
            handlers: Vec::new(),
            default_timeout: Duration::from_secs(30),
        }
    }

    /// Register a handler (appended).
    pub fn register(&mut self, handler: Box<dyn HookHandler>) {
        self.handlers.push(handler);
    }

    /// Remove all handlers with this name. Returns how many were removed.
    pub fn remove(&mut self, name: &str) -> usize {
        let before = self.handlers.len();
        self.handlers.retain(|h| h.name() != name);
        before - self.handlers.len()
    }

    /// Clear all handlers.
    pub fn clear(&mut self) {
        self.handlers.clear();
    }

    /// Number of handlers.
    pub fn len(&self) -> usize {
        self.handlers.len()
    }

    /// Whether no handlers are registered.
    pub fn is_empty(&self) -> bool {
        self.handlers.is_empty()
    }

    /// Handler names in order.
    pub fn names(&self) -> Vec<String> {
        self.handlers.iter().map(|h| h.name().to_string()).collect()
    }

    /// Fire all matching handlers; merge with `mode`.
    ///
    /// On PreTool, **stops invoking further handlers** once a Deny outcome is produced.
    /// Errors from handlers are collected and treated as fail-open.
    pub async fn fire(&self, event: &HookEvent, mode: MergeMode) -> HookFireResult {
        let mut result = HookFireResult {
            outcomes: Vec::new(),
            effect: merge_outcomes(mode, &[]),
            errors: Vec::new(),
        };
        for h in &self.handlers {
            if !h.matches(event) {
                continue;
            }
            match h.on_event(event).await {
                Ok(outcomes) => {
                    let denied = outcomes
                        .iter()
                        .any(|o| matches!(o, HookOutcome::Deny { .. }));
                    result.outcomes.extend(outcomes);
                    if denied && mode == MergeMode::PreTool {
                        break;
                    }
                }
                Err(e) => {
                    tracing::warn!(hook = h.name(), error = %e, "hook handler error (fail-open)");
                    result.errors.push(format!("{}: {e}", h.name()));
                }
            }
        }
        result.effect = merge_outcomes(mode, &result.outcomes);
        result
    }

    /// Fire using the event kind's default merge mode.
    pub async fn fire_default(&self, event: &HookEvent) -> HookFireResult {
        self.fire(event, event.kind.default_merge_mode()).await
    }

    /// Convenience: PreTool fire + merge.
    pub async fn fire_pre_tool(&self, event: &HookEvent) -> HookFireResult {
        self.fire(event, MergeMode::PreTool).await
    }

    /// Convenience: PostTool fire + merge.
    pub async fn fire_post_tool(&self, event: &HookEvent) -> HookFireResult {
        self.fire(event, MergeMode::PostTool).await
    }

    /// Convenience: PermissionRequest fire + merge.
    pub async fn fire_permission(&self, event: &HookEvent) -> HookFireResult {
        self.fire(event, MergeMode::PermissionRequest).await
    }
}

/// Simple glob: `*` any chars, `?` one char; `|` alternation.
///
/// Exact match (no wildcards) is case-insensitive. Patterns with `*`/`?` are case-sensitive.
/// Claude-style `Bash(npm:*)` is reduced to the tool name before `(`.
pub fn glob_match(pattern: &str, text: &str) -> bool {
    if pattern == "*" || pattern.is_empty() {
        return true;
    }
    if pattern.contains('|') {
        return pattern.split('|').any(|p| glob_match(p.trim(), text));
    }
    let pat = pattern.split('(').next().unwrap_or(pattern).trim();
    if !pat.contains('*') && !pat.contains('?') {
        return pat.eq_ignore_ascii_case(text);
    }
    let pat: Vec<char> = pat.chars().collect();
    let text: Vec<char> = text.chars().collect();
    match_glob(&pat, &text)
}

fn match_glob(pat: &[char], text: &[char]) -> bool {
    let mut pi = 0;
    let mut ti = 0;
    let mut star_p = None;
    let mut star_t = 0;
    while ti < text.len() {
        if pi < pat.len() && (pat[pi] == '?' || pat[pi] == text[ti]) {
            pi += 1;
            ti += 1;
        } else if pi < pat.len() && pat[pi] == '*' {
            star_p = Some(pi);
            star_t = ti;
            pi += 1;
        } else if let Some(sp) = star_p {
            pi = sp + 1;
            star_t += 1;
            ti = star_t;
        } else {
            return false;
        }
    }
    while pi < pat.len() && pat[pi] == '*' {
        pi += 1;
    }
    pi == pat.len()
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::contract::{PermissionDecision, PreToolEffect};
    use serde_json::json;

    struct StaticHook {
        name: String,
        kinds: Vec<HookEventKind>,
        matcher: Option<String>,
        outcomes: Vec<HookOutcome>,
        fail: bool,
    }

    #[async_trait]
    impl HookHandler for StaticHook {
        fn name(&self) -> &str {
            &self.name
        }
        fn event_kinds(&self) -> &[HookEventKind] {
            &self.kinds
        }
        fn tool_matcher(&self) -> Option<&str> {
            self.matcher.as_deref()
        }
        async fn on_event(&self, _event: &HookEvent) -> Result<Vec<HookOutcome>, String> {
            if self.fail {
                return Err("boom".into());
            }
            Ok(self.outcomes.clone())
        }
    }

    fn hook(
        name: &str,
        kinds: &[HookEventKind],
        matcher: Option<&str>,
        outcomes: Vec<HookOutcome>,
    ) -> StaticHook {
        StaticHook {
            name: name.into(),
            kinds: kinds.to_vec(),
            matcher: matcher.map(str::to_string),
            outcomes,
            fail: false,
        }
    }

    #[tokio::test]
    async fn ordered_mutate_and_deny_short_circuit() {
        let mut reg = HookRegistry::new();
        reg.register(Box::new(hook(
            "a",
            &[HookEventKind::PreTool],
            None,
            vec![HookOutcome::mutate_args(json!({"command": "one"}))],
        )));
        reg.register(Box::new(hook(
            "b",
            &[HookEventKind::PreTool],
            None,
            vec![HookOutcome::deny("stop")],
        )));
        reg.register(Box::new(hook(
            "c",
            &[HookEventKind::PreTool],
            None,
            vec![HookOutcome::mutate_args(json!({"command": "three"}))],
        )));

        let ev = HookEvent::pre_tool("shell", json!({}));
        let r = reg.fire_pre_tool(&ev).await;
        let PreToolEffect { deny, args, .. } = r.effect.as_pre_tool().cloned().unwrap_or_default();
        assert_eq!(deny.as_deref(), Some("stop"));
        assert_eq!(args, Some(json!({"command": "one"})));
        assert_eq!(r.outcomes.len(), 2);
    }

    #[tokio::test]
    async fn fail_open_on_handler_error() {
        let mut reg = HookRegistry::new();
        reg.register(Box::new(StaticHook {
            name: "bad".into(),
            kinds: vec![],
            matcher: None,
            outcomes: vec![],
            fail: true,
        }));
        reg.register(Box::new(hook(
            "good",
            &[],
            None,
            vec![HookOutcome::context("ok")],
        )));
        let r = reg
            .fire(
                &HookEvent::unit(HookEventKind::SessionStart),
                MergeMode::InjectOnly,
            )
            .await;
        assert_eq!(r.errors.len(), 1);
        assert_eq!(r.effect.contexts().len(), 1);
    }

    #[tokio::test]
    async fn tool_matcher_filters() {
        let mut reg = HookRegistry::new();
        reg.register(Box::new(hook(
            "only-shell",
            &[HookEventKind::PreTool],
            Some("shell|Bash"),
            vec![HookOutcome::deny("x")],
        )));
        let r = reg
            .fire_pre_tool(&HookEvent::pre_tool("FileRead", json!({})))
            .await;
        assert!(r.outcomes.is_empty());
        let r = reg
            .fire_pre_tool(&HookEvent::pre_tool("Bash", json!({})))
            .await;
        assert!(r.effect.as_pre_tool().is_some_and(|e| e.is_denied()));
    }

    #[tokio::test]
    async fn kind_filter() {
        let mut reg = HookRegistry::new();
        reg.register(Box::new(hook(
            "pre-only",
            &[HookEventKind::PreTool],
            None,
            vec![HookOutcome::context("x")],
        )));
        let r = reg
            .fire_default(&HookEvent::unit(HookEventKind::SessionStart))
            .await;
        assert!(r.outcomes.is_empty());
    }

    #[tokio::test]
    async fn remove_and_clear() {
        let mut reg = HookRegistry::new();
        reg.register(Box::new(hook("a", &[], None, vec![])));
        reg.register(Box::new(hook("b", &[], None, vec![])));
        assert_eq!(reg.len(), 2);
        assert_eq!(reg.remove("a"), 1);
        assert_eq!(reg.names(), vec!["b".to_string()]);
        reg.clear();
        assert!(reg.is_empty());
    }

    #[tokio::test]
    async fn post_tool_and_permission_helpers() {
        let mut reg = HookRegistry::new();
        reg.register(Box::new(hook(
            "p",
            &[HookEventKind::PostTool],
            None,
            vec![HookOutcome::replace_result("new")],
        )));
        reg.register(Box::new(hook(
            "perm",
            &[HookEventKind::PermissionRequest],
            None,
            vec![HookOutcome::Allow],
        )));
        let r = reg
            .fire_post_tool(&HookEvent::post_tool("t", "old"))
            .await;
        assert_eq!(
            r.effect
                .as_post_tool()
                .and_then(|e| e.replace_result.as_deref()),
            Some("new")
        );
        let r = reg
            .fire_permission(&HookEvent::permission_request("t", json!({})))
            .await;
        assert_eq!(
            r.effect.as_permission().map(|e| &e.decision),
            Some(&PermissionDecision::Allow)
        );
    }

    #[test]
    fn glob_cases() {
        assert!(glob_match("Bash|Shell", "Shell"));
        assert!(glob_match("File*", "FileRead"));
        assert!(!glob_match("Git*", "FileRead"));
        assert!(glob_match("bash", "Bash")); // exact case-insensitive
        assert!(glob_match("*", "anything"));
        assert!(glob_match("Bash(npm:*)", "Bash"));
        assert!(glob_match("f?o", "foo"));
        assert!(!glob_match("f?o", "fooo"));
    }
}