Support @deprecated directives without a reason attribute #711
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
rveguilla
changed the title
Emily
approved these changes
Jul 9, 2024
| @@ -2780,23 +2780,37 @@ class KotlinCodeGenTest { | |||
| } | |||
|
|
|||
| @Test | |||
| fun deprecateAnnotationWithNoMesssage() { | |||
| fun deprecateAnnotationWithNoReason() { | |||
There was a problem hiding this comment.
Nit: since we're changing it anyway, can we change it to be correct (there is a reason in this test case).
There was a problem hiding this comment.
I will make it correct by removing the reason attribute so that its missing from both deprecated directives. And for consistency, I will also update the corresponding test in CodeGenTest to test for the same scenario.
kilink
reviewed
Jul 9, 2024
| @@ -46,7 +46,7 @@ fun applyDirectivesKotlin(directives: List<Directive>, config: CodeGenConfig): M | |||
| if (argumentMap.containsKey(ParserConstants.REASON)) { | |||
| annotations.add(deprecatedAnnotation((argumentMap[ParserConstants.REASON] as StringValue).value)) | |||
| } else { | |||
| throw IllegalArgumentException("Deprecated requires an argument `${ParserConstants.REASON}`") | |||
| annotations.add(deprecatedAnnotation("Deprecated.")) | |||
There was a problem hiding this comment.
I think a String like "Deprecated in GraphQL schema" might be a bit better.
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.
This PR changes how the code generator handle schema
@deprecateddirectives that are missing thereasonattribute. The existing behavior was to throw an exception, which results in broken builds. The new behavior is to default to an empty comment when generating Java code and to default to a "Deprecated." message when generating Kotlin@deprecatedannotations.