feat(client): update jackson client generation to always annotate all…

… fields (#1976) ### 📝 Description Update Jackson client generation logic to always annotate all fields with @get:JsonProperty. This is a workaround to Jackson limitations due to its reliance on reflections to find getters/setters following JavaBean naming conventions. Simple mutation: ``` graphql mutation CreateIssuedInvoice($input: IssuedInvoiceInput!) { CreateIssuedInvoice(IssuedInvoice: $input) { ID Stav CisloDokladu } } ``` Genarated before change: ```kotlin public const val CREATE_ISSUED_INVOICE: String = "mutation CreateIssuedInvoice(${'$'}input: IssuedInvoiceInput!) {\n CreateIssuedInvoice(IssuedInvoice: ${'$'}input) {\n ID\n Stav\n CisloDokladu\n }\n}" @generated public class CreateIssuedInvoice( override val variables: CreateIssuedInvoice.Variables, ) : GraphQLClientRequest<CreateIssuedInvoice.Result> { override val query: String = CREATE_ISSUED_INVOICE override val operationName: String = "CreateIssuedInvoice" override fun responseType(): KClass<CreateIssuedInvoice.Result> = CreateIssuedInvoice.Result::class @generated public data class Variables( @get:JsonProperty(value = "input") public val input: IssuedInvoiceInput, ) /** * Dotazy pro zápis, editaci a mazání S5 objektů */ @generated public data class Result( /** * Faktura vydaná (zápis) */ public val CreateIssuedInvoice: IssuedInvoice? = null, ) } ``` Genareted after change: ```kotlin public const val CREATE_ISSUED_INVOICE: String = "mutation CreateIssuedInvoice(${'$'}input: IssuedInvoiceInput!) {\n CreateIssuedInvoice(IssuedInvoice: ${'$'}input) {\n ID\n Stav\n CisloDokladu\n }\n}" @generated public class CreateIssuedInvoice( override val variables: CreateIssuedInvoice.Variables, ) : GraphQLClientRequest<CreateIssuedInvoice.Result> { override val query: String = CREATE_ISSUED_INVOICE override val operationName: String = "CreateIssuedInvoice" override fun responseType(): KClass<CreateIssuedInvoice.Result> = CreateIssuedInvoice.Result::class @generated public data class Variables( @get:JsonProperty(value = "input") public val input: IssuedInvoiceInput, ) /** * Dotazy pro zápis, editaci a mazání S5 objektů */ @generated public data class Result( /** * Faktura vydaná (zápis) */ @get:JsonProperty("CreateIssuedInvoice") public val CreateIssuedInvoice: IssuedInvoice? = null, ) } ``` data class IssuedInvoice **before** change: ```kotlin @generated public data class IssuedInvoice( /** * ID */ @JsonSerialize(converter = UUIDToAnyConverter::class) @JsonDeserialize(converter = AnyToUUIDConverter::class) public val ID: UUID? = null, /** * Stav */ public val Stav: Int? = null, /** * Číslo dokladu */ public val CisloDokladu: String? = null, ) ``` data class IssuedInvoice **after** change: ```kotlin @generated public data class IssuedInvoice( /** * ID */ @JsonSerialize(converter = UUIDToAnyConverter::class) @JsonDeserialize(converter = AnyToUUIDConverter::class) @get:JsonProperty("ID") public val ID: UUID? = null, /** * Stav */ @get:JsonProperty("Stav") public val Stav: Int? = null, /** * Číslo dokladu */ @get:JsonProperty("CisloDokladu") public val CisloDokladu: String? = null, ) ``` ### 🔗 Related Issues https://kotlinlang.slack.com/archives/CQLNT7B29/p1717655752084109
ExpediaGroup · Jun 13, 2024 · 60879c5 · 60879c5
1 parent bce5bc4
commit 60879c5
Show file tree

Hide file tree

Showing 85 changed files with 303 additions and 0 deletions.
diff --git a/...in/kotlin/com/expediagroup/graphql/plugin/client/generator/types/generatePropertySpecs.kt b/...in/kotlin/com/expediagroup/graphql/plugin/client/generator/types/generatePropertySpecs.kt
@@ -17,10 +17,12 @@
 package com.expediagroup.graphql.plugin.client.generator.types
 
 import com.expediagroup.graphql.plugin.client.generator.GraphQLClientGeneratorContext
+import com.expediagroup.graphql.plugin.client.generator.GraphQLSerializer
 import com.expediagroup.graphql.plugin.client.generator.ScalarConverterInfo
 import com.expediagroup.graphql.plugin.client.generator.exceptions.DeprecatedFieldsSelectedException
 import com.expediagroup.graphql.plugin.client.generator.exceptions.InvalidSelectionSetException
 import com.expediagroup.graphql.plugin.client.generator.exceptions.MissingArgumentException
+import com.fasterxml.jackson.annotation.JsonProperty
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize
 import com.fasterxml.jackson.databind.annotation.JsonSerialize
 import com.squareup.kotlinpoet.AnnotationSpec
@@ -96,6 +98,16 @@ internal fun generatePropertySpecs(
         fieldDefinition.description?.content?.let { kdoc ->
             propertySpecBuilder.addKdoc("%L", kdoc)
         }
+        if (context.serializer == GraphQLSerializer.JACKSON) {
+            // always add @get:JsonProperty annotation as a workaround to Jackson limitations
+            // related to JavaBean naming conventions
+            propertySpecBuilder.addAnnotation(
+                AnnotationSpec.builder(JsonProperty::class)
+                    .useSiteTarget(AnnotationSpec.UseSiteTarget.GET)
+                    .addMember("value = \"$fieldName\"")
+                    .build()
+            )
+        }
         propertySpecBuilder.build()
     }
 

diff --git a/plugins/client/graphql-kotlin-client-generator/src/test/data/generator/alias/AliasQuery.kt b/plugins/client/graphql-kotlin-client-generator/src/test/data/generator/alias/AliasQuery.kt
@@ -2,6 +2,7 @@ package com.expediagroup.graphql.generated
 
 import com.expediagroup.graphql.client.Generated
 import com.expediagroup.graphql.client.types.GraphQLClientRequest
+import com.fasterxml.jackson.`annotation`.JsonProperty
 import kotlin.Boolean
 import kotlin.String
 import kotlin.reflect.KClass
@@ -22,10 +23,12 @@ public class AliasQuery : GraphQLClientRequest<AliasQuery.Result> {
     /**
      * Query that accepts some input arguments
      */
+    @get:JsonProperty(value = "first")
     public val first: Boolean,
     /**
      * Query that accepts some input arguments
      */
+    @get:JsonProperty(value = "second")
     public val second: Boolean,
   )
 }
