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
//! The core functionality of creating and managing [Component](crate::component::Component)
//! instances.

use crate::component::Injectable;
#[cfg(feature = "async")]
use futures::future::BoxFuture;
#[cfg(feature = "async")]
use futures::FutureExt;
use itertools::Itertools;
#[cfg(test)]
use mockall::automock;
use std::any::{Any, TypeId};
use std::error::Error;
#[cfg(not(feature = "threadsafe"))]
use std::rc::Rc;
#[cfg(feature = "threadsafe")]
use std::sync::Arc;
use thiserror::Error;

#[cfg(not(feature = "threadsafe"))]
pub type ErrorPtr = Rc<dyn Error>;
#[cfg(feature = "threadsafe")]
pub type ErrorPtr = Arc<dyn Error + Send + Sync>;

/// Errors related to creating and managing components.
#[derive(Error, Debug, Clone)]
pub enum ComponentInstanceProviderError {
    /// Primary instance of a given component is not specified, if many components exist for a given
    /// type, or not component registered at all.
    #[error("Cannot find a primary instance for component '{0:?}' - either none or multiple exists without a primary marker.")]
    NoPrimaryInstance(TypeId),
    /// Tired to case one type to another, incompatible one.
    #[error("Tried to downcast component to incompatible type: {0:?}")]
    IncompatibleComponent(TypeId),
    /// Cannot find component with given name.
    #[error("Cannot find named component: {0}")]
    NoNamedInstance(String),
    /// Component registered for unknown scope - possibly missing associated
    /// [ScopeFactory](crate::scope::ScopeFactory).
    #[error("Unrecognized scope: {0}")]
    UnrecognizedScope(String),
    #[error("Detected dependency cycle for: {0:?}")]
    /// Found a cycle when creating given type.
    DependencyCycle(TypeId),
    /// Custom constructor returned an error.
    #[error("Error in component constructor: {0}")]
    ConstructorError(#[source] ErrorPtr),
}

#[cfg(not(feature = "threadsafe"))]
pub type ComponentInstancePtr<T> = Rc<T>;
#[cfg(feature = "threadsafe")]
pub type ComponentInstancePtr<T> = Arc<T>;

#[cfg(not(feature = "threadsafe"))]
pub type ComponentInstanceAnyPtr = ComponentInstancePtr<dyn Any + 'static>;
#[cfg(feature = "threadsafe")]
pub type ComponentInstanceAnyPtr = ComponentInstancePtr<dyn Any + Send + Sync + 'static>;

/// (Usually generated) cast function which consumes given type-erased instance pointer and casts it
/// to the desired [`ComponentInstancePtr<T>`]. The result is then returned as type-erased `Box` which
/// is then converted back to [`ComponentInstancePtr<T>`]. Such shenanigans are needed to be able to
/// convert between two `dyn Traits`.
pub type CastFunction =
    fn(instance: ComponentInstanceAnyPtr) -> Result<Box<dyn Any>, ComponentInstanceAnyPtr>;

/// Generic provider for component instances.
#[cfg_attr(test, automock)]
pub trait ComponentInstanceProvider {
    #[cfg(feature = "async")]
    /// Tries to return a primary instance of a given component. A primary component is either the
    /// only one registered or one marked as primary.
    fn primary_instance(
        &mut self,
        type_id: TypeId,
    ) -> BoxFuture<
        '_,
        Result<(ComponentInstanceAnyPtr, CastFunction), ComponentInstanceProviderError>,
    >;

    #[cfg(not(feature = "async"))]
    /// Tries to return a primary instance of a given component. A primary component is either the
    /// only one registered or one marked as primary.
    fn primary_instance(
        &mut self,
        type_id: TypeId,
    ) -> Result<(ComponentInstanceAnyPtr, CastFunction), ComponentInstanceProviderError>;

    #[cfg(feature = "async")]
    /// Tries to instantiate and return all registered components for given type, stopping on first
    /// error. Be aware this might be an expensive operation if the number of registered components
    /// is high.
    fn instances(
        &mut self,
        type_id: TypeId,
    ) -> BoxFuture<
        '_,
        Result<Vec<(ComponentInstanceAnyPtr, CastFunction)>, ComponentInstanceProviderError>,
    >;

    #[cfg(not(feature = "async"))]
    /// Tries to instantiate and return all registered components for given type, stopping on first
    /// error. Be aware this might be an expensive operation if the number of registered components
    /// is high.
    fn instances(
        &mut self,
        type_id: TypeId,
    ) -> Result<Vec<(ComponentInstanceAnyPtr, CastFunction)>, ComponentInstanceProviderError>;

