@Validated in @ConfigurationProperties doesn't work when running in native image #6976

KimSeongIl · 2023-07-12T00:05:44Z

Describe the issue

It worked fine on the jvm, but when I run it on the native image I get an error.
But if I remove the Pattern annotation, it works fine.

Why is this issue occurring?
How can I solve this problem?

Steps to reproduce the issue

git clone https://github.com/KimSeongIl/demo.git
nativeCompile
nativeRun

DemoContext.kt

@ConfigurationProperties(prefix = "demo.context")
@Validated
class DemoContext {

    var exclude: List<Exclude> = mutableListOf()

    data class Exclude(
        var url: List<String>? = null,

        var httpMethod: List<HttpMethod>? = null,

        var httpStatus: List<@Pattern(regexp="^([1-5][x|X]{2}|[1-5][0-9]{2})\$") String>? = null,

        var elapsedTime: Long? = null
    )

}

application.yml

demo:
  context:
    exclude:
      - httpStatus: 2xx

nativeRun result

Binding to target [Bindable@517a5ddb type = java.util.List<DemoContext$Exclude>, value = 'provided', annotations = array<Annotation>[[empty]]] failed:

    Property: demo.context.exclude[0].httpstatus
    Value: "2xx"
    Origin: class path resource [application.yml] - 31:21
    Reason: The elements [demo.context.exclude[0].httpstatus] were left unbound.

Action:

Update your application's configuration

Describe GraalVM and your environment

spring boot version: 3.1.0
graalvm plugin version: id("org.graalvm.buildtools.native") version "0.9.20"
graalvm version: 22.3.r17

More details

spring-projects/spring-boot#37101

discussed in the above issue
@sdeleuze said it looks like a graalvm bug.

The text was updated successfully, but these errors were encountered:

vjovanov · 2023-07-16T10:35:18Z

I tried running this app with -H:ThrowMissingRegistrationErrors= -H:MissingRegistrationReportingMode=Warn and I get the following list of missing metadata:

org.graalvm.nativeimage.MissingReflectionRegistrationError: The program tried to reflectively access jakarta.validation.constraints.Pattern.getDeclaredConstructors() without it being registered for runtime reflection. Add it to the reflection metadata to solve this problem. See https://www.graalvm.org/latest/reference-manual/native-image/metadata/#reflection for help.
  [email protected]/java.lang.Class.getDeclaredConstructors(DynamicHub.java:1121)
  kotlin.reflect.jvm.internal.impl.descriptors.runtime.structure.ReflectJavaClass.getConstructors(ReflectJavaClass.kt:96)
  kotlin.reflect.jvm.internal.impl.descriptors.runtime.structure.ReflectJavaClass.getConstructors(ReflectJavaClass.kt:29)
  kotlin.reflect.jvm.internal.impl.load.java.lazy.descriptors.LazyJavaClassMemberScope$constructors$1.invoke(LazyJavaClassMemberScope.kt:84)

Why would these reflective accesses be registered by GraalVM? Have you tried running with the agent to collect reflection metadata?

KimSeongIl · 2023-07-17T01:18:20Z

@RegisterReflectionForBinding(
Pattern::class,
Pattern.Flag::class)

@vjovanov
I added the reflect setting with the annotation as above.

If I add the annotation, the application works but
The pattern rule doesn't work.

vjovanov · 2023-07-17T11:25:33Z

Can you please run the application with the native image agent so we can see all the produced JSON?

KimSeongIl · 2023-07-19T01:43:57Z

@vjovanov
What is a native image agent?

I ran it with nativeCompile and nativeRun in gradle environment.

https://github.com/KimSeongIl/demo/blob/main/build/resources/aot/META-INF/native-image/com.example/demoo/reflect-config.json

Does the produced json say this?

vjovanov · 2023-07-19T06:38:04Z

This should help: https://graalvm.github.io/native-build-tools/latest/gradle-plugin.html#agent-support

KimSeongIl · 2023-07-19T07:20:31Z

@vjovanov

https://github.com/KimSeongIl/demo/blob/main/build/resources/aot/META-INF/native-image/com.example/demoo/reflect-config.json

