Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(swagger): include model name in circular dependency warning #3353

Closed

Conversation

dunklesToast
Copy link

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Other - Improved Error Message

What is the current behavior?

Right now nest shows something like this:
Error: A circular dependency has been detected (property key: "id"). Please, make sure that each side of a bidirectional relationships are using lazy resolvers ("type: () => ClassType").. If you've changed / refactored few files in your repo you probably don't easily know with Model had the error (and since the error occurred in the id field for me, it could've been basically any)

What is the new behavior?

We're now checking if there is a pendingSchemaRef. As far as I understood the code this is a list of models to work on. In my testing the first item always equaled the model that the error was thrown so I thought it might be a good idea to include the model name in the error message.
If I was just "lucky" and the order of the pendingSchemaRefs isn't actually sorted in any way making the error message invalid, I guess we can close this (if there is no other easy way to infer the models name)

Does this PR introduce a breaking change?

  • No

@kamilmysliwiec
Copy link
Member

Yeah we can't rely on the pendingSchemaRefs order in this case

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants