turboclaudeagent 0.3.0

Interactive Agent SDK for TurboClaude - Use Claude agents in your Rust applications
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
429
430
431
432
//! Hook system for agent event handling
//!
//! Provides a registry for registering and dispatching hooks that fire during query execution.
//! Hooks can observe events (PreToolUse, PostToolUse, etc.) and optionally modify inputs.

use crate::error::Result as AgentResult;
use std::collections::HashMap;
use std::future::Future;
use std::pin::Pin;
use std::sync::Arc;
use tokio::sync::Mutex;
use turboclaude_protocol::{HookRequest, HookResponse};

/// Type alias for async hook handlers
///
/// Handlers take a HookRequest and return a Future with a HookResponse.
pub type HookHandler = (
    String,
    Arc<
        dyn Fn(HookRequest) -> Pin<Box<dyn Future<Output = AgentResult<HookResponse>> + Send>>
            + Send
            + Sync,
    >,
);

/// Handle for a registered hook (allows deregistration)
#[derive(Debug, Clone)]
pub struct HookHandle {
    id: String,
    event_type: String,
}

/// Registry for hook handlers
///
/// Stores handlers for different hook event types and provides dispatch functionality.
/// Handlers are called sequentially, and responses are merged with AND logic (all must continue).
pub struct HookRegistry {
    /// Map of event type to list of handlers
    handlers: Arc<Mutex<HashMap<String, Vec<HookHandler>>>>,
}

impl HookRegistry {
    /// Create a new hook registry
    pub fn new() -> Self {
        Self {
            handlers: Arc::new(Mutex::new(HashMap::new())),
        }
    }

    /// Register a handler for a specific hook event type
    ///
    /// Returns a handle that can be used to deregister the handler later.
    pub async fn register<F>(&self, event_type: impl Into<String>, handler: F) -> HookHandle
    where
        F: Fn(HookRequest) -> Pin<Box<dyn Future<Output = AgentResult<HookResponse>> + Send>>
            + Send
            + Sync
            + 'static,
    {
        let event_type = event_type.into();
        let handler = Arc::new(handler);
        let id = format!("{}-{}", event_type, uuid::Uuid::new_v4());

        let mut handlers = self.handlers.lock().await;
        handlers
            .entry(event_type.clone())
            .or_insert_with(Vec::new)
            .push((id.clone(), handler));

        HookHandle { id, event_type }
    }

    /// Dispatch a hook event to all registered handlers
    ///
    /// Calls handlers sequentially and merges responses:
    /// - ALL handlers must return continue=true for overall continue=true
    /// - Modified inputs from handlers are merged (later overrides earlier)
    /// - Contexts are accumulated
    pub async fn dispatch(
        &self,
        event_type: impl Into<String>,
        request: HookRequest,
    ) -> AgentResult<HookResponse> {
        let event_type = event_type.into();
        let handlers = self.handlers.lock().await;

        // Get handlers for this event type
        let event_handlers = match handlers.get(&event_type) {
            Some(h) => h.clone(),
            None => {
                // No handlers registered, return continue=true
                return Ok(HookResponse::continue_exec());
            }
        };

        // Call each handler and collect responses
        let mut responses = Vec::new();
        for (_id, handler) in event_handlers {
            let response = handler(request.clone()).await?;
            responses.push(response);
        }

        // Merge responses
        Ok(merge_hook_responses(responses))
    }

    /// Deregister a hook.
    pub async fn deregister(&self, handle: HookHandle) {
        let mut handlers = self.handlers.lock().await;
        if let Some(event_handlers) = handlers.get_mut(&handle.event_type) {
            event_handlers.retain(|(id, _)| id != &handle.id);
        }
    }
}

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

