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.

Sign up for GitHub

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

Jump to bottom

Fixed a bug in #512. #533

Merged
merged 8 commits into from
Jan 7, 2022
+107 −25
Merged

Fixed a bug in #512. #533

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
844ce35
In order to reduce processing costs, not rewrite if not necessary.
k163377 Jan 3, 2022
b01c4bd
Fix the call would fail if callable.isAccessible was false.
k163377 Jan 3, 2022
c0a58ab
Fix the call would fail if the companion object was private.
k163377 Jan 3, 2022
3428cd3
Fix test case
k163377 Jan 3, 2022
5eca9cd
add comments
k163377 Jan 4, 2022
b19c44f
formatting
k163377 Jan 4, 2022
c9df362
Merge remote-tracking branch 'origin/2.13' into github512/fix
dinomite Jan 5, 2022
9aa88e5
Fixed to public
k163377 Jan 7, 2022
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
3 changes: 2 additions & 1 deletion src/main/kotlin/com/fasterxml/jackson/module/kotlin/ConstructorValueCreator.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ internal class ConstructorValueCreator<T>(override val callable: KFunction<T>) :
override val accessible: Boolean = callable.isAccessible

init {
callable.isAccessible = true
// To prevent the call from failing, save the initial value and then rewrite the flag.
if (!accessible) callable.isAccessible = true
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would you add a note here or in the class comment as to why isAccessible is being forced to true?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.
5eca9cd

}
}
9 changes: 7 additions & 2 deletions src/main/kotlin/com/fasterxml/jackson/module/kotlin/MethodValueCreator.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,19 @@ internal class MethodValueCreator<T> private constructor(
// abort, we have some unknown case here
if (!possibleCompanion.isCompanion) return null

// To prevent the call from failing, save the initial value and then rewrite the flag.
val initialCallableAccessible = callable.isAccessible
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good name 👍

if (!initialCallableAccessible) callable.isAccessible = true

val (companionObjectInstance: Any, accessible: Boolean) = try {
// throws ex
val instance = possibleCompanion.objectInstance!!

// If an instance of the companion object can be obtained, accessibility depends on the KFunction
instance to callable.isAccessible
instance to initialCallableAccessible
} catch (ex: IllegalAccessException) {
// fallback for when an odd access exception happens through Kotlin reflection
possibleCompanion.java.enclosingClass.fields
possibleCompanion.java.enclosingClass.declaredFields
.firstOrNull { it.type.kotlin.isCompanion }
?.let {
it.isAccessible = true
Expand Down
120 changes: 98 additions & 22 deletions src/test/kotlin/com/fasterxml/jackson/module/kotlin/test/ParameterNameTests.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,13 @@ class TestJacksonWithKotlin {
val wrongName: Boolean
val createdDt: Date

fun validate(nameField: String = name, ageField: Int = age, addressField: String = primaryAddress, wrongNameField: Boolean = wrongName, createDtField: Date = createdDt) {
fun validate(
nameField: String = name,
ageField: Int = age,
addressField: String = primaryAddress,
wrongNameField: Boolean = wrongName,
createDtField: Date = createdDt
) {
assertThat(nameField, equalTo("Frank"))
assertThat(ageField, equalTo(30))
assertThat(addressField, equalTo("something here"))
Expand All @@ -50,7 +56,10 @@ class TestJacksonWithKotlin {

// ==================

private class DefaultAndSpecificConstructor(override var name: String = "", override var age: Int = 0) : TestFields {
private class DefaultAndSpecificConstructor(
override var name: String = "",
override var age: Int = 0
) : TestFields {
@JsonProperty("renamed")
override var wrongName: Boolean = false

Expand All @@ -65,7 +74,13 @@ class TestJacksonWithKotlin {

// ==================

private class NoFailWithoutJsonCreator(override val name: String, override val age: Int, override val primaryAddress: String, val renamed: Boolean, override val createdDt: Date) : TestFields {
private class NoFailWithoutJsonCreator(
override val name: String,
override val age: Int,
override val primaryAddress: String,
val renamed: Boolean,
override val createdDt: Date
) : TestFields {
@JsonIgnore
override val wrongName = renamed // here for the test validation only
}
Expand All @@ -77,7 +92,13 @@ class TestJacksonWithKotlin {

// ==================

private data class StateObjectAsDataClassExplicitJsonCreator @JsonCreator constructor(override val name: String, override val age: Int, override val primaryAddress: String, val renamed: Boolean, override val createdDt: Date) : TestFields {
private data class StateObjectAsDataClassExplicitJsonCreator @JsonCreator constructor(
override val name: String,
override val age: Int,
override val primaryAddress: String,
val renamed: Boolean,
override val createdDt: Date
) : TestFields {
@JsonIgnore
override val wrongName = renamed // here for the test validation only
}
Expand All @@ -95,11 +116,18 @@ class TestJacksonWithKotlin {

// ==================

private data class StateObjectAsDataClassWithJsonCreatorAndJsonProperty @JsonCreator constructor(override val name: String, override val age: Int, override val primaryAddress: String, @JsonProperty("renamed") override val wrongName: Boolean, override val createdDt: Date) : TestFields
private data class StateObjectAsDataClassWithJsonCreatorAndJsonProperty @JsonCreator constructor(
override val name: String,
override val age: Int,
override val primaryAddress: String,
@JsonProperty("renamed") override val wrongName: Boolean,
override val createdDt: Date
) : TestFields

@Test fun testDataClassWithExplicitJsonCreatorAndJsonProperty() {
// data class with JsonCreator and JsonProperty
val stateObj = normalCasedMapper.readValue<StateObjectAsDataClassWithJsonCreatorAndJsonProperty>(normalCasedJson)
val stateObj = normalCasedMapper
.readValue<StateObjectAsDataClassWithJsonCreatorAndJsonProperty>(normalCasedJson)
stateObj.validate()

val test1out = normalCasedMapper.writeValueAsString(stateObj)
Expand All @@ -108,7 +136,13 @@ class TestJacksonWithKotlin {

// ==================

private class StateObjectAsNormalClass @JsonCreator constructor(override val name: String, override val age: Int, override val primaryAddress: String, @JsonProperty("renamed") override val wrongName: Boolean, override val createdDt: Date) : TestFields
private class StateObjectAsNormalClass @JsonCreator constructor(
override val name: String,
override val age: Int,
override val primaryAddress: String,
@JsonProperty("renamed") override val wrongName: Boolean,
override val createdDt: Date
) : TestFields

@Test fun testNormalClassWithJsonCreator() {
// normal class
Expand All @@ -118,7 +152,11 @@ class TestJacksonWithKotlin {

// ==================

private class StateObjectWithPartialFieldsInConstructor(override val name: String, override val age: Int, override val primaryAddress: String) : TestFields {
private class StateObjectWithPartialFieldsInConstructor(
override val name: String,
override val age: Int,
override val primaryAddress: String
) : TestFields {
@JsonProperty("renamed") override var wrongName: Boolean = false
override var createdDt: Date by Delegates.notNull()
}
Expand All @@ -131,13 +169,15 @@ class TestJacksonWithKotlin {

// ==================

private class StateObjectAsDataClassConfusingConstructor constructor (@Suppress("UNUSED_PARAMETER") nonField: String?,
override val name: String,
@Suppress("UNUSED_PARAMETER") yearOfBirth: Int,
override val age: Int,
override val primaryAddress: String,
@JsonProperty("renamed") override val wrongName: Boolean,
override val createdDt: Date) : TestFields
private class StateObjectAsDataClassConfusingConstructor constructor(
@Suppress("UNUSED_PARAMETER") nonField: String?,
override val name: String,
@Suppress("UNUSED_PARAMETER") yearOfBirth: Int,
override val age: Int,
override val primaryAddress: String,
@JsonProperty("renamed") override val wrongName: Boolean,
override val createdDt: Date
) : TestFields

@Test fun testDataClassWithNonFieldParametersInConstructor() {
// data class with non fields appearing as parameters in constructor, this works but null values or defaults for primitive types are passed to
Expand All @@ -162,10 +202,22 @@ class TestJacksonWithKotlin {

// ==================

private class StateObjectWithFactory private constructor (override val name: String, override val age: Int, override val primaryAddress: String, override val wrongName: Boolean, override val createdDt: Date) : TestFields {
private class StateObjectWithFactory private constructor(
override val name: String,
override val age: Int,
override val primaryAddress: String,
override val wrongName: Boolean,
override val createdDt: Date
) : TestFields {
var factoryUsed: Boolean = false
companion object {
@JvmStatic @JsonCreator fun create(@JsonProperty("name") nameThing: String, @JsonProperty("age") age: Int, @JsonProperty("primaryAddress") primaryAddress: String, @JsonProperty("renamed") wrongName: Boolean, @JsonProperty("createdDt") createdDt: Date): StateObjectWithFactory {
@JvmStatic @JsonCreator fun create(
@JsonProperty("name") nameThing: String,
@JsonProperty("age") age: Int,
@JsonProperty("primaryAddress") primaryAddress: String,
@JsonProperty("renamed") wrongName: Boolean,
@JsonProperty("createdDt") createdDt: Date
): StateObjectWithFactory {
val obj = StateObjectWithFactory(nameThing, age, primaryAddress, wrongName, createdDt)
obj.factoryUsed = true
return obj
Expand All @@ -179,9 +231,21 @@ class TestJacksonWithKotlin {
assertThat(stateObj.factoryUsed, equalTo(true))
}

private class StateObjectWithFactoryNoParamAnnotations(val name: String, val age: Int, val primaryAddress: String, val renamed: Boolean, val createdDt: Date) {
private class StateObjectWithFactoryNoParamAnnotations(
val name: String,
val age: Int,
val primaryAddress: String,
val renamed: Boolean,
val createdDt: Date
) {
companion object {
@JvmStatic @JsonCreator fun create(name: String, age: Int, primaryAddress: String, renamed: Boolean, createdDt: Date): StateObjectWithFactoryNoParamAnnotations {
@JvmStatic @JsonCreator fun create(
name: String,
age: Int,
primaryAddress: String,
renamed: Boolean,
createdDt: Date
): StateObjectWithFactoryNoParamAnnotations {
return StateObjectWithFactoryNoParamAnnotations(name, age, primaryAddress, renamed, createdDt)
}
}
Expand All @@ -197,10 +261,22 @@ class TestJacksonWithKotlin {
}
}

private class StateObjectWithFactoryOnNamedCompanion private constructor (override val name: String, override val age: Int, override val primaryAddress: String, override val wrongName: Boolean, override val createdDt: Date) : TestFields {
private class StateObjectWithFactoryOnNamedCompanion private constructor(
override val name: String,
override val age: Int,
override val primaryAddress: String,
override val wrongName: Boolean,
override val createdDt: Date
) : TestFields {
var factoryUsed: Boolean = false
companion object Named {
@JvmStatic @JsonCreator fun create(@JsonProperty("name") nameThing: String, @JsonProperty("age") age: Int, @JsonProperty("primaryAddress") primaryAddress: String, @JsonProperty("renamed") wrongName: Boolean, @JsonProperty("createdDt") createdDt: Date): StateObjectWithFactoryOnNamedCompanion {
private companion object Named {
@JvmStatic @JsonCreator fun create(
@JsonProperty("name") nameThing: String,
@JsonProperty("age") age: Int,
@JsonProperty("primaryAddress") primaryAddress: String,
@JsonProperty("renamed") wrongName: Boolean,
@JsonProperty("createdDt") createdDt: Date
): StateObjectWithFactoryOnNamedCompanion {
val obj = StateObjectWithFactoryOnNamedCompanion(nameThing, age, primaryAddress, wrongName, createdDt)
obj.factoryUsed = true
return obj
Expand Down