mirror of
https://github.com/spring-projects/spring-boot.git
synced 2024-07-05 00:56:58 +08:00
Don't migrate properties that cause a circular reference
Update `PropertiesMigrationReporter` so that properties are only migrated automatically when they don't cause a circular reference. Fixes gh-35919
This commit is contained in:
parent
2f39ebfe89
commit
efa072204a
@ -17,9 +17,11 @@
|
||||
package org.springframework.boot.context.properties.migrator;
|
||||
|
||||
import java.util.Collections;
|
||||
import java.util.HashSet;
|
||||
import java.util.LinkedHashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.Set;
|
||||
import java.util.function.Predicate;
|
||||
import java.util.stream.Collectors;
|
||||
|
||||
@ -86,14 +88,26 @@ class PropertiesMigrationReporter {
|
||||
if (renamed.isEmpty()) {
|
||||
return null;
|
||||
}
|
||||
String target = "migrate-" + name;
|
||||
Map<String, OriginTrackedValue> content = new LinkedHashMap<>();
|
||||
for (PropertyMigration candidate : renamed) {
|
||||
OriginTrackedValue value = OriginTrackedValue.of(candidate.getProperty().getValue(),
|
||||
candidate.getProperty().getOrigin());
|
||||
content.put(candidate.getNewPropertyName(), value);
|
||||
NameTrackingPropertySource nameTrackingPropertySource = new NameTrackingPropertySource();
|
||||
this.environment.getPropertySources().addFirst(nameTrackingPropertySource);
|
||||
try {
|
||||
String target = "migrate-" + name;
|
||||
Map<String, OriginTrackedValue> content = new LinkedHashMap<>();
|
||||
for (PropertyMigration candidate : renamed) {
|
||||
String newPropertyName = candidate.getNewPropertyName();
|
||||
Object value = candidate.getProperty().getValue();
|
||||
if (nameTrackingPropertySource.isPlaceholderThatAccessesName(value, newPropertyName)) {
|
||||
continue;
|
||||
}
|
||||
OriginTrackedValue originTrackedValue = OriginTrackedValue.of(value,
|
||||
candidate.getProperty().getOrigin());
|
||||
content.put(newPropertyName, originTrackedValue);
|
||||
}
|
||||
return new OriginTrackedMapPropertySource(target, content);
|
||||
}
|
||||
finally {
|
||||
this.environment.getPropertySources().remove(nameTrackingPropertySource.getName());
|
||||
}
|
||||
return new OriginTrackedMapPropertySource(target, content);
|
||||
}
|
||||
|
||||
private boolean isMapType(ConfigurationMetadataProperty property) {
|
||||
@ -172,4 +186,33 @@ class PropertiesMigrationReporter {
|
||||
return source.getUnderlyingSource().toString();
|
||||
}
|
||||
|
||||
/**
|
||||
* {@link PropertySource} used to track accessed properties to protect against
|
||||
* circular references.
|
||||
*/
|
||||
private class NameTrackingPropertySource extends PropertySource<Object> {
|
||||
|
||||
private final Set<String> accessedNames = new HashSet<>();
|
||||
|
||||
NameTrackingPropertySource() {
|
||||
super(NameTrackingPropertySource.class.getName());
|
||||
}
|
||||
|
||||
boolean isPlaceholderThatAccessesName(Object value, String name) {
|
||||
if (value instanceof String) {
|
||||
this.accessedNames.clear();
|
||||
PropertiesMigrationReporter.this.environment.resolvePlaceholders((String) value);
|
||||
return this.accessedNames.contains(name);
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Object getProperty(String name) {
|
||||
this.accessedNames.add(name);
|
||||
return null;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
@ -205,6 +205,14 @@ class PropertiesMigrationReporterTests {
|
||||
.contains("Replacement: custom.the-map-replacement.key");
|
||||
}
|
||||
|
||||
@Test // gh-35919
|
||||
void directCircularReference() {
|
||||
this.environment.getPropertySources()
|
||||
.addFirst(new MapPropertySource("backcompat", Collections.singletonMap("wrong.two", "${test.two}")));
|
||||
createAnalyzer(loadRepository("metadata/sample-metadata.json")).getReport();
|
||||
assertThat(this.environment.getProperty("test.two")).isNull();
|
||||
}
|
||||
|
||||
private List<String> mapToNames(PropertySources sources) {
|
||||
List<String> names = new ArrayList<>();
|
||||
for (PropertySource<?> source : sources) {
|
||||
|
Loading…
Reference in New Issue
Block a user