Merge pull request #52742 from radcortez/fix-52718

Ensure that `@ConfigProperties` are registered before Startup event

Author: geoand

extensions/arc/deployment/src/main/java/io/quarkus/arc/deployment/ConfigBuildStep.java

@@ -65,6 +65,7 @@
 import io.quarkus.deployment.builditem.ConfigPropertiesBuildItem;
 import io.quarkus.deployment.builditem.ConfigurationBuildItem;
 import io.quarkus.deployment.builditem.GeneratedClassBuildItem;
+import io.quarkus.deployment.builditem.ServiceStartBuildItem;
 import io.quarkus.deployment.builditem.nativeimage.ReflectiveClassBuildItem;
 import io.quarkus.deployment.builditem.nativeimage.ReflectiveMethodBuildItem;
 import io.quarkus.deployment.pkg.NativeConfig;
@@ -451,15 +452,28 @@ void validateConfigPropertiesInjectionPoints(
         toRegister.forEach(configProperties::produce);
     }
 
+    /**
+     * Registers the {@link org.eclipse.microprofile.config.inject.ConfigProperties} beans after
+     * the creation of {@link io.smallrye.config.SmallRyeConfig}. It should be possible to register these in the config
+     * builder during build time, but unfortunately the MP Config TCK requires to throw a
+     * {@link jakarta.enterprise.inject.spi.DeploymentException} when a
+     * {@link org.eclipse.microprofile.config.inject.ConfigProperties} bean cannot be initialized (due to missing
+     * configuration). When {@link io.smallrye.config.SmallRyeConfig} cannot map a config class, it throws a
+     * {@link io.smallrye.config.ConfigValidationException}. The recorder catches this exception and throws the
+     * expected {@link jakarta.enterprise.inject.spi.DeploymentException}.
+     */
     @BuildStep
     @Record(RUNTIME_INIT)
     void registerConfigClasses(
             RecorderContext context,
             ConfigRecorder recorder,
-            List<ConfigMappingBuildItem> configMappings,
-            List<ConfigPropertiesBuildItem> configProperties) throws Exception {
+            List<ConfigPropertiesBuildItem> configProperties,
+            BuildProducer<ServiceStartBuildItem> serviceStart) throws Exception {
+
+        if (configProperties.isEmpty()) {
+            return;
+        }
 
-        // TODO - Register ConfigProperties during build time
         context.registerNonDefaultConstructor(
                 ConfigClass.class.getDeclaredConstructor(Class.class, String.class),
                 configClass -> Stream.of(configClass.getType(), configClass.getPrefix())
@@ -469,6 +483,9 @@ void registerConfigClasses(
                 configProperties.stream()
                         .map(p -> configClass(p.getConfigClass(), p.getPrefix()))
                         .collect(toSet()));
+
+        // Ensure that @ConfigProperties are registered before Startup events
+        serviceStart.produce(new ServiceStartBuildItem("microprofile-config-properties"));
     }
 
     private static String getPropertyName(String name, ClassInfo declaringClass) {

extensions/arc/deployment/src/test/java/io/quarkus/arc/test/config/ConfigPropertiesTest.java

@@ -5,6 +5,7 @@
 
 import java.util.Map;
 
+import jakarta.enterprise.context.ApplicationScoped;
 import jakarta.enterprise.context.Dependent;
 import jakarta.enterprise.inject.spi.CDI;
 import jakarta.inject.Inject;
@@ -14,6 +15,7 @@
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.RegisterExtension;
 
+import io.quarkus.runtime.Startup;
 import io.quarkus.test.QuarkusUnitTest;
 import io.smallrye.config.ConfigMapping;
 import io.smallrye.config.WithDefault;
@@ -137,6 +139,17 @@ void overridePrefixBean() {
         assertEquals(80, client.port());
     }
 
+    @Inject
+    StartupBean startupBean;
+
+    @Test
+    void startup() {
+        ServerConfigProperties server = startupBean.getServer();
+        assertNotNull(server);
+        assertEquals("localhost", server.host);
+        assertEquals(8080, server.port);
+    }
+
     @ConfigMapping(prefix = "server")
     public interface Server {
         String host();
@@ -183,4 +196,19 @@ public void setClient(@ConfigMapping(prefix = "client") final Server client) {
             this.client = client;
         }
     }
+
+    @ApplicationScoped
+    @Startup
+    static class StartupBean {
+        ServerConfigProperties server;
+
+        @Inject
+        public StartupBean(@ConfigProperties ServerConfigProperties server) {
+            this.server = server;
+        }
+
+        public ServerConfigProperties getServer() {
+            return server;
+        }
+    }
 }