Document that ContextConfigurator#done() is invoked automatically

[manovotn]

Note that this doesn't change or fix any behavior since there is a safety latch that already did this invocation in ArcProcessor, see this code.
Purpose of this PR is just to add clarity in how to properly operate with context configurators.

[Ladicek]

I'd prefer to keep it all as a single statement, as that's how builders are typically used, but that's just a personal preference. @mkouba WDYT?

[mkouba]

I wonder if we should just add a note to the ContextConfiguratorBuildItem that done() is called automatically. That was probably one of the reasons why we introduced the ContextConfiguratorBuildItem anyway...

I'd prefer to keep it all as a single statement, as that's how builders are typically used, but that's just a personal preference. @mkouba WDYT?

👍

[github-actions]

🎊 PR Preview e2c3b4e has been successfully built and deployed to https://quarkus-pr-main-33404-preview.surge.sh/version/main/guides/

[manovotn]

I'd prefer to keep it all as a single statement, as that's how builders are typically used, but that's just a personal preference.

WDYM? The done() method returns void which prevents you from doing something like:

 return new ContextConfiguratorBuildItem(contextRegistrationPhase.getContext()
                .configure(TransactionScoped.class).normal().contextClass(TransactionContext.class).done());

[manovotn]

I wonder if we should just add a note to the ContextConfiguratorBuildItem that done() is called automatically.

Right, we could do that instead but I found it sort of weird since all other Arc related configurators have done() method and require you to invoke it 🤷
I don't mind either way as long as it clarifies what is happening/should happen.

That was probably one of the reasons why we introduced the ContextConfiguratorBuildItem anyway...

I don't recall this but it's very well possible :)

[mkouba]

Right, we could do that instead but I found it sort of weird since all other Arc related configurators have done() method and require you to invoke it shrug
I don't mind either way as long as it clarifies what is happening/should happen.

There are other places where we already call done() automatically: https://github.com/quarkusio/quarkus/blob/main/independent-projects/arc/processor/src/main/java/io/quarkus/arc/processor/AnnotationsTransformer.java#L372-L380 ;-)

[Ladicek]

The done() method returns void

Ouch, totally forgot about that. Well, that might be another reason why we call done() automatically :-)

[manovotn]

There are other places where we already call done() automatically: https://github.com/quarkusio/quarkus/blob/main/independent-projects/arc/processor/src/main/java/io/quarkus/arc/processor/AnnotationsTransformer.java#L372-L380 ;-)

That's good pointer, I didn't realize we're already doing it. In that case, I'll scratch this and instead mention it's done automatically.

No longer relevant due to changes

[manovotn]

@mkouba @Ladicek I've changed the PR so that it now instead documents that ContextConfigurator#done() is invoked automatically.

[quarkus-bot]

✔️ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.