nestrs_core/

lib.rs

use std::any::{Any, TypeId};
use std::collections::{HashMap, HashSet};
use std::future::Future;
use std::pin::Pin;
use std::sync::Arc;
use std::sync::OnceLock;
use std::sync::RwLock;

use async_trait::async_trait;
use axum::Router;

mod admin_snapshot;
pub mod als;
pub mod client_ip;
mod database;
mod discovery;
mod execution_context;
mod guard;
mod metadata;
mod module_ref;
mod pipe;
mod platform;
mod route_registry;
mod strategy;
mod trace;

#[cfg(feature = "sse")]
pub mod sse;

pub use admin_snapshot::AdminSnapshot;
pub use als::{AlsContext, AlsError};
pub use client_ip::{
    best_effort_client_ip, rate_limit_key_ip_or_unknown, trusted_hops_from_parts, RateLimitKey,
    TrustedProxyHops, X_FORWARDED_FOR, X_REAL_IP,
};
pub use database::DatabasePing;
pub use discovery::DiscoveryService;
pub use execution_context::{ExecutionContext, HostType, HttpExecutionArguments};
pub use guard::{CanActivate, GuardError};
pub use metadata::MetadataRegistry;
pub use module_ref::ModuleRef;
pub use pipe::{HttpPipeTransform, PipeTransform};
pub use platform::{AxumHttpEngine, HttpServerEngine};
pub use route_registry::{OpenApiResponseDesc, OpenApiRouteSpec, RouteInfo, RouteRegistry};
pub use strategy::{AuthError, AuthStrategy};
pub use trace::{current_trace_context, parse_traceparent, with_trace_context, TraceContext};

#[cfg(feature = "sse")]
pub use sse::{serialize_to_event, IntoSseEvent, SseEvent, SseKeepAlive, SseResponse};

type CustomFactoryFn =
    std::sync::Arc<dyn Fn(&ProviderRegistry) -> Arc<dyn Any + Send + Sync> + Send + Sync>;

/// Provider lifetime semantics (NestJS `Scope.DEFAULT` / `Scope.TRANSIENT` / `Scope.REQUEST` analogues).
///
/// Set per type via `#[injectable(scope = "singleton" | "transient" | "request")]` or pass to
/// [`ProviderRegistry::register_use_factory`]. **Request** scope requires the app to call
/// [`nestrs::NestApplication::use_request_scope`](https://docs.rs/nestrs/latest/nestrs/struct.NestApplication.html#method.use_request_scope).
///
/// **Docs:** mdBook **Fundamentals** in the repository (`docs/src/fundamentals.md`).
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum ProviderScope {
    /// One instance per application container (default).
    Singleton,
    /// A new instance is created on every injection site / resolution.
    Transient,
    /// One instance per request/task scope (requires request-scope middleware).
    Request,
}

/// A lightweight `(name, scope)` view of a registered provider, suitable
/// for serialization. Returned by [`ProviderRegistry::provider_summaries`].
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct ProviderSummary {
    pub type_name: &'static str,
    pub scope: ProviderScope,
}

#[derive(Clone)]
enum ProviderFactory {
    InjectableFn(fn(&ProviderRegistry) -> Arc<dyn Any + Send + Sync>),
    Custom(CustomFactoryFn),
}

#[derive(Clone)]
struct ProviderEntry {
    type_name: &'static str,
    scope: ProviderScope,
    factory: ProviderFactory,
    instance: Arc<OnceLock<Arc<dyn Any + Send + Sync>>>,
    on_module_init: HookFn,
    on_module_destroy: HookFn,
    on_application_bootstrap: HookFn,
    /// NestJS `beforeApplicationShutdown`: fires before `onApplicationShutdown` /
    /// `onModuleDestroy` during graceful shutdown.
    on_before_application_shutdown: HookFn,
    on_application_shutdown: HookFn,
}

fn noop_hook<'a>(_registry: &'a ProviderRegistry) -> HookFuture<'a> {
    Box::pin(async {})
}

fn create_entry_for_injectable<T: Injectable + Send + Sync + 'static>() -> ProviderEntry {
    fn factory<T: Injectable + Send + Sync + 'static>(
        registry: &ProviderRegistry,
    ) -> Arc<dyn Any + Send + Sync> {
        T::construct(registry)
    }

    ProviderEntry {
        type_name: std::any::type_name::<T>(),
        scope: T::scope(),
        factory: ProviderFactory::InjectableFn(factory::<T>),
        instance: Arc::new(OnceLock::new()),
        on_module_init: hook_on_module_init::<T>,
        on_module_destroy: hook_on_module_destroy::<T>,
        on_application_bootstrap: hook_on_application_bootstrap::<T>,
        on_before_application_shutdown: hook_on_before_application_shutdown::<T>,
        on_application_shutdown: hook_on_application_shutdown::<T>,
    }
}

pub struct ProviderRegistry {
    entries: HashMap<TypeId, ProviderEntry>,
    /// Registration order of providers. Iteration over [`Self::entries`] alone is nondeterministic
    /// (HashMap), so lifecycle hooks and discovery use this order for stable startup/shutdown.
    order: Vec<TypeId>,
}

