Fix a bug where duplicate parameters are shown in DocService #4645
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
Motivation:
When an annotation is applied to Kotlin data class,
Kotlin compiler constructor parameters with the annotation and
add the fields as well.
```kt
data class ExampleQueries(
@param
val application: String,
@param
val topic: String,
@param
val group: String,
)
```
Annotated services extracts both the fields from the constructor and
fields using reflection. The problem was reported by line#3454 and fixed by line#3461.
Howerver, there is a bug in detect duplicate.
See for the detail. line#3454 (comment)
Modifications:
- Check both `httpElementName` and `anntationType()` if they are not
equal to provide a consistent comparision.
Result:
You no longer see duplicate parameters in `DocService` when
parameter annotations for a request object are added to Kotlin data class.
jrhee17
reviewed
Feb 3, 2023
kotlin/src/test/kotlin/com/linecorp/armeria/server/kotlin/DataClassDocServiceTest.kt
Outdated
Show resolved
Hide resolved
kotlin/src/test/kotlin/com/linecorp/armeria/server/kotlin/DataClassDocServiceTest.kt
Outdated
Show resolved
Hide resolved
Comment on lines
127
to
128
| o1Name += o1.annotationType().getName(); | ||
| o2Name += o2.annotationType().getName(); |
There was a problem hiding this comment.
It seems like o1.annotationType() can be null
minwoox
reviewed
Feb 7, 2023
.../main/java/com/linecorp/armeria/internal/server/annotation/AnnotatedBeanFactoryRegistry.java
Outdated
Show resolved
Hide resolved
.../main/java/com/linecorp/armeria/internal/server/annotation/AnnotatedBeanFactoryRegistry.java
Show resolved
Hide resolved
minwoox
approved these changes
Feb 7, 2023
jrhee17
approved these changes
Feb 8, 2023
There was a problem hiding this comment.
Thanks @ikhoon ! 🙇 👍 🚀 (and @KarboniteKream who reported the issue 🙇 🙇 🙇 )
.../main/java/com/linecorp/armeria/internal/server/annotation/AnnotatedBeanFactoryRegistry.java
Show resolved
Hide resolved
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:
When an annotation is applied to Kotlin data class, Kotlin compiler constructor parameters with the annotation and adds the fields as well.
Annotated services extract both the fields from the constructor and fields using reflection. The problem was reported by #3454 and fixed by #3461. However, there is a bug in detecting duplicates.
See for the detail. #3454 (comment)
Modifications:
httpElementNameandanntationType()if they are not equal to provide a consistent comparison.Result:
You no longer see duplicate parameters in
DocServicewhen parameter annotations for a request object are added to Kotlin data class.