BREAKING CHANGE: Upgrade to Jackson 3 (#2162)

Helpful Context:
- Jackson 3 Upgrade Guide
https://github.com/FasterXML/jackson/blob/main/jackson3/MIGRATING_TO_JACKSON_3.md
- Spring Boot 4 Upgrade Guide - Jackson Section
https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-4.0-Migration-Guide#upgrading-jackson

In my previous Spring Boot breaking change PR, I assumed that since
graphql-java used Jackson 2 that we'd be pinned to that as well.
However, on further review, they're only using it as a [test
dependency](https://github.com/graphql-java/graphql-java/blob/e0ca0613e1c15a7a6c4d012e1ebba37e091ac682/build.gradle#L149).

So, this PR takes on the migration to Jackson 3.

Big highlights:
* Use the Spring-preferred `spring-boot-jackson` instead of
`spring-boot-jackson2`
* Bring in ktor support for jackson 3 by moving from
`ktor-serialization-jackson` to `ktor-serialization-jackson3`
* Added in [3.4.0](https://github.com/ktorio/ktor/releases/tag/3.4.0)
with `https://github.com/ktorio/ktor/pull/5301`
* The package for most Jackson classes changed from
`com.fasterxml.jackson.*` to `tools.jackson.*`
* With the exception of `*.annotation.*` classes, those remain under the
old package path
* `ObjectMapper`s are now immutable, the new pattern is provide builder
modifications

---------

Co-authored-by: Jordan Lopez <jordlopez@expediagroup.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: JordanJLopez <8593393+JordanJLopez@users.noreply.github.com>

Author: 4 people

clients/graphql-kotlin-client-jackson/src/main/kotlin/com/expediagroup/graphql/client/jackson/GraphQLClientJacksonSerializer.kt

@@ -22,25 +22,21 @@ import com.expediagroup.graphql.client.jackson.types.UndefinedFilter
 import com.expediagroup.graphql.client.serializer.GraphQLClientSerializer
 import com.expediagroup.graphql.client.types.GraphQLClientRequest
 import com.fasterxml.jackson.annotation.JsonInclude
-import com.fasterxml.jackson.databind.DeserializationFeature
-import com.fasterxml.jackson.databind.JavaType
-import com.fasterxml.jackson.databind.ObjectMapper
-import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
+import tools.jackson.databind.JavaType
+import tools.jackson.databind.ObjectMapper
+import tools.jackson.databind.cfg.EnumFeature
+import tools.jackson.databind.json.JsonMapper
+import tools.jackson.module.kotlin.jacksonMapperBuilder
 import java.util.concurrent.ConcurrentHashMap
 import kotlin.reflect.KClass
 
 /**
  * Jackson based GraphQL request/response serializer.
  */
-class GraphQLClientJacksonSerializer(private val mapper: ObjectMapper = jacksonObjectMapper()) : GraphQLClientSerializer {
+class GraphQLClientJacksonSerializer(mapper: JsonMapper = jacksonMapperBuilder().build()) : GraphQLClientSerializer {
+    private val mapper: ObjectMapper = configureMapper(mapper)
     private val typeCache = ConcurrentHashMap<KClass<*>, JavaType>()
 
-    init {
-        mapper.enable(DeserializationFeature.READ_UNKNOWN_ENUM_VALUES_USING_DEFAULT_VALUE)
-        mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL)
-        mapper.configOverride(OptionalInput::class.java).include = JsonInclude.Value.empty().withValueInclusion(JsonInclude.Include.CUSTOM).withValueFilter(UndefinedFilter::class.java)
-    }
-
     override fun serialize(request: GraphQLClientRequest<*>): String = mapper.writeValueAsString(request)
 
     override fun serialize(requests: List<GraphQLClientRequest<*>>): String = mapper.writeValueAsString(requests)
@@ -66,4 +62,18 @@ class GraphQLClientJacksonSerializer(private val mapper: ObjectMapper = jacksonO
         typeCache.computeIfAbsent(resultType) {
             mapper.typeFactory.constructParametricType(JacksonGraphQLResponse::class.java, resultType.java)
         }
+
+    companion object {
+        private fun configureMapper(mapper: JsonMapper): JsonMapper = mapper.rebuild()
+            .enable(EnumFeature.READ_UNKNOWN_ENUM_VALUES_USING_DEFAULT_VALUE)
+            .changeDefaultPropertyInclusion { it.withValueInclusion(JsonInclude.Include.NON_NULL) }
+            .withConfigOverride(OptionalInput::class.java) { cfg ->
+                cfg.setInclude(
+                    JsonInclude.Value.empty()
+                        .withValueInclusion(JsonInclude.Include.CUSTOM)
+                        .withValueFilter(UndefinedFilter::class.java)
+                )
+            }
+            .build()
+    }
 }

clients/graphql-kotlin-client-jackson/src/main/kotlin/com/expediagroup/graphql/client/jackson/serializers/OptionalInputSerializer.kt

@@ -17,24 +17,24 @@
 package com.expediagroup.graphql.client.jackson.serializers
 
 import com.expediagroup.graphql.client.jackson.types.OptionalInput
-import com.fasterxml.jackson.core.JsonGenerator
-import com.fasterxml.jackson.databind.JsonSerializer
-import com.fasterxml.jackson.databind.SerializerProvider
+import tools.jackson.core.JsonGenerator
+import tools.jackson.databind.SerializationContext
+import tools.jackson.databind.ValueSerializer
 
-class OptionalInputSerializer : JsonSerializer<OptionalInput<*>>() {
+class OptionalInputSerializer : ValueSerializer<OptionalInput<*>>() {
 
-    override fun isEmpty(provider: SerializerProvider, value: OptionalInput<*>?): Boolean {
+    override fun isEmpty(ctxt: SerializationContext, value: OptionalInput<*>?): Boolean {
         return value == OptionalInput.Undefined
     }
 
-    override fun serialize(value: OptionalInput<*>, gen: JsonGenerator, serializers: SerializerProvider) {
+    override fun serialize(value: OptionalInput<*>, gen: JsonGenerator, ctxt: SerializationContext) {
         when (value) {
             is OptionalInput.Undefined -> return
             is OptionalInput.Defined -> {
                 if (value.value == null) {
-                    serializers.defaultNullValueSerializer.serialize(value.value, gen, serializers)
+                    ctxt.defaultNullValueSerializer.serialize(value.value, gen, ctxt)
                 } else {
-                    serializers.findValueSerializer(value.value::class.java).serialize(value.value, gen, serializers)
+                    ctxt.findValueSerializer(value.value::class.java).serialize(value.value, gen, ctxt)
                 }
             }
         }

clients/graphql-kotlin-client-jackson/src/main/kotlin/com/expediagroup/graphql/client/jackson/types/OptionalInput.kt

@@ -19,7 +19,7 @@ package com.expediagroup.graphql.client.jackson.types
 import com.expediagroup.graphql.client.jackson.serializers.OptionalInputSerializer
 import com.fasterxml.jackson.annotation.JsonCreator
 import com.fasterxml.jackson.annotation.JsonValue
-import com.fasterxml.jackson.databind.annotation.JsonSerialize
+import tools.jackson.databind.annotation.JsonSerialize
 
 @JsonSerialize(using = OptionalInputSerializer::class)
 sealed class OptionalInput<out T> {

clients/graphql-kotlin-client-jackson/src/test/kotlin/com/expediagroup/graphql/client/jackson/GraphQLClientJacksonSerializerTest.kt

@@ -32,18 +32,22 @@ import com.expediagroup.graphql.client.jackson.types.JacksonGraphQLError
 import com.expediagroup.graphql.client.jackson.types.JacksonGraphQLResponse
 import com.expediagroup.graphql.client.jackson.types.JacksonGraphQLSourceLocation
 import com.expediagroup.graphql.client.jackson.types.OptionalInput
-import com.fasterxml.jackson.databind.SerializationFeature
-import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
 import org.junit.jupiter.api.Test
+import tools.jackson.databind.SerializationFeature
+import tools.jackson.module.kotlin.jacksonMapperBuilder
 import java.util.UUID
 import kotlin.test.assertEquals
 
 class GraphQLClientJacksonSerializerTest {
 
-    private val testMapper = jacksonObjectMapper()
-        .enable(SerializationFeature.INDENT_OUTPUT)
+    private val testMapper = jacksonMapperBuilder().enable(SerializationFeature.INDENT_OUTPUT).build()
     private val serializer = GraphQLClientJacksonSerializer(testMapper)
 
+    private fun assertSerializedJsonEquals(expected: String, actual: String) {
+        // Check the contents rather than the string order
+        assertEquals(testMapper.readTree(expected), testMapper.readTree(actual))
+    }
+
     @Test
     fun `verify we can serialize GraphQLClientRequest`() {
         val testQuery = FirstQuery(FirstQuery.Variables(input = 1.0f))
@@ -58,7 +62,7 @@ class GraphQLClientJacksonSerializerTest {
             """.trimMargin()
 
         val serialized = serializer.serialize(testQuery)
-        assertEquals(expected, serialized)
+        assertSerializedJsonEquals(expected, serialized)
     }
 
     @Test
@@ -78,7 +82,7 @@ class GraphQLClientJacksonSerializerTest {
             """.trimMargin()
 
         val serialized = serializer.serialize(queries)
-        assertEquals(expected, serialized)
+        assertSerializedJsonEquals(expected, serialized)
     }
 
     @Test
@@ -193,7 +197,7 @@ class GraphQLClientJacksonSerializerTest {
             """.trimMargin()
 
         val serialized = serializer.serialize(scalarQuery)
-        assertEquals(expected, serialized)
+        assertSerializedJsonEquals(expected, serialized)
     }
 
     @Test
@@ -239,7 +243,7 @@ class GraphQLClientJacksonSerializerTest {
             """.trimMargin()
 
         val serialized = serializer.serialize(query)
-        assertEquals(expected, serialized)
+        assertSerializedJsonEquals(expected, serialized)
     }
 
     @Test
@@ -276,7 +280,7 @@ class GraphQLClientJacksonSerializerTest {
             """.trimMargin()
 
         val serialized = serializer.serialize(query)
-        assertEquals(expected, serialized)
+        assertSerializedJsonEquals(expected, serialized)
     }
 
     @Test
@@ -309,7 +313,7 @@ class GraphQLClientJacksonSerializerTest {
             |}
         """.trimMargin()
         val serialized = serializer.serialize(query)
-        assertEquals(expected, serialized)
+        assertSerializedJsonEquals(expected, serialized)
     }
 
     @Test
@@ -325,7 +329,7 @@ class GraphQLClientJacksonSerializerTest {
             |}
         """.trimMargin()
         val serialized = serializer.serialize(query)
-        assertEquals(expected, serialized)
+        assertSerializedJsonEquals(expected, serialized)
     }
 
     @Test
@@ -345,6 +349,6 @@ class GraphQLClientJacksonSerializerTest {
             """.trimMargin()
 
         val serialized = serializer.serialize(entitiesQuery)
-        assertEquals(expected, serialized)
+        assertSerializedJsonEquals(expected, serialized)
     }
 }

clients/graphql-kotlin-client-jackson/src/test/kotlin/com/expediagroup/graphql/client/jackson/data/EntitiesQuery.kt

@@ -20,8 +20,8 @@ import com.expediagroup.graphql.client.jackson.data.entitiesquery._Entity
 import com.expediagroup.graphql.client.jackson.data.scalars.AnyToAnyConverter
 import com.expediagroup.graphql.client.types.GraphQLClientRequest
 import com.fasterxml.jackson.annotation.JsonProperty
-import com.fasterxml.jackson.databind.annotation.JsonDeserialize
-import com.fasterxml.jackson.databind.annotation.JsonSerialize
+import tools.jackson.databind.annotation.JsonDeserialize
+import tools.jackson.databind.annotation.JsonSerialize
 import kotlin.reflect.KClass
 
 class EntitiesQuery(
@@ -34,8 +34,8 @@ class EntitiesQuery(
     override fun responseType(): KClass<Result> = Result::class
 
     data class Variables(
-        @JsonSerialize(contentConverter = AnyToAnyConverter::class)
-        @JsonDeserialize(contentConverter = AnyToAnyConverter::class)
+        @get:JsonSerialize(contentConverter = AnyToAnyConverter::class)
+        @get:JsonDeserialize(contentConverter = AnyToAnyConverter::class)
         @get:JsonProperty("representations")
         public val representations: List<Any>,
     )

clients/graphql-kotlin-client-jackson/src/test/kotlin/com/expediagroup/graphql/client/jackson/data/ScalarQuery.kt

@@ -20,8 +20,8 @@ import com.expediagroup.graphql.client.jackson.data.scalars.AnyToUUIDConverter
 import com.expediagroup.graphql.client.jackson.data.scalars.UUIDToAnyConverter
 import com.expediagroup.graphql.client.types.GraphQLClientRequest
 import com.fasterxml.jackson.annotation.JsonProperty
-import com.fasterxml.jackson.databind.annotation.JsonDeserialize
-import com.fasterxml.jackson.databind.annotation.JsonSerialize
+import tools.jackson.databind.annotation.JsonDeserialize
+import tools.jackson.databind.annotation.JsonSerialize
 import java.util.UUID
 import kotlin.reflect.KClass
 
@@ -40,16 +40,16 @@ class ScalarQuery(
     data class Variables(
         @get:JsonProperty("alias")
         val alias: ID? = null,
-        @JsonSerialize(converter = UUIDToAnyConverter::class)
-        @JsonDeserialize(converter = AnyToUUIDConverter::class)
+        @get:JsonSerialize(converter = UUIDToAnyConverter::class)
+        @get:JsonDeserialize(converter = AnyToUUIDConverter::class)
         @get:JsonProperty("custom")
         val custom: UUID? = null
     )
 
     data class Result(
         val scalarAlias: ID,
-        @JsonSerialize(converter = UUIDToAnyConverter::class)
-        @JsonDeserialize(converter = AnyToUUIDConverter::class)
+        @get:JsonSerialize(converter = UUIDToAnyConverter::class)
+        @get:JsonDeserialize(converter = AnyToUUIDConverter::class)
         val customScalar: UUID
     )
 }

clients/graphql-kotlin-client-jackson/src/test/kotlin/com/expediagroup/graphql/client/jackson/data/scalars/AnyToAnyConverter.kt

@@ -17,7 +17,8 @@
 package com.expediagroup.graphql.client.jackson.data.scalars
 
 import com.expediagroup.graphql.client.converter.ScalarConverter
-import com.fasterxml.jackson.databind.util.StdConverter
+import com.fasterxml.jackson.annotation.JsonProperty
+import tools.jackson.databind.util.StdConverter
 import kotlin.Any
 
 class AnyToAnyConverter : StdConverter<Any, Any>() {
@@ -34,5 +35,6 @@ class AnyScalarConverter : ScalarConverter<Any> {
 
 // representation would not be part of the generated sources
 data class ProductEntityRepresentation(val id: String) {
+    @get:JsonProperty("__typename")
     val __typename: String = "Product"
 }

clients/graphql-kotlin-client-jackson/src/test/kotlin/com/expediagroup/graphql/client/jackson/data/scalars/UUIDConverters.kt

@@ -17,7 +17,7 @@
 package com.expediagroup.graphql.client.jackson.data.scalars
 
 import com.expediagroup.graphql.client.converter.ScalarConverter
-import com.fasterxml.jackson.databind.util.StdConverter
+import tools.jackson.databind.util.StdConverter
 import java.util.UUID
 import kotlin.Any
 

clients/graphql-kotlin-client-jackson/src/test/kotlin/com/expediagroup/graphql/client/jackson/serializers/OptionalInputSerializerTest.kt

@@ -18,16 +18,15 @@ package com.expediagroup.graphql.client.jackson.serializers
 
 import com.expediagroup.graphql.client.jackson.types.OptionalInput
 import com.fasterxml.jackson.annotation.JsonInclude
-import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
 import org.junit.jupiter.api.Test
+import tools.jackson.module.kotlin.jacksonMapperBuilder
 import kotlin.test.assertEquals
 
 class OptionalInputSerializerTest {
 
-    private val mapper = jacksonObjectMapper()
-    init {
-        mapper.setSerializationInclusion(JsonInclude.Include.NON_EMPTY)
-    }
+    private val mapper = jacksonMapperBuilder()
+        .changeDefaultPropertyInclusion { incl -> incl.withValueInclusion(JsonInclude.Include.NON_EMPTY) }
+        .build()
 
     @Test
     fun `verify undefined value is serialized to empty JSON`() {