Skip to content

Use since attribute in configuration properties deprecation consistently #47980

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

Open
wants to merge 2 commits into
base: 3.5.x
Choose a base branch
from
+1,024 −504
Open

Use since attribute in configuration properties deprecation consistently #47980

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4460dcf
Add since attribute to uses of DeprecatedConfigurationProperty
scottfrederick Nov 5, 2025
3f58fcb
Add since to deprecations in config metadata JSON files
scottfrederick Nov 6, 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
17 changes: 17 additions & 0 deletions buildSrc/src/main/java/org/springframework/boot/build/architecture/ArchitectureRules.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ static List<ArchRule> standard() {
rules.add(methodLevelConfigurationPropertiesShouldNotSpecifyOnlyPrefixAttribute());
rules.add(conditionsShouldNotBePublic());
rules.add(allConfigurationPropertiesBindingBeanMethodsShouldBeStatic());
rules.add(allDeprecatedConfigurationPropertiesShouldIncludeSince());
return List.copyOf(rules);
}

Expand Down Expand Up @@ -348,6 +349,22 @@ private static ArchRule allConfigurationPropertiesBindingBeanMethodsShouldBeStat
.allowEmptyShould(true);
}

private static ArchRule allDeprecatedConfigurationPropertiesShouldIncludeSince() {
return methodsThatAreAnnotatedWith(
"org.springframework.boot.context.properties.DeprecatedConfigurationProperty")
.should(check("include a non-empty 'since' attribute", (method, events) -> {
JavaAnnotation<JavaMethod> annotation = method
.getAnnotationOfType("org.springframework.boot.context.properties.DeprecatedConfigurationProperty");
Map<String, Object> properties = annotation.getProperties();
Object since = properties.get("since");
if (!(since instanceof String) || ((String) since).isEmpty()) {
addViolation(events, method, annotation.getDescription()
+ " should include a non-empty 'since' attribute of @DeprecatedConfigurationProperty");
}
}))
.allowEmptyShould(true);
}

private static boolean containsOnlySingleType(JavaType[] types, JavaType type) {
return types.length == 1 && type.equals(types[0]);
}
Expand Down
27 changes: 19 additions & 8 deletions ...ngframework/boot/build/context/properties/CheckAdditionalSpringConfigurationMetadata.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,6 @@
import java.util.List;
import java.util.Map;

import com.fasterxml.jackson.core.JsonParseException;
import com.fasterxml.jackson.databind.JsonMappingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.gradle.api.file.FileTree;
import org.gradle.api.file.RegularFileProperty;
Expand Down Expand Up @@ -65,7 +63,7 @@ public FileTree getSource() {
}

@TaskAction
void check() throws JsonParseException, IOException {
void check() throws IOException {
Report report = createReport();
File reportFile = getReportLocation().get().getAsFile();
Files.write(reportFile.toPath(), report, StandardOpenOption.CREATE, StandardOpenOption.TRUNCATE_EXISTING);
Expand All @@ -76,21 +74,22 @@ void check() throws JsonParseException, IOException {
}

@SuppressWarnings("unchecked")
private Report createReport() throws IOException, JsonParseException, JsonMappingException {
private Report createReport() throws IOException {
ObjectMapper objectMapper = new ObjectMapper();
Report report = new Report();
for (File file : getSource().getFiles()) {
Analysis analysis = report.analysis(this.projectDir.toPath().relativize(file.toPath()));
Map<String, Object> json = objectMapper.readValue(file, Map.class);
check("groups", json, analysis);
check("properties", json, analysis);
check("hints", json, analysis);
checkSorting("groups", json, analysis);
checkSorting("properties", json, analysis);
checkSorting("hints", json, analysis);
checkPropertyDeprecationSince(json, analysis);
}
return report;
}

@SuppressWarnings("unchecked")
private void check(String key, Map<String, Object> json, Analysis analysis) {
private void checkSorting(String key, Map<String, Object> json, Analysis analysis) {
List<Map<String, Object>> groups = (List<Map<String, Object>>) json.getOrDefault(key, Collections.emptyList());
List<String> names = groups.stream().map((group) -> (String) group.get("name")).toList();
List<String> sortedNames = sortedCopy(names);
Expand All @@ -110,6 +109,18 @@ private List<String> sortedCopy(Collection<String> original) {
return copy;
}

@SuppressWarnings("unchecked")
private void checkPropertyDeprecationSince(Map<String, Object> json, Analysis analysis) {
List<Map<String, Object>> properties = (List<Map<String, Object>>) json.get("properties");
properties.stream().filter((property) -> property.containsKey("deprecation")).forEach((property) -> {
Map<String, Object> deprecation = (Map<String, Object>) property.get("deprecation");
if (!deprecation.containsKey("since")) {
analysis.problems.add("Property with name '" + property.get("name")
+ "' contains 'deprecation' without 'since' attribute");
}
});
}

private static final class Report implements Iterable<String> {

private final List<Analysis> analyses = new ArrayList<>();
Expand Down
Loading