Spring DI exposing Custom scopes as build item

[ozangunalp]

Resolves #47544

I am not sure of the impact of this change. So letting the CI run and have feedback from @mkouba, @geoand and @aureamunoz

[mkouba]

CustomScopeBuildItem should only be produced for custom scopes; which isn't the case here, or?

@ozangunalp Why exactly do we need this?

[ozangunalp]

AFAICT the Spring DI extension is adding CDI scope annotations to classes where these Spring annotations are present.

So when it comes to other extensions adding default scope to classes containing some annotations (RM adding Dependent to classes containing Incoming/Outgoing, grpc adding Singleton to classes containing GrpcService, etc.) they can check whether custom scope is already present on the class.

[mkouba]

I see. So the correct solution for multiple extensions trying to add an "auto" scope is to "prioritize", i.e. only one extension can win ;-).

In this particular case, I guess that Spring DI should win because of the org.springframework.stereotype.Service annotation used.

Therefore, I'd recommend to (1) rewrite the SmallRyeReactiveMessagingProcessor#transformBeanScope() to produce a transformation with lower priority (Spring DI is using the default priority of 1000). An idiomatic approach for an annotation transformer that merely adds a scope is to use the AutoAddScopeBuildItem; it handles most of the tricky parts automatically (such as declared scope annotations).

Something like:

@BuildStep
AutoAddScopeBuildItem autoAddScope() {
   return AutoAddScopeBuildItem.builder()
      .containsAnnotations(INCOMING, OUTGOING, CHANNEL) 
      .defaultScope(BuiltinScope.DEPENDENT)
      .build();
}

However, the AutoAddScopeBuildItem transformer has the priority 2000 so we need to (2) modify the priority of the Spring DI's transformer as well. Or use a custom annotation transformer with lower priority instead of AutoAddScopeBuildItem.

[ozangunalp]

I need to adapt the IT I modified so see if it works. Obviously container runtime is not available on windows tests.

[mkouba]

It might make sense to add a comment that the value is 500 because the Spring DI's annotation transformer has the default priority of value 1000 and we want it to take precedence?

Also I would squash the changes, i.e. remove the first commit completely...

[ozangunalp]

Yes, I pushed the change to run the CI. Squasing now.

[quarkus-bot]

Status for workflow Quarkus CI

This is the status report for running Quarkus CI on commit 3f7a2da.

✅ 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.

You can consult the Develocity build scans.

---

Flaky tests - Develocity

⚙️ JVM Integration Tests - JDK 17

📦 integration-tests/opentelemetry-grpc-only

✖ io.quarkus.it.opentelemetry.grpc.HelloGrpcClientTest.testHello - History

• java.lang.RuntimeException: Failed to start quarkus - java.lang.RuntimeException

java.lang.RuntimeException: java.lang.RuntimeException: Failed to start quarkus
	at io.quarkus.test.junit.QuarkusTestExtension.throwBootFailureException(QuarkusTestExtension.java:693)
	at io.quarkus.test.junit.QuarkusTestExtension.interceptTestClassConstructor(QuarkusTestExtension.java:791)
	at java.base/java.util.Optional.orElseGet(Optional.java:364)
	at java.base/java.util.ArrayList.forEach(ArrayList.java:1511)
	at java.base/java.util.ArrayList.forEach(ArrayList.java:1511)
Caused by: java.lang.RuntimeException: Failed to start quarkus
	at io.quarkus.runner.ApplicationImpl.doStart(Unknown Source)