    #[cfg(feature = "async")]
    /// Tries to return an instance with the given name and type.
    fn instance_by_name(
        &mut self,
        name: &str,
        type_id: TypeId,
    ) -> BoxFuture<
        '_,
        Result<(ComponentInstanceAnyPtr, CastFunction), ComponentInstanceProviderError>,
    >;

    #[cfg(not(feature = "async"))]
    /// Tries to return an instance with the given name and type.
    fn instance_by_name(
        &mut self,
        name: &str,
        type_id: TypeId,
    ) -> Result<(ComponentInstanceAnyPtr, CastFunction), ComponentInstanceProviderError>;
}

/// Helper trait for [ComponentInstanceProvider] providing strongly-typed access.
pub trait TypedComponentInstanceProvider {
    #[cfg(feature = "async")]
    /// Typesafe version of [ComponentInstanceProvider::primary_instance].
    fn primary_instance_typed<T: Injectable + ?Sized>(
        &mut self,
    ) -> BoxFuture<'_, Result<ComponentInstancePtr<T>, ComponentInstanceProviderError>>;

    #[cfg(not(feature = "async"))]
    /// Typesafe version of [ComponentInstanceProvider::primary_instance].
    fn primary_instance_typed<T: Injectable + ?Sized>(
        &mut self,
    ) -> Result<ComponentInstancePtr<T>, ComponentInstanceProviderError>;

    #[cfg(feature = "async")]
    /// Tries to get an instance like [TypedComponentInstanceProvider::primary_instance_typed] does,
    /// but returns `None` on missing instance.
    fn primary_instance_option<T: Injectable + ?Sized>(
        &mut self,
    ) -> BoxFuture<'_, Result<Option<ComponentInstancePtr<T>>, ComponentInstanceProviderError>>;

    #[cfg(not(feature = "async"))]
    /// Tries to get an instance like [TypedComponentInstanceProvider::primary_instance_typed] does,
    /// but returns `None` on missing instance.
    fn primary_instance_option<T: Injectable + ?Sized>(
        &mut self,
    ) -> Result<Option<ComponentInstancePtr<T>>, ComponentInstanceProviderError>;

    #[cfg(feature = "async")]
    /// Typesafe version of [ComponentInstanceProvider::instances].
    fn instances_typed<T: Injectable + ?Sized>(
        &mut self,
    ) -> BoxFuture<'_, Result<Vec<ComponentInstancePtr<T>>, ComponentInstanceProviderError>>;

    #[cfg(not(feature = "async"))]
    /// Typesafe version of [ComponentInstanceProvider::instances].
    fn instances_typed<T: Injectable + ?Sized>(
        &mut self,
    ) -> Result<Vec<ComponentInstancePtr<T>>, ComponentInstanceProviderError>;

    #[cfg(feature = "async")]
    /// Typesafe version of [ComponentInstanceProvider::instance_by_name].
    fn instance_by_name_typed<T: Injectable + ?Sized>(
        &mut self,
        name: &str,
    ) -> BoxFuture<'_, Result<ComponentInstancePtr<T>, ComponentInstanceProviderError>>;

    #[cfg(not(feature = "async"))]
    /// Typesafe version of [ComponentInstanceProvider::instance_by_name].
    fn instance_by_name_typed<T: Injectable + ?Sized>(
        &mut self,
        name: &str,
    ) -> Result<ComponentInstancePtr<T>, ComponentInstanceProviderError>;

    #[cfg(feature = "async")]
    /// Tries to get an instance like [TypedComponentInstanceProvider::instance_by_name_typed] does,
    /// but returns `None` on missing instance.
    fn instance_by_name_option<T: Injectable + ?Sized>(
        &mut self,
        name: &str,
    ) -> BoxFuture<'_, Result<Option<ComponentInstancePtr<T>>, ComponentInstanceProviderError>>;

    #[cfg(not(feature = "async"))]
    /// Tries to get an instance like [TypedComponentInstanceProvider::instance_by_name_typed] does,
    /// but returns `None` on missing instance.
    fn instance_by_name_option<T: Injectable + ?Sized>(
        &mut self,
        name: &str,
    ) -> Result<Option<ComponentInstancePtr<T>>, ComponentInstanceProviderError>;
}

//noinspection DuplicatedCode
#[cfg(feature = "async")]
impl<CIP: ComponentInstanceProvider + ?Sized + Sync + Send> TypedComponentInstanceProvider for CIP {
    fn primary_instance_typed<T: Injectable + ?Sized>(
        &mut self,
    ) -> BoxFuture<'_, Result<ComponentInstancePtr<T>, ComponentInstanceProviderError>> {
        async {
            let type_id = TypeId::of::<T>();
            self.primary_instance(type_id)
                .await
                .and_then(move |(p, cast)| cast_instance(p, cast, type_id))
        }
        .boxed()
    }

