Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Prevent recursive config props from causing a stack overflow

Browse Source 
Previously, when the configuration properties annotation processor
encountered a property that was the same as an outer type that had
already been processed, it would fail with a stack overflow error.

This commit introduces the use of a stack to track the types that
have been processed. Types that have been seen before are skipped,
thereby preventing a failure from occurring. We do not fail upon
encountering a recursive type to allow metadata generation to
complete. At runtime, the recursive property will not cause a problem
if it is not bound.

Fixes gh-18365
This commit is contained in:
Andy Wilkinson
2019-11-05 14:46:19 +00:00
parent 8b62f448ba
commit 59bc3c5602
3 changed files with 56 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/ConfigurationMetadataAnnotationProcessor.java
View File

@@ -26,6 +26,7 @@ import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.Stack;
import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.ProcessingEnvironment;
@@ -258,8 +259,10 @@ public class ConfigurationMetadataAnnotationProcessor extends AbstractProcessor
Map<String, Object> fieldValues = members.getFieldValues();
processSimpleTypes(prefix, element, source, members, fieldValues);
processSimpleLombokTypes(prefix, element, source, members, fieldValues);
processNestedTypes(prefix, element, source, members);
processNestedLombokTypes(prefix, element, source, members);
Stack<TypeElement> seen = new Stack<>();
seen.push(element);
processNestedTypes(prefix, element, source, members, seen);
processNestedLombokTypes(prefix, element, source, members, seen);
}
private void processSimpleTypes(String prefix, TypeElement element, ExecutableElement source,
@@ -324,19 +327,19 @@ public class ConfigurationMetadataAnnotationProcessor extends AbstractProcessor
}
private void processNestedTypes(String prefix, TypeElement element, ExecutableElement source,
TypeElementMembers members) {
TypeElementMembers members, Stack<TypeElement> seen) {
members.getPublicGetters().forEach((name, getter) -> {
VariableElement field = members.getFields().get(name);
processNestedType(prefix, element, source, name, getter, field, getter.getReturnType());
processNestedType(prefix, element, source, name, getter, field, getter.getReturnType(), seen);
});
}
private void processNestedLombokTypes(String prefix, TypeElement element, ExecutableElement source,
TypeElementMembers members) {
TypeElementMembers members, Stack<TypeElement> seen) {
members.getFields().forEach((name, field) -> {
if (isLombokField(field, element)) {
ExecutableElement getter = members.getPublicGetter(name, field.asType());
processNestedType(prefix, element, source, name, getter, field, field.asType());
processNestedType(prefix, element, source, name, getter, field, field.asType(), seen);
}
});
}
@@ -378,7 +381,7 @@ public class ConfigurationMetadataAnnotationProcessor extends AbstractProcessor
}
private void processNestedType(String prefix, TypeElement element, ExecutableElement source, String name,
ExecutableElement getter, VariableElement field, TypeMirror returnType) {
ExecutableElement getter, VariableElement field, TypeMirror returnType, Stack<TypeElement> seen) {
Element returnElement = this.processingEnv.getTypeUtils().asElement(returnType);
boolean isNested = isNested(returnElement, field, element);
AnnotationMirror annotation = getAnnotation(getter, configurationPropertiesAnnotation());
@@ -387,7 +390,12 @@ public class ConfigurationMetadataAnnotationProcessor extends AbstractProcessor
this.metadataCollector
.add(ItemMetadata.newGroup(nestedPrefix, this.typeUtils.getQualifiedName(returnElement),
this.typeUtils.getQualifiedName(element), (getter != null) ? getter.toString() : null));
processTypeElement(nestedPrefix, (TypeElement) returnElement, source);
TypeElement nestedElement = (TypeElement) returnElement;
if (!seen.contains(nestedElement)) {
seen.push(nestedElement);
processTypeElement(nestedPrefix, nestedElement, source);
seen.pop();
}
}
}