dependency-injector 1.0.0

High-performance, lock-free dependency injection container for Rust
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
//! Verified Service Providers
//!
//! This module provides traits for services that declare their dependencies
//! at compile time, enabling static verification of dependency graphs.
//!
//! # Features
//!
//! - **`Service` trait**: Declare dependencies and creation logic
//! - **`ServiceProvider` trait**: Auto-register services with their factories
//! - **Compile-time cycle detection**: The type system prevents circular deps
//!
//! # Example
//!
//! ```rust
//! use dependency_injector::verified::{Service, ServiceProvider};
//! use dependency_injector::Container;
//! use std::sync::Arc;
//!
//! #[derive(Clone)]
//! struct Database {
//!     url: String,
//! }
//!
//! impl Service for Database {
//!     type Dependencies = ();
//!
//!     fn create(_deps: Self::Dependencies) -> Self {
//!         Database { url: "postgres://localhost".into() }
//!     }
//! }
//!
//! #[derive(Clone)]
//! struct UserRepository {
//!     db: Arc<Database>,
//! }
//!
//! impl Service for UserRepository {
//!     type Dependencies = Arc<Database>;
//!
//!     fn create(db: Self::Dependencies) -> Self {
//!         UserRepository { db }
//!     }
//! }
//!
//! // Auto-register with dependencies resolved
//! let container = Container::new();
//! container.provide::<Database>();
//! container.provide::<UserRepository>();
//!
//! let repo = container.get::<UserRepository>().unwrap();
//! ```

use crate::{Container, Injectable};
use std::sync::Arc;

// =============================================================================
// Service Trait
// =============================================================================

/// A service that declares its dependencies at compile time.
///
/// The `Dependencies` associated type specifies what the service needs,
/// and `create` defines how to construct the service given those dependencies.
///
/// # Supported Dependency Types
///
/// - `()` - No dependencies
/// - `Arc<T>` - Single required dependency
/// - `(Arc<A>, Arc<B>)` - Multiple dependencies (tuples up to 12)
/// - `Option<Arc<T>>` - Optional dependency
///
/// # Example
///
/// ```rust
/// use dependency_injector::verified::Service;
/// use std::sync::Arc;
///
/// #[derive(Clone)]
/// struct Config {
///     debug: bool,
/// }
///
/// impl Service for Config {
///     type Dependencies = ();
///
///     fn create(_: ()) -> Self {
///         Config { debug: false }
///     }
/// }
///
/// #[derive(Clone)]
/// struct Logger {
///     config: Arc<Config>,
/// }
///
/// impl Service for Logger {
///     type Dependencies = Arc<Config>;
///
///     fn create(config: Arc<Config>) -> Self {
///         Logger { config }
///     }
/// }
/// ```
pub trait Service: Injectable + Sized {
    /// The dependencies required to create this service.
    ///
    /// Use `()` for no dependencies, `Arc<T>` for one, or tuples for multiple.
    type Dependencies: Resolvable;

    /// Create a new instance given the resolved dependencies.
    fn create(deps: Self::Dependencies) -> Self;
}

// =============================================================================
// Resolvable Trait - Dependencies that can be resolved from a container
// =============================================================================

/// Trait for types that can be resolved from a container.
///
/// This is automatically implemented for:
/// - `()` - No dependencies
/// - `Arc<T>` - Single service
/// - Tuples of `Arc<T>` - Multiple services
/// - `Option<Arc<T>>` - Optional service
pub trait Resolvable: Sized {
    /// Resolve this dependency from the container.
    ///
    /// Returns `None` if any required dependency is missing.
    fn resolve(container: &Container) -> Option<Self>;
}

// No dependencies
impl Resolvable for () {
    #[inline]
    fn resolve(_container: &Container) -> Option<Self> {
        Some(())
    }
}

// Single dependency
impl<T: Injectable> Resolvable for Arc<T> {
    #[inline]
    fn resolve(container: &Container) -> Option<Self> {
        container.try_get::<T>()
    }
}