/// Per-request handle identifying the matched handler (used for metadata lookups).
#[derive(Clone, Copy, Debug)]
pub struct HandlerKey(pub &'static str);

impl ProviderRegistry {
    pub fn new() -> Self {
        Self {
            entries: HashMap::new(),
            order: Vec::new(),
        }
    }

    fn insert_entry(&mut self, type_id: TypeId, entry: ProviderEntry) {
        if !self.entries.contains_key(&type_id) {
            self.order.push(type_id);
        }
        self.entries.insert(type_id, entry);
    }

    pub fn register<T>(&mut self)
    where
        T: Injectable + Send + Sync + 'static,
    {
        self.insert_entry(TypeId::of::<T>(), create_entry_for_injectable::<T>());
    }

    /// NestJS **`useValue`**: register a pre-built singleton without an [`Injectable`] impl.
    ///
    /// Lifecycle hooks do **not** run for this registration (any `T` is accepted, so there is no
    /// hook impl to call). If `T` implements [`ProviderLifecycle`], use
    /// [`Self::register_use_value_with_lifecycle`] to have the framework drive its hooks.
    pub fn register_use_value<T: Send + Sync + 'static>(&mut self, value: Arc<T>) {
        let preset: Arc<dyn Any + Send + Sync> = value;
        let cell = Arc::new(OnceLock::new());
        let _ = cell.set(preset.clone());
        self.insert_entry(
            TypeId::of::<T>(),
            ProviderEntry {
                type_name: std::any::type_name::<T>(),
                scope: ProviderScope::Singleton,
                factory: ProviderFactory::Custom(Arc::new(move |_| preset.clone())),
                instance: cell,
                on_module_init: noop_hook,
                on_module_destroy: noop_hook,
                on_application_bootstrap: noop_hook,
                on_before_application_shutdown: noop_hook,
                on_application_shutdown: noop_hook,
            },
        );
    }

    /// NestJS **`useFactory`**: register a provider from a **synchronous** closure `Fn(&ProviderRegistry) -> Arc<T>`.
    ///
    /// The closure may call [`Self::get`] for dependencies. For **async** initialization of `T`, keep
    /// `construct`/`factory` cheap and use [`Injectable::on_module_init`] on `T`, or load **module
    /// options** with [`ConfigurableModuleBuilder::for_root_async`]. Do **not** block the async
    /// runtime inside the factory.
    ///
    /// Prefer [`Self::register`] when the provider is a normal `#[injectable]` type.
    ///
    /// Lifecycle hooks do **not** run for this registration (any `T` is accepted, so there is no
    /// hook impl to call). If `T` implements [`ProviderLifecycle`], use
    /// [`Self::register_use_factory_with_lifecycle`] to have the framework drive its hooks.
    pub fn register_use_factory<T, F>(&mut self, scope: ProviderScope, factory: F)
    where
        T: Send + Sync + 'static,
        F: Fn(&ProviderRegistry) -> Arc<T> + Send + Sync + 'static,
    {
        let factory: std::sync::Arc<F> = std::sync::Arc::new(factory);
        let factory = factory.clone();
        self.insert_entry(
            TypeId::of::<T>(),
            ProviderEntry {
                type_name: std::any::type_name::<T>(),
                scope,
                factory: ProviderFactory::Custom(Arc::new(move |r| {
                    let v = factory(r);
                    v as Arc<dyn Any + Send + Sync>
                })),
                instance: Arc::new(OnceLock::new()),
                on_module_init: noop_hook,
                on_module_destroy: noop_hook,
                on_application_bootstrap: noop_hook,
                on_before_application_shutdown: noop_hook,
                on_application_shutdown: noop_hook,
            },
        );
    }

    /// NestJS **`useValue`** with lifecycle hooks: like [`Self::register_use_value`], but the
    /// singleton's [`ProviderLifecycle`] hooks are driven by the framework (module init/destroy,
    /// application bootstrap/shutdown) in the same order as [`Injectable`] hooks.
    pub fn register_use_value_with_lifecycle<T>(&mut self, value: Arc<T>)
    where
        T: ProviderLifecycle + Send + Sync + 'static,
    {
        let preset: Arc<dyn Any + Send + Sync> = value;
        let cell = Arc::new(OnceLock::new());
        let _ = cell.set(preset.clone());
        self.insert_entry(
            TypeId::of::<T>(),
            ProviderEntry {
                type_name: std::any::type_name::<T>(),
                scope: ProviderScope::Singleton,
                factory: ProviderFactory::Custom(Arc::new(move |_| preset.clone())),
                instance: cell,
                on_module_init: lifecycle_on_module_init::<T>,
                on_module_destroy: lifecycle_on_module_destroy::<T>,
                on_application_bootstrap: lifecycle_on_application_bootstrap::<T>,
                on_before_application_shutdown: lifecycle_on_before_application_shutdown::<T>,
                on_application_shutdown: lifecycle_on_application_shutdown::<T>,
            },
        );
    }

    /// NestJS **`useFactory`** with lifecycle hooks: like [`Self::register_use_factory`], but
    /// `T`'s [`ProviderLifecycle`] hooks are driven by the framework. Hooks run only while `T`
    /// is **singleton-scoped** (matching [`Injectable`] providers: request/transient instances
    /// have no framework-driven lifecycle).
    pub fn register_use_factory_with_lifecycle<T, F>(&mut self, scope: ProviderScope, factory: F)
    where
        T: ProviderLifecycle + Send + Sync + 'static,
        F: Fn(&ProviderRegistry) -> Arc<T> + Send + Sync + 'static,
    {
        let factory: std::sync::Arc<F> = std::sync::Arc::new(factory);
        let factory = factory.clone();
        self.insert_entry(
            TypeId::of::<T>(),
            ProviderEntry {
                type_name: std::any::type_name::<T>(),
                scope,
                factory: ProviderFactory::Custom(Arc::new(move |r| {
                    let v = factory(r);
                    v as Arc<dyn Any + Send + Sync>
                })),
                instance: Arc::new(OnceLock::new()),
                on_module_init: lifecycle_on_module_init::<T>,
                on_module_destroy: lifecycle_on_module_destroy::<T>,
                on_application_bootstrap: lifecycle_on_application_bootstrap::<T>,
                on_before_application_shutdown: lifecycle_on_before_application_shutdown::<T>,
                on_application_shutdown: lifecycle_on_application_shutdown::<T>,
            },
        );
    }

    /// NestJS **`useClass`**: equivalent to [`Self::register`] for a normal injectable type.
    #[inline]
    pub fn register_use_class<T>(&mut self)
    where
        T: Injectable + Send + Sync + 'static,
    {
        self.register::<T>();
    }

    /// Override a provider with a concrete instance (testing utility).
    ///
    /// This is primarily intended for `TestingModule`-style overrides where you want to replace an
    /// injectable with a mock instance.
    ///
    /// The override preserves the provider's declared scope (`T::scope()`): a request- or
    /// transient-scoped provider keeps its per-request / per-resolution semantics, and every
    /// resolution hands out the given instance — an override explicitly targets one concrete
    /// object, so request-scoped overrides share that instance across requests.
    pub fn override_provider<T>(&mut self, instance: Arc<T>)
    where
        T: Injectable + Send + Sync + 'static,
    {
        let preset: Arc<dyn Any + Send + Sync> = instance;
        let instance_cell = Arc::new(OnceLock::new());
        let _ = instance_cell.set(preset.clone());
        let entry = ProviderEntry {
            type_name: std::any::type_name::<T>(),
            scope: T::scope(),
            // A real factory (not a placeholder) so request/transient resolutions
            // return the override instead of panicking; the preset cell serves
            // the singleton path directly.
            factory: ProviderFactory::Custom(Arc::new(move |_| preset.clone())),
            instance: instance_cell,
            on_module_init: hook_on_module_init::<T>,
            on_module_destroy: hook_on_module_destroy::<T>,
            on_application_bootstrap: hook_on_application_bootstrap::<T>,
            on_before_application_shutdown: hook_on_before_application_shutdown::<T>,
            on_application_shutdown: hook_on_application_shutdown::<T>,
        };

        self.insert_entry(TypeId::of::<T>(), entry);
    }

    /// Produce an instance for `entry`, or `None` when it cannot be resolved
    /// here — a `Request`-scoped provider resolved outside any request scope
    /// (e.g. from a bare `tokio::spawn` background task). This is what makes
    /// [`Self::try_get`] honor its "returns `None` instead of panicking"
    /// contract for the scope case as well as the not-registered case.
    fn produce_any(
        &self,
        type_id: TypeId,
        entry: &ProviderEntry,
    ) -> Option<Arc<dyn Any + Send + Sync>> {
        match entry.scope {
            ProviderScope::Singleton => {
                let _guard = ConstructionGuard::push(type_id, entry.type_name);
                Some(
                    entry
                        .instance
                        .get_or_init(|| match &entry.factory {
                            ProviderFactory::InjectableFn(f) => f(self),
                            ProviderFactory::Custom(f) => f(self),
                        })
                        .clone(),
                )
            }
            ProviderScope::Transient => {
                let _guard = ConstructionGuard::push(type_id, entry.type_name);
                Some(match &entry.factory {
                    ProviderFactory::InjectableFn(f) => f(self),
                    ProviderFactory::Custom(f) => f(self),
                })
            }
            ProviderScope::Request => {
                let _guard = ConstructionGuard::push(type_id, entry.type_name);
                // No scope on this task (bare `tokio::spawn`, a standalone
                // runtime, lifecycle-hook runners): resolution is impossible,
                // not a construction failure — surface `None` and let the
                // caller decide (`try_get`) or name the fix (`get`).
                REQUEST_SCOPE_CACHE
                    .try_with(|cell| {
                        if let Some(existing) = cell.borrow().get(&type_id).cloned() {
                            return existing;
                        }
                        let value = match &entry.factory {
                            ProviderFactory::InjectableFn(f) => f(self),
                            ProviderFactory::Custom(f) => f(self),
                        };
                        cell.borrow_mut().insert(type_id, value.clone());
                        value
                    })
                    .ok()
            }
        }
    }

    /// Resolves a provider, panicking when it cannot be resolved. Prefer
    /// [`Self::try_get`] at call sites that can handle absence.
    ///
    /// Panics with a distinct, actionable message when a `Request`-scoped
    /// provider is resolved outside a request scope (e.g. from a background
    /// task spawned with bare `tokio::spawn`) — run such work through
    /// [`spawn_with_request_scope`] instead.
    ///
    /// When called **during** another provider's construction (inside `construct` or a
    /// `useFactory` closure), the edge `constructor -> requested` is recorded so lifecycle
    /// hooks can run in dependency order (see [`Self::run_on_module_init`]).
    pub fn get<T>(&self) -> Arc<T>
    where
        T: Send + Sync + 'static,
    {
        self.try_get::<T>().unwrap_or_else(|| {
            // try_get yields None for two distinct reasons; name the right one.
            if let Some(entry) = self.entries.get(&TypeId::of::<T>()) {
                if matches!(entry.scope, ProviderScope::Request) {
                    panic!(
                        "Request-scoped provider `{}` requested outside a request scope; \
                         enable request scope middleware (`use_request_scope`), spawn \
                         background work with `spawn_with_request_scope`, or use \
                         `try_get` to handle absence gracefully",
                        entry.type_name
                    );
                }
            }
            panic!("Provider `{}` not registered", std::any::type_name::<T>())
        })
    }

    /// Fallible resolution: returns `None` instead of panicking when the
    /// provider cannot be resolved — either it is not registered, or it is
    /// `Request`-scoped and this task has no request scope (a bare
    /// `tokio::spawn` background task, a standalone runtime context). Use
    /// [`spawn_with_request_scope`] to give background work a scope.
    pub fn try_get<T>(&self) -> Option<Arc<T>>
    where
        T: Send + Sync + 'static,
    {
        let type_id = TypeId::of::<T>();
        let entry = self.entries.get(&type_id)?;

        if let Some(parent) =
            CONSTRUCTION_STACK.with(|stack| stack.borrow().last().map(|(_, id)| *id))
        {
            record_provider_dependency(parent, type_id);
        }

        let any = self.produce_any(type_id, entry)?;

        any.downcast::<T>().ok()
    }

    /// All registered provider [`TypeId`] keys (NestJS discovery-style introspection), in registration order.
    pub fn registered_type_ids(&self) -> Vec<TypeId> {
        self.order.clone()
    }

    /// Human-readable type names for registered providers (debug / tooling), in registration order.
    pub fn registered_type_names(&self) -> Vec<&'static str> {
        self.order
            .iter()
            .filter_map(|id| self.entries.get(id).map(|e| e.type_name))
            .collect()
    }

    /// Pair of `(type_name, scope)` for every registered provider, in
    /// registration order. Powers the `nestrs::admin` sidecar's
    /// `GET /__nestrs/providers` endpoint and `nestrs-mcp`'s
    /// `get_app_providers` tool.
    pub fn provider_summaries(&self) -> Vec<ProviderSummary> {
        self.order
            .iter()
            .filter_map(|id| {
                self.entries.get(id).map(|e| ProviderSummary {
                    type_name: e.type_name,
                    scope: e.scope,
                })
            })
            .collect()
    }

    pub fn absorb(&mut self, other: ProviderRegistry) {
        let ProviderRegistry { entries, order } = other;
        let mut leftover = entries;
        for type_id in order {
            if let Some(entry) = leftover.remove(&type_id) {
                self.insert_entry(type_id, entry);
            }
        }
        for (type_id, entry) in leftover {
            self.insert_entry(type_id, entry);
        }
    }

    pub fn absorb_exported(&mut self, mut other: ProviderRegistry, exported: &[TypeId]) {
        if exported.is_empty() {
            return;
        }
        let allow = exported.iter().copied().collect::<HashSet<_>>();
        // Preserve the source registry's registration order (every entry is tracked in `order`).
        for type_id in std::mem::take(&mut other.order) {
            if allow.contains(&type_id) {
                if let Some(entry) = other.entries.remove(&type_id) {
                    self.insert_entry(type_id, entry);
                }
            }
        }
    }

    /// Like [`Self::absorb_exported`], but clones bindings from `other` so the source registry is kept intact
    /// (used for lazy modules and shared provider cells).
    pub fn absorb_exported_from(&mut self, other: &ProviderRegistry, exported: &[TypeId]) {
        if exported.is_empty() {
            return;
        }
        let allow = exported.iter().copied().collect::<HashSet<_>>();
        for type_id in &other.order {
            if allow.contains(type_id) {
                if let Some(entry) = other.entries.get(type_id) {
                    self.insert_entry(*type_id, entry.clone());
                }
            }
        }
    }

    /// Construct all singleton providers (so their lifecycle hooks can run deterministically),
    /// in registration order.
    pub fn eager_init_singletons(&self) {
        for type_id in &self.order {
            let Some(entry) = self.entries.get(type_id) else {
                continue;
            };
            if entry.scope == ProviderScope::Singleton {
                let _guard = ConstructionGuard::push(*type_id, entry.type_name);
                let _ = entry.instance.get_or_init(|| match &entry.factory {
                    ProviderFactory::InjectableFn(f) => f(self),
                    ProviderFactory::Custom(f) => f(self),
                });
            }
        }
    }

    /// Registration-ordered, dependency-sorted [`TypeId`]s of all **singleton** providers.
    ///
    /// Ordering: construction dependencies recorded by [`Self::get`] are respected first
    /// (dependencies initialize before dependents); ties fall back to registration order.
    /// Providers involved in a hook-time cycle are appended in registration order.
    fn ordered_singletons(&self) -> Vec<TypeId> {
        let singletons: HashSet<TypeId> = self
            .order
            .iter()
            .filter(|id| {
                self.entries
                    .get(id)
                    .is_some_and(|e| e.scope == ProviderScope::Singleton)
            })
            .copied()
            .collect();

        // The graph records `constructor -> dependency` (the DEPENDENT first); the
        // sort needs `dep -> dependent` (dependencies initialize first). Only edges
        // between registered singletons participate (edges to transient/request types
        // or types from other registries are ignored).
        let deps = provider_dep_graph().read().expect("provider dep graph");
        let mut incoming: HashMap<TypeId, usize> =
            singletons.iter().map(|id| (*id, 0usize)).collect();
        let mut adjacency: HashMap<TypeId, Vec<TypeId>> = HashMap::new();
        for (from, targets) in deps.iter() {
            if !singletons.contains(from) {
                continue;
            }
            for to in targets {
                if singletons.contains(to) {
                    adjacency.entry(*to).or_default().push(*from);
                    *incoming.entry(*from).or_insert(0) += 1;
                }
            }
        }
        drop(deps);

        // Kahn's algorithm; among ready nodes pick the earliest registration order for stability.
        use std::cmp::Reverse;
        let position: HashMap<&TypeId, usize> = self
            .order
            .iter()
            .enumerate()
            .map(|(i, id)| (id, i))
            .collect();
        let mut ready: std::collections::BinaryHeap<Reverse<usize>> = singletons
            .iter()
            .filter(|id| incoming[id] == 0)
            .map(|id| Reverse(position[id]))
            .collect();

        let mut sorted = Vec::with_capacity(singletons.len());
        let mut visited = HashSet::new();
        while let Some(Reverse(pos)) = ready.pop() {
            let id = self.order[pos];
            visited.insert(id);
            sorted.push(id);
            if let Some(dependents) = adjacency.get(&id) {
                for to in dependents {
                    let e = incoming.get_mut(to).expect("edge target tracked");
                    *e -= 1;
                    if *e == 0 && !visited.contains(to) {
                        ready.push(Reverse(position[to]));
                    }
                }
            }
        }

        // Cycle fallback: append anything not reached, in registration order.
        for id in &self.order {
            if singletons.contains(id) && !visited.contains(id) {
                sorted.push(*id);
            }
        }
        sorted
    }

    pub async fn run_on_module_init(&self) {
        for type_id in self.ordered_singletons() {
            if let Some(entry) = self.entries.get(&type_id) {
                (entry.on_module_init)(self).await;
            }
        }
    }

    /// Destroy hooks run in **reverse** initialization order (dependencies torn down after dependents).
    pub async fn run_on_module_destroy(&self) {
        for type_id in self.ordered_singletons().into_iter().rev() {
            if let Some(entry) = self.entries.get(&type_id) {
                (entry.on_module_destroy)(self).await;
            }
        }
    }

    pub async fn run_on_application_bootstrap(&self) {
        for type_id in self.ordered_singletons() {
            if let Some(entry) = self.entries.get(&type_id) {
                (entry.on_application_bootstrap)(self).await;
            }
        }
    }

    /// NestJS `beforeApplicationShutdown` mirror: fires BEFORE `run_on_application_shutdown` and
    /// `run_on_module_destroy` during graceful shutdown. Reverse initialization order so that
    /// providers holding resources release them after their dependents have shut down.
    pub async fn run_on_before_application_shutdown(&self) {
        for type_id in self.ordered_singletons().into_iter().rev() {
            if let Some(entry) = self.entries.get(&type_id) {
                (entry.on_before_application_shutdown)(self).await;
            }
        }
    }

    /// Shutdown hooks run in **reverse** initialization order (dependencies torn down after dependents).
    pub async fn run_on_application_shutdown(&self) {
        for type_id in self.ordered_singletons().into_iter().rev() {
            if let Some(entry) = self.entries.get(&type_id) {
                (entry.on_application_shutdown)(self).await;
            }
        }
    }
}

