feat(core): introduce entry providers concept

nestjs · Feb 10, 2023 · a2b3e1b · a2b3e1b
1 parent 7a90b7c
commit a2b3e1b
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 12 deletions.
diff --git a/packages/common/constants.ts b/packages/common/constants.ts
@@ -48,3 +48,4 @@ export const VERSION_METADATA = '__version__';
 export const INJECTABLE_WATERMARK = '__injectable__';
 export const CONTROLLER_WATERMARK = '__controller__';
 export const CATCH_WATERMARK = '__catch__';
+export const ENTRY_PROVIDER_WATERMARK = '__entryProvider__';
diff --git a/packages/core/injector/module.ts b/packages/core/injector/module.ts
@@ -1,4 +1,7 @@
-import { EnhancerSubtype } from '@nestjs/common/constants';
+import {
+  EnhancerSubtype,
+  ENTRY_PROVIDER_WATERMARK,
+} from '@nestjs/common/constants';
 import {
   ClassProvider,
   Controller,
@@ -61,7 +64,9 @@ export class Module {
     InstanceToken,
     InstanceWrapper<Controller>
   >();
+  private readonly _entryProviderKeys = new Set<InstanceToken>();
   private readonly _exports = new Set<InstanceToken>();
+
   private _distance = 0;
   private _initOnPreview = false;
   private _isGlobal = false;
@@ -148,6 +153,12 @@ export class Module {
     return this._controllers;
   }
 
+  get entryProviders(): Array<InstanceWrapper<Injectable>> {
+    return Array.from(this._entryProviderKeys).map(token =>
+      this.providers.get(token),
+    );
+  }
+
   get exports(): Set<InstanceToken> {
     return this._exports;
   }
@@ -258,8 +269,12 @@ export class Module {
   ): Provider | InjectionToken;
   public addProvider(provider: Provider, enhancerSubtype?: EnhancerSubtype) {
     if (this.isCustomProvider(provider)) {
+      if (this.isEntryProvider(provider.provide)) {
+        this._entryProviderKeys.add(provider.provide);
+      }
       return this.addCustomProvider(provider, this._providers, enhancerSubtype);
     }
+
     this._providers.set(
       provider,
       new InstanceWrapper({
@@ -273,6 +288,11 @@ export class Module {
         host: this,
       }),
     );
+
+    if (this.isEntryProvider(provider)) {
+      this._entryProviderKeys.add(provider);
+    }
+
     return provider as Type<Injectable>;
   }
 
@@ -349,10 +369,12 @@ export class Module {
     if (isUndefined(durable)) {
       durable = isDurable(useClass);
     }
+
+    const token = provider.provide;
     collection.set(
-      provider.provide,
+      token,
       new InstanceWrapper({
-        token: provider.provide,
+        token,
         name: useClass?.name || useClass,
         metatype: useClass,
         instance: null,
@@ -632,6 +654,12 @@ export class Module {
     };
   }
 
+  private isEntryProvider(metatype: InjectionToken): boolean {
+    return typeof metatype === 'function'
+      ? !!Reflect.getMetadata(ENTRY_PROVIDER_WATERMARK, metatype)
+      : false;
+  }
+
   private generateUuid(): string {
     const prefix = 'M_';
     const key = this.name?.toString() ?? this.token?.toString();

diff --git a/packages/core/scanner.ts b/packages/core/scanner.ts
@@ -15,19 +15,18 @@ import {
 import {
   CanActivate,
   ClassProvider,
+  Controller,
   ExceptionFilter,
   ExistingProvider,
   FactoryProvider,
+  Injectable,
   InjectionToken,
   NestInterceptor,
   PipeTransform,
   Scope,
-  ValueProvider,
-  Controller,
-  Injectable,
   Type,
+  ValueProvider,
 } from '@nestjs/common/interfaces';
-import { randomStringGenerator } from '@nestjs/common/utils/random-string-generator.util';
 import {
   isFunction,
   isNil,
@@ -54,7 +53,6 @@ import { Module } from './injector/module';
 import { GraphInspector } from './inspector/graph-inspector';
 import { UuidFactory } from './inspector/uuid-factory';
 import { MetadataScanner } from './metadata-scanner';
-import { ParamsMetadata } from './helpers/interfaces/params-metadata.interface';
 
 interface ApplicationProviderWrapper {
   moduleKey: string;
@@ -529,11 +527,16 @@ export class DependenciesScanner {
         const { injectables } = modulesContainer.get(moduleKey);
         const instanceWrapper = injectables.get(providerKey);
 
-        iterate(modulesContainer.values())
-          .map(module => module.controllers.values())
+        const iterableIterator = modulesContainer.values();
+        iterate(iterableIterator)
+          .map(moduleRef =>
+            Array.from<InstanceWrapper>(moduleRef.controllers.values()).concat(
+              moduleRef.entryProviders,
+            ),
+          )
           .flatten()
-          .forEach(controller =>
-            controller.addEnhancerMetadata(instanceWrapper),
+          .forEach(controllerOrEntryProvider =>
+            controllerOrEntryProvider.addEnhancerMetadata(instanceWrapper),
           );
       });
   }