feat(@nestjs/scheduler): Add a warning when using non static providers #726
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds a warning when trying to register cron jobs/timeouts/intervals using a non static provider.
jshayes
commented
Nov 15, 2021
| ); | ||
| }); | ||
| instanceWrappers.forEach((wrapper: InstanceWrapper) => { | ||
| const { instance } = wrapper; |
There was a problem hiding this comment.
I'm not exactly sure the implication of getting an instance for a request scoped provider here. It seems like it uses a static context id when resolving the instance, but I do not know if this could cause any issues.
There was a problem hiding this comment.
This should be fine! For request-scoped providers, instance would be a prototype object
|
This is great @jshayes, thank you! 🙌 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Currently when registering a request scoped provider that defines cron jobs, it does not register the cron jobs. This is because it filters out non static providers. In addition to this, there are not warning logs, making this less obvious as to why the cron jobs are not being registered.
What is the new behavior?
It behaves the same way as before except it will now log a warning when using a request scoped provider.
Does this PR introduce a breaking change?
Other information
In our cron jobs we emit events over nats. We had an issue come up recently where the nats client was updated to become request scoped. This resulted in our cron jobs breaking since it does not register cron jobs for request scoped providers. There were also no warning logs associated with this, so it was not immediately obvious why the cron jobs stopped working. This adds some warning logs to make this issue easier to debug in the future.