impl Clone for ProviderRegistry {
    fn clone(&self) -> Self {
        Self {
            entries: self.entries.clone(),
            order: self.order.clone(),
        }
    }
}

impl Default for ProviderRegistry {
    fn default() -> Self {
        Self::new()
    }
}

type HookFuture<'a> = Pin<Box<dyn Future<Output = ()> + Send + 'a>>;
type HookFn = for<'a> fn(&'a ProviderRegistry) -> HookFuture<'a>;

fn hook_on_module_init<'a, T>(registry: &'a ProviderRegistry) -> HookFuture<'a>
where
    T: Injectable + Send + Sync + 'static,
{
    Box::pin(async move {
        let v = registry.get::<T>();
        v.on_module_init().await;
    })
}

fn hook_on_module_destroy<'a, T>(registry: &'a ProviderRegistry) -> HookFuture<'a>
where
    T: Injectable + Send + Sync + 'static,
{
    Box::pin(async move {
        let v = registry.get::<T>();
        v.on_module_destroy().await;
    })
}

fn hook_on_application_bootstrap<'a, T>(registry: &'a ProviderRegistry) -> HookFuture<'a>
where
    T: Injectable + Send + Sync + 'static,
{
    Box::pin(async move {
        let v = registry.get::<T>();
        v.on_application_bootstrap().await;
    })
}

fn hook_on_before_application_shutdown<'a, T>(registry: &'a ProviderRegistry) -> HookFuture<'a>
where
    T: Injectable + Send + Sync + 'static,
{
    Box::pin(async move {
        let v = registry.get::<T>();
        v.on_before_application_shutdown().await;
    })
}

fn hook_on_application_shutdown<'a, T>(registry: &'a ProviderRegistry) -> HookFuture<'a>
where
    T: Injectable + Send + Sync + 'static,
{
    Box::pin(async move {
        let v = registry.get::<T>();
        v.on_application_shutdown().await;
    })
}

/// [`ProviderLifecycle`] twin of [`hook_on_module_init`]: resolves the provider and drives its
/// hook. Works for both value (preset cell) and factory (lazily built) singletons.
fn lifecycle_on_module_init<'a, T>(registry: &'a ProviderRegistry) -> HookFuture<'a>
where
    T: ProviderLifecycle + Send + Sync + 'static,
{
    Box::pin(async move {
        let v = registry.get::<T>();
        v.on_module_init().await;
    })
}

