smith-protocol 0.1.2

Shared protocol definitions for agent execution system
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
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
use crate::{capabilities, Event};
use anyhow::{anyhow, Result};
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use uuid::Uuid;

/// Protocol version constants
pub const PROTOCOL_V0: u32 = 0;
pub const PROTOCOL_V1: u32 = 1;
pub const CURRENT_VERSION: u32 = PROTOCOL_V0; // v0 is current stable

/// Supported protocol versions in order of preference (newest first)
pub const SUPPORTED_VERSIONS: &[u32] = &[PROTOCOL_V1, PROTOCOL_V0];

/// Version negotiation result
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct NegotiationResult {
    pub version: u32,
    pub capabilities: Vec<String>,
    pub fallback_reason: Option<String>,
    pub service_info: HashMap<String, String>,
}

/// Client information for negotiation
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ClientInfo {
    pub supported_versions: Vec<u32>,
    pub requested_capabilities: Vec<String>,
    pub client_metadata: HashMap<String, String>,
}

/// Version and capability negotiator
pub struct ProtocolNegotiator {
    service_id: Uuid,
    available_capabilities: Vec<String>,
    service_metadata: HashMap<String, String>,
}

impl ProtocolNegotiator {
    pub fn new(service_id: Uuid) -> Self {
        let mut service_metadata = HashMap::new();
        service_metadata.insert(
            "service_name".to_string(),
            "claude-code-rs-core".to_string(),
        );
        service_metadata.insert("version".to_string(), env!("CARGO_PKG_VERSION").to_string());
        service_metadata.insert(
            "build_timestamp".to_string(),
            std::env::var("BUILD_TIMESTAMP").unwrap_or_else(|_| "unknown".to_string()),
        );
        service_metadata.insert(
            "git_commit".to_string(),
            std::env::var("GIT_COMMIT").unwrap_or_else(|_| "unknown".to_string()),
        );

        // Determine available capabilities based on compile-time features
        let available_capabilities = vec![
            capabilities::SHELL_EXEC.to_string(),
            capabilities::REPLAY.to_string(),
            capabilities::TRACING.to_string(),
            #[cfg(feature = "hooks-quickjs")]
            capabilities::HOOKS_JS.to_string(),
            #[cfg(feature = "hooks-rust")]
            capabilities::HOOKS_RUST.to_string(),
            #[cfg(feature = "nats")]
            capabilities::NATS.to_string(),
        ];

        #[cfg(feature = "protobuf")]
        service_metadata.insert("protobuf_support".to_string(), "true".to_string());

        Self {
            service_id,
            available_capabilities,
            service_metadata,
        }
    }

    /// Negotiate protocol version and capabilities with a client
    pub fn negotiate(&self, client_info: ClientInfo) -> Result<NegotiationResult> {
        // Find the highest mutually supported version
        let selected_version = self.select_version(&client_info.supported_versions)?;

        // Filter capabilities to those we actually support
        let granted_capabilities = self.filter_capabilities(&client_info.requested_capabilities);

        // Determine if fallback is needed
        let fallback_reason =
            self.check_fallback_conditions(selected_version, &granted_capabilities);

        // Add negotiation metadata
        let mut service_info = self.service_metadata.clone();
        service_info.insert(
            "negotiated_version".to_string(),
            selected_version.to_string(),
        );
        service_info.insert(
            "granted_capabilities".to_string(),
            granted_capabilities.len().to_string(),
        );

        Ok(NegotiationResult {
            version: selected_version,
            capabilities: granted_capabilities,
            fallback_reason,
            service_info,
        })
    }

    /// Select the best mutually supported protocol version
    fn select_version(&self, client_versions: &[u32]) -> Result<u32> {
        // Find the highest version that both client and server support
        for &server_version in SUPPORTED_VERSIONS {
            if client_versions.contains(&server_version) {
                return Ok(server_version);
            }
        }

        Err(anyhow!(
            "No compatible protocol version found. Server supports: {:?}, Client supports: {:?}",
            SUPPORTED_VERSIONS,
            client_versions
        ))
    }

    /// Filter requested capabilities to those actually available
    fn filter_capabilities(&self, requested: &[String]) -> Vec<String> {
        requested
            .iter()
            .filter(|cap| self.available_capabilities.contains(cap))
            .cloned()
            .collect()
    }

    /// Check if fallback to v0 is needed despite v1 being negotiated
    fn check_fallback_conditions(&self, version: u32, _capabilities: &[String]) -> Option<String> {
        match version {
            PROTOCOL_V1 => {
                // Check if protobuf feature is actually enabled
                #[cfg(not(feature = "protobuf"))]
                {
                    Some("Protobuf support not compiled in, falling back to JSONL".to_string())
                }

                #[cfg(feature = "protobuf")]
                {
                    // Could add other runtime checks here
                    None
                }
            }
            PROTOCOL_V0 => None, // v0 always works
            _ => Some(format!("Unsupported version {}, using v0", version)),
        }
    }

