paladin-ai 0.4.3

Enterprise AI orchestration framework with multi-agent coordination patterns
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
//! Paladin Registry - HashMap-based Implementation
//!
//! This module provides a thread-safe, HashMap-based implementation of the
//! `PaladinRegistry` trait for storing and retrieving Paladin instances by ID.
//!
//! # Features
//!
//! - Thread-safe concurrent access using `RwLock`
//! - `O(1)` average case lookup performance
//! - Duplicate ID prevention
//! - Shared ownership via `Arc<Paladin>`
//!
//! # Example
//!
//! ```rust
//! use paladin::infrastructure::adapters::paladin_registry::HashMapPaladinRegistry;
//! use paladin_ports::output::paladin_registry::PaladinRegistry;
//! use paladin::core::platform::container::paladin::{PaladinData, Paladin};
//! use paladin::core::base::entity::node::Node;
//! use std::sync::Arc;
//!
//! let registry = HashMapPaladinRegistry::new();
//!
//! // Register a Paladin
//! let paladin_data = PaladinData::default();
//! let paladin = Node::new(paladin_data, Some("analyzer".to_string()));
//! registry.register("analyzer".to_string(), Arc::new(paladin)).unwrap();
//!
//! // Retrieve it
//! let retrieved = registry.get("analyzer").expect("Paladin should exist");
//! assert_eq!(retrieved.name, Some("analyzer".to_string()));
//! ```

use crate::core::platform::container::paladin::Paladin;
use paladin_ports::output::paladin_registry::{PaladinRegistry, RegistryError};
use std::collections::HashMap;
use std::sync::{Arc, RwLock};

/// HashMap-based Paladin registry with thread-safe concurrent access
///
/// Uses a `RwLock<HashMap>` internally to allow multiple concurrent readers
/// or a single writer. This provides good performance for read-heavy workloads
/// (which is typical for registry lookups during Battalion execution).
///
/// # Thread Safety
///
/// - Multiple threads can read simultaneously
/// - Writes are exclusive (block all other access)
/// - Lock poisoning is handled by returning `AccessFailed` errors
///
/// # Performance
///
/// - `register`: O(1) average case, acquires write lock
/// - `get`: O(1) average case, acquires read lock
/// - `contains`: O(1) average case, acquires read lock
/// - `list_ids`: O(n) where n is the number of registered Paladins, acquires read lock
#[derive(Debug, Default)]
pub struct HashMapPaladinRegistry {
    /// Internal storage: Paladin ID -> Arc<Paladin>
    paladins: RwLock<HashMap<String, Arc<Paladin>>>,
}

impl HashMapPaladinRegistry {
    /// Create a new empty registry
    ///
    /// # Example
    ///
    /// ```rust
    /// use paladin::infrastructure::adapters::paladin_registry::HashMapPaladinRegistry;
    /// use paladin_ports::output::paladin_registry::PaladinRegistry;
    ///
    /// let registry = HashMapPaladinRegistry::new();
    /// assert!(registry.list_ids().is_empty());
    /// ```
    pub fn new() -> Self {
        Self {
            paladins: RwLock::new(HashMap::new()),
        }
    }

    /// Create a pre-populated registry from a HashMap
    ///
    /// Useful for testing or when migrating from another registry implementation.
    ///
    /// # Arguments
    ///
    /// * `paladins` - Initial HashMap of Paladin ID to Paladin mappings
    ///
    /// # Example
    ///
    /// ```rust
    /// use paladin::infrastructure::adapters::paladin_registry::HashMapPaladinRegistry;
    /// use paladin_ports::output::paladin_registry::PaladinRegistry;
    /// use paladin::core::platform::container::paladin::{PaladinData, Paladin};
    /// use paladin::core::base::entity::node::Node;
    /// use std::collections::HashMap;
    /// use std::sync::Arc;
    ///
    /// let mut initial = HashMap::new();
    /// let paladin_data = PaladinData::default();
    /// let paladin = Node::new(paladin_data, Some("analyzer".to_string()));
    /// initial.insert("analyzer".to_string(), Arc::new(paladin));
    ///
    /// let registry = HashMapPaladinRegistry::from_map(initial);
    /// assert!(registry.contains("analyzer"));
    /// ```
    pub fn from_map(paladins: HashMap<String, Arc<Paladin>>) -> Self {
        Self {
            paladins: RwLock::new(paladins),
        }
    }