// Optional dependency
impl<T: Injectable> Resolvable for Option<Arc<T>> {
    #[inline]
    fn resolve(container: &Container) -> Option<Self> {
        Some(container.try_get::<T>())
    }
}

// Tuple implementations (2-12 elements)
macro_rules! impl_resolvable_tuple {
    ($($T:ident),+) => {
        impl<$($T: Injectable),+> Resolvable for ($(Arc<$T>,)+) {
            #[inline]
            fn resolve(container: &Container) -> Option<Self> {
                Some(($(container.try_get::<$T>()?,)+))
            }
        }
    };
}

impl_resolvable_tuple!(A, B);
impl_resolvable_tuple!(A, B, C);
impl_resolvable_tuple!(A, B, C, D);
impl_resolvable_tuple!(A, B, C, D, E);
impl_resolvable_tuple!(A, B, C, D, E, F);
impl_resolvable_tuple!(A, B, C, D, E, F, G);
impl_resolvable_tuple!(A, B, C, D, E, F, G, H);
impl_resolvable_tuple!(A, B, C, D, E, F, G, H, I);
impl_resolvable_tuple!(A, B, C, D, E, F, G, H, I, J);
impl_resolvable_tuple!(A, B, C, D, E, F, G, H, I, J, K);
impl_resolvable_tuple!(A, B, C, D, E, F, G, H, I, J, K, L);

// =============================================================================
// ServiceProvider Trait - Auto-registration
// =============================================================================

/// Extension trait for containers to auto-register services.
pub trait ServiceProvider {
    /// Register a service using its `Service` implementation.
    ///
    /// The service will be created lazily on first access, with dependencies
    /// resolved from the container.
    ///
    /// # Panics
    ///
    /// The created factory will panic at runtime if dependencies are missing.
    /// For compile-time safety, use the typed builder API.
    ///
    /// # Example
    ///
    /// ```rust
    /// use dependency_injector::{Container, verified::{Service, ServiceProvider}};
    ///
    /// #[derive(Clone)]
    /// struct MyService;
    ///
    /// impl Service for MyService {
    ///     type Dependencies = ();
    ///     fn create(_: ()) -> Self { MyService }
    /// }
    ///
    /// let container = Container::new();
    /// container.provide::<MyService>();
    ///
    /// let service = container.get::<MyService>().unwrap();
    /// ```
    fn provide<T: Service>(&self);

    /// Register a service as a singleton with pre-resolved dependencies.
    ///
    /// Dependencies are resolved immediately, not lazily.
    ///
    /// # Returns
    ///
    /// `true` if all dependencies were resolved and the service was registered,
    /// `false` if any dependency was missing.
    fn provide_singleton<T: Service>(&self) -> bool;

    /// Register a service as transient.
    ///
    /// A new instance is created on every resolution.
    fn provide_transient<T: Service>(&self);
}

impl ServiceProvider for Container {
    #[inline]
    fn provide<T: Service>(&self) {
        let container = self.clone();
        self.lazy(move || {
            let deps = T::Dependencies::resolve(&container)
                .expect("Failed to resolve dependencies for service");
            T::create(deps)
        });
    }

    #[inline]
    fn provide_singleton<T: Service>(&self) -> bool {
        if let Some(deps) = T::Dependencies::resolve(self) {
            self.singleton(T::create(deps));
            true
        } else {
            false
        }
    }

    #[inline]
    fn provide_transient<T: Service>(&self) {
        let container = self.clone();
        self.transient(move || {
            let deps = T::Dependencies::resolve(&container)
                .expect("Failed to resolve dependencies for transient service");
            T::create(deps)
        });
    }
}

// =============================================================================
// ServiceModule - Group related services
// =============================================================================

