Skip to content

Commit 0487505

Browse files
cowtowncodercowtowncoder
committed
Merge branch '3.x' of github.com:FasterXML/jackson-module-kotlin into 3.x
2 parents c138d61 + 4f9b1b4 commit 0487505

File tree

12 files changed

+317
-20
lines changed

12 files changed

+317
-20
lines changed

‎release-notes/CREDITS-2.x‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ Contributors:
1717

1818
# 2.19.0 (not yet released)
1919

20+
WrongWrong (@k163377)
21+
* #944: Fixed to use common util for Member accessibility override
22+
* #937: Added type match check to read functions
23+
2024
Tatu Saloranta (@cowtowncoder)
2125
* #889: Upgrade kotlin dep to 1.9.25 (from 1.9.24)
2226

‎release-notes/VERSION-2.x‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,15 @@ Co-maintainers:
1616
=== Releases ===
1717
------------------------------------------------------------------------
1818

19+
2.19.0 (not yet released)
20+
21+
#944: Common util is now used for member accessibility overrides.
22+
#937: For `readValue` and other shorthands for `ObjectMapper` deserialization methods,
23+
type consistency checks have been added.
24+
A `RuntimeJsonMappingException` will be thrown in case of inconsistency.
25+
This fixes a problem that broke `Kotlin` null safety by reading null as a value even if the type parameter was specified as non-null.
26+
It also checks for custom errors in ObjectMapper that cause a different value to be read than the specified type parameter.
27+
1928
2.19.0-rc2 (07-Apr-2025)
2029

2130
#929: Added consideration of `JsonProperty.isRequired` added in `2.19` in `hasRequiredMarker` processing.

