spikard 0.3.2 → 0.3.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/LICENSE +1 -1
- data/README.md +659 -659
- data/ext/spikard_rb/Cargo.toml +17 -17
- data/ext/spikard_rb/extconf.rb +10 -10
- data/ext/spikard_rb/src/lib.rs +6 -6
- data/lib/spikard/app.rb +386 -386
- data/lib/spikard/background.rb +27 -27
- data/lib/spikard/config.rb +396 -396
- data/lib/spikard/converters.rb +13 -13
- data/lib/spikard/handler_wrapper.rb +113 -113
- data/lib/spikard/provide.rb +214 -214
- data/lib/spikard/response.rb +173 -173
- data/lib/spikard/schema.rb +243 -243
- data/lib/spikard/sse.rb +111 -111
- data/lib/spikard/streaming_response.rb +44 -44
- data/lib/spikard/testing.rb +221 -221
- data/lib/spikard/upload_file.rb +131 -131
- data/lib/spikard/version.rb +5 -5
- data/lib/spikard/websocket.rb +59 -59
- data/lib/spikard.rb +43 -43
- data/sig/spikard.rbs +360 -360
- data/vendor/crates/spikard-core/Cargo.toml +40 -40
- data/vendor/crates/spikard-core/src/bindings/mod.rs +3 -3
- data/vendor/crates/spikard-core/src/bindings/response.rs +133 -133
- data/vendor/crates/spikard-core/src/debug.rs +63 -63
- data/vendor/crates/spikard-core/src/di/container.rs +726 -726
- data/vendor/crates/spikard-core/src/di/dependency.rs +273 -273
- data/vendor/crates/spikard-core/src/di/error.rs +118 -118
- data/vendor/crates/spikard-core/src/di/factory.rs +538 -538
- data/vendor/crates/spikard-core/src/di/graph.rs +545 -545
- data/vendor/crates/spikard-core/src/di/mod.rs +192 -192
- data/vendor/crates/spikard-core/src/di/resolved.rs +411 -411
- data/vendor/crates/spikard-core/src/di/value.rs +283 -283
- data/vendor/crates/spikard-core/src/errors.rs +39 -39
- data/vendor/crates/spikard-core/src/http.rs +153 -153
- data/vendor/crates/spikard-core/src/lib.rs +29 -29
- data/vendor/crates/spikard-core/src/lifecycle.rs +422 -422
- data/vendor/crates/spikard-core/src/parameters.rs +722 -722
- data/vendor/crates/spikard-core/src/problem.rs +310 -310
- data/vendor/crates/spikard-core/src/request_data.rs +189 -189
- data/vendor/crates/spikard-core/src/router.rs +249 -249
- data/vendor/crates/spikard-core/src/schema_registry.rs +183 -183
- data/vendor/crates/spikard-core/src/type_hints.rs +304 -304
- data/vendor/crates/spikard-core/src/validation.rs +699 -699
- data/vendor/crates/spikard-http/Cargo.toml +58 -58
- data/vendor/crates/spikard-http/src/auth.rs +247 -247
- data/vendor/crates/spikard-http/src/background.rs +249 -249
- data/vendor/crates/spikard-http/src/bindings/mod.rs +3 -3
- data/vendor/crates/spikard-http/src/bindings/response.rs +1 -1
- data/vendor/crates/spikard-http/src/body_metadata.rs +8 -8
- data/vendor/crates/spikard-http/src/cors.rs +490 -490
- data/vendor/crates/spikard-http/src/debug.rs +63 -63
- data/vendor/crates/spikard-http/src/di_handler.rs +423 -423
- data/vendor/crates/spikard-http/src/handler_response.rs +190 -190
- data/vendor/crates/spikard-http/src/handler_trait.rs +228 -228
- data/vendor/crates/spikard-http/src/handler_trait_tests.rs +284 -284
- data/vendor/crates/spikard-http/src/lib.rs +529 -529
- data/vendor/crates/spikard-http/src/lifecycle/adapter.rs +149 -149
- data/vendor/crates/spikard-http/src/lifecycle.rs +428 -428
- data/vendor/crates/spikard-http/src/middleware/mod.rs +285 -285
- data/vendor/crates/spikard-http/src/middleware/multipart.rs +86 -86
- data/vendor/crates/spikard-http/src/middleware/urlencoded.rs +147 -147
- data/vendor/crates/spikard-http/src/middleware/validation.rs +287 -287
- data/vendor/crates/spikard-http/src/openapi/mod.rs +309 -309
- data/vendor/crates/spikard-http/src/openapi/parameter_extraction.rs +190 -190
- data/vendor/crates/spikard-http/src/openapi/schema_conversion.rs +308 -308
- data/vendor/crates/spikard-http/src/openapi/spec_generation.rs +195 -195
- data/vendor/crates/spikard-http/src/parameters.rs +1 -1
- data/vendor/crates/spikard-http/src/problem.rs +1 -1
- data/vendor/crates/spikard-http/src/query_parser.rs +369 -369
- data/vendor/crates/spikard-http/src/response.rs +399 -399
- data/vendor/crates/spikard-http/src/router.rs +1 -1
- data/vendor/crates/spikard-http/src/schema_registry.rs +1 -1
- data/vendor/crates/spikard-http/src/server/handler.rs +87 -87
- data/vendor/crates/spikard-http/src/server/lifecycle_execution.rs +98 -98
- data/vendor/crates/spikard-http/src/server/mod.rs +805 -805
- data/vendor/crates/spikard-http/src/server/request_extraction.rs +119 -119
- data/vendor/crates/spikard-http/src/sse.rs +447 -447
- data/vendor/crates/spikard-http/src/testing/form.rs +14 -14
- data/vendor/crates/spikard-http/src/testing/multipart.rs +60 -60
- data/vendor/crates/spikard-http/src/testing/test_client.rs +285 -285
- data/vendor/crates/spikard-http/src/testing.rs +377 -377
- data/vendor/crates/spikard-http/src/type_hints.rs +1 -1
- data/vendor/crates/spikard-http/src/validation.rs +1 -1
- data/vendor/crates/spikard-http/src/websocket.rs +324 -324
- data/vendor/crates/spikard-rb/Cargo.toml +42 -42
- data/vendor/crates/spikard-rb/build.rs +8 -8
- data/vendor/crates/spikard-rb/src/background.rs +63 -63
- data/vendor/crates/spikard-rb/src/config.rs +294 -294
- data/vendor/crates/spikard-rb/src/conversion.rs +453 -453
- data/vendor/crates/spikard-rb/src/di.rs +409 -409
- data/vendor/crates/spikard-rb/src/handler.rs +625 -625
- data/vendor/crates/spikard-rb/src/lib.rs +2771 -2771
- data/vendor/crates/spikard-rb/src/lifecycle.rs +274 -274
- data/vendor/crates/spikard-rb/src/server.rs +283 -283
- data/vendor/crates/spikard-rb/src/sse.rs +231 -231
- data/vendor/crates/spikard-rb/src/test_client.rs +404 -404
- data/vendor/crates/spikard-rb/src/test_sse.rs +143 -143
- data/vendor/crates/spikard-rb/src/test_websocket.rs +221 -221
- data/vendor/crates/spikard-rb/src/websocket.rs +233 -233
- data/vendor/spikard-core/Cargo.toml +40 -40
- data/vendor/spikard-core/src/bindings/mod.rs +3 -3
- data/vendor/spikard-core/src/bindings/response.rs +133 -133
- data/vendor/spikard-core/src/debug.rs +63 -63
- data/vendor/spikard-core/src/di/container.rs +726 -726
- data/vendor/spikard-core/src/di/dependency.rs +273 -273
- data/vendor/spikard-core/src/di/error.rs +118 -118
- data/vendor/spikard-core/src/di/factory.rs +538 -538
- data/vendor/spikard-core/src/di/graph.rs +545 -545
- data/vendor/spikard-core/src/di/mod.rs +192 -192
- data/vendor/spikard-core/src/di/resolved.rs +411 -411
- data/vendor/spikard-core/src/di/value.rs +283 -283
- data/vendor/spikard-core/src/http.rs +153 -153
- data/vendor/spikard-core/src/lib.rs +28 -28
- data/vendor/spikard-core/src/lifecycle.rs +422 -422
- data/vendor/spikard-core/src/parameters.rs +719 -719
- data/vendor/spikard-core/src/problem.rs +310 -310
- data/vendor/spikard-core/src/request_data.rs +189 -189
- data/vendor/spikard-core/src/router.rs +249 -249
- data/vendor/spikard-core/src/schema_registry.rs +183 -183
- data/vendor/spikard-core/src/type_hints.rs +304 -304
- data/vendor/spikard-core/src/validation.rs +699 -699
- data/vendor/spikard-http/Cargo.toml +58 -58
- data/vendor/spikard-http/src/auth.rs +247 -247
- data/vendor/spikard-http/src/background.rs +249 -249
- data/vendor/spikard-http/src/bindings/mod.rs +3 -3
- data/vendor/spikard-http/src/bindings/response.rs +1 -1
- data/vendor/spikard-http/src/body_metadata.rs +8 -8
- data/vendor/spikard-http/src/cors.rs +490 -490
- data/vendor/spikard-http/src/debug.rs +63 -63
- data/vendor/spikard-http/src/di_handler.rs +423 -423
- data/vendor/spikard-http/src/handler_response.rs +190 -190
- data/vendor/spikard-http/src/handler_trait.rs +228 -228
- data/vendor/spikard-http/src/handler_trait_tests.rs +284 -284
- data/vendor/spikard-http/src/lib.rs +529 -529
- data/vendor/spikard-http/src/lifecycle/adapter.rs +149 -149
- data/vendor/spikard-http/src/lifecycle.rs +428 -428
- data/vendor/spikard-http/src/middleware/mod.rs +285 -285
- data/vendor/spikard-http/src/middleware/multipart.rs +86 -86
- data/vendor/spikard-http/src/middleware/urlencoded.rs +147 -147
- data/vendor/spikard-http/src/middleware/validation.rs +287 -287
- data/vendor/spikard-http/src/openapi/mod.rs +309 -309
- data/vendor/spikard-http/src/openapi/parameter_extraction.rs +190 -190
- data/vendor/spikard-http/src/openapi/schema_conversion.rs +308 -308
- data/vendor/spikard-http/src/openapi/spec_generation.rs +195 -195
- data/vendor/spikard-http/src/parameters.rs +1 -1
- data/vendor/spikard-http/src/problem.rs +1 -1
- data/vendor/spikard-http/src/query_parser.rs +369 -369
- data/vendor/spikard-http/src/response.rs +399 -399
- data/vendor/spikard-http/src/router.rs +1 -1
- data/vendor/spikard-http/src/schema_registry.rs +1 -1
- data/vendor/spikard-http/src/server/handler.rs +80 -80
- data/vendor/spikard-http/src/server/lifecycle_execution.rs +98 -98
- data/vendor/spikard-http/src/server/mod.rs +805 -805
- data/vendor/spikard-http/src/server/request_extraction.rs +119 -119
- data/vendor/spikard-http/src/sse.rs +447 -447
- data/vendor/spikard-http/src/testing/form.rs +14 -14
- data/vendor/spikard-http/src/testing/multipart.rs +60 -60
- data/vendor/spikard-http/src/testing/test_client.rs +285 -285
- data/vendor/spikard-http/src/testing.rs +377 -377
- data/vendor/spikard-http/src/type_hints.rs +1 -1
- data/vendor/spikard-http/src/validation.rs +1 -1
- data/vendor/spikard-http/src/websocket.rs +324 -324
- data/vendor/spikard-rb/Cargo.toml +42 -42
- data/vendor/spikard-rb/build.rs +8 -8
- data/vendor/spikard-rb/src/background.rs +63 -63
- data/vendor/spikard-rb/src/config.rs +294 -294
- data/vendor/spikard-rb/src/conversion.rs +392 -392
- data/vendor/spikard-rb/src/di.rs +409 -409
- data/vendor/spikard-rb/src/handler.rs +534 -534
- data/vendor/spikard-rb/src/lib.rs +2020 -2020
- data/vendor/spikard-rb/src/lifecycle.rs +267 -267
- data/vendor/spikard-rb/src/server.rs +283 -283
- data/vendor/spikard-rb/src/sse.rs +231 -231
- data/vendor/spikard-rb/src/test_client.rs +404 -404
- data/vendor/spikard-rb/src/test_sse.rs +143 -143
- data/vendor/spikard-rb/src/test_websocket.rs +221 -221
- data/vendor/spikard-rb/src/websocket.rs +233 -233
- metadata +1 -1
|
@@ -1,192 +1,192 @@
|
|
|
1
|
-
//! Dependency Injection system for Spikard
|
|
2
|
-
//!
|
|
3
|
-
//! This module provides a comprehensive dependency injection system with:
|
|
4
|
-
//!
|
|
5
|
-
//! - **Type-safe dependency resolution**: Dependencies are stored as `Arc<dyn Any>` but
|
|
6
|
-
//! can be retrieved with type safety using `ResolvedDependencies::get<T>()`
|
|
7
|
-
//! - **Async resolution**: All dependencies can perform async operations during resolution
|
|
8
|
-
//! - **Batched parallel resolution**: Dependencies with no interdependencies are resolved
|
|
9
|
-
//! in parallel using topological sorting
|
|
10
|
-
//! - **Multiple caching strategies**:
|
|
11
|
-
//! - Singleton: Resolved once globally, cached forever
|
|
12
|
-
//! - Per-request cacheable: Resolved once per request
|
|
13
|
-
//! - Non-cacheable: Resolved every time
|
|
14
|
-
//! - **Cycle detection**: Circular dependencies are detected at registration time
|
|
15
|
-
//! - **Cleanup support**: Generator-pattern dependencies can register cleanup tasks
|
|
16
|
-
//!
|
|
17
|
-
//! # Architecture
|
|
18
|
-
//!
|
|
19
|
-
//! The DI system is built on several core components:
|
|
20
|
-
//!
|
|
21
|
-
//! - [`Dependency`] trait: The core abstraction that all dependencies implement
|
|
22
|
-
//! - [`DependencyContainer`]: Manages registration and resolution
|
|
23
|
-
//! - [`ResolvedDependencies`]: Stores resolved dependencies with type-safe access
|
|
24
|
-
//! - [`DependencyGraph`]: Handles topological sorting and cycle detection
|
|
25
|
-
//! - [`ValueDependency<T>`]: Simple static value dependencies
|
|
26
|
-
//! - [`FactoryDependency`]: Dynamic factory-based dependencies
|
|
27
|
-
//!
|
|
28
|
-
//! # Examples
|
|
29
|
-
//!
|
|
30
|
-
//! ## Basic Usage
|
|
31
|
-
//!
|
|
32
|
-
//! ```ignore
|
|
33
|
-
//! use spikard_core::di::{DependencyContainer, ValueDependency, FactoryDependency};
|
|
34
|
-
//! use std::sync::Arc;
|
|
35
|
-
//!
|
|
36
|
-
//! # tokio_test::block_on(async {
|
|
37
|
-
//! let mut container = DependencyContainer::new();
|
|
38
|
-
//!
|
|
39
|
-
//! // Register a simple value dependency
|
|
40
|
-
//! let config = ValueDependency::new("database_url", "postgresql://localhost/mydb");
|
|
41
|
-
//! container.register("database_url".to_string(), Arc::new(config)).unwrap();
|
|
42
|
-
//!
|
|
43
|
-
//! // Register a factory dependency that depends on the config
|
|
44
|
-
//! let pool = FactoryDependency::builder("db_pool")
|
|
45
|
-
//! .depends_on(vec!["database_url".to_string()])
|
|
46
|
-
//! .factory(|_req, _data, resolved| {
|
|
47
|
-
//! Box::pin(async move {
|
|
48
|
-
//! let url: Arc<String> = resolved.get("database_url").unwrap();
|
|
49
|
-
//! let pool = format!("Pool connected to {}", *url);
|
|
50
|
-
//! Ok(Arc::new(pool) as Arc<dyn std::any::Any + Send + Sync>)
|
|
51
|
-
//! })
|
|
52
|
-
//! })
|
|
53
|
-
//! .singleton(true) // Share across all requests
|
|
54
|
-
//! .build();
|
|
55
|
-
//! container.register("db_pool".to_string(), Arc::new(pool)).unwrap();
|
|
56
|
-
//!
|
|
57
|
-
//! // Resolve for a handler
|
|
58
|
-
//! use http::Request;
|
|
59
|
-
//! use crate::request_data::RequestData;
|
|
60
|
-
//! use std::collections::HashMap;
|
|
61
|
-
//!
|
|
62
|
-
//! let request = Request::builder().body(()).unwrap();
|
|
63
|
-
//! let request_data = RequestData {
|
|
64
|
-
//! path_params: Arc::new(HashMap::new()),
|
|
65
|
-
//! query_params: serde_json::Value::Null,
|
|
66
|
-
//! raw_query_params: Arc::new(HashMap::new()),
|
|
67
|
-
//! body: serde_json::Value::Null,
|
|
68
|
-
//! raw_body: None,
|
|
69
|
-
//! headers: Arc::new(HashMap::new()),
|
|
70
|
-
//! cookies: Arc::new(HashMap::new()),
|
|
71
|
-
//! method: "GET".to_string(),
|
|
72
|
-
//! path: "/".to_string(),
|
|
73
|
-
//! };
|
|
74
|
-
//!
|
|
75
|
-
//! let resolved = container
|
|
76
|
-
//! .resolve_for_handler(&["db_pool".to_string()], &request, &request_data)
|
|
77
|
-
//! .await
|
|
78
|
-
//! .unwrap();
|
|
79
|
-
//!
|
|
80
|
-
//! let pool: Option<Arc<String>> = resolved.get("db_pool");
|
|
81
|
-
//! assert!(pool.is_some());
|
|
82
|
-
//! # });
|
|
83
|
-
//! ```
|
|
84
|
-
//!
|
|
85
|
-
//! ## Request-Scoped Dependencies
|
|
86
|
-
//!
|
|
87
|
-
//! ```ignore
|
|
88
|
-
//! use spikard_core::di::{DependencyContainer, FactoryDependency};
|
|
89
|
-
//! use std::sync::Arc;
|
|
90
|
-
//!
|
|
91
|
-
//! # tokio_test::block_on(async {
|
|
92
|
-
//! let mut container = DependencyContainer::new();
|
|
93
|
-
//!
|
|
94
|
-
//! // Create a request-scoped dependency (e.g., request ID)
|
|
95
|
-
//! let request_id = FactoryDependency::builder("request_id")
|
|
96
|
-
//! .factory(|_req, _data, _resolved| {
|
|
97
|
-
//! Box::pin(async {
|
|
98
|
-
//! let id = uuid::Uuid::new_v4().to_string();
|
|
99
|
-
//! Ok(Arc::new(id) as Arc<dyn std::any::Any + Send + Sync>)
|
|
100
|
-
//! })
|
|
101
|
-
//! })
|
|
102
|
-
//! .cacheable(true) // Same ID throughout the request
|
|
103
|
-
//! .build();
|
|
104
|
-
//!
|
|
105
|
-
//! container.register("request_id".to_string(), Arc::new(request_id)).unwrap();
|
|
106
|
-
//! # });
|
|
107
|
-
//! ```
|
|
108
|
-
//!
|
|
109
|
-
//! ## Accessing Request Data
|
|
110
|
-
//!
|
|
111
|
-
//! ```ignore
|
|
112
|
-
//! use spikard_core::di::{DependencyContainer, FactoryDependency};
|
|
113
|
-
//! use std::sync::Arc;
|
|
114
|
-
//!
|
|
115
|
-
//! # tokio_test::block_on(async {
|
|
116
|
-
//! let mut container = DependencyContainer::new();
|
|
117
|
-
//!
|
|
118
|
-
//! // Access headers, query params, etc.
|
|
119
|
-
//! let user_agent = FactoryDependency::builder("user_agent")
|
|
120
|
-
//! .factory(|_req, request_data, _resolved| {
|
|
121
|
-
//! let ua = request_data.headers
|
|
122
|
-
//! .get("user-agent")
|
|
123
|
-
//! .cloned()
|
|
124
|
-
//! .unwrap_or_else(|| "unknown".to_string());
|
|
125
|
-
//!
|
|
126
|
-
//! Box::pin(async move {
|
|
127
|
-
//! Ok(Arc::new(ua) as Arc<dyn std::any::Any + Send + Sync>)
|
|
128
|
-
//! })
|
|
129
|
-
//! })
|
|
130
|
-
//! .build();
|
|
131
|
-
//!
|
|
132
|
-
//! container.register("user_agent".to_string(), Arc::new(user_agent)).unwrap();
|
|
133
|
-
//! # });
|
|
134
|
-
//! ```
|
|
135
|
-
//!
|
|
136
|
-
//! ## Cleanup Tasks
|
|
137
|
-
//!
|
|
138
|
-
//! ```ignore
|
|
139
|
-
//! use spikard_core::di::ResolvedDependencies;
|
|
140
|
-
//! use std::sync::Arc;
|
|
141
|
-
//!
|
|
142
|
-
//! # tokio_test::block_on(async {
|
|
143
|
-
//! let mut resolved = ResolvedDependencies::new();
|
|
144
|
-
//!
|
|
145
|
-
//! // Add a dependency with cleanup
|
|
146
|
-
//! resolved.insert("connection".to_string(), Arc::new("DB Connection"));
|
|
147
|
-
//!
|
|
148
|
-
//! // Register cleanup task
|
|
149
|
-
//! resolved.add_cleanup_task(Box::new(|| {
|
|
150
|
-
//! Box::pin(async {
|
|
151
|
-
//! println!("Closing database connection");
|
|
152
|
-
//! })
|
|
153
|
-
//! }));
|
|
154
|
-
//!
|
|
155
|
-
//! // Cleanup runs when resolved is dropped (or explicitly)
|
|
156
|
-
//! resolved.cleanup().await;
|
|
157
|
-
//! # });
|
|
158
|
-
//! ```
|
|
159
|
-
//!
|
|
160
|
-
//! # Performance
|
|
161
|
-
//!
|
|
162
|
-
//! The DI system is designed for high performance:
|
|
163
|
-
//!
|
|
164
|
-
//! - **Parallel resolution**: Independent dependencies are resolved concurrently
|
|
165
|
-
//! - **Efficient caching**: Singleton and per-request caching minimize redundant work
|
|
166
|
-
//! - **Arc-based sharing**: Values are reference-counted, not cloned
|
|
167
|
-
//! - **Zero-cost abstractions**: Type erasure has minimal overhead
|
|
168
|
-
//!
|
|
169
|
-
//! # Thread Safety
|
|
170
|
-
//!
|
|
171
|
-
//! All components are thread-safe:
|
|
172
|
-
//!
|
|
173
|
-
//! - `DependencyContainer` can be shared with `Arc<DependencyContainer>`
|
|
174
|
-
//! - Singleton cache uses `RwLock` for concurrent access
|
|
175
|
-
//! - All dependencies must be `Send + Sync`
|
|
176
|
-
|
|
177
|
-
mod container;
|
|
178
|
-
mod dependency;
|
|
179
|
-
mod error;
|
|
180
|
-
mod factory;
|
|
181
|
-
mod graph;
|
|
182
|
-
mod resolved;
|
|
183
|
-
mod value;
|
|
184
|
-
|
|
185
|
-
// Public exports
|
|
186
|
-
pub use container::DependencyContainer;
|
|
187
|
-
pub use dependency::Dependency;
|
|
188
|
-
pub use error::DependencyError;
|
|
189
|
-
pub use factory::{FactoryDependency, FactoryDependencyBuilder, FactoryFn};
|
|
190
|
-
pub use graph::DependencyGraph;
|
|
191
|
-
pub use resolved::ResolvedDependencies;
|
|
192
|
-
pub use value::ValueDependency;
|
|
1
|
+
//! Dependency Injection system for Spikard
|
|
2
|
+
//!
|
|
3
|
+
//! This module provides a comprehensive dependency injection system with:
|
|
4
|
+
//!
|
|
5
|
+
//! - **Type-safe dependency resolution**: Dependencies are stored as `Arc<dyn Any>` but
|
|
6
|
+
//! can be retrieved with type safety using `ResolvedDependencies::get<T>()`
|
|
7
|
+
//! - **Async resolution**: All dependencies can perform async operations during resolution
|
|
8
|
+
//! - **Batched parallel resolution**: Dependencies with no interdependencies are resolved
|
|
9
|
+
//! in parallel using topological sorting
|
|
10
|
+
//! - **Multiple caching strategies**:
|
|
11
|
+
//! - Singleton: Resolved once globally, cached forever
|
|
12
|
+
//! - Per-request cacheable: Resolved once per request
|
|
13
|
+
//! - Non-cacheable: Resolved every time
|
|
14
|
+
//! - **Cycle detection**: Circular dependencies are detected at registration time
|
|
15
|
+
//! - **Cleanup support**: Generator-pattern dependencies can register cleanup tasks
|
|
16
|
+
//!
|
|
17
|
+
//! # Architecture
|
|
18
|
+
//!
|
|
19
|
+
//! The DI system is built on several core components:
|
|
20
|
+
//!
|
|
21
|
+
//! - [`Dependency`] trait: The core abstraction that all dependencies implement
|
|
22
|
+
//! - [`DependencyContainer`]: Manages registration and resolution
|
|
23
|
+
//! - [`ResolvedDependencies`]: Stores resolved dependencies with type-safe access
|
|
24
|
+
//! - [`DependencyGraph`]: Handles topological sorting and cycle detection
|
|
25
|
+
//! - [`ValueDependency<T>`]: Simple static value dependencies
|
|
26
|
+
//! - [`FactoryDependency`]: Dynamic factory-based dependencies
|
|
27
|
+
//!
|
|
28
|
+
//! # Examples
|
|
29
|
+
//!
|
|
30
|
+
//! ## Basic Usage
|
|
31
|
+
//!
|
|
32
|
+
//! ```ignore
|
|
33
|
+
//! use spikard_core::di::{DependencyContainer, ValueDependency, FactoryDependency};
|
|
34
|
+
//! use std::sync::Arc;
|
|
35
|
+
//!
|
|
36
|
+
//! # tokio_test::block_on(async {
|
|
37
|
+
//! let mut container = DependencyContainer::new();
|
|
38
|
+
//!
|
|
39
|
+
//! // Register a simple value dependency
|
|
40
|
+
//! let config = ValueDependency::new("database_url", "postgresql://localhost/mydb");
|
|
41
|
+
//! container.register("database_url".to_string(), Arc::new(config)).unwrap();
|
|
42
|
+
//!
|
|
43
|
+
//! // Register a factory dependency that depends on the config
|
|
44
|
+
//! let pool = FactoryDependency::builder("db_pool")
|
|
45
|
+
//! .depends_on(vec!["database_url".to_string()])
|
|
46
|
+
//! .factory(|_req, _data, resolved| {
|
|
47
|
+
//! Box::pin(async move {
|
|
48
|
+
//! let url: Arc<String> = resolved.get("database_url").unwrap();
|
|
49
|
+
//! let pool = format!("Pool connected to {}", *url);
|
|
50
|
+
//! Ok(Arc::new(pool) as Arc<dyn std::any::Any + Send + Sync>)
|
|
51
|
+
//! })
|
|
52
|
+
//! })
|
|
53
|
+
//! .singleton(true) // Share across all requests
|
|
54
|
+
//! .build();
|
|
55
|
+
//! container.register("db_pool".to_string(), Arc::new(pool)).unwrap();
|
|
56
|
+
//!
|
|
57
|
+
//! // Resolve for a handler
|
|
58
|
+
//! use http::Request;
|
|
59
|
+
//! use crate::request_data::RequestData;
|
|
60
|
+
//! use std::collections::HashMap;
|
|
61
|
+
//!
|
|
62
|
+
//! let request = Request::builder().body(()).unwrap();
|
|
63
|
+
//! let request_data = RequestData {
|
|
64
|
+
//! path_params: Arc::new(HashMap::new()),
|
|
65
|
+
//! query_params: serde_json::Value::Null,
|
|
66
|
+
//! raw_query_params: Arc::new(HashMap::new()),
|
|
67
|
+
//! body: serde_json::Value::Null,
|
|
68
|
+
//! raw_body: None,
|
|
69
|
+
//! headers: Arc::new(HashMap::new()),
|
|
70
|
+
//! cookies: Arc::new(HashMap::new()),
|
|
71
|
+
//! method: "GET".to_string(),
|
|
72
|
+
//! path: "/".to_string(),
|
|
73
|
+
//! };
|
|
74
|
+
//!
|
|
75
|
+
//! let resolved = container
|
|
76
|
+
//! .resolve_for_handler(&["db_pool".to_string()], &request, &request_data)
|
|
77
|
+
//! .await
|
|
78
|
+
//! .unwrap();
|
|
79
|
+
//!
|
|
80
|
+
//! let pool: Option<Arc<String>> = resolved.get("db_pool");
|
|
81
|
+
//! assert!(pool.is_some());
|
|
82
|
+
//! # });
|
|
83
|
+
//! ```
|
|
84
|
+
//!
|
|
85
|
+
//! ## Request-Scoped Dependencies
|
|
86
|
+
//!
|
|
87
|
+
//! ```ignore
|
|
88
|
+
//! use spikard_core::di::{DependencyContainer, FactoryDependency};
|
|
89
|
+
//! use std::sync::Arc;
|
|
90
|
+
//!
|
|
91
|
+
//! # tokio_test::block_on(async {
|
|
92
|
+
//! let mut container = DependencyContainer::new();
|
|
93
|
+
//!
|
|
94
|
+
//! // Create a request-scoped dependency (e.g., request ID)
|
|
95
|
+
//! let request_id = FactoryDependency::builder("request_id")
|
|
96
|
+
//! .factory(|_req, _data, _resolved| {
|
|
97
|
+
//! Box::pin(async {
|
|
98
|
+
//! let id = uuid::Uuid::new_v4().to_string();
|
|
99
|
+
//! Ok(Arc::new(id) as Arc<dyn std::any::Any + Send + Sync>)
|
|
100
|
+
//! })
|
|
101
|
+
//! })
|
|
102
|
+
//! .cacheable(true) // Same ID throughout the request
|
|
103
|
+
//! .build();
|
|
104
|
+
//!
|
|
105
|
+
//! container.register("request_id".to_string(), Arc::new(request_id)).unwrap();
|
|
106
|
+
//! # });
|
|
107
|
+
//! ```
|
|
108
|
+
//!
|
|
109
|
+
//! ## Accessing Request Data
|
|
110
|
+
//!
|
|
111
|
+
//! ```ignore
|
|
112
|
+
//! use spikard_core::di::{DependencyContainer, FactoryDependency};
|
|
113
|
+
//! use std::sync::Arc;
|
|
114
|
+
//!
|
|
115
|
+
//! # tokio_test::block_on(async {
|
|
116
|
+
//! let mut container = DependencyContainer::new();
|
|
117
|
+
//!
|
|
118
|
+
//! // Access headers, query params, etc.
|
|
119
|
+
//! let user_agent = FactoryDependency::builder("user_agent")
|
|
120
|
+
//! .factory(|_req, request_data, _resolved| {
|
|
121
|
+
//! let ua = request_data.headers
|
|
122
|
+
//! .get("user-agent")
|
|
123
|
+
//! .cloned()
|
|
124
|
+
//! .unwrap_or_else(|| "unknown".to_string());
|
|
125
|
+
//!
|
|
126
|
+
//! Box::pin(async move {
|
|
127
|
+
//! Ok(Arc::new(ua) as Arc<dyn std::any::Any + Send + Sync>)
|
|
128
|
+
//! })
|
|
129
|
+
//! })
|
|
130
|
+
//! .build();
|
|
131
|
+
//!
|
|
132
|
+
//! container.register("user_agent".to_string(), Arc::new(user_agent)).unwrap();
|
|
133
|
+
//! # });
|
|
134
|
+
//! ```
|
|
135
|
+
//!
|
|
136
|
+
//! ## Cleanup Tasks
|
|
137
|
+
//!
|
|
138
|
+
//! ```ignore
|
|
139
|
+
//! use spikard_core::di::ResolvedDependencies;
|
|
140
|
+
//! use std::sync::Arc;
|
|
141
|
+
//!
|
|
142
|
+
//! # tokio_test::block_on(async {
|
|
143
|
+
//! let mut resolved = ResolvedDependencies::new();
|
|
144
|
+
//!
|
|
145
|
+
//! // Add a dependency with cleanup
|
|
146
|
+
//! resolved.insert("connection".to_string(), Arc::new("DB Connection"));
|
|
147
|
+
//!
|
|
148
|
+
//! // Register cleanup task
|
|
149
|
+
//! resolved.add_cleanup_task(Box::new(|| {
|
|
150
|
+
//! Box::pin(async {
|
|
151
|
+
//! println!("Closing database connection");
|
|
152
|
+
//! })
|
|
153
|
+
//! }));
|
|
154
|
+
//!
|
|
155
|
+
//! // Cleanup runs when resolved is dropped (or explicitly)
|
|
156
|
+
//! resolved.cleanup().await;
|
|
157
|
+
//! # });
|
|
158
|
+
//! ```
|
|
159
|
+
//!
|
|
160
|
+
//! # Performance
|
|
161
|
+
//!
|
|
162
|
+
//! The DI system is designed for high performance:
|
|
163
|
+
//!
|
|
164
|
+
//! - **Parallel resolution**: Independent dependencies are resolved concurrently
|
|
165
|
+
//! - **Efficient caching**: Singleton and per-request caching minimize redundant work
|
|
166
|
+
//! - **Arc-based sharing**: Values are reference-counted, not cloned
|
|
167
|
+
//! - **Zero-cost abstractions**: Type erasure has minimal overhead
|
|
168
|
+
//!
|
|
169
|
+
//! # Thread Safety
|
|
170
|
+
//!
|
|
171
|
+
//! All components are thread-safe:
|
|
172
|
+
//!
|
|
173
|
+
//! - `DependencyContainer` can be shared with `Arc<DependencyContainer>`
|
|
174
|
+
//! - Singleton cache uses `RwLock` for concurrent access
|
|
175
|
+
//! - All dependencies must be `Send + Sync`
|
|
176
|
+
|
|
177
|
+
mod container;
|
|
178
|
+
mod dependency;
|
|
179
|
+
mod error;
|
|
180
|
+
mod factory;
|
|
181
|
+
mod graph;
|
|
182
|
+
mod resolved;
|
|
183
|
+
mod value;
|
|
184
|
+
|
|
185
|
+
// Public exports
|
|
186
|
+
pub use container::DependencyContainer;
|
|
187
|
+
pub use dependency::Dependency;
|
|
188
|
+
pub use error::DependencyError;
|
|
189
|
+
pub use factory::{FactoryDependency, FactoryDependencyBuilder, FactoryFn};
|
|
190
|
+
pub use graph::DependencyGraph;
|
|
191
|
+
pub use resolved::ResolvedDependencies;
|
|
192
|
+
pub use value::ValueDependency;
|