feat(core): enhance circular dependency error message

[ntibi]

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our guidelines: https://github.com/nestjs/nest/blob/master/CONTRIBUTING.md
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

• Bugfix
• Feature
• Code style update (formatting, local variables)
• Refactoring (no functional changes, no api changes)
• Build related changes
• CI related changes
• Other... Please describe:

What is the current behavior?

when trying to insert an undefined provider (due to a circular dependency), you get this message

A circular dependency has been detected. Please, make sure that each side of a bidirectional relationships are decorated with "forwardRef()".,

Issue Number: N/A

What is the new behavior?

if the module you are inserting the provider into is defined, you get the module name in the error (hinting where to look for to find the circular dependency)

A circular dependency has been detected in TheModule. Please, make sure that each side of a bidirectional relationships are decorated with "forwardRef()".,

Does this PR introduce a breaking change?

• Yes
• No

Other information

[micalevisk]

I believe the message will be
A circular dependency has been detected inside TheModule. Please, make sure that each side of a bidirectional relationships are decorated with "forwardRef()".

[kamilmysliwiec]

Could you share a minimum reproduction repository that showcases the exact scenario this PR improves?

[ntibi]

@kamilmysliwiec just having an undefined provider (to simulate the circular dependency) is enough to reproduce the scenario

import { NestFactory } from '@nestjs/core';
import { Module } from '@nestjs/common';

const provider = undefined; // not set because of a circular dependency

@Module({
  providers: [provider],
})
export class App {}

NestFactory.create(App).then(app => app.listen(3000))

upstream:

nest start
[Nest] 1402850 - 05/08/2022, 1:35:15 AM LOG [NestFactory] Starting Nest application...
[Nest] 1402850 - 05/08/2022, 1:35:15 AM ERROR [ExceptionHandler] A circular dependency has been detected. Please, make sure that each side of a bidirectional relationships are decorated with "forwardRef()".

this branch:

nest start
[Nest] 1404399 - 05/08/2022, 1:35:16 AM LOG [NestFactory] Starting Nest application...
[Nest] 1404399 - 05/08/2022, 1:35:16 AM ERROR [ExceptionHandler] A circular dependency has been detected inside App. Please, make sure that each side of a bidirectional relationships are decorated with "forwardRef()".