Isn't the produced json the link above?

./gradlew -Pagent run

If I run

java.lang.IllegalArgumentException: Could not find class [com.demo.search.middle.demo.DemooApplicationKt__ApplicationContextInitializer]

The above error occurs.

vjovanov · 2023-07-19T14:50:19Z

Not sure it is the same file. Does the ./gradlew run work? If no, is it possible to make it work?

KimSeongIl · 2023-07-20T08:05:23Z

@vjovanov
The ./gradlew run command also gives an error for the same reason.

[native-image-plugin] Instrumenting task with the native-image-agent: processAot

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::                (v3.1.0)

2023-07-20T10:14:10.724+09:00 ERROR 82427 --- [           main] o.s.boot.SpringApplication               : Application run failed
java.lang.IllegalArgumentException: Could not find class [com.demo.search.middle.demo.DemooApplicationKt__ApplicationContextInitializer]

am trying to solve it.

@sdeleuze
Is this error caused by Kotlin environment?

KimSeongIl · 2023-07-25T01:16:19Z

@vjovanov

./gradlew run works fine.
Why did you fail before

graalvmNative {

agent {
          enabled.set(true)
   }
}

Because of the above settings, it was run as an agent .

As a result
./gradlew run works, but
./gradlew -Pagent run doesn't work.

[native-image-plugin] Instrumenting task with the native-image-agent: processAot

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::                (v3.1.0)

2023-07-20T10:14:10.724+09:00 ERROR 82427 --- [           main] o.s.boot.SpringApplication               : Application run failed
java.lang.IllegalArgumentException: Could not find class [com.demo.search.middle.demo.DemooApplicationKt__ApplicationContextInitializer]

How to solve above error when there is agent parameter?

sdeleuze · 2023-08-07T08:48:00Z

@KimSeongIl You can use Spring Boot 3.1.2 to fix this error (was a Spring bug I fixed).

Why would these reflective accesses be registered by GraalVM? Have you tried running with the agent to collect reflection metadata?

@vjovanov Let see what the agent says, if the usage of Pattern.Flag is due to Pattern instantiation, I agree GraalVM can't guess it automatically and maybe we need to refine Spring Hibernate Validator algorithm. But let's fully analyze this from a pure GraalVM perspective to be sure.

KimSeongIl · 2023-08-08T00:01:00Z

@sdeleuze

Thank you for answer. 😁

https://github.com/KimSeongIl/demo

However, upgrading the spring boot version to 3.1.2 does not change anything.
Are additional code modifications required?

https://github.com/spring-projects/spring-boot/releases/tag/v3.1.2

Where in the release notes are the bugfixes related?

sdeleuze · 2023-08-10T09:36:13Z

@KimSeongIl I meant to fix the java.lang.IllegalArgumentException: Could not find class [com.demo.search.middle.demo.DemooApplicationKt__ApplicationContextInitializer] error with the agent. With Spring Boot 3.1.2, you can now run ./gradlew -Pagent run (I just tried) and provide a feedback to @vjovanov on the generated metadata.

KimSeongIl · 2023-08-11T05:42:51Z

@sdeleuze
I understand. Thanks. 😁

https://github.com/KimSeongIl/demo/tree/main/src/main/resources/META-INF/native-image

@vjovanov

./gradlew -Pagent run

./gradlew metadataCopy --task run --dir src/main/resources/META-INF/native-image

./gradlew nativeCompile

./gradlew nativeRun

After running these commands, it works as expected.

Why do I have to go through that process?

@sdeleuze

Is it normal to have to go through that process?

https://docs.spring.io/spring-boot/docs/current/reference/html/native-image.html#native-image.developing-your-first-application.native-build-tools.gradle

I couldn't find it in spring documentation.

sdeleuze · 2023-08-17T07:47:04Z

@KimSeongIl When the bug will be fixed either on GraalVM or Spring side, this "dance" won't be needed anymore, but for now yes that's what I would expect when you need to use the agent. Looks reasonable to me this is documented on GraalVM side as there is no Spring specific here (we may add a note later).

