Merge pull request #12519 from micalevisk/fix/issue-12518

fix(core): when the discoverable decorator was not used on calling `getProviders`/`getControllers`

integration/discovery/e2e/discover-by-meta.spec.ts

@@ -1,15 +1,21 @@
-import { Test } from '@nestjs/testing';
+import { Test, TestingModule } from '@nestjs/testing';
+import { DiscoveryService } from '@nestjs/core';
 import { expect } from 'chai';
 import { AppModule } from '../src/app.module';
 import { WebhooksExplorer } from '../src/webhooks.explorer';
+import { NonAppliedDecorator } from '../src/decorators/non-applied.decorator';
 
 describe('DiscoveryModule', () => {
-  it('should discover all providers & handlers with corresponding annotations', async () => {
-    const builder = Test.createTestingModule({
+  let moduleRef: TestingModule;
+
+  beforeEach(async () => {
+    moduleRef = await Test.createTestingModule({
       imports: [AppModule],
-    });
-    const testingModule = await builder.compile();
-    const webhooksExplorer = testingModule.get(WebhooksExplorer);
+    }).compile();
+  });
+
+  it('should discover all providers & handlers with corresponding annotations', async () => {
+    const webhooksExplorer = moduleRef.get(WebhooksExplorer);
 
     expect(webhooksExplorer.getWebhooks()).to.be.eql([
       {
@@ -32,4 +38,22 @@ describe('DiscoveryModule', () => {
       },
     ]);
   });
+
+  it('should return an empty array if no providers were found for a given discoverable decorator', () => {
+    const discoveryService = moduleRef.get(DiscoveryService);
+
+    const providers = discoveryService.getProviders({
+      metadataKey: NonAppliedDecorator.KEY,
+    });
+    expect(providers).to.be.eql([]);
+  });
+
+  it('should return an empty array if no controllers were found for a given discoverable decorator', () => {
+    const discoveryService = moduleRef.get(DiscoveryService);
+
+    const controllers = discoveryService.getControllers({
+      metadataKey: NonAppliedDecorator.KEY,
+    });
+    expect(controllers).to.be.eql([]);
+  });
 });

integration/discovery/src/decorators/non-applied.decorator.ts

@@ -0,0 +1,9 @@
+import { DiscoveryService } from '@nestjs/core';
+
+/**
+ * This decorator must not be used anywhere!
+ *
+ * This will be used to test the scenario where we are trying to retrieving
+ * metadata for a discoverable decorator that was not applied to any class.
+ */
+export const NonAppliedDecorator = DiscoveryService.createDecorator();

packages/core/discovery/discoverable-meta-host-collection.ts

@@ -94,7 +94,7 @@ export class DiscoverableMetaHostCollection {
     metaKey: string,
   ): Set<InstanceWrapper> {
     const wrappersByMetaKey = this.providersByMetaKey.get(hostContainerRef);
-    return wrappersByMetaKey.get(metaKey);
+    return wrappersByMetaKey?.get(metaKey) ?? new Set<InstanceWrapper>();
   }
 
   public static getControllersByMetaKey(
@@ -102,7 +102,7 @@ export class DiscoverableMetaHostCollection {
     metaKey: string,
   ): Set<InstanceWrapper> {
     const wrappersByMetaKey = this.controllersByMetaKey.get(hostContainerRef);
-    return wrappersByMetaKey.get(metaKey);
+    return wrappersByMetaKey?.get(metaKey) ?? new Set<InstanceWrapper>();
   }
 
   private static inspectInstanceWrapper(