fn lifecycle_on_module_destroy<'a, T>(registry: &'a ProviderRegistry) -> HookFuture<'a>
where
    T: ProviderLifecycle + Send + Sync + 'static,
{
    Box::pin(async move {
        let v = registry.get::<T>();
        v.on_module_destroy().await;
    })
}

fn lifecycle_on_application_bootstrap<'a, T>(registry: &'a ProviderRegistry) -> HookFuture<'a>
where
    T: ProviderLifecycle + Send + Sync + 'static,
{
    Box::pin(async move {
        let v = registry.get::<T>();
        v.on_application_bootstrap().await;
    })
}

fn lifecycle_on_before_application_shutdown<'a, T>(registry: &'a ProviderRegistry) -> HookFuture<'a>
where
    T: ProviderLifecycle + Send + Sync + 'static,
{
    Box::pin(async move {
        let v = registry.get::<T>();
        v.on_before_application_shutdown().await;
    })
}

fn lifecycle_on_application_shutdown<'a, T>(registry: &'a ProviderRegistry) -> HookFuture<'a>
where
    T: ProviderLifecycle + Send + Sync + 'static,
{
    Box::pin(async move {
        let v = registry.get::<T>();
        v.on_application_shutdown().await;
    })
}

/// Application service or provider type constructed through the DI container.
///
/// **`construct` is synchronous.** Perform async I/O in [`Self::on_module_init`] or after you have
/// an `Arc<Self>` from the registry. Lifecycle hooks run for **singleton** providers when the
/// framework drives [`ProviderRegistry::run_on_module_init`] and related methods (see `NestFactory` / `listen`).
///
/// **Scopes:** override [`Self::scope`] via `#[injectable(scope = "...")]`.
///
/// **Docs:** mdBook **Fundamentals** (`docs/src/fundamentals.md`).
#[async_trait]
pub trait Injectable: Send + Sync + 'static {
    fn construct(registry: &ProviderRegistry) -> Arc<Self>;

    /// Provider scope used when the module registers this type.
    fn scope() -> ProviderScope {
        ProviderScope::Singleton
    }

    async fn on_module_init(&self) {}
    async fn on_module_destroy(&self) {}
    async fn on_application_bootstrap(&self) {}
    /// NestJS `beforeApplicationShutdown`: fires before `on_application_shutdown` /
    /// `on_module_destroy` during graceful shutdown. Use to flush caches, close
    /// long-lived connections, or release resources while dependents are still alive.
    async fn on_before_application_shutdown(&self) {}
    async fn on_application_shutdown(&self) {}
}

/// Lifecycle hooks for **value / factory** providers — the NestJS pattern of a
/// `useValue`/`useFactory` object implementing `OnModuleInit` & friends.
///
/// NestJS calls lifecycle interfaces on any provider object that implements them, no matter how
/// the provider was declared. Rust has no specialization, so
/// [`ProviderRegistry::register_use_value`] / [`ProviderRegistry::register_use_factory`] — which
/// accept any `T: Send + Sync + 'static` — cannot detect hook impls and never run hooks. Implement
/// this trait instead and register through [`ProviderRegistry::register_use_value_with_lifecycle`]
/// or [`ProviderRegistry::register_use_factory_with_lifecycle`]: the framework then drives the
/// hooks for **singleton** providers in the same dependency/registration order as [`Injectable`]
/// hooks (destroy/shutdown hooks reversed).
///
/// If `T` already implements [`Injectable`], its own hooks fire when registered via
/// [`ProviderRegistry::register`] — this trait is only for the custom-provider paths.
///
/// **Docs:** mdBook **Fundamentals** in the repository (`docs/src/fundamentals.md`).
#[async_trait]
pub trait ProviderLifecycle: Send + Sync + 'static {
    async fn on_module_init(&self) {}
    async fn on_module_destroy(&self) {}
    async fn on_application_bootstrap(&self) {}
    /// NestJS `beforeApplicationShutdown`: fires before [`Self::on_application_shutdown`] /
    /// [`Self::on_module_destroy`] during graceful shutdown. Use to flush caches, close
    /// long-lived connections, or release resources while dependents are still alive.
    async fn on_before_application_shutdown(&self) {}
    async fn on_application_shutdown(&self) {}
}

pub trait Controller {
    fn register(router: Router, registry: &ProviderRegistry) -> Router;
}

pub trait Module {
    fn build() -> (ProviderRegistry, Router);

    fn exports() -> Vec<TypeId> {
        Vec::new()
    }
}

/// Testing-oriented module traversal API.
///
/// Unlike [`Module::build`], implementations are expected to register *all* providers and controllers
/// from the import graph into a shared registry/router, so tests can apply overrides before
/// controllers are registered.
pub trait ModuleGraph {
    fn register_providers(registry: &mut ProviderRegistry);
    fn register_controllers(router: Router, registry: &ProviderRegistry) -> Router;
}

/// Runtime-composed module unit for conditional imports (feature flags, env switches, plugins).
///
/// Typical constructors: [`Self::from_module`], [`Self::from_parts`], [`Self::lazy`], or builders
/// such as [`DynamicModuleBuilder`] / [`ConfigurableModuleBuilder`]. Import the resulting value from
/// `#[module(imports = [...])]` when the macro accepts a `DynamicModule` expression.
///
/// **Docs:** mdBook **Fundamentals** (`docs/src/fundamentals.md`).
pub struct DynamicModule {
    /// Provider registry for this dynamic module.
    pub registry: ProviderRegistry,
    pub router: Router,
    /// Types exported to importing modules.
    pub exports: Vec<TypeId>,
}

impl DynamicModule {
    /// Builds a dynamic module from a static [`Module`] type.
    pub fn from_module<M: Module>() -> Self {
        let (registry, router) = M::build();
        let exports = <M as Module>::exports();
        Self {
            registry,
            router,
            exports,
        }
    }

    /// Wrap an already-built [`Router`] subtree as a dynamic module.
    pub fn from_router(router: Router) -> Self {
        Self {
            registry: ProviderRegistry::new(),
            router,
            exports: Vec::new(),
        }
    }

    /// Construct a dynamic module from explicit parts.
    pub fn from_parts(registry: ProviderRegistry, router: Router, exports: Vec<TypeId>) -> Self {
        Self {
            registry,
            router,
            exports,
        }
    }

    /// NestJS-style **lazy module**: `M::build()` runs at most once per process; imports clone bindings
    /// so singleton [`ProviderRegistry`] cells stay shared (see [`ProviderRegistry::absorb_exported_from`]).
    pub fn lazy<M: Module + 'static>() -> Self {
        static CELL: std::sync::OnceLock<DynamicModule> = std::sync::OnceLock::new();
        CELL.get_or_init(DynamicModule::from_module::<M>).clone()
    }
}

impl Clone for DynamicModule {
    fn clone(&self) -> Self {
        Self {
            registry: self.registry.clone(),
            router: self.router.clone(),
            exports: self.exports.clone(),
        }
    }
}

/// Typed runtime options token for configurable modules.
///
/// This is intended to be provided via `ConfigurableModuleBuilder` / `DynamicModuleBuilder`
/// (it panics if requested without an override).
pub struct ModuleOptions<O, M> {
    inner: O,
    _marker: std::marker::PhantomData<fn() -> M>,
}

impl<O, M> ModuleOptions<O, M> {
    pub fn new(inner: O) -> Self {
        Self {
            inner,
            _marker: std::marker::PhantomData,
        }
    }

    pub fn get(&self) -> &O {
        &self.inner
    }

    pub fn into_inner(self) -> O {
        self.inner
    }
}

impl<O, M> std::ops::Deref for ModuleOptions<O, M> {
    type Target = O;

    fn deref(&self) -> &Self::Target {
        &self.inner
    }
}

#[async_trait]
impl<O, M> Injectable for ModuleOptions<O, M>
where
    O: Send + Sync + 'static,
    M: 'static,
{
    fn construct(_registry: &ProviderRegistry) -> Arc<Self> {
        panic!(
            "ModuleOptions requested but no value was provided. Use ConfigurableModuleBuilder / DynamicModuleBuilder to supply module options."
        );
    }
}

type RegistryOverrideFn = Box<dyn FnOnce(&mut ProviderRegistry) + Send>;

/// Builds a [`DynamicModule`] from a static module graph, optionally applying provider overrides
/// before controllers are registered (useful for configurable modules and testing-like setups).
pub struct DynamicModuleBuilder<M>
where
    M: Module + ModuleGraph,
{
    overrides: Vec<RegistryOverrideFn>,
    _marker: std::marker::PhantomData<M>,
}

