Configuration Metadata for Actuator endpoints do not take Nullness into account #46854
Conversation
Update MetadataGenerationEnvironment#getAnnotation to also inspect type-use annotations (element.asType().getAnnotationMirrors()) in addition to declaration annotations. This ensures that @nullable on method parameter types is correctly detected when generating configuration metadata for Actuator endpoints. Previously, parameters annotated with @nullable in TYPE_USE position could be missed, causing them to be marked as required in metadata. With this change, both declaration-level and type-use @nullable annotations are recognized. No new dependencies are introduced, and existing public APIs remain unchanged. Signed-off-by: wonyongg <[email protected]>
spring-projects-issues
added
the
status: waiting-for-triage
|
Thanks for the PR.
How do you know? Without additional tests that validates this is taken into account in the same way as |
snicoll
added
the
status: waiting-for-feedback
- Add NullableParameterEndpoint test sample with @nullable parameter - Add OptionalParameterEndpoint test sample for comparison - Add test to verify @nullable and @OptionalParameter are treated equivalently - Ensures TYPE_USE annotation detection works correctly for optional parameters Signed-off-by: wonyongg <[email protected]>
|
Thanks for the feedback! I've added comprehensive tests that validate the @nullable annotation detection works correctly for Actuator endpoint parameters. The tests include:
These tests demonstrate that the updated getAnnotation method correctly detects @nullable annotations on method parameters, ensuring they are treated the same as @OptionalParameter annotations when determining if a parameter is optional. This validates the core fix in the PR where TYPE_USE annotations are now properly discovered. |
spring-projects-issues
added
status: feedback-provided
...st/java/org/springframework/boot/configurationsample/endpoint/NullableParameterEndpoint.java
Outdated
Show resolved
Hide resolved
...ata/spring-boot-configuration-processor/src/test/java/org/springframework/lang/Nullable.java
Outdated
Show resolved
Hide resolved
snicoll
added
status: waiting-for-feedback
- Switch tests to org.jspecify.annotations.Nullable and remove local org.springframework.lang.Nullable - Recognize both org.springframework.lang.Nullable and org.jspecify.annotations.Nullable as optional in the processor (backward compatible) - Add org.jspecify:jspecify as testCompileOnly (no runtime impact) Signed-off-by: wonyongg <[email protected]>
|
Thanks for the review. I’ve updated the tests to use org.jspecify.annotations.Nullable and removed the local org.springframework.lang.Nullable. I also added org.jspecify:jspecify as testCompileOnly to avoid any runtime impact. If you’d prefer a different direction (recognizing only JSpecify, keeping the processor unchanged and limiting this PR to tests, or splitting the changes), I’m happy to adjust. |
spring-projects-issues
added
status: feedback-provided
snicoll
changed the title
This commit expands the detection of optional parameters for Actuator Endpoints. Before this commit, JSpecify's `@Nullable` annotation was not detected. See gh-46854 Signed-off-by: wonyongg <[email protected]>
snicoll
added
type: bug
Update
MetadataGenerationEnvironment#getAnnotationto also inspect type-use annotations (element.asType().getAnnotationMirrors()) in addition to declaration annotations. This ensures that@Nullableon method parameter types is correctly detected when generating configuration metadata for Actuator endpoints.Previously, parameters annotated with
@Nullablein TYPE_USE position could be missed, causing them to be marked as required in metadata. With this change, both declaration-level and type-use@Nullableannotations are recognized.No new dependencies are introduced, and existing public APIs remain unchanged.
This pull request addresses the issue described in #46837.
Future improvement:
Currently, the processor only looks for
org.springframework.lang.Nullable. If there is interest, we could follow up with a small, separate PR to support additional well-known@Nullableannotations (e.g.org.jspecify.annotations.Nullable,javax.annotation.Nullable).