/// A module that groups related service registrations.
///
/// # Example
///
/// ```rust
/// use dependency_injector::{Container, verified::{Service, ServiceModule, ServiceProvider}};
///
/// #[derive(Clone)]
/// struct Database;
///
/// impl Service for Database {
///     type Dependencies = ();
///     fn create(_: ()) -> Self { Database }
/// }
///
/// #[derive(Clone)]
/// struct Cache;
///
/// impl Service for Cache {
///     type Dependencies = ();
///     fn create(_: ()) -> Self { Cache }
/// }
///
/// struct DataModule;
///
/// impl ServiceModule for DataModule {
///     fn register(container: &Container) {
///         container.provide::<Database>();
///         container.provide::<Cache>();
///     }
/// }
///
/// let container = Container::new();
/// DataModule::register(&container);
///
/// assert!(container.contains::<Database>());
/// assert!(container.contains::<Cache>());
/// ```
pub trait ServiceModule {
    /// Register all services in this module.
    fn register(container: &Container);
}

// =============================================================================
// Dependency Graph Helpers
// =============================================================================

/// Trait for extracting dependency type information.
///
/// This is mainly useful for debugging and visualization.
pub trait DependencyInfo {
    /// Get the type names of all dependencies.
    fn dependency_names() -> Vec<&'static str>;
}

impl DependencyInfo for () {
    fn dependency_names() -> Vec<&'static str> {
        vec![]
    }
}

impl<T: Injectable> DependencyInfo for Arc<T> {
    fn dependency_names() -> Vec<&'static str> {
        vec![std::any::type_name::<T>()]
    }
}

impl<T: Injectable> DependencyInfo for Option<Arc<T>> {
    fn dependency_names() -> Vec<&'static str> {
        vec![std::any::type_name::<T>()]
    }
}

// Tuple implementations for DependencyInfo
macro_rules! impl_dependency_info_tuple {
    ($($T:ident),+) => {
        impl<$($T: Injectable),+> DependencyInfo for ($(Arc<$T>,)+) {
            fn dependency_names() -> Vec<&'static str> {
                vec![$(std::any::type_name::<$T>()),+]
            }
        }
    };
}

impl_dependency_info_tuple!(A, B);
impl_dependency_info_tuple!(A, B, C);
impl_dependency_info_tuple!(A, B, C, D);
impl_dependency_info_tuple!(A, B, C, D, E);
impl_dependency_info_tuple!(A, B, C, D, E, F);

// =============================================================================
// Compile-Time Cycle Detection (Documentation Only)
// =============================================================================

// Note: Full compile-time cycle detection requires either:
// 1. A procedural macro that analyzes the full dependency graph
// 2. Unstable Rust features (specialization, const generics)
//
// The current approach provides partial protection:
// - The `Service` trait requires explicit dependency declaration
// - The `TypedBuilder::with_dependencies` method verifies deps exist
// - Runtime errors are caught when resolving missing dependencies
//
// For complete compile-time cycle detection, consider:
// - Using the `#[derive(Service)]` macro which can analyze dependencies
// - Using the typed builder API which tracks registrations
//
// Future: When Rust's type system supports it, we can add full cycle detection.

// =============================================================================
// Tests
// =============================================================================

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

    #[derive(Clone)]
    struct Config {
        debug: bool,
    }

    impl Service for Config {
        type Dependencies = ();

        fn create(_: ()) -> Self {
            Config { debug: true }
        }
    }

    #[derive(Clone)]
    struct Database {
        url: String,
    }

    impl Service for Database {
        type Dependencies = Arc<Config>;

        fn create(config: Arc<Config>) -> Self {
            Database {
                url: if config.debug {
                    "debug://localhost".into()
                } else {
                    "prod://server".into()
                },
            }
        }
    }

    #[derive(Clone)]
    struct Cache {
        size: usize,
    }

    impl Service for Cache {
        type Dependencies = ();

        fn create(_: ()) -> Self {
            Cache { size: 1024 }
        }
    }

    #[derive(Clone)]
    struct UserRepository {
        db: Arc<Database>,
        cache: Arc<Cache>,
    }

    impl Service for UserRepository {
        type Dependencies = (Arc<Database>, Arc<Cache>);

        fn create((db, cache): (Arc<Database>, Arc<Cache>)) -> Self {
            UserRepository { db, cache }
        }
    }

    #[test]
    fn test_service_no_deps() {
        let container = Container::new();
        container.provide::<Config>();

        let config = container.get::<Config>().unwrap();
        assert!(config.debug);
    }

    #[test]
    fn test_service_single_dep() {
        let container = Container::new();
        container.provide::<Config>();
        container.provide::<Database>();

        let db = container.get::<Database>().unwrap();
        assert_eq!(db.url, "debug://localhost");
    }

    #[test]
    fn test_service_multiple_deps() {
        let container = Container::new();
        container.provide::<Config>();
        container.provide::<Database>();
        container.provide::<Cache>();
        container.provide::<UserRepository>();

        let repo = container.get::<UserRepository>().unwrap();
        assert_eq!(repo.db.url, "debug://localhost");
        assert_eq!(repo.cache.size, 1024);
    }

    #[test]
    fn test_provide_singleton() {
        let container = Container::new();
        container.provide::<Config>();

        // Should succeed
        let result = container.provide_singleton::<Database>();
        assert!(result);

        let db = container.get::<Database>().unwrap();
        assert_eq!(db.url, "debug://localhost");
    }

    #[test]
    fn test_provide_singleton_missing_dep() {
        let container = Container::new();

        // Should fail - Config not registered
        let result = container.provide_singleton::<Database>();
        assert!(!result);
    }

    #[test]
    fn test_provide_transient() {
        use std::sync::atomic::{AtomicU32, Ordering};

        static COUNTER: AtomicU32 = AtomicU32::new(0);

        #[derive(Clone)]
        struct Counter(u32);

        impl Service for Counter {
            type Dependencies = ();

            fn create(_: ()) -> Self {
                Counter(COUNTER.fetch_add(1, Ordering::SeqCst))
            }
        }

        let container = Container::new();
        container.provide_transient::<Counter>();

        let c1 = container.get::<Counter>().unwrap();
        let c2 = container.get::<Counter>().unwrap();

        assert_ne!(c1.0, c2.0);
    }

    #[test]
    fn test_optional_dependency() {
        #[derive(Clone)]
        struct OptionalCache;

        #[derive(Clone)]
        struct ServiceWithOptional {
            cache: Option<Arc<OptionalCache>>,
        }

        impl Service for ServiceWithOptional {
            type Dependencies = Option<Arc<OptionalCache>>;

            fn create(cache: Option<Arc<OptionalCache>>) -> Self {
                ServiceWithOptional { cache }
            }
        }

        let container = Container::new();
        container.provide::<ServiceWithOptional>();

        let svc = container.get::<ServiceWithOptional>().unwrap();
        assert!(svc.cache.is_none());

        // Now register the optional dep
        let container2 = Container::new();
        container2.singleton(OptionalCache);
        container2.provide::<ServiceWithOptional>();

        let svc2 = container2.get::<ServiceWithOptional>().unwrap();
        assert!(svc2.cache.is_some());
    }

    #[test]
    fn test_dependency_info() {
        assert_eq!(
            <() as DependencyInfo>::dependency_names(),
            Vec::<&str>::new()
        );
        assert_eq!(
            <Arc<Config> as DependencyInfo>::dependency_names(),
            vec!["dependency_injector::verified::tests::Config"]
        );
        assert_eq!(
            <(Arc<Database>, Arc<Cache>) as DependencyInfo>::dependency_names().len(),
            2
        );
    }

    #[test]
    fn test_service_module() {
        struct TestModule;

        impl ServiceModule for TestModule {
            fn register(container: &Container) {
                container.provide::<Config>();
                container.provide::<Cache>();
            }
        }

        let container = Container::new();
        TestModule::register(&container);

        assert!(container.contains::<Config>());
        assert!(container.contains::<Cache>());
    }
}