diff --git a/.../graphql-kotlin-client-generator/src/test/data/generator/alias_nested/AliasNestedQuery.kt b/.../graphql-kotlin-client-generator/src/test/data/generator/alias_nested/AliasNestedQuery.kt
@@ -4,6 +4,7 @@ import com.expediagroup.graphql.client.Generated
 import com.expediagroup.graphql.client.types.GraphQLClientRequest
 import com.expediagroup.graphql.generated.aliasnestedquery.ComplexObject
 import com.expediagroup.graphql.generated.aliasnestedquery.ComplexObject2
+import com.fasterxml.jackson.`annotation`.JsonProperty
 import kotlin.String
 import kotlin.reflect.KClass
 
@@ -23,10 +24,12 @@ public class AliasNestedQuery : GraphQLClientRequest<AliasNestedQuery.Result> {
     /**
      * Query returning an object that references another object
      */
+    @get:JsonProperty(value = "first")
     public val first: ComplexObject,
     /**
      * Query returning an object that references another object
      */
+    @get:JsonProperty(value = "second")
     public val second: ComplexObject2,
   )
 }
diff --git a/...n-client-generator/src/test/data/generator/alias_nested/aliasnestedquery/ComplexObject.kt b/...n-client-generator/src/test/data/generator/alias_nested/aliasnestedquery/ComplexObject.kt
@@ -1,6 +1,7 @@
 package com.expediagroup.graphql.generated.aliasnestedquery
 
 import com.expediagroup.graphql.client.Generated
