Skip to content

Make type argument in JsonTransformingSerializer nullable #2911

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

Merged
merged 2 commits into from
Jan 28, 2025
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
Original file line number Diff line number Diff line change
Expand Up @@ -98,4 +98,29 @@ class JsonTransformingSerializerTest : JsonTestBase() {
assertEquals(correctExample, json.decodeFromString(DocExample.serializer(), """{"data":["str1"]}""", streaming))
assertEquals(correctExample, json.decodeFromString(DocExample.serializer(), """{"data":"str1"}""", streaming))
}

// Wraps/unwraps {"data":null} to just `null`, because StringData.data is not nullable
object NullableStringDataSerializer : JsonTransformingSerializer<StringData?>(StringData.serializer().nullable) {
override fun transformDeserialize(element: JsonElement): JsonElement {
val data = element.jsonObject["data"]?.jsonPrimitive
if (data?.contentOrNull.isNullOrBlank()) return JsonNull
return element
}

override fun transformSerialize(element: JsonElement): JsonElement {
return if (element is JsonNull) JsonObject(mapOf("data" to JsonNull))
else element
}
}

@Serializable
data class NullableStringDataHolder(@Serializable(NullableStringDataSerializer::class) val stringData: StringData?)

@Test
fun testNullableTransformingSerializer() {
val normalInput = """{"stringData":{"data":"str1"}}"""
val nullInput = """{"stringData":{"data":null}}"""
assertJsonFormAndRestored(NullableStringDataHolder.serializer(), NullableStringDataHolder(StringData("str1")), normalInput)
assertJsonFormAndRestored(NullableStringDataHolder.serializer(), NullableStringDataHolder(null), nullInput)
}
}
2 changes: 1 addition & 1 deletion formats/json/api/kotlinx-serialization-json.klib.api
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ abstract class <#A: kotlin/Any> kotlinx.serialization.json/JsonContentPolymorphi
final fun serialize(kotlinx.serialization.encoding/Encoder, #A) // kotlinx.serialization.json/JsonContentPolymorphicSerializer.serialize|serialize(kotlinx.serialization.encoding.Encoder;1:0){}[0]
}

abstract class <#A: kotlin/Any> kotlinx.serialization.json/JsonTransformingSerializer : kotlinx.serialization/KSerializer<#A> { // kotlinx.serialization.json/JsonTransformingSerializer|null[0]
abstract class <#A: kotlin/Any?> kotlinx.serialization.json/JsonTransformingSerializer : kotlinx.serialization/KSerializer<#A> { // kotlinx.serialization.json/JsonTransformingSerializer|null[0]
Copy link
Member Author

Choose a reason for hiding this comment

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

This particular change is binary compatible in klibs

constructor <init>(kotlinx.serialization/KSerializer<#A>) // kotlinx.serialization.json/JsonTransformingSerializer.<init>|<init>(kotlinx.serialization.KSerializer<1:0>){}[0]

open val descriptor // kotlinx.serialization.json/JsonTransformingSerializer.descriptor|{}descriptor[0]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ import kotlinx.serialization.json.internal.*
* Should be able to parse [JsonElement] from [transformDeserialize] function.
* Usually, default [serializer] is sufficient.
*/
public abstract class JsonTransformingSerializer<T : Any>(
public abstract class JsonTransformingSerializer<T : Any?>(
private val tSerializer: KSerializer<T>
) : KSerializer<T> {

Expand Down