fix(core): add missing capability to control global dynamic modules

Author: kamilmysliwiec

packages/common/interfaces/modules/dynamic-module.interface.ts

@@ -1,5 +1,5 @@
-import { ModuleMetadata } from './module-metadata.interface';
 import { Type } from '../type.interface';
+import { ModuleMetadata } from './module-metadata.interface';
 
 /**
  * Interface defining a Dynamic Module.
@@ -10,7 +10,18 @@ import { Type } from '../type.interface';
  */
 export interface DynamicModule extends ModuleMetadata {
   /**
-   * A module
+   * A module reference
    */
   module: Type<any>;
+
+  /**
+   * When "true", makes a module global-scoped.
+   *
+   * Once imported into any module, a global-scoped module will be visible
+   * in all modules. Thereafter, modules that wish to inject a service exported
+   * from a global module do not need to import the provider module.
+   *
+   * Default: false
+   */
+  isGlobal?: boolean;
 }

packages/core/injector/container.ts

@@ -65,10 +65,11 @@ export class NestContainer {
     }
     const module = new Module(type, scope, this);
     this.modules.set(token, module);
-
     this.addDynamicMetadata(token, dynamicMetadata, [].concat(scope, type));
-    this.isGlobalModule(type) && this.addGlobalModule(module);
 
+    if (this.isGlobalModule(type, dynamicMetadata)) {
+      this.addGlobalModule(module);
+    }
     return module;
   }
 
@@ -93,7 +94,13 @@ export class NestContainer {
     modules.forEach(module => this.addModule(module, scope));
   }
 
-  public isGlobalModule(metatype: Type<any>): boolean {
+  public isGlobalModule(
+    metatype: Type<any>,
+    dynamicMetadata?: Partial<DynamicModule>,
+  ): boolean {
+    if (dynamicMetadata && dynamicMetadata.isGlobal) {
+      return true;
+    }
     return !!Reflect.getMetadata(GLOBAL_MODULE_METADATA, metatype);
   }
 

packages/core/test/injector/container.spec.ts

@@ -83,14 +83,20 @@ describe('NestContainer', () => {
     });
   });
   describe('isGlobalModule', () => {
-    describe('when module is not global scoped', () => {
+    describe('when module is not globally scoped', () => {
       it('should return false', () => {
-        expect(container.isGlobalModule(TestModule as any)).to.be.false;
+        expect(container.isGlobalModule(TestModule)).to.be.false;
       });
     });
-    describe('when module is not global scoped', () => {
+    describe('when module is globally scoped', () => {
       it('should return true', () => {
-        expect(container.isGlobalModule(GlobalTestModule as any)).to.be.true;
+        expect(container.isGlobalModule(GlobalTestModule)).to.be.true;
+      });
+    });
+    describe('when dynamic module is globally scoped', () => {
+      it('should return true', () => {
+        expect(container.isGlobalModule(TestModule, { isGlobal: true })).to.be
+          .true;
       });
     });
   });