impl<M> DynamicModuleBuilder<M>
where
    M: Module + ModuleGraph,
{
    pub fn new() -> Self {
        Self {
            overrides: Vec::new(),
            _marker: std::marker::PhantomData,
        }
    }

    pub fn override_provider<T>(mut self, instance: Arc<T>) -> Self
    where
        T: Injectable + Send + Sync + 'static,
    {
        self.overrides
            .push(Box::new(move |r| r.override_provider::<T>(instance)));
        self
    }

    pub fn build(self) -> DynamicModule {
        let mut registry = ProviderRegistry::new();
        M::register_providers(&mut registry);
        for apply in self.overrides {
            apply(&mut registry);
        }
        let router = M::register_controllers(Router::new(), &registry);
        DynamicModule::from_parts(registry, router, M::exports())
    }
}

impl<M> Default for DynamicModuleBuilder<M>
where
    M: Module + ModuleGraph,
{
    fn default() -> Self {
        Self::new()
    }
}

/// Convenience builder for NestJS-like configurable modules (`for_root`, `for_root_async`).
pub struct ConfigurableModuleBuilder<O> {
    _marker: std::marker::PhantomData<O>,
}

impl<O> ConfigurableModuleBuilder<O>
where
    O: Send + Sync + 'static,
{
    pub fn for_root<M>(options: O) -> DynamicModule
    where
        M: Module + ModuleGraph + 'static,
    {
        DynamicModuleBuilder::<M>::new()
            .override_provider::<ModuleOptions<O, M>>(Arc::new(ModuleOptions::new(options)))
            .build()
    }

    pub async fn for_root_async<M, F, Fut>(factory: F) -> DynamicModule
    where
        M: Module + ModuleGraph + 'static,
        F: FnOnce() -> Fut,
        Fut: Future<Output = O>,
    {
        let options = factory().await;
        Self::for_root::<M>(options)
    }
}

thread_local! {
    static MODULE_BUILD_STACK: std::cell::RefCell<Vec<(&'static str, TypeId)>> =
        const { std::cell::RefCell::new(Vec::new()) };
}

/// Internal module build/graph traversal guard (used by `#[module]`-generated code).
#[doc(hidden)]
pub struct __NestrsModuleBuildGuard {
    type_id: TypeId,
}

impl __NestrsModuleBuildGuard {
    pub fn push(type_id: TypeId, type_name: &'static str) -> Self {
        let is_cycle = MODULE_BUILD_STACK.with(|stack| {
            let mut guard = stack.borrow_mut();
            let cycle = guard.iter().any(|(_, id)| *id == type_id);
            if !cycle {
                guard.push((type_name, type_id));
            }
            cycle
        });

        if is_cycle {
            __nestrs_panic_circular_module_dependency(type_name);
        }

        Self { type_id }
    }
}

impl Drop for __NestrsModuleBuildGuard {
    fn drop(&mut self) {
        MODULE_BUILD_STACK.with(|stack| {
            let mut guard = stack.borrow_mut();
            if let Some((_, id)) = guard.last() {
                if *id == self.type_id {
                    guard.pop();
                }
            }
        });
    }
}

#[doc(hidden)]
pub fn __nestrs_module_stack_contains(type_id: TypeId) -> bool {
    MODULE_BUILD_STACK.with(|stack| stack.borrow().iter().any(|(_, id)| *id == type_id))
}

#[doc(hidden)]
pub fn __nestrs_panic_circular_module_dependency(import_type_name: &'static str) -> ! {
    let chain = MODULE_BUILD_STACK.with(|stack| {
        stack
            .borrow()
            .iter()
            .map(|(name, _)| *name)
            .chain(std::iter::once(import_type_name))
            .collect::<Vec<_>>()
            .join(" -> ")
    });

    panic!(
        "Circular module dependency detected: {chain}. If intentional, mark the NestJS-style back-edge import with `forward_ref::<T>()` (or `forwardRef` alias in the `#[module]` macro). See the nestrs mdBook chapter **Fundamentals** (`docs/src/fundamentals.md`).",
    );
}

tokio::task_local! {
    static REQUEST_SCOPE_CACHE: std::cell::RefCell<HashMap<TypeId, Arc<dyn Any + Send + Sync>>>;
}

/// Runs `future` inside the request-scoped provider cache (used by request
/// middleware and the transport scope installers).
///
/// **Nesting layers; it never replaces.** When a request scope is already
/// active on this task, `future` joins it: values inserted by outer
/// middleware (e.g. a `RequestScoped` provider already constructed by a
/// guard) stay visible, and anything inserted here lands in the same scope.
/// Only when no scope is active does this open a fresh one for `future`.
///
/// Without the join, every nested installer — `install_transactional_middleware`
/// under `request_scope_middleware`, or the GraphQL/WS/MCP scope wrappers on
/// an in-request transport — would fork the cache: request-scoped providers
/// resolved by outer middleware would be invisible (and re-constructed a
/// second time) inside, breaking the one-instance-per-request DI contract.
pub async fn with_request_scope<Fut, T>(future: Fut) -> T
where
    Fut: std::future::Future<Output = T>,
{
    // `try_with` succeeds only while a `scope(...)` future is being polled
    // on this task — i.e. precisely "a request scope is active".
    if REQUEST_SCOPE_CACHE.try_with(|_| ()).is_ok() {
        return future.await;
    }
    REQUEST_SCOPE_CACHE
        .scope(std::cell::RefCell::new(HashMap::new()), future)
        .await
}

/// Spawns `future` on the ambient tokio runtime with the request scope
/// carried over — the supported way to run background work that resolves
/// `Request`-scoped providers.
///
/// **Snapshot semantics.** Task-locals do not cross `tokio::spawn`, so the
/// child task cannot share the parent's cache. Instead, the request-scoped
/// instances already constructed at spawn time are snapshotted (the `Arc`s
/// are cloned; the maps are independent) and installed as the child's
/// scope:
///
/// - The child resolves the **same instances** the request had — including
///   any in-flight `TransactionSlot` (nestrs) — so spawned work is a
///   continuation of the request, not a new one.
/// - Values constructed or inserted **after** the spawn are private to
///   whichever side constructed them: the parent does not see the child's
///   inserts, and the child does not see providers the parent constructs
///   later.
/// - Spawned **outside** any request scope (a scheduler, a startup job),
///   the child simply gets a fresh empty scope — request-scoped providers
///   construct per spawned task and are isolated from every other task.
///
/// **Not carried:** the ability / principal slots. Row-level authz stays
/// deny-closed in the spawned task unless the caller explicitly wraps the
/// future with the ability helpers — background work inheriting the
/// request's authority should be an explicit decision, not a side effect
/// of spawning.
pub fn spawn_with_request_scope<F>(future: F) -> tokio::task::JoinHandle<F::Output>
where
    F: std::future::Future + Send + 'static,
    F::Output: Send + 'static,
{
    let snapshot = REQUEST_SCOPE_CACHE
        .try_with(|cell| cell.borrow().clone())
        .ok();
    tokio::spawn(async move {
        match snapshot {
            Some(map) => {
                REQUEST_SCOPE_CACHE
                    .scope(std::cell::RefCell::new(map), future)
                    .await
            }
            None => with_request_scope(future).await,
        }
    })
}

/// Look up a value previously inserted into the request scope via
/// `request_scope_insert` or by the `RequestScoped<T>` provider. Returns
/// `None` outside of a request scope.
pub fn request_scope_get(type_id: TypeId) -> Option<Arc<dyn Any + Send + Sync>> {
    REQUEST_SCOPE_CACHE
        .try_with(|c| c.borrow().get(&type_id).cloned())
        .ok()
        .flatten()
}

/// Insert a value into the request scope. Must be called from inside a
/// `with_request_scope` future; otherwise it's a no-op.
pub fn request_scope_insert(type_id: TypeId, value: Arc<dyn Any + Send + Sync>) {
    let _ = REQUEST_SCOPE_CACHE.try_with(|c| {
        c.borrow_mut().insert(type_id, value);
    });
}

// ---------------------------------------------------------------------------
// Per-task ability slot (type-erased)
//
// `Ability` itself is defined in `nestrs::policies`. To let transport crates
// (GraphQL, MCP, workers) install / read the same per-task ability without
// forcing a `nestrs` dependency on them, the slot lives here as a type-erased
// `Arc<dyn Any + Send + Sync>`. `nestrs::policies::current_ability()` does
// the downcast; transport crates that need a typed read do the same via
// their own thin accessor in `nestrs`.
// ---------------------------------------------------------------------------

tokio::task_local! {
    static ABILITY_SLOT: std::cell::RefCell<Option<Arc<dyn Any + Send + Sync>>>;
}

/// Run `future` with the given type-erased ability installed in the per-task
/// ability slot. The caller is responsible for passing an `Arc<Ability>` (or
/// any other type they want to read back via `current_ability_erased`).
///
/// `nestrs::policies::with_ability` is the typed convenience wrapper that
/// takes an `Arc<Ability>` directly.
pub async fn with_ability_erased<F, T>(ability: Arc<dyn Any + Send + Sync>, future: F) -> T
where
    F: std::future::Future<Output = T>,
{
    ABILITY_SLOT
        .scope(std::cell::RefCell::new(Some(ability)), future)
        .await
}

/// Read the type-erased ability for the current task, if one was installed
/// via `with_ability_erased` (or via `nestrs::policies::with_ability`, which
/// writes to the same slot). Returns `None` outside of a scope.
pub fn current_ability_erased() -> Option<Arc<dyn Any + Send + Sync>> {
    ABILITY_SLOT.try_with(|c| c.borrow().clone()).ok().flatten()
}

// ---------------------------------------------------------------------------
// Per-task principal slot (type-erased)
//
// Row-level authorization predicates receive the current `Principal`. Like
// the ability slot above, the slot lives here type-erased so transport
// crates (HTTP authn middleware, WS, GraphQL, MCP) can install / read the
// per-task principal without a `nestrs` dependency cycle. The value is a
// `nestrs::policies::Principal`; `nestrs::policies::current_principal()`
// does the downcast.
// ---------------------------------------------------------------------------

tokio::task_local! {
    static PRINCIPAL_SLOT: std::cell::RefCell<Option<Arc<dyn Any + Send + Sync>>>;
}

/// Run `future` with the given type-erased principal installed in the
/// per-task principal slot. The caller is responsible for passing an
/// `Arc<policies::Principal>` (or any other type they want to read back via
/// `current_principal_erased`).
///
/// `nestrs::policies::with_principal` is the typed convenience wrapper that
/// takes an `Arc<Principal>` directly.
pub async fn with_principal_erased<F, T>(principal: Arc<dyn Any + Send + Sync>, future: F) -> T
where
    F: std::future::Future<Output = T>,
{
    PRINCIPAL_SLOT
        .scope(std::cell::RefCell::new(Some(principal)), future)
        .await
}

/// Read the type-erased principal for the current task, if one was installed
/// via `with_principal_erased` (or via `nestrs::policies::with_principal`,
/// which writes to the same slot). Returns `None` outside of a scope.
pub fn current_principal_erased() -> Option<Arc<dyn Any + Send + Sync>> {
    PRINCIPAL_SLOT
        .try_with(|c| c.borrow().clone())
        .ok()
        .flatten()
}

thread_local! {
    static CONSTRUCTION_STACK: std::cell::RefCell<Vec<(&'static str, TypeId)>> =
        const { std::cell::RefCell::new(Vec::new()) };
}

struct ConstructionGuard {
    type_id: TypeId,
}

impl ConstructionGuard {
    fn push(type_id: TypeId, type_name: &'static str) -> Self {
        CONSTRUCTION_STACK.with(|stack| {
            let mut guard = stack.borrow_mut();
            if guard.iter().any(|(_, id)| *id == type_id) {
                let chain = guard
                    .iter()
                    .map(|(name, _)| *name)
                    .chain(std::iter::once(type_name))
                    .collect::<Vec<_>>()
                    .join(" -> ");
                panic!(
                    "Circular provider dependency detected: {chain}. Break the cycle with lazy construction (`register_use_factory`), split types, defer work to `on_module_init`, or a `forward_ref`-style module import for module graphs. See the nestrs mdBook chapter **Fundamentals** (`docs/src/fundamentals.md`)."
                );
            }
            guard.push((type_name, type_id));
        });
        Self { type_id }
    }
}

impl Drop for ConstructionGuard {
    fn drop(&mut self) {
        CONSTRUCTION_STACK.with(|stack| {
            let mut guard = stack.borrow_mut();
            if let Some((_, id)) = guard.last() {
                if *id == self.type_id {
                    guard.pop();
                }
            }
        });
    }
}

/// Global construction-dependency graph (`constructor -> dependency`) recorded by
/// [`ProviderRegistry::get`] while a provider factory is running. Used to order lifecycle hooks.
fn provider_dep_graph() -> &'static RwLock<HashMap<TypeId, Vec<TypeId>>> {
    static DEPS: OnceLock<RwLock<HashMap<TypeId, Vec<TypeId>>>> = OnceLock::new();
    DEPS.get_or_init(|| RwLock::new(HashMap::new()))
}

fn record_provider_dependency(from: TypeId, to: TypeId) {
    // Hot path: the edge is almost always already recorded — the first
    // resolution of a constructor -> dependency pair records it, and every
    // later resolution (each request-scoped/transient construction on a
    // warm process) only needs this read-locked check, instead of
    // contending on the global write lock for every single resolution.
    {
        let deps = provider_dep_graph().read().expect("provider dep graph");
        if let Some(targets) = deps.get(&from) {
            if targets.contains(&to) {
                return;
            }
        }
    }
    let mut deps = provider_dep_graph().write().expect("provider dep graph");
    let targets = deps.entry(from).or_default();
    if !targets.contains(&to) {
        targets.push(to);
    }
}

/// Clears the recorded provider dependency graph.
///
/// **Available only with the `test-hooks` feature.** For tests; see `STABILITY.md` in the repo root.
#[cfg(feature = "test-hooks")]
pub fn clear_provider_dependencies_for_tests() {
    provider_dep_graph()
        .write()
        .expect("provider dep graph")
        .clear();
}

type ModuleBuildFn = Box<dyn FnOnce() -> (ProviderRegistry, Router) + Send>;

static MODULE_BUILD_CACHE: OnceLock<RwLock<HashMap<TypeId, Arc<OnceLock<DynamicModule>>>>> =
    OnceLock::new();

fn module_build_cache() -> &'static RwLock<HashMap<TypeId, Arc<OnceLock<DynamicModule>>>> {
    MODULE_BUILD_CACHE.get_or_init(|| RwLock::new(HashMap::new()))
}

