Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix handling of vararg deserialization #743

Merged
merged 5 commits into from
Dec 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions release-notes/CREDITS-2.x
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Contributors:
# 2.17.0 (not yet released)

WrongWrong (@k163377)
* #743: Fix handling of vararg deserialization.
* #742: Minor performance improvements to NullToEmptyCollection/Map.
* #741: Changed to allow KotlinFeature to be set in the function that registers a KotlinModule.
* #740: Reduce conversion cache from Executable to KFunction.
Expand Down
2 changes: 2 additions & 0 deletions release-notes/VERSION-2.x
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ Co-maintainers:

2.17.0 (not yet released)

* #743: The handling of deserialization using vararg arguments has been improved to allow deserialization even when the input to the vararg argument is undefined.
In addition, vararg arguments are now reported as non-required.
#742: Minor performance improvements to NullToEmptyCollection/Map.
#741: Changed to allow KotlinFeature to be set in the function that registers a KotlinModule.
The `jacksonObjectMapper {}` and `registerKotlinModule {}` lambdas allow configuration for KotlinModule.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -207,13 +207,12 @@ internal class KotlinAnnotationIntrospector(
private fun KFunction<*>.isParameterRequired(index: Int): Boolean {
val param = parameters[index]
val paramType = param.type
val javaType = paramType.javaType
val isPrimitive = when (javaType) {
val isPrimitive = when (val javaType = paramType.javaType) {
is Class<*> -> javaType.isPrimitive
else -> false
}

return !paramType.isMarkedNullable && !param.isOptional &&
return !paramType.isMarkedNullable && !param.isOptional && !param.isVararg &&
!(isPrimitive && !context.isEnabled(DeserializationFeature.FAIL_ON_NULL_FOR_PRIMITIVES))
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ internal class KotlinValueInstantiator(
tempParamVal
} else {
when {
paramDef.isOptional -> return@forEachIndexed
paramDef.isOptional || paramDef.isVararg -> return@forEachIndexed
// do not try to create any object if it is nullable and the value is missing
paramType.isMarkedNullable -> null
// Primitive types always try to get from a buffer, considering several settings
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ class TestPropertyRequiredness {

// ---

private data class TestDataClass(
private class TestDataClass(
val a: Int,
val b: Int?,
val c: Int = 5,
Expand All @@ -85,6 +85,7 @@ class TestPropertyRequiredness {
val f: TestParamClass?,
val g: TestParamClass = TestParamClass(),
val h: TestParamClass? = TestParamClass(),
vararg val i: Int,
@JsonProperty("x", required = true) val x: Int?, // TODO: either error in test case with this not being on the property getter, or error in introspection not seeing this on the constructor parameter
@get:JsonProperty("z", required = true) val z: Int
)
Expand Down Expand Up @@ -117,6 +118,9 @@ class TestPropertyRequiredness {
"h".isOptionalForSerializationOf(testClass, mapper)
"h".isOptionalForDeserializationOf(testClass, mapper)

"i".isRequiredForSerializationOf(testClass, mapper)
"i".isOptionalForDeserializationOf(testClass, mapper)

"x".isRequiredForDeserializationOf(testClass, mapper)
"x".isOptionalForSerializationOf(testClass, mapper)

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
package com.fasterxml.jackson.module.kotlin.test

import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
import com.fasterxml.jackson.module.kotlin.readValue
import junit.framework.TestCase.assertEquals
import junit.framework.TestCase.assertTrue
import org.junit.Ignore
import org.junit.experimental.runners.Enclosed
import org.junit.runner.RunWith
import kotlin.test.Test

// from https:/ProjectMapK/jackson-module-kogera/blob/0631cd3b07c7fb6971a00ac1f6811b4367a1720e/src/test/kotlin/io/github/projectmapk/jackson/module/kogera/zIntegration/deser/VarargTest.kt#L1
@RunWith(Enclosed::class)
class VarargDeserTest {
@Ignore
companion object {
val mapper = jacksonObjectMapper()
}

@Ignore
class OnlyVararg(vararg val v: Int)

class OnlyVarargTest {
@Test
fun hasArgs() {
val r = mapper.readValue<OnlyVararg>("""{"v":[1,2,3]}""")
assertEquals(listOf(1, 2, 3), r.v.asList())
}

@Test
fun empty() {
val r = mapper.readValue<OnlyVararg>("""{"v":[]}""")
assertTrue(r.v.isEmpty())
}

@Test
fun undefined() {
val r = mapper.readValue<OnlyVararg>("""{}""")
assertTrue(r.v.isEmpty())
}
}

@Ignore
class HeadVararg(vararg val v: Int?, val i: Int)

class HeadVarargTest {
@Test
fun hasArgs() {
val r = mapper.readValue<HeadVararg>("""{"i":0,"v":[1,2,null]}""")
assertEquals(listOf(1, 2, null), r.v.asList())
assertEquals(0, r.i)
}

@Test
fun empty() {
val r = mapper.readValue<HeadVararg>("""{"i":0,"v":[]}""")
assertTrue(r.v.isEmpty())
assertEquals(0, r.i)
}

@Test
fun undefined() {
val r = mapper.readValue<HeadVararg>("""{"i":0}""")
assertTrue(r.v.isEmpty())
assertEquals(0, r.i)
}
}

@Ignore
class TailVararg(val i: Int, vararg val v: String)

class TailVarargTest {
@Test
fun hasArgs() {
val r = mapper.readValue<TailVararg>("""{"i":0,"v":["foo","bar","baz"]}""")
assertEquals(listOf("foo", "bar", "baz"), r.v.asList())
assertEquals(0, r.i)
}

@Test
fun empty() {
val r = mapper.readValue<TailVararg>("""{"i":0,"v":[]}""")
assertTrue(r.v.isEmpty())
assertEquals(0, r.i)
}

@Test
fun undefined() {
val r = mapper.readValue<TailVararg>("""{"i":0}""")
assertTrue(r.v.isEmpty())
assertEquals(0, r.i)
}
}

@Ignore
class HasDefaultVararg(vararg val v: String? = arrayOf("foo", "bar"))

class HasDefaultVarargTest {
@Test
fun hasArgs() {
val r = mapper.readValue<HasDefaultVararg>("""{"v":["foo","bar",null]}""")
assertEquals(listOf("foo", "bar", null), r.v.asList())
}

@Test
fun empty() {
val r = mapper.readValue<HasDefaultVararg>("""{"v":[]}""")
assertTrue(r.v.isEmpty())
}

@Test
fun undefined() {
val r = mapper.readValue<HasDefaultVararg>("""{}""")
assertEquals(listOf("foo", "bar"), r.v.asList())
}
}
}