Skip to content

Commit

Permalink
Update SpringBootJoranConfigurator to use proper GraalVM format
Browse files Browse the repository at this point in the history
Before this commit, the generated name for the inner class had
a wrong format <package>.<parent>.<child> (canonical name).
GraalVM expects $ to separate the parent from the inner class.

This commit updates SpringBootJoranConfigurator to generate
an appropriate format for a class name. Specifically, an inner class
should be separated by a dollar sign, not a dot.

See spring-projectsgh-44016

Signed-off-by: Dmytro Nosan <[email protected]>
  • Loading branch information
nosan committed Jan 30, 2025
1 parent c09c454 commit f6f5e9e
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 10 deletions.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2012-2024 the original author or authors.
* Copyright 2012-2025 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -231,12 +231,12 @@ private Set<Class<? extends Serializable>> serializationTypes(Model model) {
return modelClasses;
}

private Set<String> reflectionTypes(Model model) {
private Set<Class<?>> reflectionTypes(Model model) {
return reflectionTypes(model, () -> null);
}

private Set<String> reflectionTypes(Model model, Supplier<Object> parent) {
Set<String> reflectionTypes = new HashSet<>();
private Set<Class<?>> reflectionTypes(Model model, Supplier<Object> parent) {
Set<Class<?>> reflectionTypes = new HashSet<>();
Class<?> componentType = determineType(model, parent);
if (componentType != null) {
processComponent(componentType, reflectionTypes);
Expand Down Expand Up @@ -306,23 +306,22 @@ private Object instantiate(Class<?> type) {
}
}

private void processComponent(Class<?> componentType, Set<String> reflectionTypes) {
private void processComponent(Class<?> componentType, Set<Class<?>> reflectionTypes) {
BeanDescription beanDescription = this.modelInterpretationContext.getBeanDescriptionCache()
.getBeanDescription(componentType);
reflectionTypes.addAll(parameterTypesNames(beanDescription.getPropertyNameToAdder().values()));
reflectionTypes.addAll(parameterTypesNames(beanDescription.getPropertyNameToSetter().values()));
reflectionTypes.add(componentType.getCanonicalName());
reflectionTypes.add(componentType);
}

private Collection<String> parameterTypesNames(Collection<Method> methods) {
private Collection<Class<?>> parameterTypesNames(Collection<Method> methods) {
return methods.stream()
.filter((method) -> !method.getDeclaringClass().equals(ContextAware.class)
&& !method.getDeclaringClass().equals(ContextAwareBase.class))
.map(Method::getParameterTypes)
.flatMap(Stream::of)
.filter((type) -> !type.isPrimitive() && !type.equals(String.class))
.map((type) -> type.isArray() ? type.getComponentType() : type)
.map(Class::getName)
.toList();
}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2012-2024 the original author or authors.
* Copyright 2012-2025 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -23,6 +23,7 @@
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Properties;
import java.util.function.Consumer;
import java.util.function.Predicate;
Expand Down Expand Up @@ -54,6 +55,7 @@
import org.springframework.aot.hint.MemberCategory;
import org.springframework.aot.hint.RuntimeHints;
import org.springframework.aot.hint.SerializationHints;
import org.springframework.aot.hint.TypeHint;
import org.springframework.aot.hint.TypeReference;
import org.springframework.aot.hint.predicate.RuntimeHintsPredicates;
import org.springframework.aot.test.generate.TestGenerationContext;
Expand Down Expand Up @@ -158,6 +160,11 @@ void componentModelClassAndSetterParametersAreRegisteredForReflection() {
assertThat(invokePublicConstructorsAndInspectAndInvokePublicMethodsOf(
TimeBasedFileNamingAndTriggeringPolicy.class))
.accepts(generationContext.getRuntimeHints());

assertThat(hasValidTypeName(SizeAndTimeBasedRollingPolicy.class)).accepts(generationContext.getRuntimeHints());
assertThat(hasValidTypeName(FileSize.class)).accepts(generationContext.getRuntimeHints());
assertThat(hasValidTypeName(FileAppender.class)).accepts(generationContext.getRuntimeHints());

}

@Test
Expand All @@ -173,6 +180,10 @@ void implicitModelClassAndSetterParametersAreRegisteredForReflection() {
.accepts(generationContext.getRuntimeHints());
assertThat(invokePublicConstructorsAndInspectAndInvokePublicMethodsOf(Charset.class))
.accepts(generationContext.getRuntimeHints());

assertThat(hasValidTypeName(PatternLayoutEncoder.class)).accepts(generationContext.getRuntimeHints());
assertThat(hasValidTypeName(Layout.class)).accepts(generationContext.getRuntimeHints());
assertThat(hasValidTypeName(Charset.class)).accepts(generationContext.getRuntimeHints());
}

@Test
Expand All @@ -186,6 +197,8 @@ void componentModelReferencingImportedClassNameIsRegisteredForReflection() {
TestGenerationContext generationContext = applyContribution(model);
assertThat(invokePublicConstructorsAndInspectAndInvokePublicMethodsOf(SizeAndTimeBasedRollingPolicy.class))
.accepts(generationContext.getRuntimeHints());

assertThat(hasValidTypeName(SizeAndTimeBasedRollingPolicy.class)).accepts(generationContext.getRuntimeHints());
}

@Test
Expand All @@ -200,6 +213,10 @@ void typeFromParentsSetterIsRegisteredForReflection() {
.accepts(generationContext.getRuntimeHints());
assertThat(invokePublicConstructorsAndInspectAndInvokePublicMethodsOf(Implementation.class))
.accepts(generationContext.getRuntimeHints());

assertThat(hasValidTypeName(Outer.class)).accepts(generationContext.getRuntimeHints());
assertThat(hasValidTypeName(Implementation.class)).accepts(generationContext.getRuntimeHints());

}

@Test
Expand All @@ -214,6 +231,13 @@ void typeFromParentsDefaultClassAnnotatedSetterIsRegisteredForReflection() {
.accepts(generationContext.getRuntimeHints());
assertThat(invokePublicConstructorsAndInspectAndInvokePublicMethodsOf(Implementation.class))
.accepts(generationContext.getRuntimeHints());
assertThat(invokePublicConstructorsAndInspectAndInvokePublicMethodsOf(BaseImplementation.Details.class))
.accepts(generationContext.getRuntimeHints());

assertThat(hasValidTypeName(OuterWithDefaultClass.class)).accepts(generationContext.getRuntimeHints());
assertThat(hasValidTypeName(Implementation.class)).accepts(generationContext.getRuntimeHints());
assertThat(hasValidTypeName(BaseImplementation.Details.class)).accepts(generationContext.getRuntimeHints());

}

@Test
Expand All @@ -223,6 +247,10 @@ void componentTypesOfArraysAreRegisteredForReflection() {
TestGenerationContext generationContext = applyContribution(component);
assertThat(invokePublicConstructorsAndInspectAndInvokePublicMethodsOf(InetSocketAddress.class))
.accepts(generationContext.getRuntimeHints());

assertThat(hasValidTypeName(InetSocketAddress.class)).accepts(generationContext.getRuntimeHints());
assertThat(hasValidTypeName(ArrayParameters.class)).accepts(generationContext.getRuntimeHints());

}

@Test
Expand All @@ -235,6 +263,10 @@ void placeholdersInComponentClassAttributeAreReplaced() {
.accepts(generationContext.getRuntimeHints());
assertThat(invokePublicConstructorsAndInspectAndInvokePublicMethodsOf(Implementation.class))
.accepts(generationContext.getRuntimeHints());

assertThat(hasValidTypeName(Outer.class)).accepts(generationContext.getRuntimeHints());
assertThat(hasValidTypeName(Implementation.class)).accepts(generationContext.getRuntimeHints());

}

private Predicate<RuntimeHints> invokePublicConstructorsOf(String name) {
Expand All @@ -250,6 +282,16 @@ private Predicate<RuntimeHints> invokePublicConstructorsAndInspectAndInvokePubli
MemberCategory.INVOKE_PUBLIC_METHODS);
}

private Predicate<RuntimeHints> hasValidTypeName(Class<?> type) {
return (runtimeHints) -> {
String name = Optional.ofNullable(runtimeHints.reflection().getTypeHint(type))
.map(TypeHint::getType)
.map(TypeReference::getName)
.orElse("");
return type.getTypeName().equals(name);
};
}

private Properties load(InputStreamSource source) {
try (InputStream inputStream = source.getInputStream()) {
Properties properties = new Properties();
Expand Down Expand Up @@ -323,7 +365,21 @@ public void setContract(Contract contract) {

}

public static class Implementation implements Contract {
public static class BaseImplementation implements Contract {

private Details details;

public void setDetails(Details details) {
this.details = details;
}

public static final class Details {

}

}

public static class Implementation extends BaseImplementation {

}

Expand Down

0 comments on commit f6f5e9e

Please sign in to comment.