    /// Create a Ready event after successful negotiation
    pub fn create_ready_event(&self, result: &NegotiationResult) -> Event {
        Event::Ready {
            version: result.version,
            capabilities: result.capabilities.clone(),
            service_id: self.service_id,
        }
    }

    /// Get available capabilities
    pub fn get_available_capabilities(&self) -> &[String] {
        &self.available_capabilities
    }

    /// Check if a specific capability is supported
    pub fn supports_capability(&self, capability: &str) -> bool {
        self.available_capabilities
            .contains(&capability.to_string())
    }

    /// Get service metadata
    pub fn get_service_metadata(&self) -> &HashMap<String, String> {
        &self.service_metadata
    }
}

/// Capability compatibility checker
pub struct CapabilityChecker;

impl CapabilityChecker {
    /// Check if requested capabilities are compatible with each other
    pub fn check_compatibility(capabilities: &[String]) -> Result<Vec<String>> {
        let mut warnings = Vec::new();

        // Check for conflicting hook systems
        let has_js_hooks = capabilities.contains(&capabilities::HOOKS_JS.to_string());
        let has_rust_hooks = capabilities.contains(&capabilities::HOOKS_RUST.to_string());

        if has_js_hooks && has_rust_hooks {
            warnings
                .push("Both JS and Rust hooks enabled - performance may be impacted".to_string());
        }

        // Check for NATS without tracing (suboptimal observability)
        let has_nats = capabilities.contains(&capabilities::NATS.to_string());
        let has_tracing = capabilities.contains(&capabilities::TRACING.to_string());

        if has_nats && !has_tracing {
            warnings.push("NATS enabled without tracing - reduced observability".to_string());
        }

        // Warn about replay overhead
        let has_replay = capabilities.contains(&capabilities::REPLAY.to_string());
        if has_replay {
            warnings.push(
                "Replay enabled - performance overhead for recording all operations".to_string(),
            );
        }

        Ok(warnings)
    }

