Merge pull request #48635 from radcortez/fix-47963

Automatically ignore mapping paths shared by build time and runtime config

Author: radcortez

core/deployment/src/main/java/io/quarkus/deployment/configuration/BuildTimeConfigurationReader.java

@@ -128,6 +128,7 @@ private static List<Class<?>> collectConfigRoots(ClassLoader classLoader) throws
     final List<ConfigClass> buildTimeRunTimeMappings;
     final List<ConfigClass> runTimeMappings;
     final List<ConfigClass> buildTimeVisibleMappings;
+    final Set<String> mappingsIgnorePaths;
 
     final Set<String> deprecatedProperties;
     final Set<String> deprecatedRuntimeProperties;
@@ -256,6 +257,28 @@ private BuildTimeConfigurationReader(ClassLoader classLoader, final List<Class<?
         buildTimeVisibleMappings.addAll(buildTimeMappings);
         buildTimeVisibleMappings.addAll(buildTimeRunTimeMappings);
 
+        mappingsIgnorePaths = new HashSet<>();
+        for (ConfigClass buildTimeMapping : buildTimeMappings) {
+            // Already ignored all the quarkus namespace in QuarkusConfigBuilderCustomizer
+            if (buildTimeMapping.getPrefix().equals("quarkus") || buildTimeMapping.getPrefix().startsWith("quarkus.")) {
+                continue;
+            }
+
+            for (ConfigClass staticMapping : buildTimeRunTimeMappings) {
+                if (buildTimeMapping.getPrefix().equals(staticMapping.getPrefix())) {
+                    mappingsIgnorePaths.add(buildTimeMapping.getPrefix() + ".**");
+                    break;
+                }
+            }
+
+            for (ConfigClass runtimeMapping : runTimeMappings) {
+                if (buildTimeMapping.getPrefix().equals(runtimeMapping.getPrefix())) {
+                    mappingsIgnorePaths.add(buildTimeMapping.getPrefix() + ".**");
+                    break;
+                }
+            }
+        }
+
         deprecatedProperties = getDeprecatedProperties(allRoots);
         deprecatedRuntimeProperties = getDeprecatedProperties(runTimeRoots);
 
@@ -422,6 +445,9 @@ public SmallRyeConfig initConfiguration(LaunchMode launchMode, Properties buildS
         for (ConfigClass mapping : getBuildTimeVisibleMappings()) {
             builder.withMapping(mapping);
         }
+        for (String mappingsIgnorePath : mappingsIgnorePaths) {
+            builder.withMappingIgnore(mappingsIgnorePath);
+        }
 
         builder.withInterceptors(buildConfigTracker);
         builder.withInterceptors(ConfigCompatibility.FrontEnd.instance(), ConfigCompatibility.BackEnd.instance());
@@ -672,7 +698,7 @@ public void accept(final ConfigSource buildSystem) {
 
             // ConfigMappings
             for (ConfigClass mapping : buildTimeVisibleMappings) {
-                objectsByClass.put(mapping.getKlass(), config.getConfigMapping(mapping.getKlass(), mapping.getPrefix()));
+                objectsByClass.put(mapping.getType(), config.getConfigMapping(mapping.getType(), mapping.getPrefix()));
             }
 
             Set<PropertyName> buildTimeNames = mappingsToNames(buildTimeMappings).keySet();
@@ -725,6 +751,7 @@ public void accept(final ConfigSource buildSystem) {
                     .setBuildTimeMappings(buildTimeMappings)
                     .setBuildTimeRunTimeMappings(buildTimeRunTimeMappings)
                     .setRunTimeMappings(runTimeMappings)
+                    .setMappingsIgnorePaths(mappingsIgnorePaths)
                     .setUnknownBuildProperties(unknownBuildProperties)
                     .setDeprecatedRuntimeProperties(deprecatedRuntimeProperties)
                     .setBuildConfigTracker(buildConfigTracker)
@@ -1319,6 +1346,7 @@ public static final class ReadResult {
         final List<ConfigClass> buildTimeRunTimeMappings;
         final List<ConfigClass> runTimeMappings;
         final List<ConfigClass> allMappings;
+        final Set<String> mappingsIgnorePaths;
         final Map<Class<?>, ConfigClass> allMappingsByClass;
 
         final Set<String> unknownBuildProperties;
@@ -1343,6 +1371,7 @@ public ReadResult(final Builder builder) {
             this.buildTimeMappings = builder.getBuildTimeMappings();
             this.buildTimeRunTimeMappings = builder.getBuildTimeRunTimeMappings();
             this.runTimeMappings = builder.getRunTimeMappings();
+            this.mappingsIgnorePaths = builder.getMappingsIgnorePaths();
             this.allMappings = new ArrayList<>(mappingsToMap(builder).values());
             this.allMappingsByClass = mappingsToMap(builder);
 
@@ -1363,13 +1392,13 @@ private static Map<Class<?>, RootDefinition> rootsToMap(Builder builder) {
         private static Map<Class<?>, ConfigClass> mappingsToMap(Builder builder) {
             Map<Class<?>, ConfigClass> map = new HashMap<>();
             for (ConfigClass mapping : builder.getBuildTimeMappings()) {
-                map.put(mapping.getKlass(), mapping);
+                map.put(mapping.getType(), mapping);
             }
             for (ConfigClass mapping : builder.getBuildTimeRunTimeMappings()) {
-                map.put(mapping.getKlass(), mapping);
+                map.put(mapping.getType(), mapping);
             }
             for (ConfigClass mapping : builder.getRunTimeMappings()) {
-                map.put(mapping.getKlass(), mapping);
+                map.put(mapping.getType(), mapping);
             }
             return map;
         }
@@ -1426,6 +1455,10 @@ public List<ConfigClass> getRunTimeMappings() {
             return runTimeMappings;
         }
 
+        public Set<String> getMappingsIgnorePaths() {
+            return mappingsIgnorePaths;
+        }
+
         public List<ConfigClass> getAllMappings() {
             return allMappings;
         }
@@ -1467,6 +1500,7 @@ static class Builder {
             private List<ConfigClass> buildTimeMappings;
             private List<ConfigClass> buildTimeRunTimeMappings;
             private List<ConfigClass> runTimeMappings;
+            private Set<String> mappingsIgnorePaths;
             private Set<String> unknownBuildProperties;
             private Set<String> deprecatedRuntimeProperties;
             private ConfigTrackingInterceptor buildConfigTracker;
@@ -1579,6 +1613,15 @@ Builder setRunTimeMappings(final List<ConfigClass> runTimeMappings) {
                 return this;
             }
 
+            Set<String> getMappingsIgnorePaths() {
+                return mappingsIgnorePaths;
+            }
+
+            Builder setMappingsIgnorePaths(final Set<String> mappingsIgnorePaths) {
+                this.mappingsIgnorePaths = mappingsIgnorePaths;
+                return this;
+            }
+
             Set<String> getUnknownBuildProperties() {
                 return unknownBuildProperties;
             }

core/deployment/src/main/java/io/quarkus/deployment/steps/ConfigGenerationBuildStep.java

@@ -301,6 +301,7 @@ void generateBuilders(
                 staticSafeServices(secretKeyHandlerFactories),
                 Set.of(),
                 staticMappings,
+                configItem.getReadResult().getMappingsIgnorePaths(),
                 staticCustomizers,
                 staticInitConfigBuilders.stream().map(StaticInitConfigBuilderBuildItem::getBuilderClassName).collect(toSet()));
         reflectiveClass.produce(ReflectiveClassBuildItem.builder(CONFIG_STATIC_NAME).build());
@@ -328,6 +329,7 @@ void generateBuilders(
                 secretKeyHandlerFactories,
                 staticMappings,
                 runTimeMappings,
+                configItem.getReadResult().getMappingsIgnorePaths(),
                 runtimeCustomizers,
                 runTimeConfigBuilders.stream().map(RunTimeConfigBuilderBuildItem::getBuilderClassName).collect(toSet()));
         reflectiveClass.produce(ReflectiveClassBuildItem.builder(CONFIG_RUNTIME_NAME).build());
@@ -593,6 +595,9 @@ private static String getPathWithoutExtension(Path path) {
     private static final MethodDescriptor WITH_MAPPING_INSTANCE = MethodDescriptor.ofMethod(AbstractConfigBuilder.class,
             "withMappingInstance",
             void.class, SmallRyeConfigBuilder.class, ConfigClass.class);
+    private static final MethodDescriptor WITH_MAPPING_IGNORE = MethodDescriptor.ofMethod(AbstractConfigBuilder.class,
+            "withMappingIgnore",
+            void.class, SmallRyeConfigBuilder.class, String.class);
     private static final MethodDescriptor WITH_CUSTOMIZER = MethodDescriptor.ofMethod(AbstractConfigBuilder.class,
             "withCustomizer",
             void.class, SmallRyeConfigBuilder.class, SmallRyeConfigBuilderCustomizer.class);
@@ -667,6 +672,7 @@ private static void generateConfigBuilder(
             Set<String> secretKeyHandlerFactories,
             Set<ConfigClass> mappingsInstances,
             Set<ConfigClass> mappings,
+            Set<String> mappingsIgnorePaths,
             Set<String> configCustomizers,
             Set<String> configBuilders) {
 
@@ -753,6 +759,10 @@ private static void generateConfigBuilder(
                 method.invokeStaticMethod(WITH_MAPPING, configBuilder, method.readStaticField(sharedFields.get(mapping)));
             }
 
+            for (String path : mappingsIgnorePaths) {
+                method.invokeStaticMethod(WITH_MAPPING_IGNORE, configBuilder, method.load(path));
+            }
+
             clinit.returnVoid();
             method.returnVoid();
         }

core/runtime/src/main/java/io/quarkus/runtime/configuration/AbstractConfigBuilder.java

@@ -87,6 +87,10 @@ protected static void withMappingInstance(SmallRyeConfigBuilder builder, ConfigC
         builder.getMappingsBuilder().mappingInstance(mapping, config.getConfigMapping(mapping.getType(), mapping.getPrefix()));
     }
 
+    protected static void withMappingIgnore(SmallRyeConfigBuilder builder, String path) {
+        builder.withMappingIgnore(path);
+    }
+
     protected static void withBuilder(SmallRyeConfigBuilder builder, ConfigBuilder configBuilder) {
         builder.withCustomizers(new SmallRyeConfigBuilderCustomizer() {
             @Override

integration-tests/test-extension/extension/deployment/src/main/java/io/quarkus/extest/deployment/IgnoreSharedBuildTimeConfig.java

@@ -0,0 +1,12 @@
+package io.quarkus.extest.deployment;
+
+import io.quarkus.runtime.annotations.ConfigPhase;
+import io.quarkus.runtime.annotations.ConfigRoot;
+import io.smallrye.config.ConfigMapping;
+
+@ConfigMapping(prefix = "ignore.build-time.config")
+@ConfigRoot(phase = ConfigPhase.BUILD_TIME)
+public interface IgnoreSharedBuildTimeConfig {
+    /** Docs */
+    String buildTime();
+}

integration-tests/test-extension/extension/deployment/src/main/java/io/quarkus/extest/deployment/TestProcessor.java

@@ -84,6 +84,7 @@ public final class TestProcessor {
     TestConfigRoot configRoot;
     TestBuildTimeConfig buildTimeConfig;
     TestBuildAndRunTimeConfig buildAndRunTimeConfig;
+    IgnoreSharedBuildTimeConfig ignoreSharedBuildTimeConfig;
 
     /**
      * Register an extension capability and feature

integration-tests/test-extension/extension/runtime/src/main/java/io/quarkus/extest/runtime/config/IgnoreSharedRuntimeConfig.java

@@ -0,0 +1,12 @@
+package io.quarkus.extest.runtime.config;
+
+import io.quarkus.runtime.annotations.ConfigPhase;
+import io.quarkus.runtime.annotations.ConfigRoot;
+import io.smallrye.config.ConfigMapping;
+
+@ConfigMapping(prefix = "ignore.build-time.config")
+@ConfigRoot(phase = ConfigPhase.RUN_TIME)
+public interface IgnoreSharedRuntimeConfig {
+    /** Docs */
+    String runtime();
+}

integration-tests/test-extension/extension/runtime/src/main/resources/application.properties

@@ -0,0 +1,2 @@
+ignore.build-time.config.build-time=value
+ignore.build-time.config.runtime=value