fix: duplicated description annotation on union fields (#25)

ExpediaGroup · Apr 3, 2024 · f1f0894 · f1f0894
1 parent 78a7316
commit f1f0894
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 1 deletion.
diff --git a/src/helpers/build-directive-annotations.ts b/src/helpers/build-directive-annotations.ts
@@ -39,6 +39,9 @@ export function buildDirectiveAnnotations(
           deprecatedReasonNode?.kind === "StringValue"
             ? deprecatedReasonNode.value
             : "";
+        if (incomingNode.description?.value && resolvedType?.unionAnnotation) {
+          return "";
+        }
         const descriptionAnnotator = resolvedType?.unionAnnotation
           ? "@GraphQLDescription"
           : "@Deprecated";

diff --git a/test/unit/should_annotate_types_properly/expected.kt b/test/unit/should_annotate_types_properly/expected.kt
@@ -22,7 +22,10 @@ data class MyType(
     val deprecated5: Any? = null,
     @MyUnion
     @GraphQLDescription("It uses the GraphQLDescription annotation for union types")
-    val deprecated6: Any? = null
+    val deprecated6: Any? = null,
+    @MyUnion
+    @GraphQLDescription("When there is a description")
+    val deprecated7: Any? = null
 )
 
 @GraphQLUnion(

diff --git a/test/unit/should_annotate_types_properly/schema.graphql b/test/unit/should_annotate_types_properly/schema.graphql
@@ -24,6 +24,9 @@ type MyType {
     @deprecated(
       reason: "It uses the GraphQLDescription annotation for union types"
     )
+  "When there is a description"
+  deprecated7: MyUnion
+    @deprecated(reason: "It omits the @Deprecated annotation for now")
 }
 
 union MyUnion = MyType