/// Merge multiple hook responses into a single response
///
/// Semantics:
/// - continue_: AND logic (all must say true for result to be true)
/// - modified_inputs: Later inputs override earlier ones
/// - context: Accumulated from all hooks
/// - permission_decision: First non-None value wins (deny > ask > allow)
/// - Additional fields: Later values override earlier ones
fn merge_hook_responses(responses: Vec<HookResponse>) -> HookResponse {
    if responses.is_empty() {
        return HookResponse {
            continue_: true,
            modified_inputs: None,
            context: None,
            permission_decision: None,
            permission_decision_reason: None,
            additional_context: None,
            continue_reason: None,
            stop_reason: None,
            system_message: None,
            reason: None,
            suppress_output: None,
        };
    }

    // ALL must say continue for result to be true
    let continue_ = responses.iter().all(|r| r.continue_);

    // Merge modified inputs (later overrides earlier)
    let modified_inputs = responses
        .iter()
        .filter_map(|r| r.modified_inputs.clone())
        .next_back();

    // Accumulate contexts
    let mut context = None;
    for response in &responses {
        if let Some(ctx) = &response.context {
            match context {
                None => context = Some(ctx.clone()),
                Some(ref mut existing) => {
                    // Merge into existing context
                    if let (serde_json::Value::Object(obj), serde_json::Value::Object(new)) =
                        (existing, ctx)
                    {
                        for (k, v) in new {
                            obj.insert(k.clone(), v.clone());
                        }
                    }
                }
            }
        }
    }

    // Permission decision: deny > ask > allow (most restrictive wins)
    let permission_decision = responses
        .iter()
        .filter_map(|r| r.permission_decision.as_ref())
        .find(|d| d.as_str() == "deny")
        .or_else(|| {
            responses
                .iter()
                .filter_map(|r| r.permission_decision.as_ref())
                .find(|d| d.as_str() == "ask")
        })
        .or_else(|| {
            responses
                .iter()
                .filter_map(|r| r.permission_decision.as_ref())
                .next()
        })
        .cloned();

    // Other fields: later overrides earlier
    let permission_decision_reason = responses
        .iter()
        .filter_map(|r| r.permission_decision_reason.clone())
        .next_back();

    let additional_context = responses
        .iter()
        .filter_map(|r| r.additional_context.clone())
        .next_back();

    let continue_reason = responses
        .iter()
        .filter_map(|r| r.continue_reason.clone())
        .next_back();

    let stop_reason = responses
        .iter()
        .filter_map(|r| r.stop_reason.clone())
        .next_back();

    let system_message = responses
        .iter()
        .filter_map(|r| r.system_message.clone())
        .next_back();

    let reason = responses
        .iter()
        .filter_map(|r| r.reason.clone())
        .next_back();

    let suppress_output = responses
        .iter()
        .filter_map(|r| r.suppress_output)
        .next_back();

    HookResponse {
        continue_,
        modified_inputs,
        context,
        permission_decision,
        permission_decision_reason,
        additional_context,
        continue_reason,
        stop_reason,
        system_message,
        reason,
        suppress_output,
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[tokio::test]
    async fn test_hook_registry_creation() {
        let registry = HookRegistry::new();
        assert_eq!(registry.handlers.lock().await.len(), 0);
    }

    #[tokio::test]
    async fn test_hook_register() {
        let registry = HookRegistry::new();

        registry
            .register("PreToolUse", |_req| {
                Box::pin(async { Ok(HookResponse::continue_exec()) })
            })
            .await;

        assert_eq!(registry.handlers.lock().await.len(), 1);
    }

    #[tokio::test]
    async fn test_hook_dispatch_no_handlers() {
        let registry = HookRegistry::new();
        let request = HookRequest {
            event_type: "PreToolUse".to_string(),
            data: serde_json::json!({}),
        };

        let response = registry.dispatch("PreToolUse", request).await.unwrap();
        assert!(response.continue_);
        assert!(response.modified_inputs.is_none());
        assert!(response.permission_decision.is_none());
    }

    #[tokio::test]
    async fn test_hook_dispatch_single_handler() {
        let registry = HookRegistry::new();

        registry
            .register("PreToolUse", |_req| {
                Box::pin(async { Ok(HookResponse::continue_exec()) })
            })
            .await;

        let request = HookRequest {
            event_type: "PreToolUse".to_string(),
            data: serde_json::json!({}),
        };

        let response = registry.dispatch("PreToolUse", request).await.unwrap();
        assert!(response.continue_);
    }

    #[tokio::test]
    async fn test_hook_dispatch_multiple_handlers_all_continue() {
        let registry = HookRegistry::new();

        registry
            .register("PreToolUse", |_req| {
                Box::pin(async { Ok(HookResponse::continue_exec()) })
            })
            .await;

        registry
            .register("PreToolUse", |_req| {
                Box::pin(async { Ok(HookResponse::continue_exec()) })
            })
            .await;

        let request = HookRequest {
            event_type: "PreToolUse".to_string(),
            data: serde_json::json!({}),
        };

        let response = registry.dispatch("PreToolUse", request).await.unwrap();
        assert!(response.continue_);
    }

    #[tokio::test]
    async fn test_hook_dispatch_one_handler_stops() {
        let registry = HookRegistry::new();

        registry
            .register("PreToolUse", |_req| {
                Box::pin(async { Ok(HookResponse::continue_exec()) })
            })
            .await;

        registry
            .register("PreToolUse", |_req| {
                Box::pin(async { Ok(HookResponse::stop()) })
            })
            .await;

        let request = HookRequest {
            event_type: "PreToolUse".to_string(),
            data: serde_json::json!({}),
        };

        let response = registry.dispatch("PreToolUse", request).await.unwrap();
        assert!(!response.continue_); // One handler said stop
    }

    #[tokio::test]
    async fn test_hook_response_merge_continue() {
        let responses = vec![HookResponse::continue_exec(), HookResponse::continue_exec()];

        let merged = merge_hook_responses(responses);
        assert!(merged.continue_);
    }

    #[tokio::test]
    async fn test_hook_response_merge_stop() {
        let responses = vec![HookResponse::continue_exec(), HookResponse::stop()];

        let merged = merge_hook_responses(responses);
        assert!(!merged.continue_);
    }

    #[tokio::test]
    async fn test_hook_response_merge_inputs() {
        let mut resp1 = HookResponse::continue_exec();
        resp1.modified_inputs = Some(turboclaude_protocol::ModifiedInputs {
            tool_name: Some("tool1".to_string()),
            input: None,
        });

        let mut resp2 = HookResponse::continue_exec();
        resp2.modified_inputs = Some(turboclaude_protocol::ModifiedInputs {
            tool_name: Some("tool2".to_string()),
            input: None,
        });

        let responses = vec![resp1, resp2];

        let merged = merge_hook_responses(responses);
        assert!(merged.continue_);
        assert_eq!(
            merged.modified_inputs.unwrap().tool_name,
            Some("tool2".to_string())
        ); // Later overrides
    }

    #[tokio::test]
    async fn test_hook_response_merge_permission_decision() {
        // Test that "deny" wins over "allow"
        let resp1 = HookResponse::continue_exec().with_permission_decision("allow");
        let resp2 = HookResponse::continue_exec().with_permission_decision("deny");

        let merged = merge_hook_responses(vec![resp1, resp2]);
        assert_eq!(merged.permission_decision, Some("deny".to_string()));

        // Test that "ask" wins over "allow"
        let resp1 = HookResponse::continue_exec().with_permission_decision("allow");
        let resp2 = HookResponse::continue_exec().with_permission_decision("ask");

        let merged = merge_hook_responses(vec![resp1, resp2]);
        assert_eq!(merged.permission_decision, Some("ask".to_string()));

        // Test that "deny" wins over "ask"
        let resp1 = HookResponse::continue_exec().with_permission_decision("ask");
        let resp2 = HookResponse::continue_exec().with_permission_decision("deny");

        let merged = merge_hook_responses(vec![resp1, resp2]);
        assert_eq!(merged.permission_decision, Some("deny".to_string()));
    }

    #[tokio::test]
    async fn test_hook_response_merge_additional_fields() {
        let resp1 = HookResponse::continue_exec()
            .with_system_message("First message")
            .with_reason("First reason");

        let resp2 = HookResponse::continue_exec()
            .with_system_message("Second message")
            .with_additional_context(serde_json::json!({"key": "value"}));

        let merged = merge_hook_responses(vec![resp1, resp2]);
        assert_eq!(merged.system_message, Some("Second message".to_string()));
        // reason: Last non-None value wins (resp2 had no reason, so resp1's remains)
        assert_eq!(merged.reason, Some("First reason".to_string()));
        assert!(merged.additional_context.is_some());
    }
}