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

Update FAQ Hybrid application Docs to clarify bootstrap order #2485

Open
1 task done
haimprecise opened this issue Sep 30, 2022 · 1 comment
Open
1 task done

Update FAQ Hybrid application Docs to clarify bootstrap order #2485

haimprecise opened this issue Sep 30, 2022 · 1 comment

Comments

@haimprecise
Copy link

Is there an existing issue that is already proposing this?

  • I have searched the existing issues

Is your feature request related to a problem? Please describe it

When utilizing onApplicationBootstrap / onModuleInit and consuming app's functionality inside Microservices, it is important to clarify that the order of the bootstrap lines plays an essential role:

For example:

await app.startAllMicroservices();
await app.listen(3001);

The lifecycle events will complete after the microservices have started.

await app.listen(3001);
await app.startAllMicroservices();

The lifecycle events will complete before the microservices have started.

We had a bug when our application started and a microservice was immediately consumed, before our Promises from modules' OnModuleInit functions have finished.

Describe the solution you'd like

  1. Explain that lifecycle events happen when you call listen and not create
  2. Explain that the order of startAllMicroservices and listen is crucial

Teachability, documentation, adoption, migration strategy

Update the Lifecycle and Hybrid Application pages

What is the motivation / use case for changing the behavior?

To educate developers and to avoid future bugs. I had to debug your code to figure these things out...

@Tony133
Copy link
Contributor

Tony133 commented Sep 30, 2022

Hi @haimprecise, for questions or issue regarding documentation you have to open them in this repository: https://github.com/nestjs/docs.nestjs.com

Anyway feel free to do a PR if you want for this problem

@kamilmysliwiec kamilmysliwiec transferred this issue from nestjs/nest Oct 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants