spikard 0.2.1 → 0.2.5

data/vendor/crates/spikard-core/src/di/mod.rs

@@ -0,0 +1,192 @@
+//! Dependency Injection system for Spikard
+//!
+//! This module provides a comprehensive dependency injection system with:
+//!
+//! - **Type-safe dependency resolution**: Dependencies are stored as `Arc<dyn Any>` but
+//!   can be retrieved with type safety using `ResolvedDependencies::get<T>()`
+//! - **Async resolution**: All dependencies can perform async operations during resolution
+//! - **Batched parallel resolution**: Dependencies with no interdependencies are resolved
+//!   in parallel using topological sorting
+//! - **Multiple caching strategies**:
+//!   - Singleton: Resolved once globally, cached forever
+//!   - Per-request cacheable: Resolved once per request
+//!   - Non-cacheable: Resolved every time
+//! - **Cycle detection**: Circular dependencies are detected at registration time
+//! - **Cleanup support**: Generator-pattern dependencies can register cleanup tasks
+//!
+//! # Architecture
+//!
+//! The DI system is built on several core components:
+//!
+//! - [`Dependency`] trait: The core abstraction that all dependencies implement
+//! - [`DependencyContainer`]: Manages registration and resolution
+//! - [`ResolvedDependencies`]: Stores resolved dependencies with type-safe access
+//! - [`DependencyGraph`]: Handles topological sorting and cycle detection
+//! - [`ValueDependency<T>`]: Simple static value dependencies
+//! - [`FactoryDependency`]: Dynamic factory-based dependencies
+//!
+//! # Examples
+//!
+//! ## Basic Usage
+//!
+//! ```ignore
+//! use spikard_core::di::{DependencyContainer, ValueDependency, FactoryDependency};
+//! use std::sync::Arc;
+//!
+//! # tokio_test::block_on(async {
+//! let mut container = DependencyContainer::new();
+//!
+//! // Register a simple value dependency
+//! let config = ValueDependency::new("database_url", "postgresql://localhost/mydb");
+//! container.register("database_url".to_string(), Arc::new(config)).unwrap();
+//!
+//! // Register a factory dependency that depends on the config
+//! let pool = FactoryDependency::builder("db_pool")
+//!     .depends_on(vec!["database_url".to_string()])
+//!     .factory(|_req, _data, resolved| {
+//!         Box::pin(async move {
+//!             let url: Arc<String> = resolved.get("database_url").unwrap();
+//!             let pool = format!("Pool connected to {}", *url);
+//!             Ok(Arc::new(pool) as Arc<dyn std::any::Any + Send + Sync>)
+//!         })
+//!     })
+//!     .singleton(true)  // Share across all requests
+//!     .build();
+//! container.register("db_pool".to_string(), Arc::new(pool)).unwrap();
+//!
+//! // Resolve for a handler
+//! use http::Request;
+//! use crate::request_data::RequestData;
+//! use std::collections::HashMap;
+//!
+//! let request = Request::builder().body(()).unwrap();
+//! let request_data = RequestData {
+//!     path_params: Arc::new(HashMap::new()),
+//!     query_params: serde_json::Value::Null,
+//!     raw_query_params: Arc::new(HashMap::new()),
+//!     body: serde_json::Value::Null,
+//!     raw_body: None,
+//!     headers: Arc::new(HashMap::new()),
+//!     cookies: Arc::new(HashMap::new()),
+//!     method: "GET".to_string(),
+//!     path: "/".to_string(),
+//! };
+//!
+//! let resolved = container
+//!     .resolve_for_handler(&["db_pool".to_string()], &request, &request_data)
+//!     .await
+//!     .unwrap();
+//!
+//! let pool: Option<Arc<String>> = resolved.get("db_pool");
+//! assert!(pool.is_some());
+//! # });
+//! ```
+//!
+//! ## Request-Scoped Dependencies
+//!
+//! ```ignore
+//! use spikard_core::di::{DependencyContainer, FactoryDependency};
+//! use std::sync::Arc;
+//!
+//! # tokio_test::block_on(async {
+//! let mut container = DependencyContainer::new();
+//!
+//! // Create a request-scoped dependency (e.g., request ID)
+//! let request_id = FactoryDependency::builder("request_id")
+//!     .factory(|_req, _data, _resolved| {
+//!         Box::pin(async {
+//!             let id = uuid::Uuid::new_v4().to_string();
+//!             Ok(Arc::new(id) as Arc<dyn std::any::Any + Send + Sync>)
+//!         })
+//!     })
+//!     .cacheable(true)  // Same ID throughout the request
+//!     .build();
+//!
+//! container.register("request_id".to_string(), Arc::new(request_id)).unwrap();
+//! # });
+//! ```
+//!
+//! ## Accessing Request Data
+//!
+//! ```ignore
+//! use spikard_core::di::{DependencyContainer, FactoryDependency};
+//! use std::sync::Arc;
+//!
+//! # tokio_test::block_on(async {
+//! let mut container = DependencyContainer::new();
+//!
+//! // Access headers, query params, etc.
+//! let user_agent = FactoryDependency::builder("user_agent")
+//!     .factory(|_req, request_data, _resolved| {
+//!         let ua = request_data.headers
+//!             .get("user-agent")
+//!             .cloned()
+//!             .unwrap_or_else(|| "unknown".to_string());
+//!
+//!         Box::pin(async move {
+//!             Ok(Arc::new(ua) as Arc<dyn std::any::Any + Send + Sync>)
+//!         })
+//!     })
+//!     .build();
+//!
+//! container.register("user_agent".to_string(), Arc::new(user_agent)).unwrap();
+//! # });
+//! ```
+//!
+//! ## Cleanup Tasks
+//!
+//! ```ignore
+//! use spikard_core::di::ResolvedDependencies;
+//! use std::sync::Arc;
+//!
+//! # tokio_test::block_on(async {
+//! let mut resolved = ResolvedDependencies::new();
+//!
+//! // Add a dependency with cleanup
+//! resolved.insert("connection".to_string(), Arc::new("DB Connection"));
+//!
+//! // Register cleanup task
+//! resolved.add_cleanup_task(Box::new(|| {
+//!     Box::pin(async {
+//!         println!("Closing database connection");
+//!     })
+//! }));
+//!
+//! // Cleanup runs when resolved is dropped (or explicitly)
+//! resolved.cleanup().await;
+//! # });
+//! ```
+//!
+//! # Performance
+//!
+//! The DI system is designed for high performance:
+//!
+//! - **Parallel resolution**: Independent dependencies are resolved concurrently
+//! - **Efficient caching**: Singleton and per-request caching minimize redundant work
+//! - **Arc-based sharing**: Values are reference-counted, not cloned
+//! - **Zero-cost abstractions**: Type erasure has minimal overhead
+//!
+//! # Thread Safety
+//!
+//! All components are thread-safe:
+//!
+//! - `DependencyContainer` can be shared with `Arc<DependencyContainer>`
+//! - Singleton cache uses `RwLock` for concurrent access
+//! - All dependencies must be `Send + Sync`
+
+mod container;
+mod dependency;
+mod error;
+mod factory;
+mod graph;
+mod resolved;
+mod value;
+
+// Public exports
+pub use container::DependencyContainer;
+pub use dependency::Dependency;
+pub use error::DependencyError;
+pub use factory::{FactoryDependency, FactoryDependencyBuilder, FactoryFn};
+pub use graph::DependencyGraph;
+pub use resolved::ResolvedDependencies;
+pub use value::ValueDependency;

data/vendor/crates/spikard-core/src/di/resolved.rs

@@ -0,0 +1,411 @@
+//! Storage for resolved dependencies
+//!
+//! This module provides the `ResolvedDependencies` type which holds all dependencies
+//! resolved for a particular request, with type-safe access and cleanup support.
+
+use std::any::Any;
+use std::collections::HashMap;
+use std::future::Future;
+use std::pin::Pin;
+use std::sync::{Arc, Mutex};
+
+type BoxFuture<'a, T> = Pin<Box<dyn Future<Output = T> + Send + 'a>>;
+type CleanupTask = Box<dyn FnOnce() -> BoxFuture<'static, ()> + Send>;
+
+/// Storage for resolved dependencies with type-safe access
+///
+/// This type stores all dependencies that have been resolved for a request,
+/// allowing type-safe retrieval and supporting cleanup tasks for generator-pattern
+/// dependencies.
+///
+/// Uses Arc<Mutex<>> internally for thread-safe shared access.
+///
+/// # Examples
+///
+/// ```ignore
+/// use spikard_core::di::ResolvedDependencies;
+/// use std::sync::Arc;
+///
+/// # tokio_test::block_on(async {
+/// let mut resolved = ResolvedDependencies::new();
+///
+/// // Insert a dependency
+/// let value = Arc::new(42i32);
+/// resolved.insert("answer".to_string(), value.clone());
+///
+/// // Retrieve with type safety
+/// let retrieved: Option<Arc<i32>> = resolved.get("answer");
+/// assert_eq!(retrieved.map(|v| *v), Some(42));
+///
+/// // Type mismatch returns None
+/// let wrong_type: Option<Arc<String>> = resolved.get("answer");
+/// assert!(wrong_type.is_none());
+///
+/// // Cleanup
+/// resolved.cleanup().await;
+/// # });
+/// ```
+#[derive(Default, Clone)]
+pub struct ResolvedDependencies {
+    /// Map of dependency keys to type-erased values
+    dependencies: Arc<Mutex<HashMap<String, Arc<dyn Any + Send + Sync>>>>,
+    /// Cleanup tasks to run when dependencies are dropped
+    cleanup_tasks: Arc<Mutex<Vec<CleanupTask>>>,
+}
+
+impl ResolvedDependencies {
+    /// Create a new empty resolved dependencies storage
+    ///
+    /// # Examples
+    ///
+    /// ```ignore
+    /// use spikard_core::di::ResolvedDependencies;
+    ///
+    /// let resolved = ResolvedDependencies::new();
+    /// ```
+    #[must_use]
+    pub fn new() -> Self {
+        Self {
+            dependencies: Arc::new(Mutex::new(HashMap::new())),
+            cleanup_tasks: Arc::new(Mutex::new(Vec::new())),
+        }
+    }
+
+    /// Insert a dependency into the storage
+    ///
+    /// # Arguments
+    ///
+    /// * `key` - The unique key for this dependency
+    /// * `value` - The dependency value wrapped in Arc<dyn Any + Send + Sync>
+    ///
+    /// # Examples
+    ///
+    /// ```ignore
+    /// use spikard_core::di::ResolvedDependencies;
+    /// use std::sync::Arc;
+    ///
+    /// let mut resolved = ResolvedDependencies::new();
+    /// let config = Arc::new("production".to_string());
+    /// resolved.insert("config".to_string(), config);
+    /// ```
+    pub fn insert(&mut self, key: String, value: Arc<dyn Any + Send + Sync>) {
+        self.dependencies.lock().unwrap().insert(key, value);
+    }
+
+    /// Get a dependency with type-safe downcasting
+    ///
+    /// Returns `Some(Arc<T>)` if the dependency exists and is of type `T`,
+    /// or `None` if it doesn't exist or has a different type.
+    ///
+    /// # Type Parameters
+    ///
+    /// * `T` - The expected type of the dependency (must be Send + Sync)
+    ///
+    /// # Arguments
+    ///
+    /// * `key` - The key of the dependency to retrieve
+    ///
+    /// # Examples
+    ///
+    /// ```ignore
+    /// use spikard_core::di::ResolvedDependencies;
+    /// use std::sync::Arc;
+    ///
+    /// let mut resolved = ResolvedDependencies::new();
+    /// resolved.insert("count".to_string(), Arc::new(100i32));
+    ///
+    /// // Correct type
+    /// let count: Option<Arc<i32>> = resolved.get("count");
+    /// assert_eq!(count.map(|v| *v), Some(100));
+    ///
+    /// // Wrong type
+    /// let wrong: Option<Arc<String>> = resolved.get("count");
+    /// assert!(wrong.is_none());
+    ///
+    /// // Missing key
+    /// let missing: Option<Arc<i32>> = resolved.get("missing");
+    /// assert!(missing.is_none());
+    /// ```
+    pub fn get<T: Send + Sync + 'static>(&self, key: &str) -> Option<Arc<T>> {
+        self.dependencies
+            .lock()
+            .unwrap()
+            .get(key)
+            .and_then(|value| Arc::clone(value).downcast::<T>().ok())
+    }
+
+    /// Get a dependency as Arc<dyn Any> without type checking
+    ///
+    /// This is useful when you need to pass dependencies around without
+    /// knowing their concrete type.
+    ///
+    /// # Arguments
+    ///
+    /// * `key` - The key of the dependency to retrieve
+    ///
+    /// # Examples
+    ///
+    /// ```ignore
+    /// use spikard_core::di::ResolvedDependencies;
+    /// use std::sync::Arc;
+    ///
+    /// let mut resolved = ResolvedDependencies::new();
+    /// resolved.insert("data".to_string(), Arc::new(vec![1, 2, 3]));
+    ///
+    /// let any_ref = resolved.get_arc("data");
+    /// assert!(any_ref.is_some());
+    /// ```
+    pub fn get_arc(&self, key: &str) -> Option<Arc<dyn Any + Send + Sync>> {
+        self.dependencies.lock().unwrap().get(key).cloned()
+    }
+
+    /// Check if a dependency exists
+    ///
+    /// # Arguments
+    ///
+    /// * `key` - The key to check
+    ///
+    /// # Examples
+    ///
+    /// ```ignore
+    /// use spikard_core::di::ResolvedDependencies;
+    /// use std::sync::Arc;
+    ///
+    /// let mut resolved = ResolvedDependencies::new();
+    /// resolved.insert("exists".to_string(), Arc::new(true));
+    ///
+    /// assert!(resolved.contains("exists"));
+    /// assert!(!resolved.contains("missing"));
+    /// ```
+    #[must_use]
+    pub fn contains(&self, key: &str) -> bool {
+        self.dependencies.lock().unwrap().contains_key(key)
+    }
+
+    /// Get all dependency keys
+    ///
+    /// Returns a vector of all keys currently stored in this resolved dependencies.
+    /// Useful for iterating over all dependencies when you need to extract them.
+    ///
+    /// # Examples
+    ///
+    /// ```ignore
+    /// use spikard_core::di::ResolvedDependencies;
+    /// use std::sync::Arc;
+    ///
+    /// let mut resolved = ResolvedDependencies::new();
+    /// resolved.insert("config".to_string(), Arc::new("prod".to_string()));
+    /// resolved.insert("db".to_string(), Arc::new(42i32));
+    ///
+    /// let keys = resolved.keys();
+    /// assert_eq!(keys.len(), 2);
+    /// assert!(keys.contains(&"config".to_string()));
+    /// assert!(keys.contains(&"db".to_string()));
+    /// ```
+    #[must_use]
+    pub fn keys(&self) -> Vec<String> {
+        self.dependencies.lock().unwrap().keys().cloned().collect()
+    }
+
+    /// Add a cleanup task to be run when dependencies are cleaned up
+    ///
+    /// Cleanup tasks are useful for generator-pattern dependencies that need
+    /// to perform cleanup (e.g., closing database connections, releasing locks).
+    ///
+    /// # Arguments
+    ///
+    /// * `task` - A function that returns a future performing cleanup
+    ///
+    /// # Examples
+    ///
+    /// ```ignore
+    /// use spikard_core::di::ResolvedDependencies;
+    ///
+    /// # tokio_test::block_on(async {
+    /// let mut resolved = ResolvedDependencies::new();
+    ///
+    /// resolved.add_cleanup_task(Box::new(|| {
+    ///     Box::pin(async {
+    ///         println!("Cleaning up resources");
+    ///     })
+    /// }));
+    ///
+    /// resolved.cleanup().await;
+    /// # });
+    /// ```
+    pub fn add_cleanup_task(&self, task: CleanupTask) {
+        self.cleanup_tasks.lock().unwrap().push(task);
+    }
+
+    /// Run all cleanup tasks in reverse order
+    ///
+    /// Cleanup tasks are executed in LIFO order (last added, first executed)
+    /// to properly handle nested resource dependencies.
+    ///
+    /// This consumes self to ensure cleanup is only run once.
+    ///
+    /// # Examples
+    ///
+    /// ```ignore
+    /// use spikard_core::di::ResolvedDependencies;
+    /// use std::sync::{Arc, Mutex};
+    ///
+    /// # tokio_test::block_on(async {
+    /// let order = Arc::new(Mutex::new(Vec::new()));
+    ///
+    /// let mut resolved = ResolvedDependencies::new();
+    ///
+    /// let order1 = order.clone();
+    /// resolved.add_cleanup_task(Box::new(move || {
+    ///     Box::pin(async move {
+    ///         order1.lock().unwrap().push(1);
+    ///     })
+    /// }));
+    ///
+    /// let order2 = order.clone();
+    /// resolved.add_cleanup_task(Box::new(move || {
+    ///     Box::pin(async move {
+    ///         order2.lock().unwrap().push(2);
+    ///     })
+    /// }));
+    ///
+    /// resolved.cleanup().await;
+    ///
+    /// // Tasks run in reverse order (LIFO)
+    /// assert_eq!(*order.lock().unwrap(), vec![2, 1]);
+    /// # });
+    /// ```
+    pub async fn cleanup(self) {
+        // Take ownership of cleanup tasks
+        let tasks = {
+            let mut cleanup_tasks = self.cleanup_tasks.lock().unwrap();
+            std::mem::take(&mut *cleanup_tasks)
+        };
+
+        // Run cleanup tasks in reverse order (LIFO)
+        for task in tasks.into_iter().rev() {
+            task().await;
+        }
+    }
+}
+
+impl std::fmt::Debug for ResolvedDependencies {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        let deps = self.dependencies.lock().unwrap();
+        let tasks = self.cleanup_tasks.lock().unwrap();
+        f.debug_struct("ResolvedDependencies")
+            .field("dependencies", &deps.keys())
+            .field("cleanup_tasks_count", &tasks.len())
+            .finish()
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_new() {
+        let resolved = ResolvedDependencies::new();
+        assert!(!resolved.contains("anything"));
+    }
+
+    #[test]
+    fn test_insert_and_get() {
+        let mut resolved = ResolvedDependencies::new();
+        let value = Arc::new(42i32);
+        resolved.insert("answer".to_string(), value.clone());
+
+        let retrieved: Option<Arc<i32>> = resolved.get("answer");
+        assert_eq!(retrieved.map(|v| *v), Some(42));
+    }
+
+    #[test]
+    fn test_get_type_mismatch() {
+        let mut resolved = ResolvedDependencies::new();
+        resolved.insert("number".to_string(), Arc::new(42i32));
+
+        // Wrong type returns None
+        let wrong: Option<Arc<String>> = resolved.get("number");
+        assert!(wrong.is_none());
+    }
+
+    #[test]
+    fn test_get_missing() {
+        let resolved = ResolvedDependencies::new();
+        let missing: Option<Arc<i32>> = resolved.get("missing");
+        assert!(missing.is_none());
+    }
+
+    #[test]
+    fn test_get_arc() {
+        let mut resolved = ResolvedDependencies::new();
+        resolved.insert("data".to_string(), Arc::new(vec![1, 2, 3]));
+
+        let any_ref = resolved.get_arc("data");
+        assert!(any_ref.is_some());
+
+        // Can downcast manually
+        let vec_ref = any_ref.unwrap().downcast::<Vec<i32>>().ok();
+        assert!(vec_ref.is_some());
+    }
+
+    #[test]
+    fn test_contains() {
+        let mut resolved = ResolvedDependencies::new();
+        resolved.insert("exists".to_string(), Arc::new(true));
+
+        assert!(resolved.contains("exists"));
+        assert!(!resolved.contains("missing"));
+    }
+
+    #[tokio::test]
+    async fn test_cleanup_order() {
+        let order = Arc::new(Mutex::new(Vec::new()));
+
+        let resolved = ResolvedDependencies::new();
+
+        let order1 = order.clone();
+        resolved.add_cleanup_task(Box::new(move || {
+            Box::pin(async move {
+                order1.lock().unwrap().push(1);
+            })
+        }));
+
+        let order2 = order.clone();
+        resolved.add_cleanup_task(Box::new(move || {
+            Box::pin(async move {
+                order2.lock().unwrap().push(2);
+            })
+        }));
+
+        let order3 = order.clone();
+        resolved.add_cleanup_task(Box::new(move || {
+            Box::pin(async move {
+                order3.lock().unwrap().push(3);
+            })
+        }));
+
+        resolved.cleanup().await;
+
+        // Tasks run in reverse order (LIFO)
+        assert_eq!(*order.lock().unwrap(), vec![3, 2, 1]);
+    }
+
+    #[tokio::test]
+    async fn test_cleanup_empty() {
+        let resolved = ResolvedDependencies::new();
+        resolved.cleanup().await; // Should not panic
+    }
+
+    #[test]
+    fn test_clone() {
+        let mut resolved1 = ResolvedDependencies::new();
+        resolved1.insert("key".to_string(), Arc::new(42i32));
+
+        // Clone shares the same underlying data
+        let resolved2 = resolved1.clone();
+        let value: Option<Arc<i32>> = resolved2.get("key");
+        assert_eq!(value.map(|v| *v), Some(42));
+    }
+}