    /// Get the current count of registered Paladins
    ///
    /// # Returns
    ///
    /// Number of Paladins currently in the registry
    ///
    /// # Example
    ///
    /// ```rust
    /// use paladin::infrastructure::adapters::paladin_registry::HashMapPaladinRegistry;
    /// use paladin_ports::output::paladin_registry::PaladinRegistry;
    /// use paladin::core::platform::container::paladin::{PaladinData, Paladin};
    /// use paladin::core::base::entity::node::Node;
    /// use std::sync::Arc;
    ///
    /// let registry = HashMapPaladinRegistry::new();
    /// assert_eq!(registry.count(), 0);
    ///
    /// let paladin_data = PaladinData::default();
    /// let paladin = Node::new(paladin_data, Some("test".to_string()));
    /// registry.register("test".to_string(), Arc::new(paladin)).unwrap();
    /// assert_eq!(registry.count(), 1);
    /// ```
    pub fn count(&self) -> usize {
        self.paladins.read().map(|map| map.len()).unwrap_or(0)
    }

    /// Clear all registered Paladins
    ///
    /// This is a destructive operation that removes all Paladins from the registry.
    /// Useful for cleanup or reset scenarios.
    ///
    /// # Example
    ///
    /// ```rust
    /// use paladin::infrastructure::adapters::paladin_registry::HashMapPaladinRegistry;
    /// use paladin_ports::output::paladin_registry::PaladinRegistry;
    /// use paladin::core::platform::container::paladin::{PaladinData, Paladin};
    /// use paladin::core::base::entity::node::Node;
    /// use std::sync::Arc;
    ///
    /// let registry = HashMapPaladinRegistry::new();
    /// let paladin_data = PaladinData::default();
    /// let paladin = Node::new(paladin_data, Some("test".to_string()));
    /// registry.register("test".to_string(), Arc::new(paladin)).unwrap();
    ///
    /// registry.clear();
    /// assert_eq!(registry.count(), 0);
    /// ```
    pub fn clear(&self) {
        if let Ok(mut map) = self.paladins.write() {
            map.clear();
        }
    }
}

impl PaladinRegistry for HashMapPaladinRegistry {
    fn register(&self, id: String, paladin: Arc<Paladin>) -> Result<(), RegistryError> {
        // Validate ID is not empty
        if id.is_empty() {
            return Err(RegistryError::InvalidId("ID cannot be empty".to_string()));
        }

        // Acquire write lock
        let mut map = self
            .paladins
            .write()
            .map_err(|e| RegistryError::AccessFailed(format!("Write lock poisoned: {}", e)))?;

        // Check for duplicates
        if map.contains_key(&id) {
            return Err(RegistryError::DuplicateId(id));
        }

        // Insert and return success
        map.insert(id, paladin);
        Ok(())
    }

    fn get(&self, id: &str) -> Option<Arc<Paladin>> {
        // Acquire read lock - on error, return None
        let map = self.paladins.read().ok()?;

        // Clone the Arc (cheap operation, just increments reference count)
        map.get(id).cloned()
    }

    fn contains(&self, id: &str) -> bool {
        // Acquire read lock - on error, return false
        let Ok(map) = self.paladins.read() else {
            return false;
        };

        map.contains_key(id)
    }

