Handle an empty query parameter with @Default #5534
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- if the type of the parameter is primitive, throw exception - if the type of the parameter is collection, empty collection - add test cases
ikhoon
reviewed
Mar 27, 2024
| @@ -86,7 +86,11 @@ class AnnotatedValueResolverTest { | |||
| static final Set<String> existingHttpParameters = ImmutableSet.of("param1", | |||
| "enum1", | |||
| "sensitive"); | |||
|
|
|||
| // These parameters will be present without the values. e.g., ?emptyParam1=&emptyParam2=&... | |||
| static final Set<String> existingWithoutValueParameters = ImmutableSet.of("emptyParam1", | |||
There was a problem hiding this comment.
Should we also add an e2e test in which a client sends a query parameter with a value or an empty value? EmptyParameterWithDefaultAnnotationTest could be added for that.
| @@ -1026,6 +1031,17 @@ private Object convert(@Nullable String value) { | |||
| if (value == null) { | |||
| return defaultOrException(); | |||
| } | |||
| if (value.isEmpty()) { | |||
| logger.warn("Parameter is present but the value is missing: " + httpElementName); | |||
There was a problem hiding this comment.
As it is an expected behavior, we can remove the warning.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5534 +/- ##
===========================================
+ Coverage 0 74.08% +74.08%
- Complexity 0 20982 +20982
===========================================
Files 0 1819 +1819
Lines 0 77315 +77315
Branches 0 9881 +9881
===========================================
+ Hits 0 57282 +57282
- Misses 0 15378 +15378
- Partials 0 4655 +4655 ☔ View full report in Codecov by Sentry. |
ikhoon
approved these changes
Apr 2, 2024
...com/linecorp/armeria/internal/server/annotation/EmptyParameterWithDefaultAnnotationTest.java
Show resolved
Hide resolved
jrhee17
approved these changes
Apr 3, 2024
...com/linecorp/armeria/internal/server/annotation/EmptyParameterWithDefaultAnnotationTest.java
Show resolved
Hide resolved
core/src/main/java/com/linecorp/armeria/server/annotation/Default.java
Outdated
Show resolved
Hide resolved
Co-authored-by: jrhee17 <guins_j@guins.org>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation:
Say we have an annotated service that uses
@Defaultannotation to optionally bind query parameters.It does not inject
nullif there is a parameter but no value. A NumberFormatException is raised when/list?page=is sent as the request path.It would be better to solve this problem as follows the value of the parameter is empty.
Modifications:
""if the type of the parameter isStringnullif the type of the parameter is notStringsuch asInteger,Booleanand so onIllegalArgumentExceptionif the type of the parameter is primitive type[]if the type of the parameter isListorSetResult:
@Default#5515.