adjust blueprint generator scheduling

[dwarakaprasad]

fixes #25444

A full blueprint (sbsBlueprint - false) will schedule immediately i.e. replacing the queue slot of the blueprinted generator.
A sbs blueprint (sbsBlueprint - true) will not affect the blueprinted generator's slot in queue but will take its own slot down below it.

---

Please make sure the below checklist is followed for Pull Requests.

• All continuous integration tests are green
• Tests are added where necessary
• The JDL part is updated if necessary
• jhipster-online is updated if necessary
• Documentation is added/updated where necessary
• Coding Rules & Commit Guidelines as per our CONTRIBUTING.md document are followed

When you are still working on the PR, consider converting it to Draft (below reviewers) and adding skip-ci label, you can still see CI build result at your branch.

[mshima]

This indeed is the correct behavior for full blueprints, but will break sbs blueprints.
Blueprint tasks will be queued before the blueprinted generator. sbs needs to be queued after.

The schedule parameter needs to be conditional, so it must be a function.
Should change here:
https://github.com/yeoman/environment/blob/1f2dd7bdcb9f9e58ed473c03a38afa0a58e63ecb/src/environment-base.ts#L428
to schedule: typeof schedule === ' function' ? schedule(generatorInstance) : schedule.

And add the conditional function before:

generator-jhipster/generators/base/generator.ts

Line 586 in 59a178a

...extraOptions,

[dwarakaprasad]

This indeed is the correct behavior for full blueprints, but will break sbs blueprints. Blueprint tasks will be queued before the blueprinted generator. sbs needs to be queued after.

The schedule parameter needs to be conditional, so it must be a function. Should change here: https://github.com/yeoman/environment/blob/1f2dd7bdcb9f9e58ed473c03a38afa0a58e63ecb/src/environment-base.ts#L428 to schedule: typeof schedule === ' function' ? schedule(generatorInstance) : schedule.

And add the conditional function before:

generator-jhipster/generators/base/generator.ts

Line 586 in 59a178a

...extraOptions,

Thank you for your insight!

please correct me if i am wrong.
So to be on the same page,

blueprint = jhipster-<blueprint>:** namespace
blueprinted generator = jhipster:** namespace
A full blueprint is one where the sbsBlueprint is set to false
A full blueprint is one where the sbsBlueprint is set to true

As is today,

1. A full blueprint's task should be queued first followed by the blueprinted generator's task i.e. should be scheduled immediately instead of going tro the environment:run loop.
   Currently composewithBlueprint method doesn't set the schedule value and so is defaulted to true and so all blueprints (full/sbs) are always being scheduled as of today. (not as expected)

2. A sbs blueprint on the other hand should let its blueprinted generator's task to queue first and then get queued i.e. using the environment:run loop.
   same as above, sbs is always being scheduled as of today (same as expected)

Expectation is,

1. A full blueprint should not be scheduled rather be queued immediately - so this mean schedule = false
2. A sbs blueprint should be scheduled - so schedule = true

Instead of only having a binary possibility, you are proposing to have a function that will let generators make sophisticated decisions.

Since this proposal needs change to yeoman-environment, both releases will have to be timed.

[mshima]

Yes, that's it.

The only part that is not correct is:

1. queued first followed by the blueprinted generator's task

The blueprinted generator's tasks are not queue unless the full blueprint inherits its tasks. The blueprinted generator is halt
Since the full blueprint completely overrides the blueprinted generator, it should replace its queue slot by queueing immediately too.

Instead of only having a binary possibility, you are proposing to have a function that will let generators make sophisticated decisions.

Should be:
schedule: generator => generator.sbsBlueprint

Since this proposal needs change to yeoman-environment, both releases will have to be timed.

No problem with that.
Are you willing to create the PR?

[dwarakaprasad]

it should replace its queue slot by queueing immediately too.

Yes, it makes sense.

Are you willing to create the PR?

Yes...

[dwarakaprasad]

@mshima changes made

1. @yeoman/type changes
2. environment change
3. jhipster change