+import com.fasterxml.jackson.`annotation`.JsonProperty
 import kotlin.String
 
 /**
@@ -13,5 +14,6 @@ public data class ComplexObject(
   /**
    * Some object name
    */
+  @get:JsonProperty(value = "nameA")
   public val nameA: String,
 )
diff --git a/...-client-generator/src/test/data/generator/alias_nested/aliasnestedquery/ComplexObject2.kt b/...-client-generator/src/test/data/generator/alias_nested/aliasnestedquery/ComplexObject2.kt
@@ -1,6 +1,7 @@
 package com.expediagroup.graphql.generated.aliasnestedquery
 
 import com.expediagroup.graphql.client.Generated
+import com.fasterxml.jackson.`annotation`.JsonProperty
 import kotlin.String
 
 /**
@@ -13,5 +14,6 @@ public data class ComplexObject2(
   /**
    * Some object name
    */
+  @get:JsonProperty(value = "nameB")
   public val nameB: String,
 )
diff --git a/...aphql-kotlin-client-generator/src/test/data/generator/documentation/DocumentationQuery.kt b/...aphql-kotlin-client-generator/src/test/data/generator/documentation/DocumentationQuery.kt
@@ -3,6 +3,7 @@ package com.expediagroup.graphql.generated
 import com.expediagroup.graphql.client.Generated
 import com.expediagroup.graphql.client.types.GraphQLClientRequest
 import com.expediagroup.graphql.generated.documentationquery.DocObject
+import com.fasterxml.jackson.`annotation`.JsonProperty
 import kotlin.String
 import kotlin.reflect.KClass
 
@@ -22,6 +23,7 @@ public class DocumentationQuery : GraphQLClientRequest<DocumentationQuery.Result
     /**
      * Query to test doc strings
      */
+    @get:JsonProperty(value = "docQuery")
     public val docQuery: DocObject,
   )
 }
diff --git a/...in-client-generator/src/test/data/generator/documentation/documentationquery/DocObject.kt b/...in-client-generator/src/test/data/generator/documentation/documentationquery/DocObject.kt
@@ -1,6 +1,7 @@
 package com.expediagroup.graphql.generated.documentationquery
 
 import com.expediagroup.graphql.client.Generated
+import com.fasterxml.jackson.`annotation`.JsonProperty
 import kotlin.Int
 
 /**
@@ -11,5 +12,6 @@ public data class DocObject(
   /**
    * An id with a comment containing % and $ as well
    */
+  @get:JsonProperty(value = "id")
   public val id: Int,
 )
diff --git a/...t-generator/src/test/data/generator/include_skip_directives/IncludeSkipDirectivesQuery.kt b/...t-generator/src/test/data/generator/include_skip_directives/IncludeSkipDirectivesQuery.kt
@@ -36,10 +36,12 @@ public class IncludeSkipDirectivesQuery(
     /**
      * Query that returns enum value
      */
+    @get:JsonProperty(value = "enumQuery")
     public val enumQuery: CustomEnum? = null,
     /**
      * Query that returns wrapper object with all supported scalar types
      */
+    @get:JsonProperty(value = "scalarQuery")
     public val scalarQuery: ScalarWrapper? = null,
   )
 }
diff --git a/...c/test/data/generator/include_skip_directives/includeskipdirectivesquery/ScalarWrapper.kt b/...c/test/data/generator/include_skip_directives/includeskipdirectivesquery/ScalarWrapper.kt
@@ -1,6 +1,7 @@
 package com.expediagroup.graphql.generated.includeskipdirectivesquery
 
 import com.expediagroup.graphql.client.Generated
+import com.fasterxml.jackson.`annotation`.JsonProperty
 import kotlin.Int
 
 /**
@@ -11,5 +12,6 @@ public data class ScalarWrapper(
   /**
    * A signed 32-bit nullable integer value
    */
+  @get:JsonProperty(value = "count")
   public val count: Int? = null,
 )