/// Memoizes a [`Module::build`] result **process-wide**, keyed by the module type.
///
/// This makes NestJS-style module-instance sharing the default: when two modules import the same
/// shared module, both importers receive bindings cloned from **one** built instance (shared
/// singleton cells, one route subtree), instead of each importer rebuilding its own copy.
///
/// Route conflicts from duplicate registration and split-singleton bugs are thereby avoided;
/// `forward_ref` back-edges still skip via the existing module build-stack check before this is reached.
///
/// # Arguments
///
/// `build` is the uncached module body (generated by `#[module]`). It runs at most once per
/// process per module type.
#[doc(hidden)]
pub fn __nestrs_memoize_module_build<M: Module + 'static>(
    build: ModuleBuildFn,
) -> (ProviderRegistry, Router) {
    let key = TypeId::of::<M>();
    let entry = Arc::clone(
        module_build_cache()
            .write()
            .expect("module build cache")
            .entry(key)
            .or_insert_with(|| Arc::new(OnceLock::new())),
    );
    // At most one thread builds `M`; concurrent/reentrant callers block on the cell. Reentrant
    // builds (a true cycle) are rejected earlier by the module build-stack circular check inside
    // `build`, matching pre-memoization semantics.
    let dm = entry.get_or_init(|| {
        let (registry, router) = build();
        DynamicModule::from_parts(registry, router, <M as Module>::exports())
    });
    (dm.registry.clone(), dm.router.clone())
}

/// Clears the process-wide module build cache.
///
/// **Available only with the `test-hooks` feature.** For tests that rebuild the same module type
/// expecting fresh instances; see `STABILITY.md` in the repo root.
#[cfg(feature = "test-hooks")]
pub fn clear_module_cache_for_tests() {
    module_build_cache()
        .write()
        .expect("module build cache")
        .clear();
}

#[cfg(test)]
mod request_scope_tests {
    // The request scope must NEST, never fork: `with_request_scope` called
    // inside an active scope joins it. Pre-fix it installed a fresh map,
    // so the transactional middleware (and the GraphQL/WS/MCP scope
    // wrappers on in-request transports) hid every value the outer
    // middleware had stashed — and, worse, `ProviderScope::Request`
    // resolution would construct a SECOND instance of a provider the
    // outer scope already built.

    use super::*;
    use std::sync::atomic::{AtomicUsize, Ordering};

    struct Marker;
    struct OtherMarker;

    #[tokio::test]
    async fn nested_with_request_scope_joins_the_outer_scope() {
        with_request_scope(async {
            request_scope_insert(
                TypeId::of::<Marker>(),
                Arc::new(Marker) as Arc<dyn Any + Send + Sync>,
            );

            // A nested scope opener (transactional middleware, transport
            // wrapper) must see the outer value — pre-fix this was None.
            with_request_scope(async {
                assert!(
                    request_scope_get(TypeId::of::<Marker>()).is_some(),
                    "nested with_request_scope must not hide outer values"
                );
                // ...and its inserts land in the SAME scope...
                request_scope_insert(
                    TypeId::of::<OtherMarker>(),
                    Arc::new(OtherMarker) as Arc<dyn Any + Send + Sync>,
                );
            })
            .await;

            // ...which the outer block still sees once the nested one ends.
            assert!(
                request_scope_get(TypeId::of::<OtherMarker>()).is_some(),
                "nested inserts must land in the active (outer) scope"
            );
        })
        .await;
    }

