Skip to content

Warn if using old @ConfigRoot class configuration mechanism #46314

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 14, 2025
Merged

Warn if using old @ConfigRoot class configuration mechanism #46314

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
69d53b6
Warn if using old @ConfigRoot class configuration mechanism
radcortez Feb 17, 2025
cb946a3
Improve warning message with useful pointers
gsmet Mar 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions ...yment/src/main/java/io/quarkus/deployment/configuration/BuildTimeConfigurationReader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@
import java.util.Set;
import java.util.SortedSet;
import java.util.TreeMap;
import java.util.TreeSet;
import java.util.stream.Collectors;

import org.eclipse.microprofile.config.Config;
import org.eclipse.microprofile.config.inject.ConfigProperty;
Expand Down Expand Up @@ -166,6 +168,8 @@ private BuildTimeConfigurationReader(ClassLoader classLoader, final List<Class<?
runTimeMappings = new ArrayList<>();

Map<Class<?>, GroupDefinition> groups = new HashMap<>();
Set<String> legacyConfigRoots = new TreeSet<>();

for (Class<?> configRoot : configRoots) {
boolean isMapping = configRoot.isAnnotationPresent(ConfigMapping.class);
if (isMapping) {
Expand Down Expand Up @@ -220,6 +224,17 @@ private BuildTimeConfigurationReader(ClassLoader classLoader, final List<Class<?
assert phase == ConfigPhase.RUN_TIME;
runTimeRoots.add(definition);
}

if (configRoot.getAnnotation(Deprecated.class) == null) {
legacyConfigRoots.add(configRoot.getName());
}
}

if (!legacyConfigRoots.isEmpty()) {
log.warn(
"The following config roots are using the legacy configuration classes infrastructure and should be adjusted to use an interface and @ConfigMapping.\n"
+ "See https://quarkus.io/guides/writing-extensions#configuration for more information. Please report this issue to their respective owners.\n\n"
+ legacyConfigRoots.stream().collect(Collectors.joining("\n- ", "- ", "")));
}

// ConfigRoots
Expand Down
Loading