diff --git a/...l-kotlin-client-generator/src/test/data/generator/input_hard_coded/HardCodedInputQuery.kt b/...l-kotlin-client-generator/src/test/data/generator/input_hard_coded/HardCodedInputQuery.kt
@@ -2,6 +2,7 @@ package com.expediagroup.graphql.generated
 
 import com.expediagroup.graphql.client.Generated
 import com.expediagroup.graphql.client.types.GraphQLClientRequest
+import com.fasterxml.jackson.`annotation`.JsonProperty
 import kotlin.Boolean
 import kotlin.String
 import kotlin.reflect.KClass
@@ -23,6 +24,7 @@ public class HardCodedInputQuery : GraphQLClientRequest<HardCodedInputQuery.Resu
     /**
      * Query that accepts some input arguments
      */
+    @get:JsonProperty(value = "inputObjectQuery")
     public val inputObjectQuery: Boolean,
   )
 }
diff --git a/...ent/graphql-kotlin-client-generator/src/test/data/generator/input_lists/InputListQuery.kt b/...ent/graphql-kotlin-client-generator/src/test/data/generator/input_lists/InputListQuery.kt
@@ -35,6 +35,7 @@ public class InputListQuery(
     /**
      * Query accepting list input
      */
+    @get:JsonProperty(value = "listInputQuery")
     public val listInputQuery: String? = null,
   )
 }
diff --git a/...lient-generator/src/test/data/generator/input_self_reference/SelfReferencingInputQuery.kt b/...lient-generator/src/test/data/generator/input_self_reference/SelfReferencingInputQuery.kt
@@ -33,6 +33,7 @@ public class SelfReferencingInputQuery(
     /**
      * Query that accepts self referencing input object
      */
+    @get:JsonProperty(value = "complexInputObjectQuery")
     public val complexInputObjectQuery: Boolean,
   )
 }
diff --git a/...rator/src/test/data/generator/interface_diff_selection_sets/DifferentSelectionSetQuery.kt b/...rator/src/test/data/generator/interface_diff_selection_sets/DifferentSelectionSetQuery.kt
@@ -4,6 +4,7 @@ import com.expediagroup.graphql.client.Generated
 import com.expediagroup.graphql.client.types.GraphQLClientRequest
 import com.expediagroup.graphql.generated.differentselectionsetquery.BasicInterface
 import com.expediagroup.graphql.generated.differentselectionsetquery.BasicInterface2
+import com.fasterxml.jackson.`annotation`.JsonProperty
 import kotlin.String
 import kotlin.reflect.KClass
 
@@ -24,10 +25,12 @@ public class DifferentSelectionSetQuery : GraphQLClientRequest<DifferentSelectio
     /**
      * Query returning an interface
      */
+    @get:JsonProperty(value = "first")
     public val first: BasicInterface,
     /**
      * Query returning an interface
      */
+    @get:JsonProperty(value = "second")
     public val second: BasicInterface2,
   )
 }
diff --git a/...data/generator/interface_diff_selection_sets/differentselectionsetquery/BasicInterface.kt b/...data/generator/interface_diff_selection_sets/differentselectionsetquery/BasicInterface.kt
@@ -1,6 +1,7 @@
 package com.expediagroup.graphql.generated.differentselectionsetquery
 
 import com.expediagroup.graphql.client.Generated
+import com.fasterxml.jackson.`annotation`.JsonProperty
 import com.fasterxml.jackson.`annotation`.JsonSubTypes
 import com.fasterxml.jackson.`annotation`.JsonTypeInfo
 import com.fasterxml.jackson.`annotation`.JsonTypeInfo.As.PROPERTY
@@ -27,11 +28,13 @@ public interface BasicInterface {
   /**
    * Unique identifier of an interface
    */
+  @get:JsonProperty(value = "id")
   public val id: Int
 
   /**
    * Name field
    */
+  @get:JsonProperty(value = "name")
   public val name: String
 }
 
