Injecting ConfigProperty of type Optional<List<String>> not working in the native mode

[DeMol-EE]

Describe the bug

Given code:

    @Inject
    @ConfigProperty(name = "stuff")
    Optional<List<String>> stuff;

will result in an empty optional, even when running in an environment where variable STUFF is set to a valid, non-empty value.

Expected behavior

That the optional is not empty if the env var STUFF is set to a valid, non-empty value.

Actual behavior

The optional is empty

How to Reproduce?

See reproducer README

Output of uname -a or ver

FROM quay.io/quarkus/quarkus-micro-image:2.0

Output of java -version

FROM quay.io/quarkus/quarkus-micro-image:2.0

Mandrel or GraalVM version (if different from Java)

FROM quay.io/quarkus/ubi-quarkus-mandrel-builder-image:jdk-21

Quarkus version or git rev

3.6.0

Build tool (ie. output of mvnw --version or gradlew --version)

FROM quay.io/quarkus/ubi-quarkus-mandrel-builder-image:jdk-21

Additional information

No response

[quarkus-bot]

/cc @Karm (mandrel), @galderz (mandrel), @zakkak (mandrel)

[mkouba]

FTR I was able to reproduce it locally even without docker involved; just built a native image from the reproducer, set an env variable via export STUFF=foo,bar, run the app and the output looks like:

2023-12-01 11:21:16,785 INFO  [org.acm.Filter] (vert.x-eventloop-thread-0) injected: Optional.empty
2023-12-01 11:21:16,785 INFO  [org.acm.Filter] (vert.x-eventloop-thread-0) located: [foo, bar]

[mkouba]

CC @radcortez

[gsmet]

@radcortez this is rather concerning as it could lead to undesired behaviors, especially since the behavior is different in native. Could you prioritize it? Thanks!

[radcortez]

I'll have a look

[radcortez]

This is expected, because filters are initialized during static init, meaning that injected configuration is the one available during build time. When config is accessed in filter, the configuration is the one available at runtime.

If you try to build the image with STUFF set and then try to change for runtime it you get an error:

2023-12-01 11:30:12,482 ERROR [io.qua.run.Application] (main) Failed to start application (with profile [prod]): java.lang.RuntimeException: Failed to start quarkus
	at io.quarkus.runner.ApplicationImpl.doStart(Unknown Source)
	at io.quarkus.runtime.Application.start(Application.java:101)
	at io.quarkus.runtime.ApplicationLifecycleManager.run(ApplicationLifecycleManager.java:111)
	at io.quarkus.runtime.Quarkus.run(Quarkus.java:71)
	at io.quarkus.runtime.Quarkus.run(Quarkus.java:44)
	at io.quarkus.runtime.Quarkus.run(Quarkus.java:124)
	at io.quarkus.runner.GeneratedMain.main(Unknown Source)
Caused by: java.lang.IllegalStateException: A runtime config property value differs from the value that was injected during the static intialization phase:
 - the runtime value of 'stuff' is [foo] but the value [foo,bar] was injected into org.acme.Filter#stuff

If that's intentional then annotate the injected field/parameter with @io.quarkus.runtime.annotations.StaticInitSafe to eliminate the false positive.
	at io.quarkus.arc.runtime.ConfigStaticInitValues.onStart(ConfigStaticInitValues.java:58)
	at io.quarkus.arc.runtime.ConfigStaticInitValues_Observer_onStart_9AFRg-nRqgtTxnkBRkFamSX9SUE.notify(Unknown Source)
	at io.quarkus.arc.impl.EventImpl$Notifier.notifyObservers(EventImpl.java:346)
	at io.quarkus.arc.impl.EventImpl$Notifier.notify(EventImpl.java:328)
	at io.quarkus.arc.impl.EventImpl.fire(EventImpl.java:82)
	at io.quarkus.arc.runtime.ArcRecorder.fireLifecycleEvent(ArcRecorder.java:157)
	at io.quarkus.arc.runtime.ArcRecorder.handleLifecycleEvents(ArcRecorder.java:108)
	at io.quarkus.deployment.steps.LifecycleEventsBuildStep$startupEvent1144526294.deploy_0(Unknown Source)
	at io.quarkus.deployment.steps.LifecycleEventsBuildStep$startupEvent1144526294.deploy(Unknown Source)
	... 7 more

This was added in #36281, but apparently it does not work properly when there is no value to record and compare when starting up the native image.

[mkouba]

This is expected, because filters are initialized during static init, meaning that injected configuration is the one available during build time. When config is accessed in filter, the configuration is the one available at runtime.

Ah, of course. So the workaround is to obtain the config property lazily, i.e. inject @ConfigProperty(name = "stuff") Instance<Optional<List<String>>> stuff instead and then stuff.get() in the filter method. It would work for any other CDI component that is not initialized during the STATIC_INIT bootstrap phase (i.e. when the native image is built).

[radcortez]

Ah, of course. So the workaround is to obtain the config property lazily, i.e. inject @ConfigProperty(name = "stuff") Instance<Optional<List<String>>> stuff instead and then stuff.get() in the filter method. It would work for any other CDI component that is not initialized during the STATIC_INIT bootstrap phase (i.e. when the native image is built).

Correct.

[DeMol-EE]

OK, thanks guys.

[mkouba]

This was added in #36281, but apparently it does not work properly when there is no value to record and compare when starting up the native image.

Hm, it seems that we intentionally do not record a missing value. Maybe we should?

[radcortez]

Hm, it seems that we intentionally do not record a missing value. Maybe we should?

Yes, to cover this case.