@vjovanov Could you please check the agent output and let me know if you see something that GraalVM could fix or if you think I should take care of that on Spring side (I will have a deeper look after your feedback)?

KimSeongIl · 2023-08-22T23:21:18Z

@vjovanov @loicottet

Can you please answer this issue?

vjovanov · 2023-08-24T10:06:34Z

The relevant metadata is:

{
  "name":"jakarta.validation.constraints.Pattern",
  "allDeclaredClasses":true,
  "queryAllDeclaredMethods":true,
  "queryAllDeclaredConstructors":true,
  "methods":[
    {"name":"flags","parameterTypes":[] }, 
    {"name":"groups","parameterTypes":[] }, 
    {"name":"message","parameterTypes":[] }, 
    {"name":"payload","parameterTypes":[] }, 
    {"name":"regexp","parameterTypes":[] }
  ]
},
{
  "name":"jakarta.validation.constraints.Pattern$Flag"
},

I do not see how GraalVM can prove this automatically. The proper fix would be for the framework that uses these flags to add the metadata into the jar.

Until that happens, the workaround is to keep the config in your project.

sdeleuze · 2023-08-24T13:04:09Z

Ok let's go back on Spring side for this one -> spring-projects/spring-boot#37101.

KimSeongIl added the bug label Jul 12, 2023

sdeleuze mentioned this issue Jul 14, 2023

@Validated in @ConfigurationProperties doesn't work when running in native image #6975

Closed

vjovanov assigned loicottet and vjovanov Jul 16, 2023

sdeleuze closed this as not planned Won't fix, can't repro, duplicate, stale Aug 24, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

@Validated in @ConfigurationProperties doesn't work when running in native image #6976

@Validated in @ConfigurationProperties doesn't work when running in native image #6976

KimSeongIl commented Jul 12, 2023

vjovanov commented Jul 16, 2023 •

edited

Loading

KimSeongIl commented Jul 17, 2023 •

edited

Loading

vjovanov commented Jul 17, 2023

KimSeongIl commented Jul 19, 2023 •

edited

Loading

vjovanov commented Jul 19, 2023

KimSeongIl commented Jul 19, 2023

vjovanov commented Jul 19, 2023

KimSeongIl commented Jul 20, 2023

KimSeongIl commented Jul 25, 2023

sdeleuze commented Aug 7, 2023 •

edited

Loading

KimSeongIl commented Aug 8, 2023

sdeleuze commented Aug 10, 2023

KimSeongIl commented Aug 11, 2023 •

edited

Loading

sdeleuze commented Aug 17, 2023

KimSeongIl commented Aug 22, 2023

vjovanov commented Aug 24, 2023

sdeleuze commented Aug 24, 2023

@Validated in @ConfigurationProperties doesn't work when running in native image #6976

@Validated in @ConfigurationProperties doesn't work when running in native image #6976

Comments

KimSeongIl commented Jul 12, 2023

vjovanov commented Jul 16, 2023 • edited Loading

KimSeongIl commented Jul 17, 2023 • edited Loading

vjovanov commented Jul 17, 2023

KimSeongIl commented Jul 19, 2023 • edited Loading

vjovanov commented Jul 19, 2023

KimSeongIl commented Jul 19, 2023

vjovanov commented Jul 19, 2023

KimSeongIl commented Jul 20, 2023

KimSeongIl commented Jul 25, 2023

sdeleuze commented Aug 7, 2023 • edited Loading

KimSeongIl commented Aug 8, 2023

sdeleuze commented Aug 10, 2023

KimSeongIl commented Aug 11, 2023 • edited Loading

sdeleuze commented Aug 17, 2023

KimSeongIl commented Aug 22, 2023

vjovanov commented Aug 24, 2023

sdeleuze commented Aug 24, 2023

vjovanov commented Jul 16, 2023 •

edited

Loading

KimSeongIl commented Jul 17, 2023 •

edited

Loading

KimSeongIl commented Jul 19, 2023 •

edited

Loading

sdeleuze commented Aug 7, 2023 •

edited

Loading

KimSeongIl commented Aug 11, 2023 •

edited

Loading