    #[tokio::test]
    async fn with_request_scope_opens_a_fresh_scope_when_none_is_active() {
        // Sanity both ways: outside any scope, get is None (insert is a
        // documented no-op)...
        assert!(request_scope_get(TypeId::of::<Marker>()).is_none());
        // ...and a top-level with_request_scope establishes one.
        with_request_scope(async {
            request_scope_insert(
                TypeId::of::<Marker>(),
                Arc::new(Marker) as Arc<dyn Any + Send + Sync>,
            );
            assert!(request_scope_get(TypeId::of::<Marker>()).is_some());
        })
        .await;
    }

    static REQUEST_PROVIDER_CONSTRUCTIONS: AtomicUsize = AtomicUsize::new(0);

    struct CountedRequestService;

    impl Injectable for CountedRequestService {
        fn construct(_registry: &ProviderRegistry) -> Arc<Self> {
            REQUEST_PROVIDER_CONSTRUCTIONS.fetch_add(1, Ordering::SeqCst);
            Arc::new(Self)
        }

        fn scope() -> ProviderScope {
            ProviderScope::Request
        }
    }

    // Per-test counted types: the tests below run concurrently on the
    // multi-thread test harness, and a shared counter would let one test's
    // `store(0)` reset another's in-flight construction count.
    static SNAPSHOT_CONSTRUCTIONS: AtomicUsize = AtomicUsize::new(0);

    struct SnapshottedService;

    impl Injectable for SnapshottedService {
        fn construct(_registry: &ProviderRegistry) -> Arc<Self> {
            SNAPSHOT_CONSTRUCTIONS.fetch_add(1, Ordering::SeqCst);
            Arc::new(Self)
        }

        fn scope() -> ProviderScope {
            ProviderScope::Request
        }
    }

    static OFF_SCOPE_CONSTRUCTIONS: AtomicUsize = AtomicUsize::new(0);

    struct OffScopeService;

    impl Injectable for OffScopeService {
        fn construct(_registry: &ProviderRegistry) -> Arc<Self> {
            OFF_SCOPE_CONSTRUCTIONS.fetch_add(1, Ordering::SeqCst);
            Arc::new(Self)
        }

        fn scope() -> ProviderScope {
            ProviderScope::Request
        }
    }

    #[tokio::test]
    async fn nested_scope_does_not_rebuild_request_providers() {
        // The DI-contract regression: a Request-scoped provider resolved
        // before a nested scope opener (guard → transactional middleware)
        // must be the SAME instance when re-resolved inside it — one
        // construction per request, not one per nested wrapper.
        REQUEST_PROVIDER_CONSTRUCTIONS.store(0, Ordering::SeqCst);
        let mut registry = ProviderRegistry::new();
        registry.register::<CountedRequestService>();

        with_request_scope(async {
            let outer: Arc<CountedRequestService> = registry.get();

            let inner: Arc<CountedRequestService> =
                with_request_scope(async { registry.get::<CountedRequestService>() }).await;

            assert!(
                Arc::ptr_eq(&outer, &inner),
                "nested with_request_scope must reuse the request-scoped instance"
            );
            assert_eq!(
                REQUEST_PROVIDER_CONSTRUCTIONS.load(Ordering::SeqCst),
                1,
                "one construction per request, not one per nested scope"
            );
        })
        .await;
    }

    // --- request scope across spawn (audit #47, v2-review item 2) -----------
    //
    // A handler that `tokio::spawn`s background work ran that child with NO
    // request scope; resolving a Request-scoped provider there panicked —
    // and panicked through `try_get` too, violating its documented
    // "returns None instead of panicking" contract.

    #[tokio::test]
    async fn try_get_returns_none_off_scope_instead_of_panicking() {
        let mut registry = ProviderRegistry::new();
        registry.register::<CountedRequestService>();

        // Off-scope: registered, but unresolvable here. `try_get` must honor
        // its graceful contract (pre-fix: panic).
        assert!(
            registry.try_get::<CountedRequestService>().is_none(),
            "off-scope Request-scoped resolution is absence, not a panic"
        );
    }

    #[test]
    #[should_panic(expected = "spawn_with_request_scope")]
    fn get_off_scope_panics_with_the_fix_in_the_message() {
        let mut registry = ProviderRegistry::new();
        registry.register::<CountedRequestService>();

        let _ = registry.get::<CountedRequestService>();
    }

    #[tokio::test]
    async fn spawned_task_sees_the_request_snapshot() {
        SNAPSHOT_CONSTRUCTIONS.store(0, Ordering::SeqCst);
        let mut registry = ProviderRegistry::new();
        registry.register::<SnapshottedService>();

        with_request_scope(async {
            let outer: Arc<SnapshottedService> = registry.get();

            let registry = registry.clone();
            let handle = spawn_with_request_scope(async move {
                let child: Arc<SnapshottedService> = registry.get();
                Arc::ptr_eq(&outer, &child)
            });

            assert!(
                handle.await.unwrap(),
                "spawned task must resolve the instance the request had at spawn time"
            );
            assert_eq!(
                SNAPSHOT_CONSTRUCTIONS.load(Ordering::SeqCst),
                1,
                "snapshot must carry the instance, not re-construct it"
            );
        })
        .await;
    }

    #[tokio::test]
    async fn spawned_task_writes_stay_in_the_child() {
        with_request_scope(async {
            let handle = spawn_with_request_scope(async {
                request_scope_insert(
                    TypeId::of::<OtherMarker>(),
                    Arc::new(OtherMarker) as Arc<dyn Any + Send + Sync>,
                );
                assert!(
                    request_scope_get(TypeId::of::<OtherMarker>()).is_some(),
                    "the child sees its own inserts"
                );
            });
            handle.await.unwrap();

            assert!(
                request_scope_get(TypeId::of::<OtherMarker>()).is_none(),
                "child-scope writes must not leak into the parent request scope"
            );
        })
        .await;
    }

    #[tokio::test]
    async fn spawning_off_scope_gives_each_child_a_fresh_scope() {
        OFF_SCOPE_CONSTRUCTIONS.store(0, Ordering::SeqCst);
        let mut registry = ProviderRegistry::new();
        registry.register::<OffScopeService>();

        // Off-scope spawn (a scheduler, a startup job): each spawned task is
        // its own unit of work — fresh scope, isolated instances.
        let a = {
            let registry = registry.clone();
            spawn_with_request_scope(async move { registry.get::<OffScopeService>() })
        };
        let b = {
            let registry = registry.clone();
            spawn_with_request_scope(async move { registry.get::<OffScopeService>() })
        };

        let a = a.await.unwrap();
        let b = b.await.unwrap();
        assert!(
            !Arc::ptr_eq(&a, &b),
            "off-scope spawns must not share request-scoped instances"
        );
        assert_eq!(
            OFF_SCOPE_CONSTRUCTIONS.load(Ordering::SeqCst),
            2,
            "one construction per spawned scope"
        );
    }
}

#[cfg(test)]
mod provider_lifecycle_tests {
    // useValue/useFactory providers registered through the *_with_lifecycle
    // variants get their ProviderLifecycle hooks driven exactly like
    // Injectable hooks: registration order for init/bootstrap, REVERSED for
    // shutdown/destroy. The plain register_use_value / register_use_factory
    // keep their documented hook-less behavior (opt-in, no bound changes).

    use super::*;
    use std::sync::Mutex;

    type Log = Arc<Mutex<Vec<String>>>;

    fn assert_log(log: &Log, expected: &[&str]) {
        let got = log.lock().unwrap();
        let expected: Vec<String> = expected.iter().map(|s| s.to_string()).collect();
        assert_eq!(*got, expected, "hook firing order");
    }

    /// `Tagged<'A'>` and `Tagged<'B'>` are distinct provider types (one per
    /// TypeId) sharing a single hook impl — the const char doubles as the
    /// event prefix in the log.
    struct Tagged<const TAG: char> {
        log: Log,
    }

    impl<const TAG: char> Tagged<TAG> {
        fn record(&self, event: &str) {
            self.log.lock().unwrap().push(format!("{TAG}:{event}"));
        }
    }

    #[async_trait]
    impl<const TAG: char> ProviderLifecycle for Tagged<TAG> {
        async fn on_module_init(&self) {
            self.record("init");
        }
        async fn on_module_destroy(&self) {
            self.record("destroy");
        }
        async fn on_application_bootstrap(&self) {
            self.record("bootstrap");
        }
        async fn on_before_application_shutdown(&self) {
            self.record("before_shutdown");
        }
        async fn on_application_shutdown(&self) {
            self.record("shutdown");
        }
    }

    #[tokio::test]
    async fn use_value_lifecycle_hooks_fire_in_framework_order() {
        let log: Log = Arc::default();
        let mut registry = ProviderRegistry::new();
        registry.register_use_value_with_lifecycle(Arc::new(Tagged::<'V'> { log: log.clone() }));

        registry.run_on_module_init().await;
        registry.run_on_application_bootstrap().await;
        registry.run_on_before_application_shutdown().await;
        registry.run_on_application_shutdown().await;
        registry.run_on_module_destroy().await;

        assert_log(
            &log,
            &[
                "V:init",
                "V:bootstrap",
                "V:before_shutdown",
                "V:shutdown",
                "V:destroy",
            ],
        );
    }