    /// Get recommended capabilities for a given use case
    pub fn recommend_capabilities(use_case: &str) -> Vec<String> {
        match use_case {
            "development" => vec![
                capabilities::SHELL_EXEC.to_string(),
                capabilities::HOOKS_JS.to_string(),
                capabilities::REPLAY.to_string(),
                capabilities::TRACING.to_string(),
            ],
            "production" => vec![
                capabilities::SHELL_EXEC.to_string(),
                capabilities::HOOKS_RUST.to_string(),
                capabilities::TRACING.to_string(),
                capabilities::NATS.to_string(),
            ],
            "testing" => vec![
                capabilities::SHELL_EXEC.to_string(),
                capabilities::REPLAY.to_string(),
                capabilities::TRACING.to_string(),
            ],
            "minimal" => vec![capabilities::SHELL_EXEC.to_string()],
            _ => vec![
                capabilities::SHELL_EXEC.to_string(),
                capabilities::TRACING.to_string(),
            ],
        }
    }
}

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

    #[test]
    fn test_version_negotiation() {
        let negotiator = ProtocolNegotiator::new(Uuid::new_v4());

        // Test successful negotiation
        let client_info = ClientInfo {
            supported_versions: vec![0, 1],
            requested_capabilities: vec![
                capabilities::SHELL_EXEC.to_string(),
                capabilities::TRACING.to_string(),
            ],
            client_metadata: HashMap::new(),
        };

        let result = negotiator.negotiate(client_info).unwrap();

        // Should select the highest mutually supported version
        assert!(result.version <= 1);
        assert!(result
            .capabilities
            .contains(&capabilities::SHELL_EXEC.to_string()));
        assert!(result
            .capabilities
            .contains(&capabilities::TRACING.to_string()));
    }

    #[test]
    fn test_incompatible_versions() {
        let negotiator = ProtocolNegotiator::new(Uuid::new_v4());

        let client_info = ClientInfo {
            supported_versions: vec![999], // Unsupported version
            requested_capabilities: vec![],
            client_metadata: HashMap::new(),
        };

        let result = negotiator.negotiate(client_info);
        assert!(result.is_err());
    }

    #[test]
    fn test_capability_filtering() {
        let negotiator = ProtocolNegotiator::new(Uuid::new_v4());

        let client_info = ClientInfo {
            supported_versions: vec![0],
            requested_capabilities: vec![
                capabilities::SHELL_EXEC.to_string(),
                "non_existent_capability".to_string(),
            ],
            client_metadata: HashMap::new(),
        };

        let result = negotiator.negotiate(client_info).unwrap();

        // Should only grant supported capabilities
        assert!(result
            .capabilities
            .contains(&capabilities::SHELL_EXEC.to_string()));
        assert!(!result
            .capabilities
            .contains(&"non_existent_capability".to_string()));
    }

    #[test]
    fn test_capability_compatibility() {
        let warnings = CapabilityChecker::check_compatibility(&[
            capabilities::HOOKS_JS.to_string(),
            capabilities::HOOKS_RUST.to_string(),
        ])
        .unwrap();

        // Should warn about conflicting hook systems
        assert!(!warnings.is_empty());
        assert!(warnings[0].contains("JS and Rust hooks"));
    }

    #[test]
    fn test_use_case_recommendations() {
        let dev_caps = CapabilityChecker::recommend_capabilities("development");
        let prod_caps = CapabilityChecker::recommend_capabilities("production");

        // Development should include replay for debugging
        assert!(dev_caps.contains(&capabilities::REPLAY.to_string()));
        assert!(dev_caps.contains(&capabilities::HOOKS_JS.to_string()));

        // Production should prioritize performance
        assert!(!prod_caps.contains(&capabilities::REPLAY.to_string()));
        assert!(prod_caps.contains(&capabilities::HOOKS_RUST.to_string()));
        assert!(prod_caps.contains(&capabilities::NATS.to_string()));
    }

    #[test]
    fn test_protocol_constants() {
        // Test protocol version constants
        assert_eq!(PROTOCOL_V0, 0);
        assert_eq!(PROTOCOL_V1, 1);
        assert_eq!(CURRENT_VERSION, PROTOCOL_V0);

        // Test supported versions array
        assert!(SUPPORTED_VERSIONS.contains(&PROTOCOL_V0));
        assert!(SUPPORTED_VERSIONS.contains(&PROTOCOL_V1));
        assert!(SUPPORTED_VERSIONS.len() >= 2);
    }

    #[test]
    fn test_negotiator_methods() {
        let service_id = Uuid::new_v4();
        let negotiator = ProtocolNegotiator::new(service_id);

        // Test capability support checking
        assert!(negotiator.supports_capability(capabilities::SHELL_EXEC));
        assert!(negotiator.supports_capability(capabilities::TRACING));
        assert!(!negotiator.supports_capability("non_existent_capability"));

        // Test available capabilities
        let caps = negotiator.get_available_capabilities();
        assert!(!caps.is_empty());
        assert!(caps.contains(&capabilities::SHELL_EXEC.to_string()));

        // Test service metadata
        let metadata = negotiator.get_service_metadata();
        assert!(metadata.contains_key("service_name"));
        assert!(metadata.contains_key("version"));
        assert_eq!(metadata.get("service_name").unwrap(), "claude-code-rs-core");
    }

    #[test]
    fn test_ready_event_creation() {
        let service_id = Uuid::new_v4();
        let negotiator = ProtocolNegotiator::new(service_id);

        let negotiation_result = NegotiationResult {
            version: PROTOCOL_V0,
            capabilities: vec![capabilities::SHELL_EXEC.to_string()],
            fallback_reason: None,
            service_info: HashMap::new(),
        };

        let event = negotiator.create_ready_event(&negotiation_result);

        match event {
            Event::Ready {
                version,
                capabilities,
                service_id: event_service_id,
            } => {
                assert_eq!(version, PROTOCOL_V0);
                assert_eq!(capabilities, vec![capabilities::SHELL_EXEC.to_string()]);
                assert_eq!(event_service_id, service_id);
            }
            _ => panic!("Expected Ready event"),
        }
    }

    #[test]
    fn test_fallback_conditions_v0() {
        let negotiator = ProtocolNegotiator::new(Uuid::new_v4());
        let fallback = negotiator.check_fallback_conditions(PROTOCOL_V0, &[]);
        assert!(fallback.is_none()); // v0 should never need fallback
    }

    #[test]
    fn test_fallback_conditions_unsupported_version() {
        let negotiator = ProtocolNegotiator::new(Uuid::new_v4());
        let fallback = negotiator.check_fallback_conditions(999, &[]);
        assert!(fallback.is_some());
        assert!(fallback.unwrap().contains("Unsupported version 999"));
    }

    #[test]
    fn test_capability_compatibility_nats_without_tracing() {
        let warnings =
            CapabilityChecker::check_compatibility(&[capabilities::NATS.to_string()]).unwrap();

        // Should warn about NATS without tracing
        assert!(!warnings.is_empty());
        assert!(warnings
            .iter()
            .any(|w| w.contains("NATS enabled without tracing")));
    }

    #[test]
    fn test_capability_compatibility_with_replay() {
        let warnings =
            CapabilityChecker::check_compatibility(&[capabilities::REPLAY.to_string()]).unwrap();

        // Should warn about replay overhead
        assert!(!warnings.is_empty());
        assert!(warnings.iter().any(|w| w.contains("Replay enabled")));
    }

    #[test]
    fn test_capability_compatibility_good_config() {
        let warnings = CapabilityChecker::check_compatibility(&[
            capabilities::SHELL_EXEC.to_string(),
            capabilities::TRACING.to_string(),
        ])
        .unwrap();

        // No warnings for good configuration
        assert!(warnings.is_empty());
    }

    #[test]
    fn test_use_case_recommendations_all_variants() {
        let test_cases = vec![
            (
                "development",
                vec![
                    capabilities::SHELL_EXEC,
                    capabilities::HOOKS_JS,
                    capabilities::REPLAY,
                    capabilities::TRACING,
                ],
            ),
            (
                "production",
                vec![
                    capabilities::SHELL_EXEC,
                    capabilities::HOOKS_RUST,
                    capabilities::TRACING,
                    capabilities::NATS,
                ],
            ),
            (
                "testing",
                vec![
                    capabilities::SHELL_EXEC,
                    capabilities::REPLAY,
                    capabilities::TRACING,
                ],
            ),
            ("minimal", vec![capabilities::SHELL_EXEC]),
            (
                "unknown_use_case",
                vec![capabilities::SHELL_EXEC, capabilities::TRACING],
            ),
        ];

        for (use_case, expected_caps) in test_cases {
            let recommendations = CapabilityChecker::recommend_capabilities(use_case);
            for cap in expected_caps {
                assert!(
                    recommendations.contains(&cap.to_string()),
                    "Use case '{}' should include capability '{}'",
                    use_case,
                    cap
                );
            }
        }
    }

    #[test]
    fn test_client_info_and_negotiation_result_serialization() {
        // Test ClientInfo serialization
        let mut metadata = HashMap::new();
        metadata.insert("client_version".to_string(), "1.0.0".to_string());

        let client_info = ClientInfo {
            supported_versions: vec![0, 1],
            requested_capabilities: vec![capabilities::SHELL_EXEC.to_string()],
            client_metadata: metadata,
        };

        let json = serde_json::to_string(&client_info).unwrap();
        let deserialized: ClientInfo = serde_json::from_str(&json).unwrap();
        assert_eq!(deserialized.supported_versions, vec![0, 1]);
        assert_eq!(
            deserialized.requested_capabilities,
            vec![capabilities::SHELL_EXEC.to_string()]
        );

        // Test NegotiationResult serialization
        let mut service_info = HashMap::new();
        service_info.insert("key".to_string(), "value".to_string());

        let result = NegotiationResult {
            version: PROTOCOL_V0,
            capabilities: vec![capabilities::SHELL_EXEC.to_string()],
            fallback_reason: Some("test fallback".to_string()),
            service_info,
        };

        let json = serde_json::to_string(&result).unwrap();
        let deserialized: NegotiationResult = serde_json::from_str(&json).unwrap();
        assert_eq!(deserialized.version, PROTOCOL_V0);
        assert_eq!(
            deserialized.fallback_reason,
            Some("test fallback".to_string())
        );
    }

    #[test]
    fn test_empty_client_versions_negotiation() {
        let negotiator = ProtocolNegotiator::new(Uuid::new_v4());

        let client_info = ClientInfo {
            supported_versions: vec![], // Empty versions
            requested_capabilities: vec![],
            client_metadata: HashMap::new(),
        };

        let result = negotiator.negotiate(client_info);
        assert!(result.is_err());
        assert!(result
            .unwrap_err()
            .to_string()
            .contains("No compatible protocol version"));
    }

    #[test]
    fn test_empty_requested_capabilities() {
        let negotiator = ProtocolNegotiator::new(Uuid::new_v4());

        let client_info = ClientInfo {
            supported_versions: vec![PROTOCOL_V0],
            requested_capabilities: vec![], // Empty capabilities
            client_metadata: HashMap::new(),
        };

        let result = negotiator.negotiate(client_info).unwrap();
        assert_eq!(result.version, PROTOCOL_V0);
        assert!(result.capabilities.is_empty()); // Should grant no capabilities
    }

    #[test]
    fn test_version_selection_priority() {
        let negotiator = ProtocolNegotiator::new(Uuid::new_v4());

        // Client supports both versions - should select the newer one (v1)
        let client_info = ClientInfo {
            supported_versions: vec![PROTOCOL_V0, PROTOCOL_V1],
            requested_capabilities: vec![],
            client_metadata: HashMap::new(),
        };

        let result = negotiator.negotiate(client_info).unwrap();
        // Should prefer the highest supported version (v1 is preferred in SUPPORTED_VERSIONS)
        assert!(SUPPORTED_VERSIONS.contains(&result.version));
    }
}