Merge pull request #461 from Netflix/fix-deprecated-usage

Add a config option for adding the deprecated annotation.
Netflix · Sep 1, 2022 · 197ba5e · 197ba5e
2 parents c3f6cd3 + 20c56a6
commit 197ba5e
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 9 deletions.
diff --git a/graphql-dgs-codegen-core/src/main/kotlin/com/netflix/graphql/dgs/codegen/CodeGen.kt b/graphql-dgs-codegen-core/src/main/kotlin/com/netflix/graphql/dgs/codegen/CodeGen.kt
@@ -466,7 +466,8 @@ data class CodeGenConfig(
     val generateCustomAnnotations: Boolean = false,
     var javaGenerateAllConstructor: Boolean = true,
     val implementSerializable: Boolean = false,
-    val addGeneratedAnnotation: Boolean = false
+    val addGeneratedAnnotation: Boolean = false,
+    val addDeprecatedAnnotation: Boolean = false
 ) {
     val packageNameClient: String = "$packageName.$subPackageNameClient"
 

diff --git a/...core/src/main/kotlin/com/netflix/graphql/dgs/codegen/generators/java/DataTypeGenerator.kt b/...core/src/main/kotlin/com/netflix/graphql/dgs/codegen/generators/java/DataTypeGenerator.kt
@@ -189,7 +189,7 @@ abstract class BaseDataTypeGenerator(
                 if (directive.name == ParserConstants.CUSTOM_ANNOTATION && config.generateCustomAnnotations) {
                     annotations.add(customAnnotation(argumentMap, config))
                 }
-                if (directive.name == ParserConstants.DEPRECATED) {
+                if (directive.name == ParserConstants.DEPRECATED && config.addDeprecatedAnnotation) {
                     annotations.add(deprecatedAnnotation())
                     if (argumentMap.containsKey(ParserConstants.REASON)) {
                         val reason: String = (argumentMap[ParserConstants.REASON] as StringValue).value

diff --git a/.../main/kotlin/com/netflix/graphql/dgs/codegen/generators/kotlin/KotlinDataTypeGenerator.kt b/.../main/kotlin/com/netflix/graphql/dgs/codegen/generators/kotlin/KotlinDataTypeGenerator.kt
@@ -158,7 +158,7 @@ abstract class AbstractKotlinDataTypeGenerator(
             if (directive.name == ParserConstants.CUSTOM_ANNOTATION && config.generateCustomAnnotations) {
                 annotations.add(customAnnotation(argumentMap, config))
             }
-            if (directive.name == ParserConstants.DEPRECATED) {
+            if (directive.name == ParserConstants.DEPRECATED && config.addDeprecatedAnnotation) {
                 if (argumentMap.containsKey(ParserConstants.REASON)) {
                     annotations.add(deprecatedAnnotation((argumentMap[ParserConstants.REASON] as StringValue).value))
                 } else {

diff --git a/graphql-dgs-codegen-core/src/test/kotlin/com/netflix/graphql/dgs/codegen/CodeGenTest.kt b/graphql-dgs-codegen-core/src/test/kotlin/com/netflix/graphql/dgs/codegen/CodeGenTest.kt
@@ -2963,7 +2963,8 @@ It takes a title and such.
                 packageName = basePackageName,
                 includeImports = mapOf(Pair("validator", "com.test.validator")),
                 includeEnumImports = mapOf("ValidPerson" to mapOf("types" to "com.enums")),
-                generateCustomAnnotations = true
+                generateCustomAnnotations = true,
+                addDeprecatedAnnotation = true
             )
         ).generate()
 
@@ -3362,7 +3363,8 @@ It takes a title and such.
                     packageName = basePackageName,
                     includeImports = mapOf(Pair("validator", "com.test.validator")),
                     includeEnumImports = mapOf("ValidPerson" to mapOf("types" to "com.enums")),
-                    generateCustomAnnotations = true
+                    generateCustomAnnotations = true,
+                    addDeprecatedAnnotation = true
                 )
             ).generate()
         }
@@ -3382,7 +3384,8 @@ It takes a title and such.
                 packageName = basePackageName,
                 includeImports = mapOf(Pair("validator", "com.test.validator")),
                 includeEnumImports = mapOf("ValidPerson" to mapOf("types" to "com.enums")),
-                generateCustomAnnotations = false
+                generateCustomAnnotations = false,
+                addDeprecatedAnnotation = true
             )
         ).generate()
 

diff --git a/...hql-dgs-codegen-core/src/test/kotlin/com/netflix/graphql/dgs/codegen/KotlinCodeGenTest.kt b/...hql-dgs-codegen-core/src/test/kotlin/com/netflix/graphql/dgs/codegen/KotlinCodeGenTest.kt
@@ -1887,7 +1887,8 @@ class KotlinCodeGenTest {
             CodeGenConfig(
                 schemas = setOf(schema),
                 packageName = basePackageName,
-                language = Language.KOTLIN
+                language = Language.KOTLIN,
+                addDeprecatedAnnotation = true
             )
         ).generate().kotlinDataTypes
 
@@ -2340,7 +2341,8 @@ class KotlinCodeGenTest {
                 CodeGenConfig(
                     schemas = setOf(schema),
                     packageName = basePackageName,
-                    language = Language.KOTLIN
+                    language = Language.KOTLIN,
+                    addDeprecatedAnnotation = true
                 )
             ).generate()
         }
@@ -3241,7 +3243,8 @@ It takes a title and such.
                 includeImports = mapOf(Pair("validator", "com.test.validator")),
                 includeEnumImports = mapOf("ValidPerson" to mapOf("types" to "com.enums")),
                 generateCustomAnnotations = false,
-                generateClientApi = true
+                generateClientApi = true,
+                addDeprecatedAnnotation = true
             )
         ).generate()
 

diff --git a/...codegen-gradle/src/main/kotlin/com/netflix/graphql/dgs/codegen/gradle/GenerateJavaTask.kt b/...codegen-gradle/src/main/kotlin/com/netflix/graphql/dgs/codegen/gradle/GenerateJavaTask.kt
@@ -132,6 +132,9 @@ open class GenerateJavaTask : DefaultTask() {
     @Input
     var addGeneratedAnnotation = false
 
+    @Input
+    var addDeprecatedAnnotation = false
+
     @Input
     var generateCustomAnnotations = false
 
@@ -182,6 +185,7 @@ open class GenerateJavaTask : DefaultTask() {
             snakeCaseConstantNames = snakeCaseConstantNames,
             implementSerializable = implementSerializable,
             addGeneratedAnnotation = addGeneratedAnnotation,
+            addDeprecatedAnnotation = addDeprecatedAnnotation,
             includeImports = includeImports,
             includeEnumImports = includeEnumImports,
             generateCustomAnnotations = generateCustomAnnotations