    fn list_ids(&self) -> Vec<String> {
        // Acquire read lock - on error, return empty vec
        let Ok(map) = self.paladins.read() else {
            return Vec::new();
        };

        // Collect all keys into a vector
        map.keys().cloned().collect()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::core::base::entity::node::Node;
    use crate::core::platform::container::paladin::PaladinData;
    use std::thread;

    fn create_test_paladin(id: &str) -> Paladin {
        let data = PaladinData {
            system_prompt: format!("Test paladin {}", id),
            name: id.to_string(),
            ..Default::default()
        };
        Node::new(data, Some(id.to_string()))
    }

    #[test]
    fn test_registry_register_and_get() {
        let registry = HashMapPaladinRegistry::new();
        let paladin = create_test_paladin("test_paladin");

        // Register
        let result = registry.register("test_paladin".to_string(), Arc::new(paladin));
        assert!(result.is_ok(), "Registration should succeed");

        // Retrieve
        let retrieved = registry.get("test_paladin");
        assert!(retrieved.is_some(), "Paladin should be retrievable");
        assert_eq!(retrieved.unwrap().name, Some("test_paladin".to_string()));
    }

    #[test]
    fn test_registry_duplicate_id_error() {
        let registry = HashMapPaladinRegistry::new();
        let paladin1 = create_test_paladin("duplicate");
        let paladin2 = create_test_paladin("duplicate");

        // First registration succeeds
        assert!(
            registry
                .register("duplicate".to_string(), Arc::new(paladin1))
                .is_ok()
        );

        // Second registration fails
        let result = registry.register("duplicate".to_string(), Arc::new(paladin2));
        assert!(result.is_err(), "Duplicate registration should fail");

        match result.unwrap_err() {
            RegistryError::DuplicateId(id) => assert_eq!(id, "duplicate"),
            _ => panic!("Expected DuplicateId error"),
        }
    }

    #[test]
    fn test_registry_contains() {
        let registry = HashMapPaladinRegistry::new();
        let paladin = create_test_paladin("exists");

        // Before registration
        assert!(!registry.contains("exists"), "Should not exist initially");

        // After registration
        registry
            .register("exists".to_string(), Arc::new(paladin))
            .unwrap();
        assert!(
            registry.contains("exists"),
            "Should exist after registration"
        );
        assert!(
            !registry.contains("nonexistent"),
            "Non-existent should return false"
        );
    }

    #[test]
    fn test_registry_list_ids() {
        let registry = HashMapPaladinRegistry::new();

        // Empty initially
        assert_eq!(registry.list_ids().len(), 0);

        // Add three paladins
        registry
            .register(
                "paladin1".to_string(),
                Arc::new(create_test_paladin("paladin1")),
            )
            .unwrap();
        registry
            .register(
                "paladin2".to_string(),
                Arc::new(create_test_paladin("paladin2")),
            )
            .unwrap();
        registry
            .register(
                "paladin3".to_string(),
                Arc::new(create_test_paladin("paladin3")),
            )
            .unwrap();

        let ids = registry.list_ids();
        assert_eq!(ids.len(), 3);
        assert!(ids.contains(&"paladin1".to_string()));
        assert!(ids.contains(&"paladin2".to_string()));
        assert!(ids.contains(&"paladin3".to_string()));
    }

    #[test]
    fn test_registry_thread_safety() {
        let registry = Arc::new(HashMapPaladinRegistry::new());
        let mut handles = vec![];

        // Spawn 10 threads that concurrently register paladins
        for i in 0..10 {
            let registry_clone = Arc::clone(&registry);
            let handle = thread::spawn(move || {
                let id = format!("paladin_{}", i);
                let paladin = create_test_paladin(&id);
                registry_clone.register(id, Arc::new(paladin)).unwrap();
            });
            handles.push(handle);
        }

        // Wait for all threads to complete
        for handle in handles {
            handle.join().unwrap();
        }

        // Verify all paladins were registered
        assert_eq!(registry.count(), 10);
        for i in 0..10 {
            let id = format!("paladin_{}", i);
            assert!(registry.contains(&id), "Paladin {} should exist", id);
        }
    }

    #[test]
    fn test_registry_invalid_id() {
        let registry = HashMapPaladinRegistry::new();
        let paladin = create_test_paladin("test");

        let result = registry.register("".to_string(), Arc::new(paladin));
        assert!(result.is_err(), "Empty ID should fail");

        match result.unwrap_err() {
            RegistryError::InvalidId(_) => {}
            _ => panic!("Expected InvalidId error"),
        }
    }

    #[test]
    fn test_registry_count() {
        let registry = HashMapPaladinRegistry::new();
        assert_eq!(registry.count(), 0);

        registry
            .register("p1".to_string(), Arc::new(create_test_paladin("p1")))
            .unwrap();
        assert_eq!(registry.count(), 1);

        registry
            .register("p2".to_string(), Arc::new(create_test_paladin("p2")))
            .unwrap();
        assert_eq!(registry.count(), 2);
    }

    #[test]
    fn test_registry_clear() {
        let registry = HashMapPaladinRegistry::new();
        registry
            .register("p1".to_string(), Arc::new(create_test_paladin("p1")))
            .unwrap();
        registry
            .register("p2".to_string(), Arc::new(create_test_paladin("p2")))
            .unwrap();

        assert_eq!(registry.count(), 2);

        registry.clear();
        assert_eq!(registry.count(), 0);
        assert!(!registry.contains("p1"));
        assert!(!registry.contains("p2"));
    }

    #[test]
    fn test_registry_from_map() {
        let mut initial = HashMap::new();
        initial.insert("p1".to_string(), Arc::new(create_test_paladin("p1")));
        initial.insert("p2".to_string(), Arc::new(create_test_paladin("p2")));

        let registry = HashMapPaladinRegistry::from_map(initial);
        assert_eq!(registry.count(), 2);
        assert!(registry.contains("p1"));
        assert!(registry.contains("p2"));
    }
}