Merge remote-tracking branch 'FasterXML/2.13' into refactor-KVI

Author: k163377

pom.xml

@@ -8,12 +8,12 @@
     <parent>
         <groupId>com.fasterxml.jackson</groupId>
         <artifactId>jackson-base</artifactId>
-        <version>2.13.1-SNAPSHOT</version>
+        <version>2.13.2-SNAPSHOT</version>
     </parent>
     <groupId>com.fasterxml.jackson.module</groupId>
     <artifactId>jackson-module-kotlin</artifactId>
     <name>jackson-module-kotlin</name>
-    <version>2.13.1-SNAPSHOT</version>
+    <version>2.13.2-SNAPSHOT</version>
     <packaging>bundle</packaging>
     <description>Add-on module for Jackson (https://github.com/FasterXML/jackson/) to support
         Kotlin language, specifically introspection of method/constructor parameter names,
@@ -204,6 +204,10 @@
                         <breakBuildOnBinaryIncompatibleModifications>true</breakBuildOnBinaryIncompatibleModifications>
                         <breakBuildOnSourceIncompatibleModifications>true</breakBuildOnSourceIncompatibleModifications>
                         <excludes>
+                            <!--
+                                TODO Remove after release of 2.14 and update the oldVersion above to 2.14.
+                            -->
+                            <exclude>com.fasterxml.jackson.module.kotlin.ValueClassBoxSerializer</exclude>
                         </excludes>
                     </parameter>
                 </configuration>

release-notes/CREDITS-2.x

@@ -4,7 +4,7 @@ Kotlin module, version 2.x
 
 Authors:
 
-  Jayson Minard/@apatrida, jayson.minard@gmail.com: author
+  Jayson Minard/@apatrida, jayson.minard@gmail.com: original author
 
   Tatu Saloranta/@cowtowncoder (tatu.saloranta@iki.fi) : co-author
 
@@ -13,125 +13,121 @@ Authors:
 
 Contributors:
 
+# 2.13.NEXT
+
+# 2.13.1
+
+Stefan Schmid (schmist@github)
+* #519: Contributed test for #518 (null should deserialize to _the_ Unit instance)
+
 wrongwrong (k163377@github)
 * #456: Refactor KNAI.findImplicitPropertyName()
 * #449: Refactor AnnotatedMethod.hasRequiredMarker()
-  (2.13.NEXT)
+* #521: Fixed lookup of instantiators
+* #527: Improvements to serialization of `value class`.
 
 Dmitri Domanine (novtor@github)
 * Contributed fix for #490: Missing value of type JsonNode? is deserialized as NullNode instead of null
-  (2.13.NEXT)
+
+# 2.13.0
 
 Fedor Bobin (Fuud@github)
 * #496, #45: Fix treeToValue extension function should not have type erasure
-  (2.13)
 
 Mikhael Sokolov (sokomishalov@github)
 * #489: JsonNode, ArrayNode and ObjectNode extension functions
-  (2.13)
 
 Max Wiechmann (MaxMello@github)
 * #494: ProGuard ProTips in the README
-  (2.13)
 
 Róbert Papp (TWiStErRob@github)
 * #477: KotlinFeature documentation & deprecation replacements
-  (2.13)
 
 wrongwrong (k163377@github)
 * #468: Improved support for value classes
-  (2.13)
 
 wrongwrong (k163377@github)
 * #460: Test for GitHub #451 (`-` in property name handling)
-  (2.13)
 
 wrongwrong (k163377@github)
 * #447: Fix edge case when dealing with sealed classes
-  (2.13)
 
 wrongwrong (k163377@github)
 * Contributed #438: Fixed mapping failure when `private` `companion object` is named
-  (2.13)
+
+# 2.12.5
 
 Marshall Pierce (marshallpierce@github)
 * #474: Reported disrespect for @JsonProperty on parent class
-  (2.12.5)
 
 Christopher Mason (masoncj@github)
 * #194: Contributed test case for @JsonIdentityInfo usage
-  (2.12.5)
 
 Martin Häusler (MartinHaeusler@github)
 * Reported #194: @JsonIdentityInfo bug
-  (2.12.5)
+
+# 2.12.2
 
 Eric Fenderbosch (efenderbosch@github)
 * Fixed #182: Serialize unsigned numbers
-  (2.12.2)
 
 Elisha Peterson (triathematician@github)
 * Reported #409: `module-info.java` missing "exports"
-  (2.12.2)
+
+# 2.12.1
 
 Wolfgang Jung (elektro-wolle@github)
 * Fixed inline class serialization
-  (2.12.1)
+
+# 2.12.0
 
 John Flynn (Neuman968@github)
 * Contributed extension methods for SimpleModule to add serializer and deserializer
   extension functions for KClass #322
-  (2.12.0)
 
 Mateusz Stefek (MateuszStefek@github)
 * Reported #321: Make MissingKotlinParameterException a descendant of MismatchedInputException
-  (2.12.0)
 
 Hideaki Tanabe (tanabe@github)
 * Brought README.md into the modern world of Gradle (compile -> implementation)
-  (2.12.0)
 
 Hidde Wieringa (hiddewie@github)
 * Contributed test case for issue 308
 * Contributed Kotlin DSL constructor
- (2.12.0)
 
 David Riggleman (DavidRigglemanININ@github)
 * Wrote strict null checking for collection values
- (2.12.0)
+
+# 2.11.0
 
 Drew Stephens (dinomite@github)
 * Contributed fix for #281: KotlinObjectSingletonDeserializer fails to deserialize
   previously serialized JSON as it doesn't delegate deserializeWithType
- (2.11.0)
+
+# 2.10.2
 
 Patrick Strawderman (kilink@github)
 * Reported #279: 2.10 introduces another binary compatibility issue in `KotlinModule`
   constructor
- (2.10.2)
 
 Vladimir Petrakovich (frost13it@github)
 * Contributed fix for #279: 2.10 introduces another binary compatibility issue in
   `KotlinModule` constructor
- (2.10.2)
+
+# 2.10.1
 
 Stéphane B (StephaneBg@github)
 * Submitted fix for #176: Version 2.9.7 breaks compatibility with Android minSdk < 24
- (2.10.1)
 
 Alain Lehmann (ciderale@github)
 * Contributed fix for #225: Don't instantiate new instances of Kotlin singleton objects
- (2.10.1)
 
 Andrey Lipatov (LipatovAndrey@github)
 * Contributed fix for #80: Boolean property name starting with 'is' not serialized /
   deserialized properly
- (2.10.1)
 
 Konstantin Volivach (kostya05983@github)
 * Contributed fix for #254: Add serializers for Sequences
- (2.10.1)
 
 Laimonas Turauskas (Laimiux@github)
 * Contributed fix for #180: handle nullable method parameters correctly (for creator methods)
- (2.10.1)

release-notes/VERSION-2.x

@@ -18,16 +18,36 @@ Co-maintainers:
 
 No changes since 2.13
 
+2.13.1 (19-Dec-2021)
+
+* #456: Refactor KNAI.findImplicitPropertyName()
+ (contributed by wrongwrong)
+* #449: Refactor AnnotatedMethod.hasRequiredMarker()
+ (contributed by wrongwrong)
+* #521: Fixed lookup of instantiators
+ (contributed by wrongwrong)
+
+Dmitri Domanine (novtor@github)
+* Contributed fix for #490: Missing value of type JsonNode? is deserialized as NullNode instead of null
+
 2.13.0 (30-Sep-2021)
 
 #438: Fixed mapping failure when `private` `companion object` is named
  (reported, fix contributed by k163377@github)
-
+#447: Fix edge case when dealing with sealed classes
+#468: Improved support for value classes
+#477: Improved documentation for KotlinFeature
+#489: Extension functions for JsonNode, ArrayNode and ObjectNode
+#490: Fix deserialization of missing value (was `NullNode`, now literal `null`)
+#494: Improved documentation for ProGuard users
+#496: Fix type erasure in treeToValue() extension function
+
+2.12.6 (15-Dec-2021)
 2.12.5 (27-Aug-2021)
 2.12.4 (06-Jul-2021)
 2.12.3 (12-Apr-2021)
 
-No changes since 2.12.2
+No recorded changes since 2.12.2
 
 2.12.2 (03-Mar-2021)
 

src/main/kotlin/com/fasterxml/jackson/module/kotlin/KotlinAnnotationIntrospector.kt

@@ -11,12 +11,14 @@ import java.lang.reflect.AccessibleObject
 import java.lang.reflect.Constructor
 import java.lang.reflect.Field
 import java.lang.reflect.Method
+import kotlin.reflect.KClass
 import kotlin.reflect.KFunction
 import kotlin.reflect.KMutableProperty1
 import kotlin.reflect.KProperty1
 import kotlin.reflect.KType
 import kotlin.reflect.full.createType
 import kotlin.reflect.full.declaredMemberProperties
+import kotlin.reflect.full.memberProperties
 import kotlin.reflect.jvm.*
 
 
@@ -59,6 +61,43 @@ internal class KotlinAnnotationIntrospector(private val context: Module.SetupCon
         return super.findCreatorAnnotation(config, a)
     }
 
+    // Find a serializer to handle the case where the getter returns an unboxed value from the value class.
+    override fun findSerializer(am: Annotated): ValueClassBoxSerializer<*>? = when (am) {
+        is AnnotatedMethod -> {
+            val getter = am.member.apply {
+                // If the return value of the getter is a value class,
+                // it will be serialized properly without doing anything.
+                if (this.returnType.isUnboxableValueClass()) return null
+            }
+
+            val kotlinProperty = getter
+                .declaringClass
+                .kotlin
+                .let {
+                    // KotlinReflectionInternalError is raised in GitHub167 test,
+                    // but it looks like an edge case, so it is ignored.
+                    try {
+                        it.memberProperties
+                    } catch (e: Error) {
+                        null
+                    }
+                }?.find { it.javaGetter == getter }
+
+            (kotlinProperty?.returnType?.classifier as? KClass<*>)
+                ?.takeIf { it.isValue }
+                ?.java
+                ?.let { outerClazz ->
+                    @Suppress("UNCHECKED_CAST")
+                    ValueClassBoxSerializer(outerClazz, getter.returnType)
+                }
+        }
+        // Ignore the case of AnnotatedField, because JvmField cannot be set in the field of value class.
+        else -> null
+    }
+
+    // Perform proper serialization even if the value wrapped by the value class is null.
+    override fun findNullSerializer(am: Annotated) = findSerializer(am)
+
     /**
      * Subclasses can be detected automatically for sealed classes, since all possible subclasses are known
      * at compile-time to Kotlin. This makes [com.fasterxml.jackson.annotation.JsonSubTypes] redundant.

src/main/kotlin/com/fasterxml/jackson/module/kotlin/KotlinDeserializers.kt

@@ -1,5 +1,3 @@
-@file:Suppress("EXPERIMENTAL_API_USAGE")
-
 package com.fasterxml.jackson.module.kotlin
 
 import com.fasterxml.jackson.core.JsonParser

src/main/kotlin/com/fasterxml/jackson/module/kotlin/KotlinKeyDeserializers.kt

@@ -0,0 +1,72 @@
+package com.fasterxml.jackson.module.kotlin
+
+import com.fasterxml.jackson.core.JsonToken
+import com.fasterxml.jackson.core.exc.InputCoercionException
+import com.fasterxml.jackson.databind.*
+import com.fasterxml.jackson.databind.deser.std.StdKeyDeserializer
+import com.fasterxml.jackson.databind.deser.std.StdKeyDeserializers
+
+// The reason why key is treated as nullable is to match the tentative behavior of StdKeyDeserializer.
+// If StdKeyDeserializer is modified, need to modify this too.
+
+internal object UByteKeyDeserializer : StdKeyDeserializer(TYPE_SHORT, UByte::class.java) {
+    override fun deserializeKey(key: String?, ctxt: DeserializationContext): UByte? = super.deserializeKey(key, ctxt)
+        ?.let {
+            (it as Short).asUByte() ?: throw InputCoercionException(
+                null,
+                "Numeric value (${key}) out of range of UByte (0 - ${UByte.MAX_VALUE}).",
+                JsonToken.VALUE_NUMBER_INT,
+                UByte::class.java
+            )
+        }
+}
+
+internal object UShortKeyDeserializer : StdKeyDeserializer(TYPE_INT, UShort::class.java) {
+    override fun deserializeKey(key: String?, ctxt: DeserializationContext): UShort? = super.deserializeKey(key, ctxt)
+        ?.let {
+            (it as Int).asUShort() ?: throw InputCoercionException(
+                null,
+                "Numeric value (${key}) out of range of UShort (0 - ${UShort.MAX_VALUE}).",
+                JsonToken.VALUE_NUMBER_INT,
+                UShort::class.java
+            )
+        }
+}
+
+internal object UIntKeyDeserializer : StdKeyDeserializer(TYPE_LONG, UInt::class.java) {
+    override fun deserializeKey(key: String?, ctxt: DeserializationContext): UInt? = super.deserializeKey(key, ctxt)
+        ?.let {
+            (it as Long).asUInt() ?: throw InputCoercionException(
+                null,
+                "Numeric value (${key}) out of range of UInt (0 - ${UInt.MAX_VALUE}).",
+                JsonToken.VALUE_NUMBER_INT,
+                UInt::class.java
+            )
+        }
+}
+
+// kind parameter is dummy.
+internal object ULongKeyDeserializer : StdKeyDeserializer(TYPE_LONG, ULong::class.java) {
+    override fun deserializeKey(key: String?, ctxt: DeserializationContext): ULong? = key?.let {
+        it.toBigInteger().asULong() ?: throw InputCoercionException(
+            null,
+            "Numeric value (${key}) out of range of ULong (0 - ${ULong.MAX_VALUE}).",
+            JsonToken.VALUE_NUMBER_INT,
+            ULong::class.java
+        )
+    }
+}
+
+internal object KotlinKeyDeserializers : StdKeyDeserializers() {
+    override fun findKeyDeserializer(
+        type: JavaType,
+        config: DeserializationConfig?,
+        beanDesc: BeanDescription?
+    ): KeyDeserializer? = when (type.rawClass) {
+        UByte::class.java -> UByteKeyDeserializer
+        UShort::class.java -> UShortKeyDeserializer
+        UInt::class.java -> UIntKeyDeserializer
+        ULong::class.java -> ULongKeyDeserializer
+        else -> null
+    }
+}

src/main/kotlin/com/fasterxml/jackson/module/kotlin/KotlinModule.kt

@@ -122,6 +122,7 @@ class KotlinModule @Deprecated(
         context.appendAnnotationIntrospector(KotlinNamesAnnotationIntrospector(this, cache, ignoredClassesForImplyingJsonCreator))
 
         context.addDeserializers(KotlinDeserializers())
+        context.addKeyDeserializers(KotlinKeyDeserializers)
         context.addSerializers(KotlinSerializers())
         context.addKeySerializers(KotlinKeySerializers())