    fn primary_instance_option<T: Injectable + ?Sized>(
        &mut self,
    ) -> BoxFuture<'_, Result<Option<ComponentInstancePtr<T>>, ComponentInstanceProviderError>>
    {
        async {
            match self.primary_instance_typed::<T>().await {
                Ok(ptr) => Ok(Some(ptr)),
                Err(ComponentInstanceProviderError::NoPrimaryInstance(_)) => Ok(None),
                Err(error) => Err(error),
            }
        }
        .boxed()
    }

    fn instances_typed<T: Injectable + ?Sized>(
        &mut self,
    ) -> BoxFuture<'_, Result<Vec<ComponentInstancePtr<T>>, ComponentInstanceProviderError>> {
        async {
            let type_id = TypeId::of::<T>();
            self.instances(type_id).await.and_then(|instances| {
                instances
                    .into_iter()
                    .map(move |(p, cast)| cast_instance(p, cast, type_id))
                    .try_collect()
            })
        }
        .boxed()
    }

    fn instance_by_name_typed<T: Injectable + ?Sized>(
        &mut self,
        name: &str,
    ) -> BoxFuture<'_, Result<ComponentInstancePtr<T>, ComponentInstanceProviderError>> {
        let name = name.to_string();
        async move {
            let type_id = TypeId::of::<T>();
            self.instance_by_name(&name, type_id)
                .await
                .and_then(move |(p, cast)| cast_instance(p, cast, type_id))
        }
        .boxed()
    }

    fn instance_by_name_option<T: Injectable + ?Sized>(
        &mut self,
        name: &str,
    ) -> BoxFuture<'_, Result<Option<ComponentInstancePtr<T>>, ComponentInstanceProviderError>>
    {
        let name = name.to_string();
        async move {
            match self.instance_by_name_typed::<T>(&name).await {
                Ok(ptr) => Ok(Some(ptr)),
                Err(ComponentInstanceProviderError::NoPrimaryInstance(_)) => Ok(None),
                Err(error) => Err(error),
            }
        }
        .boxed()
    }
}

//noinspection DuplicatedCode
#[cfg(not(feature = "async"))]
impl<CIP: ComponentInstanceProvider + ?Sized> TypedComponentInstanceProvider for CIP {
    fn primary_instance_typed<T: Injectable + ?Sized>(
        &mut self,
    ) -> Result<ComponentInstancePtr<T>, ComponentInstanceProviderError> {
        let type_id = TypeId::of::<T>();
        self.primary_instance(type_id)
            .and_then(move |(p, cast)| cast_instance(p, cast, type_id))
    }

    fn primary_instance_option<T: Injectable + ?Sized>(
        &mut self,
    ) -> Result<Option<ComponentInstancePtr<T>>, ComponentInstanceProviderError> {
        match self.primary_instance_typed::<T>() {
            Ok(ptr) => Ok(Some(ptr)),
            Err(ComponentInstanceProviderError::NoPrimaryInstance(_)) => Ok(None),
            Err(error) => Err(error),
        }
    }

    fn instances_typed<T: Injectable + ?Sized>(
        &mut self,
    ) -> Result<Vec<ComponentInstancePtr<T>>, ComponentInstanceProviderError> {
        let type_id = TypeId::of::<T>();
        self.instances(type_id).and_then(|instances| {
            instances
                .into_iter()
                .map(move |(p, cast)| cast_instance(p, cast, type_id))
                .try_collect()
        })
    }

    fn instance_by_name_typed<T: Injectable + ?Sized>(
        &mut self,
        name: &str,
    ) -> Result<ComponentInstancePtr<T>, ComponentInstanceProviderError> {
        let type_id = TypeId::of::<T>();
        self.instance_by_name(name, type_id)
            .and_then(move |(p, cast)| cast_instance(p, cast, type_id))
    }