‎src/main/kotlin/tools/jackson/module/kotlin/Converters.kt‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import tools.jackson.databind.JavaType
44
import tools.jackson.databind.deser.std.StdConvertingDeserializer
55
import tools.jackson.databind.ser.std.StdDelegatingSerializer
66
import tools.jackson.databind.type.TypeFactory
7+
import tools.jackson.databind.util.ClassUtil
78
import tools.jackson.databind.util.StdConverter
89
import kotlin.reflect.KClass
910
import kotlin.time.toJavaDuration
@@ -51,7 +52,7 @@ internal class ValueClassBoxConverter<S : Any?, D : Any>(
5152
val boxedClass: KClass<D>
5253
) : StdConverter<S, D>() {
5354
private val boxMethod = boxedClass.java.getDeclaredMethod("box-impl", unboxedClass).apply {
54-
if (!this.isAccessible) this.isAccessible = true
55+
ClassUtil.checkAndFixAccess(this, false)
5556
}
5657

5758
@Suppress("UNCHECKED_CAST")

‎src/main/kotlin/tools/jackson/module/kotlin/Extensions.kt‎

Lines changed: 119 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ package tools.jackson.module.kotlin
33
import tools.jackson.core.JsonParser
44
import tools.jackson.core.TreeNode
55
import tools.jackson.core.type.TypeReference
6+
import tools.jackson.databind.DatabindException
67
import tools.jackson.databind.JsonNode
78
import tools.jackson.databind.MappingIterator
89
import tools.jackson.databind.ObjectMapper
@@ -51,21 +52,131 @@ fun jacksonMapperBuilder(initializer: KotlinModule.Builder.() -> Unit = {}): Jso
5152

5253
inline fun <reified T> jacksonTypeRef(): TypeReference<T> = object : TypeReference<T>() {}
5354

55+
/**
56+
* It is public due to Kotlin restrictions, but should not be used externally.
57+
*/
58+
inline fun <reified T> Any?.checkTypeMismatch(): T {
59+
// Basically, this check assumes that T is non-null and the value is null.
60+
// Since this can be caused by both input or ObjectMapper implementation errors,
61+
// a more abstract DatabindException is thrown.
62+
if (this !is T) {
63+
val nullability = if (null is T) "?" else "(non-null)"
64+
65+
throw DatabindException.from(
66+
null as JsonParser?,
67+
"Deserialized value did not match the specified type; " +
68+
"specified ${T::class.qualifiedName}${nullability} but was ${this?.let { it::class.qualifiedName }}"
69+
)
70+
}
71+
return this
72+
}
73+
74+
/**
75+
* Shorthand for [ObjectMapper.readValue].
76+
* @throws DatabindException Especially if [T] is non-null and the value read is null.
77+
* Other cases where the read value is of a different type than [T]
78+
* due to an incorrect customization to [ObjectMapper].
79+
*/
5480
inline fun <reified T> ObjectMapper.readValue(jp: JsonParser): T = readValue(jp, jacksonTypeRef<T>())
55-
inline fun <reified T> ObjectMapper.readValues(jp: JsonParser): MappingIterator<T> = readValues(jp, jacksonTypeRef<T>())
81+
.checkTypeMismatch()
82+
/**
83+
* Shorthand for [ObjectMapper.readValues].
84+
* @throws DatabindException Especially if [T] is non-null and the value read is null.
85+
* Other cases where the read value is of a different type than [T]
86+
* due to an incorrect customization to [ObjectMapper].
87+
*/
88+
inline fun <reified T> ObjectMapper.readValues(jp: JsonParser): MappingIterator<T> {
89+
val values = readValues(jp, jacksonTypeRef<T>())
90+
91+
return object : MappingIterator<T>(values) {
92+
override fun nextValue(): T = super.nextValue().checkTypeMismatch()
93+
}
94+
}
5695

57-
inline fun <reified T> ObjectMapper.readValue(src: File): T = readValue(src, jacksonTypeRef<T>())
58-
inline fun <reified T> ObjectMapper.readValue(src: URL): T = readValue(src, jacksonTypeRef<T>())
96+
/**
97+
* Shorthand for [ObjectMapper.readValue].
98+
* @throws DatabindException Especially if [T] is non-null and the value read is null.
99+
* Other cases where the read value is of a different type than [T]
100+
* due to an incorrect customization to [ObjectMapper].
101+
*/
102+
inline fun <reified T> ObjectMapper.readValue(src: File): T = readValue(src, jacksonTypeRef<T>()).checkTypeMismatch()
103+
/**
104+
* Shorthand for [ObjectMapper.readValue].
105+
* @throws DatabindException Especially if [T] is non-null and the value read is null.
106+
* Other cases where the read value is of a different type than [T]
107+
* due to an incorrect customization to [ObjectMapper].
108+
*/
109+
inline fun <reified T> ObjectMapper.readValue(src: URL): T = readValue(src, jacksonTypeRef<T>()).checkTypeMismatch()
110+
/**
111+
* Shorthand for [ObjectMapper.readValue].
112+
* @throws DatabindException Especially if [T] is non-null and the value read is null.
113+
* Other cases where the read value is of a different type than [T]
114+
* due to an incorrect customization to [ObjectMapper].
115+
*/
59116
inline fun <reified T> ObjectMapper.readValue(content: String): T = readValue(content, jacksonTypeRef<T>())
60-
inline fun <reified T> ObjectMapper.readValue(src: Reader): T = readValue(src, jacksonTypeRef<T>())
117+
.checkTypeMismatch()
118+
/**
119+
* Shorthand for [ObjectMapper.readValue].
120+
* @throws DatabindException Especially if [T] is non-null and the value read is null.
121+
* Other cases where the read value is of a different type than [T]
122+
* due to an incorrect customization to [ObjectMapper].
123+
*/
124+
inline fun <reified T> ObjectMapper.readValue(src: Reader): T = readValue(src, jacksonTypeRef<T>()).checkTypeMismatch()
125+
/**
126+
* Shorthand for [ObjectMapper.readValue].
127+
* @throws DatabindException Especially if [T] is non-null and the value read is null.
128+
* Other cases where the read value is of a different type than [T]
129+
* due to an incorrect customization to [ObjectMapper].
130+
*/
61131
inline fun <reified T> ObjectMapper.readValue(src: InputStream): T = readValue(src, jacksonTypeRef<T>())
132+
.checkTypeMismatch()
133+
/**
134+
* Shorthand for [ObjectMapper.readValue].
135+
* @throws DatabindException Especially if [T] is non-null and the value read is null.
136+
* Other cases where the read value is of a different type than [T]
137+
* due to an incorrect customization to [ObjectMapper].
138+
*/
62139
inline fun <reified T> ObjectMapper.readValue(src: ByteArray): T = readValue(src, jacksonTypeRef<T>())
63-
140+
.checkTypeMismatch()
141+
142+
/**
143+
* Shorthand for [ObjectMapper.readValue].
144+
* @throws DatabindException Especially if [T] is non-null and the value read is null.
145+
* Other cases where the read value is of a different type than [T]
146+
* due to an incorrect customization to [ObjectMapper].
147+
*/
64148
inline fun <reified T> ObjectMapper.treeToValue(n: TreeNode): T = readValue(this.treeAsTokens(n), jacksonTypeRef<T>())
149+
.checkTypeMismatch()
150+
/**
151+
* Shorthand for [ObjectMapper.convertValue].
152+
* @throws DatabindException Especially if [T] is non-null and the value read is null.
153+
* Other cases where the read value is of a different type than [T]
154+
* due to an incorrect customization to [ObjectMapper].
155+
*/
65156
inline fun <reified T> ObjectMapper.convertValue(from: Any?): T = convertValue(from, jacksonTypeRef<T>())
66-
67-
inline fun <reified T> ObjectReader.readValueTyped(jp: JsonParser): T = forType(jacksonTypeRef<T>()).readValue(jp)
68-
inline fun <reified T> ObjectReader.readValuesTyped(jp: JsonParser): Iterator<T> = readValues(jp, jacksonTypeRef<T>())
157+
.checkTypeMismatch()
158+
159+
/**
160+
* Shorthand for [ObjectReader.readValue].
161+
* @throws DatabindException Especially if [T] is non-null and the value read is null.
162+
* Other cases where the read value is of a different type than [T]
163+
* due to an incorrect customization to [ObjectReader].
164+
*/
165+
inline fun <reified T> ObjectReader.readValueTyped(jp: JsonParser): T = forType(jacksonTypeRef<T>()).readValue<T>(jp)
166+
.checkTypeMismatch()
167+
/**
168+
* Shorthand for [ObjectReader.readValues].
169+
* @throws DatabindException Especially if [T] is non-null and the value read is null.
170+
* Other cases where the read value is of a different type than [T]
171+
* due to an incorrect customization to [ObjectReader].
172+
*/
173+
inline fun <reified T> ObjectReader.readValuesTyped(jp: JsonParser): Iterator<T> {
174+
val values = readValues(jp, jacksonTypeRef<T>())
175+
176+
return object : Iterator<T> by values {
177+
override fun next(): T = values.next().checkTypeMismatch<T>()
178+
}
179+
}
69180
inline fun <reified T> ObjectReader.treeToValue(jp: TreeNode): T? = forType(jacksonTypeRef<T>()).readValue(this.treeAsTokens(jp))
70181

71182
inline fun <reified T, reified U> JsonMapper.Builder.addMixIn(): JsonMapper.Builder = this.addMixIn(T::class.java, U::class.java)

‎src/main/kotlin/tools/jackson/module/kotlin/KotlinDeserializers.kt‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import tools.jackson.databind.ValueDeserializer
1111
import tools.jackson.databind.deser.Deserializers
1212
import tools.jackson.databind.deser.std.StdDeserializer
1313
import tools.jackson.databind.exc.InvalidDefinitionException
14+
import tools.jackson.databind.util.ClassUtil
1415
import java.lang.reflect.Method
1516
import java.lang.reflect.Modifier
1617
import kotlin.reflect.full.primaryConstructor
@@ -94,7 +95,7 @@ internal class WrapsNullableValueClassBoxDeserializer<S, D : Any>(
9495
private val inputType: Class<*> = creator.parameterTypes[0]
9596

9697
init {
97-
creator.apply { if (!this.isAccessible) this.isAccessible = true }
98+
ClassUtil.checkAndFixAccess(creator, false)
9899
}
99100

100101
// Cache the result of wrapping null, since the result is always expected to be the same.

‎src/main/kotlin/tools/jackson/module/kotlin/KotlinKeyDeserializers.kt‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import tools.jackson.databind.*
66
import tools.jackson.databind.deser.jdk.JDKKeyDeserializer
77
import tools.jackson.databind.deser.jdk.JDKKeyDeserializers
88
import tools.jackson.databind.exc.InvalidDefinitionException
9+
import tools.jackson.databind.util.ClassUtil
910
import java.lang.reflect.Method
1011
import kotlin.reflect.KClass
1112
import kotlin.reflect.full.primaryConstructor
@@ -70,7 +71,7 @@ internal class ValueClassKeyDeserializer<S, D : Any>(
7071
private val unboxedClass: Class<*> = creator.parameterTypes[0]
7172

7273
init {
73-
creator.apply { if (!this.isAccessible) this.isAccessible = true }
74+
ClassUtil.checkAndFixAccess(creator, false)
7475
}
7576

7677
// Based on databind error

‎src/main/kotlin/tools/jackson/module/kotlin/MethodValueCreator.kt‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package tools.jackson.module.kotlin
22

3+
import tools.jackson.databind.util.ClassUtil
34
import kotlin.reflect.KFunction
45
import kotlin.reflect.full.extensionReceiverParameter
56
import kotlin.reflect.full.instanceParameter
@@ -39,7 +40,7 @@ internal class MethodValueCreator<T> private constructor(
3940
possibleCompanion.java.enclosingClass.declaredFields
4041
.firstOrNull { it.type.kotlin.isCompanion }
4142
?.let {
42-
it.isAccessible = true
43+
ClassUtil.checkAndFixAccess(it, false)
4344

4445
// If the instance of the companion object cannot be obtained, accessibility will always be false
4546
it.get(null) to false

‎src/test/kotlin/tools/jackson/module/kotlin/ReadValueTest.kt‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
package tools.jackson.module.kotlin
2+
3+
import tools.jackson.databind.DatabindException
4+
import tools.jackson.databind.node.NullNode
5+
import org.junit.jupiter.api.Nested
6+
import org.junit.jupiter.api.Test
7+
import org.junit.jupiter.api.assertThrows
8+
import java.io.StringReader
9+
10+
class ReadValueTest {
11+
@Nested
12+
inner class CheckTypeMismatchTest {
13+
@Test
14+
fun jsonParser() {
15+
val src = defaultMapper.createParser("null")
16+
assertThrows<DatabindException> {
17+
defaultMapper.readValue<String>(src)
18+
}.printStackTrace()
19+
}
20+
21+
@Test
22+
fun file() {
23+
val src = createTempJson("null")
24+
assertThrows<DatabindException> {
25+
defaultMapper.readValue<String>(src)
26+
}
27+
}
28+
29+
// Not implemented because a way to test without mocks was not found
30+
// @Test
31+
// fun url() {
32+
// }
33+
34+
@Test
35+
fun string() {
36+
val src = "null"
37+
assertThrows<DatabindException> {
38+
defaultMapper.readValue<String>(src)
39+
}
40+
}
41+
42+
@Test
43+
fun reader() {
44+
val src = StringReader("null")
45+
assertThrows<DatabindException> {
46+
defaultMapper.readValue<String>(src)
47+
}
48+
}
49+
50+
@Test
51+
fun inputStream() {
52+
val src = "null".byteInputStream()
53+
assertThrows<DatabindException> {
54+
defaultMapper.readValue<String>(src)
55+
}
56+
}
57+
58+
@Test
59+
fun byteArray() {
60+
val src = "null".toByteArray()
61+
assertThrows<DatabindException> {
62+
defaultMapper.readValue<String>(src)
63+
}
64+
}
65+
66+
@Test
67+
fun treeToValueTreeNode() {
68+
assertThrows<DatabindException> {
69+
defaultMapper.treeToValue<String>(NullNode.instance)
70+
}
71+
}
72+
73+
@Test
74+
fun convertValueAny() {
75+
assertThrows<DatabindException> {
76+
defaultMapper.convertValue<String>(null)
77+
}
78+
}
79+
80+
@Test
81+
fun readValueTypedJsonParser() {
82+
val reader = defaultMapper.reader()
83+
val src = reader.createParser("null")
84+
assertThrows<DatabindException> {
85+
reader.readValueTyped<String>(src)
86+
}
87+
}
88+
}
89+
}

‎src/test/kotlin/tools/jackson/module/kotlin/ReadValuesTest.kt‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
package tools.jackson.module.kotlin
2+
3+
import tools.jackson.core.JsonParser
4+
import tools.jackson.databind.DatabindException
5+
import tools.jackson.databind.DeserializationContext
6+
import tools.jackson.databind.deser.std.StdDeserializer
7+
import tools.jackson.databind.module.SimpleModule
8+
import org.junit.jupiter.api.Nested
9+
import org.junit.jupiter.api.Test
10+
import org.junit.jupiter.api.assertThrows
11+
import kotlin.test.assertEquals
12+
13+
class ReadValuesTest {
14+
class MyStrDeser : StdDeserializer<String>(String::class.java) {
15+
override fun deserialize(
16+
p: JsonParser,
17+
ctxt: DeserializationContext
18+
): String? = p.valueAsString.takeIf { it != "bar" }
19+
}
20+
21+
@Nested
22+
inner class CheckTypeMismatchTest {
23+
val mapper = jacksonMapperBuilder().addModule(
24+
object : SimpleModule() {
25+
init {
26+
addDeserializer(String::class.java, MyStrDeser())
27+
}
28+
}
29+
).build()!!
30+
31+
@Test
32+
fun readValuesJsonParserNext() {
33+
val src = mapper.createParser(""""foo"${"\n"}"bar"""")
34+
val itr = mapper.readValues<String>(src)
35+
36+
assertEquals("foo", itr.next())
37+
assertThrows<DatabindException> {
38+
itr.next()
39+
}
40+
}
41+
42+
@Test
43+
fun readValuesJsonParserNextValue() {
44+
val src = mapper.createParser(""""foo"${"\n"}"bar"""")
45+
val itr = mapper.readValues<String>(src)
46+
47+
assertEquals("foo", itr.nextValue())
48+
assertThrows<DatabindException> {
49+
itr.nextValue()
50+
}
51+
}
52+
53+
@Test
54+
fun readValuesTypedJsonParser() {
55+
val reader = mapper.reader()
56+
val src = reader.createParser(""""foo"${"\n"}"bar"""")
57+
val itr = reader.readValuesTyped<String>(src)
58+
59+
assertEquals("foo", itr.next())
60+
assertThrows<DatabindException> {
61+
itr.next()
62+
}
63+
}
64+
}
65+
}

0 commit comments

Comments
 (0)