@@ -43,14 +46,17 @@ public data class FirstInterfaceImplementation(
   /**
    * Unique identifier of the first implementation
    */
+  @get:JsonProperty(value = "id")
   override val id: Int,
   /**
    * Name of the first implementation
    */
+  @get:JsonProperty(value = "name")
   override val name: String,
   /**
    * Custom field integer value
    */
+  @get:JsonProperty(value = "intValue")
   public val intValue: Int,
 ) : BasicInterface
 
@@ -62,14 +68,17 @@ public data class SecondInterfaceImplementation(
   /**
    * Unique identifier of the second implementation
    */
+  @get:JsonProperty(value = "id")
   override val id: Int,
   /**
    * Name of the second implementation
    */
+  @get:JsonProperty(value = "name")
   override val name: String,
   /**
    * Custom field float value
    */
+  @get:JsonProperty(value = "floatValue")
   public val floatValue: Double,
 ) : BasicInterface
 
@@ -82,9 +91,11 @@ public data class DefaultBasicInterfaceImplementation(
   /**
    * Unique identifier of an interface
    */
+  @get:JsonProperty(value = "id")
   override val id: Int,
   /**
    * Name field
    */
+  @get:JsonProperty(value = "name")
   override val name: String,
 ) : BasicInterface
diff --git a/...ata/generator/interface_diff_selection_sets/differentselectionsetquery/BasicInterface2.kt b/...ata/generator/interface_diff_selection_sets/differentselectionsetquery/BasicInterface2.kt
@@ -1,6 +1,7 @@
 package com.expediagroup.graphql.generated.differentselectionsetquery
 
 import com.expediagroup.graphql.client.Generated
+import com.fasterxml.jackson.`annotation`.JsonProperty
 import com.fasterxml.jackson.`annotation`.JsonSubTypes
 import com.fasterxml.jackson.`annotation`.JsonTypeInfo
 import com.fasterxml.jackson.`annotation`.JsonTypeInfo.As.PROPERTY
@@ -27,6 +28,7 @@ public interface BasicInterface2 {
   /**
    * Name field
    */
+  @get:JsonProperty(value = "name")
   public val name: String
 }
 
@@ -38,10 +40,12 @@ public data class FirstInterfaceImplementation2(
   /**
    * Name of the first implementation
    */
+  @get:JsonProperty(value = "name")
   override val name: String,
   /**
    * Custom field integer value
    */
+  @get:JsonProperty(value = "intValue")
   public val intValue: Int,
 ) : BasicInterface2
 
@@ -53,10 +57,12 @@ public data class SecondInterfaceImplementation2(
   /**
    * Name of the second implementation
    */
+  @get:JsonProperty(value = "name")
   override val name: String,
   /**
    * Custom field float value
    */
+  @get:JsonProperty(value = "floatValue")
   public val floatValue: Double,
 ) : BasicInterface2
 
@@ -69,5 +75,6 @@ public data class DefaultBasicInterface2Implementation(
   /**
    * Name field
    */
+  @get:JsonProperty(value = "name")
   override val name: String,
 ) : BasicInterface2
diff --git a/.../src/test/data/generator/interface_impl_diff_selection_sets/DifferentSelectionSetQuery.kt b/.../src/test/data/generator/interface_impl_diff_selection_sets/DifferentSelectionSetQuery.kt
@@ -4,6 +4,7 @@ import com.expediagroup.graphql.client.Generated
 import com.expediagroup.graphql.client.types.GraphQLClientRequest
 import com.expediagroup.graphql.generated.differentselectionsetquery.BasicInterface
 import com.expediagroup.graphql.generated.differentselectionsetquery.BasicInterface2
+import com.fasterxml.jackson.`annotation`.JsonProperty
 import kotlin.String
 import kotlin.reflect.KClass
 
@@ -24,10 +25,12 @@ public class DifferentSelectionSetQuery : GraphQLClientRequest<DifferentSelectio
     /**
      * Query returning an interface
      */
+    @get:JsonProperty(value = "first")
     public val first: BasicInterface,
     /**
      * Query returning an interface
      */
+    @get:JsonProperty(value = "second")
     public val second: BasicInterface2,
   )
 }