    fn instance_by_name_option<T: Injectable + ?Sized>(
        &mut self,
        name: &str,
    ) -> Result<Option<ComponentInstancePtr<T>>, ComponentInstanceProviderError> {
        match self.instance_by_name_typed::<T>(name) {
            Ok(ptr) => Ok(Some(ptr)),
            Err(ComponentInstanceProviderError::NoPrimaryInstance(_)) => Ok(None),
            Err(error) => Err(error),
        }
    }
}

fn cast_instance<T: Injectable + ?Sized>(
    instance: ComponentInstanceAnyPtr,
    cast: CastFunction,
    type_id: TypeId,
) -> Result<ComponentInstancePtr<T>, ComponentInstanceProviderError> {
    debug_assert_eq!(type_id, TypeId::of::<T>());
    cast(instance)
        .map_err(|_| ComponentInstanceProviderError::IncompatibleComponent(type_id))
        .and_then(|p| {
            p.downcast::<ComponentInstancePtr<T>>()
                .map(|p| (*p).clone())
                .map_err(|_| ComponentInstanceProviderError::IncompatibleComponent(type_id))
        })
}

#[cfg(test)]
//noinspection DuplicatedCode
mod tests {
    #[cfg(not(feature = "async"))]
    mod sync {
        use crate::component::Injectable;
        use crate::instance_provider::{
            CastFunction, ComponentInstanceAnyPtr, ComponentInstancePtr,
            MockComponentInstanceProvider, TypedComponentInstanceProvider,
        };
        use mockall::predicate::*;
        use std::any::{Any, TypeId};

        struct TestComponent;

        impl Injectable for TestComponent {}

        fn test_cast(
            instance: ComponentInstanceAnyPtr,
        ) -> Result<Box<dyn Any>, ComponentInstanceAnyPtr> {
            instance
                .downcast::<TestComponent>()
                .map(|p| Box::new(p) as Box<dyn Any>)
        }

        #[test]
        fn should_provide_primary_instance_typed() {
            let mut instance_provider = MockComponentInstanceProvider::new();
            instance_provider
                .expect_primary_instance()
                .with(eq(TypeId::of::<TestComponent>()))
                .times(1)
                .return_const(Ok((
                    ComponentInstancePtr::new(TestComponent) as ComponentInstanceAnyPtr,
                    test_cast as CastFunction,
                )));

            assert!(instance_provider
                .primary_instance_typed::<TestComponent>()
                .is_ok());
        }

        #[test]
        fn should_provide_primary_instance_option() {
            let mut instance_provider = MockComponentInstanceProvider::new();
            instance_provider
                .expect_primary_instance()
                .with(eq(TypeId::of::<TestComponent>()))
                .times(1)
                .return_const(Ok((
                    ComponentInstancePtr::new(TestComponent) as ComponentInstanceAnyPtr,
                    test_cast as CastFunction,
                )));

            assert!(instance_provider
                .primary_instance_option::<TestComponent>()
                .unwrap()
                .is_some());
        }

        #[test]
        fn should_provide_instances_typed() {
            let mut instance_provider = MockComponentInstanceProvider::new();
            instance_provider
                .expect_instances()
                .with(eq(TypeId::of::<TestComponent>()))
                .times(1)
                .return_const(Ok(vec![(
                    ComponentInstancePtr::new(TestComponent) as ComponentInstanceAnyPtr,
                    test_cast as CastFunction,
                )]));

            assert!(!instance_provider
                .instances_typed::<TestComponent>()
                .unwrap()
                .is_empty());
        }

        #[test]
        fn should_provide_instance_by_name_typed() {
            let name = "name";

            let mut instance_provider = MockComponentInstanceProvider::new();
            instance_provider
                .expect_instance_by_name()
                .with(eq(name), eq(TypeId::of::<TestComponent>()))
                .times(1)
                .return_const(Ok((
                    ComponentInstancePtr::new(TestComponent) as ComponentInstanceAnyPtr,
                    test_cast as CastFunction,
                )));

            assert!(instance_provider
                .instance_by_name_typed::<TestComponent>(name)
                .is_ok());
        }

        #[test]
        fn should_provide_instance_by_name_option() {
            let name = "name";

            let mut instance_provider = MockComponentInstanceProvider::new();
            instance_provider
                .expect_instance_by_name()
                .with(eq(name), eq(TypeId::of::<TestComponent>()))
                .times(1)
                .return_const(Ok((
                    ComponentInstancePtr::new(TestComponent) as ComponentInstanceAnyPtr,
                    test_cast as CastFunction,
                )));

            assert!(instance_provider
                .instance_by_name_option::<TestComponent>(name)
                .unwrap()
                .is_some());
        }
    }
}