Fix annotation array args with annotation elements #858
Conversation
This file contains hidden or 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
Previously, getAttributesCode() did not correctly handle annotation
instances inside annotation array parameters. For example, given:
annotation class AnnotationC(val s: String)
annotation class AnnotationD(
val s: Array<AnnotationC>
)
interface API {
@get("/")
@AnnotationD(s = [AnnotationC(s = "foo")])
fun test()
}
Ktorfit would produce an _APIImpl class with the following code:
attributes.put(annotationsAttributeKey, listOf(
AnnotationD(s = arrayOf(@com.example.AnnotationC(s = "foo"))),
))
Note the syntax error: when an annotation is used as a value (not as an
annotation on a declaration), the leading '@' should be omitted.
Actually, in KotlinPoet, this kind of value could be generated by using
AnnotationSpec.emit(..., asParameter = true)
or
CodeWriter.emitCode(..., isConstantContext = true)
However, none of those APIs are public.
As a workaround, this patch generates the code for the whole
AnnotationSpec and removes the prefixed '@', which is the simplest
solution I can find.
|
Add a test case for this |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Previously,
getAttributesCode()did not correctly handle annotation instances inside annotation array parameters. For example, given:Ktorfit would produce an
_APIImplclass with the following code:Note the syntax error: when an annotation is used as a value (not as an annotation on a declaration), the leading
@should be omitted.Actually, in KotlinPoet, this kind of value could be generated by using
or
However, none of those APIs are public. 😢
As a workaround, this patch generates the code for the whole AnnotationSpec and removes the prefixed
@, which is the simplest solution I can find.🤔 DOD Checklist