KotlinModule fails to deserialize with readerWithView for classes from external JAR

[cooperlyt]

Search before asking

• I searched in the issues and found nothing similar.
• I searched in the issues of databind and other modules used and found nothing similar.
• I have confirmed that the problem only occurs when using Kotlin.

Describe the bug

When deserializing a Kotlin data class from an external JAR using objectMapper.readerWithView(), KotlinModule fails with the following error:
Caused by: com.fasterxml.jackson.module.kotlin.MissingKotlinParameterException: Instantiation of [simple type, class io.github.cooperlyt.erp.api.data.stock.StockFreezeStatusMessage] value failed for JSON property tenant due to missing (therefore NULL) value for creator parameter tenant which is a non-nullable type at [Source: (String)"{"businessId":1336493025009664,"tenant":"first","type":"LEASE","success":false}"; line: 1, column: 79] (through reference chain: io.github.cooperlyt.erp.api.data.stock.StockFreezeStatusMessage["tenant"])

However, using objectMapper.readValue() works perfectly for the same class and JSON. This issue only occurs when the class is in an external JAR and when using readerWithView() in combination with forType().

To Reproduce

open class StockFreezeStatusMessage(
    val businessId: Long,
    val tenant: String,
    val type: StockRequestType,
    val success: Boolean,
)

1. Create a Kotlin data class inside a separate project, package it into a JAR, and include it as a dependency in the main project.
2. Register KotlinModule in the main project using:

val objectMapper = ObjectMapper().registerModule(KotlinModule())

3. Use readValue() for deserialization (this works fine):

val json = """{"businessId":1336504106360835,"tenant":"first","type":"LEASE","success":false}"""
val value = objectMapper.readValue(json, StockFreezeStatusMessage::class.java)

4. Now use readerWithView() for deserialization (this throws an exception):

val view: Class<*> = StockFreezeStatusMessage::class.java
val javaType: JavaType = objectMapper.constructType(object : TypeReference<StockFreezeStatusMessage>() {})

val value = objectMapper.readerWithView(view).forType(javaType).readValue<Any>(json)

5. The second deserialization fails with MissingKotlinParameterException indicating that a non-nullable field (tenant) is missing, even though the JSON contains the correct value.
6. Moving the data class into the main project (instead of keeping it in the external JAR) this works fine (only Jackson-module-kotlin: 2.18.0-rc1).

Expected behavior

Both readValue() and readerWithView() should correctly deserialize the JSON into the Kotlin data class regardless of whether the class is in the main project or in an external JAR.

Versions

Kotlin:
Jackson-module-kotlin: 2.15.4
Jackson-databind: 2.15.4

Additional context

No response

[cowtowncoder]

Please verify that this still occurs with 2.17.2 (or, if possible, 2.18.0-rc1) just to rule out possibility of later fixes.

[cooperlyt]

2.17.2 and 2.18.0-rc1: Moving the data class into the main project (instead of keeping it in the external JAR) works fine
but not works with JAR

[cowtowncoder]

Thank you for verifying behavior is still the same, @cooperlyt .

[cooperlyt]

I updated spring boot to 3.3.4 and jackson-module-kotlin to 2.18.0, every thing is OK.

[cooperlyt]

I have to reopen this issue because I have made some new discoveries.

When using the same version of jackson-module-kotlin as jackson-databind, this error occurs. However, when I use a higher version of jackson-module-kotlin than jackson-databind, everything works fine. I tested the following combinations:
jackson-databind 2.15.4 with jackson-module-kotlin 2.17.2 works fine,
jackson-databind 2.17.2 with jackson-module-kotlin 2.18.0 works fine.
But as soon as I try to keep their versions synchronized, an exception occurs.

I have created a simple test project, which only includes Spring Boot, to verify this bug, project

this test is very simple only:

@ExtendWith(SpringExtension::class)
@SpringBootTest(classes = [Application::class])
class JsonTest {

    @Autowired
    private lateinit var objectMapper: ObjectMapper

    data class SimpleStockFreezeStatusMessage(
         val businessId: Long,
         val success: Boolean,
         val tenantId: String,
    )

    @Test
    fun testSpringJsonMessage() {

        val json = """{"businessId":1336504106360835,"tenantId":"first","success":false}"""
        val value = objectMapper.readValue(json, SimpleStockFreezeStatusMessage::class.java)

        println("message ser by readValue : $value")
        assert(value.tenantId == "first")

        val view: Class<*> = SimpleStockFreezeStatusMessage::class.java
        val javaType: JavaType = objectMapper.constructType(object : TypeReference<SimpleStockFreezeStatusMessage>() {})

        //this is Spring message Usage, nextValue()  will throw exception on versions synchronized 
        val value2 = objectMapper.readerWithView(view).forType(javaType).readValues<Any>(json).nextValue()
        println("message ser by readerWithView: $value2")

        assertEquals((value2 as SimpleStockFreezeStatusMessage).tenantId, "first")
    }
}

change dependencies to

    implementation("com.fasterxml.jackson.module:jackson-module-kotlin:2.18.0")

test will be pass

but change to

    implementation("com.fasterxml.jackson.module:jackson-module-kotlin:2.18.0")

    implementation("com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.18.0")

    implementation("com.fasterxml.jackson.core:jackson-core:2.18.0")
    implementation("com.fasterxml.jackson.core:jackson-annotations:2.18.0")
    implementation("com.fasterxml.jackson.core:jackson-databind:2.18.0")

test will be fail

@cowtowncoder

[cowtowncoder]

Ok, that sounds weird indeed. Matching versions should work than non matching (although using later databind than kotlin module should also work, just not vice versa).

[cooperlyt]

I tracked and debugged this issue, and it seems that the problem is not with jackson-module-kotlin, but rather with jackson-databind itself, which fails during the conversion. Using a higher version of jackson-module-kotlin merely suppresses the view, making it appear as if the issue is resolved. I updated my test program to use Java instead of Kotlin, and I still couldn't get the conversion to work correctly. Should I transfer this issue to jackson-databind?

[cowtowncoder]

Yes if it is reproducible with plain java ot belongs under databind module

…

On Sun, Oct 13, 2024 at 1:12 AM cooper lee ***@***.***> wrote: I tracked and debugged this issue, and it seems that the problem is not with jackson-module-kotlin, but rather with jackson-databind itself, which fails during the conversion. Using a higher version of jackson-module-kotlin merely suppresses the view, making it appear as if the issue is resolved. I updated my test program to use Java instead of Kotlin, and I still couldn't get the conversion to work correctly. Should I transfer this issue to jackson-databind? — Reply to this email directly, view it on GitHub <#829 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAANOGJ3QARF4Q243XFUTEDZ3ITNPAVCNFSM6AAAAABOMCJGESVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDIMBYHA3TMNRYGI> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[cooperlyt]

Thanks, I will close this issue