    #[tokio::test]
    async fn lifecycle_hooks_register_order_init_reverse_destroy() {
        let log: Log = Arc::default();
        let mut registry = ProviderRegistry::new();
        registry.register_use_value_with_lifecycle(Arc::new(Tagged::<'A'> { log: log.clone() }));
        registry.register_use_value_with_lifecycle(Arc::new(Tagged::<'B'> { log: log.clone() }));

        registry.run_on_module_init().await;
        registry.run_on_module_destroy().await;

        // Destroy hooks run reversed — dependents tear down before their
        // dependencies, matching Injectable providers.
        assert_log(&log, &["A:init", "B:init", "B:destroy", "A:destroy"]);
    }

    #[tokio::test]
    async fn use_factory_lifecycle_hooks_fire_on_the_lazily_built_singleton() {
        let log: Log = Arc::default();
        let mut registry = ProviderRegistry::new();
        registry.register_use_factory_with_lifecycle(ProviderScope::Singleton, {
            let log = log.clone();
            move |_r| {
                log.lock().unwrap().push("F:construct".to_string());
                Arc::new(Tagged::<'F'> { log: log.clone() })
            }
        });

        // Nothing has resolved F yet — the init hook is the first `get` and
        // constructs the singleton itself (the same lazy contract as
        // Injectable providers whose first resolution happens in a hook).
        registry.run_on_module_init().await;
        assert_log(&log, &["F:construct", "F:init"]);

        // Later resolutions reuse the SAME singleton the hook saw.
        let _v: Arc<Tagged<'F'>> = registry.get();
        assert_log(&log, &["F:construct", "F:init"]);
    }

    #[tokio::test]
    async fn plain_use_value_and_use_factory_stay_hook_less() {
        // Opt-in contract: types registered through the PLAIN variants never
        // run lifecycle hooks, even when they implement ProviderLifecycle
        // (back-compat — the fix adds the *_with_lifecycle variants rather
        // than changing the plain methods' bounds).
        let log: Log = Arc::default();
        let mut registry = ProviderRegistry::new();
        registry.register_use_value(Arc::new(Tagged::<'V'> { log: log.clone() }));
        registry.register_use_factory(ProviderScope::Singleton, {
            let log = log.clone();
            move |_r| Arc::new(Tagged::<'G'> { log: log.clone() })
        });

        registry.run_on_module_init().await;
        registry.run_on_application_bootstrap().await;
        registry.run_on_before_application_shutdown().await;
        registry.run_on_application_shutdown().await;
        registry.run_on_module_destroy().await;

        assert_log(&log, &[]);
    }
}

#[cfg(test)]
mod provider_dep_graph_tests {
    // Dependency recording sits on the hot path of DI resolution: every
    // `registry.get` inside a provider construction records the
    // constructor -> dependency edge into the process-global graph. The
    // write lock is only needed the FIRST time an edge is seen; repeat
    // resolutions (each request-scoped/transient construction on a warm
    // process) must take the read-locked fast path instead of contending
    // on the global write lock.

    use super::*;

    struct FromA;
    struct ToB;

    #[test]
    fn record_provider_dependency_is_idempotent_on_repeated_edges() {
        let from = TypeId::of::<FromA>();
        let to = TypeId::of::<ToB>();
        record_provider_dependency(from, to);
        // Repeated resolutions of the same edge (the read-locked fast
        // path): must not duplicate the target.
        record_provider_dependency(from, to);
        record_provider_dependency(from, to);
        let deps = provider_dep_graph().read().expect("provider dep graph");
        let targets = deps.get(&from).expect("edge recorded");
        assert_eq!(targets.len(), 1, "repeated edges must not duplicate");
        assert_eq!(targets[0], to);
    }

    #[test]
    fn record_provider_dependency_dedupes_racing_first_recordings() {
        // Threads that miss the fast path simultaneously (edge not yet
        // committed) must not push the edge twice — the write-locked arm
        // re-checks before pushing.
        let from = TypeId::of::<FromA>();
        let to = TypeId::of::<ToB>();
        std::thread::scope(|s| {
            for _ in 0..16 {
                s.spawn(|| record_provider_dependency(from, to));
            }
        });
        let deps = provider_dep_graph().read().expect("provider dep graph");
        let targets = deps.get(&from).expect("edge recorded");
        assert_eq!(
            targets.len(),
            1,
            "racing recorders must not duplicate an edge"
        );
    }
}

#[cfg(test)]
mod override_provider_tests {
    // override_provider replaces WHAT a provider resolves to — it must not
    // silently change the provider's LIFETIME. Pre-fix the override entry
    // hardcoded `ProviderScope::Singleton` with an `unreachable!()`
    // placeholder factory: overriding a request- or transient-scoped
    // provider made it process-global (per-request state bleeding across
    // requests, `provider_summaries` reporting the wrong scope), and a
    // scope-preserving fix could never have resolved anything.

    use super::*;

    struct SingletonSvc;

    impl Injectable for SingletonSvc {
        fn construct(_registry: &ProviderRegistry) -> Arc<Self> {
            unreachable!("overridden before construction")
        }
    }

    struct RequestSvc;

    impl Injectable for RequestSvc {
        fn construct(_registry: &ProviderRegistry) -> Arc<Self> {
            unreachable!("overridden before construction")
        }

        fn scope() -> ProviderScope {
            ProviderScope::Request
        }
    }

    struct TransientSvc;

    impl Injectable for TransientSvc {
        fn construct(_registry: &ProviderRegistry) -> Arc<Self> {
            unreachable!("overridden before construction")
        }

        fn scope() -> ProviderScope {
            ProviderScope::Transient
        }
    }

    fn declared_scope<T: 'static>(registry: &ProviderRegistry) -> ProviderScope {
        let name = std::any::type_name::<T>();
        registry
            .provider_summaries()
            .into_iter()
            .find(|s| s.type_name == name)
            .map(|s| s.scope)
            .unwrap_or_else(|| panic!("{name} not registered"))
    }

    #[test]
    fn singleton_override_returns_the_instance_and_keeps_singleton_scope() {
        let mut registry = ProviderRegistry::new();
        registry.register::<SingletonSvc>();
        let mock = Arc::new(SingletonSvc);
        registry.override_provider::<SingletonSvc>(mock.clone());

        let resolved = registry.get::<SingletonSvc>();
        assert!(Arc::ptr_eq(&resolved, &mock), "override instance served");
        assert_eq!(
            declared_scope::<SingletonSvc>(&registry),
            ProviderScope::Singleton,
            "singleton overrides stay singleton"
        );
    }

    #[tokio::test]
    async fn request_override_keeps_request_scope_and_resolves_to_the_instance() {
        let mut registry = ProviderRegistry::new();
        registry.register::<RequestSvc>();
        let mock = Arc::new(RequestSvc);
        registry.override_provider::<RequestSvc>(mock.clone());

        // Per-request resolution: two gets inside one request return the
        // override, cached in that request's scope.
        let first = with_request_scope(async {
            let a = registry.get::<RequestSvc>();
            let b = registry.get::<RequestSvc>();
            assert!(Arc::ptr_eq(&a, &b), "one resolution per request");
            a
        })
        .await;
        assert!(Arc::ptr_eq(&first, &mock), "override served inside request");

        // A separate request resolves the SAME override — an override
        // explicitly targets one concrete instance. (Run sequentially at the
        // top level: a nested `with_request_scope` would JOIN the first
        // scope, not open a fresh one.)
        let second = with_request_scope(async { registry.get::<RequestSvc>() }).await;
        assert!(
            Arc::ptr_eq(&second, &mock),
            "override instance shared across requests"
        );

        assert_eq!(
            declared_scope::<RequestSvc>(&registry),
            ProviderScope::Request,
            "request overrides keep request scope — no silent Singleton coercion"
        );
    }

    #[test]
    fn transient_override_keeps_transient_scope_and_resolves_each_time() {
        let mut registry = ProviderRegistry::new();
        registry.register::<TransientSvc>();
        let mock = Arc::new(TransientSvc);
        registry.override_provider::<TransientSvc>(mock.clone());

        // Transient = a resolution per injection site; the override hands
        // out the one concrete instance each time (pre-fix this path
        // panicked via the placeholder factory).
        let a = registry.get::<TransientSvc>();
        let b = registry.get::<TransientSvc>();
        assert!(Arc::ptr_eq(&a, &mock), "first transient resolution served");
        assert!(Arc::ptr_eq(&b, &mock), "second transient resolution served");
        assert_eq!(
            declared_scope::<TransientSvc>(&registry),
            ProviderScope::Transient,
            "transient overrides keep transient scope"
        );
    }
}