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

Support serialization of collections that are not lists #1821

Merged
merged 5 commits into from Jan 28, 2022
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Expand Up @@ -54,7 +54,7 @@ public sealed class AbstractCollectionSerializer<Element, Collection, Builder> :
}

@PublishedApi
internal sealed class ListLikeSerializer<Element, Collection, Builder>(
internal sealed class CollectionLikeSerializer<Element, Collection, Builder>(
private val elementSerializer: KSerializer<Element>
) : AbstractCollectionSerializer<Element, Collection, Builder>() {

Expand All @@ -70,13 +70,13 @@ internal sealed class ListLikeSerializer<Element, Collection, Builder>(
}
}

protected final override fun readAll(decoder: CompositeDecoder, builder: Builder, startIndex: Int, size: Int) {
final override fun readAll(decoder: CompositeDecoder, builder: Builder, startIndex: Int, size: Int) {
sandwwraith marked this conversation as resolved.
Show resolved Hide resolved
require(size >= 0) { "Size must be known in advance when using READ_ALL" }
for (index in 0 until size)
readElement(decoder, startIndex + index, builder, checkIndex = false)
}

protected override fun readElement(decoder: CompositeDecoder, index: Int, builder: Builder, checkIndex: Boolean) {
override fun readElement(decoder: CompositeDecoder, index: Int, builder: Builder, checkIndex: Boolean) {
builder.insert(index, decoder.decodeSerializableElement(descriptor, index, elementSerializer))
}
}
Expand Down Expand Up @@ -143,7 +143,7 @@ internal abstract class PrimitiveArrayBuilder<Array> internal constructor() {
internal abstract class PrimitiveArraySerializer<Element, Array, Builder
: PrimitiveArrayBuilder<Array>> internal constructor(
primitiveSerializer: KSerializer<Element>
) : ListLikeSerializer<Element, Array, Builder>(primitiveSerializer) {
) : CollectionLikeSerializer<Element, Array, Builder>(primitiveSerializer) {
final override val descriptor: SerialDescriptor = PrimitiveArrayDescriptor(primitiveSerializer.descriptor)

final override fun Builder.builderSize(): Int = position
Expand All @@ -160,7 +160,7 @@ internal abstract class PrimitiveArraySerializer<Element, Array, Builder

protected abstract fun empty(): Array

protected abstract override fun readElement(
abstract override fun readElement(
decoder: CompositeDecoder,
index: Int,
builder: Builder,
Expand All @@ -184,7 +184,7 @@ internal abstract class PrimitiveArraySerializer<Element, Array, Builder
internal class ReferenceArraySerializer<ElementKlass : Any, Element : ElementKlass?>(
private val kClass: KClass<ElementKlass>,
eSerializer: KSerializer<Element>
) : ListLikeSerializer<Element, Array<Element>, ArrayList<Element>>(eSerializer) {
) : CollectionLikeSerializer<Element, Array<Element>, ArrayList<Element>>(eSerializer) {
override val descriptor: SerialDescriptor = ArrayClassDesc(eSerializer.descriptor)

override fun Array<Element>.collectionSize(): Int = size
Expand All @@ -202,12 +202,17 @@ internal class ReferenceArraySerializer<ElementKlass : Any, Element : ElementKla
}
}

@PublishedApi
internal abstract class CollectionSerializer<E, C: Collection<E>, B>(element: KSerializer<E>) : CollectionLikeSerializer<E, C, B>(element) {
override fun C.collectionSize(): Int = size
override fun C.collectionIterator(): Iterator<E> = iterator()
}

@InternalSerializationApi
@PublishedApi
internal class ArrayListSerializer<E>(element: KSerializer<E>) : ListLikeSerializer<E, List<E>, ArrayList<E>>(element) {
internal class ArrayListSerializer<E>(element: KSerializer<E>) : CollectionSerializer<E, List<E>, ArrayList<E>>(element) {
override val descriptor: SerialDescriptor = ArrayListClassDesc(element.descriptor)
override fun List<E>.collectionSize(): Int = size
override fun List<E>.collectionIterator(): Iterator<E> = iterator()

override fun builder(): ArrayList<E> = arrayListOf()
override fun ArrayList<E>.builderSize(): Int = size
override fun ArrayList<E>.toResult(): List<E> = this
Expand All @@ -219,11 +224,9 @@ internal class ArrayListSerializer<E>(element: KSerializer<E>) : ListLikeSeriali
@PublishedApi
internal class LinkedHashSetSerializer<E>(
eSerializer: KSerializer<E>
) : ListLikeSerializer<E, Set<E>, LinkedHashSet<E>>(eSerializer) {

) : CollectionSerializer<E, Set<E>, LinkedHashSet<E>>(eSerializer) {
override val descriptor: SerialDescriptor = LinkedHashSetClassDesc(eSerializer.descriptor)
override fun Set<E>.collectionSize(): Int = size
override fun Set<E>.collectionIterator(): Iterator<E> = iterator()

override fun builder(): LinkedHashSet<E> = linkedSetOf()
override fun LinkedHashSet<E>.builderSize(): Int = size
override fun LinkedHashSet<E>.toResult(): Set<E> = this
Expand All @@ -235,11 +238,9 @@ internal class LinkedHashSetSerializer<E>(
@PublishedApi
internal class HashSetSerializer<E>(
eSerializer: KSerializer<E>
) : ListLikeSerializer<E, Set<E>, HashSet<E>>(eSerializer) {

) : CollectionSerializer<E, Set<E>, HashSet<E>>(eSerializer) {
override val descriptor: SerialDescriptor = HashSetClassDesc(eSerializer.descriptor)
override fun Set<E>.collectionSize(): Int = size
override fun Set<E>.collectionIterator(): Iterator<E> = iterator()

override fun builder(): HashSet<E> = HashSet()
override fun HashSet<E>.builderSize(): Int = size
override fun HashSet<E>.toResult(): Set<E> = this
Expand Down
Expand Up @@ -31,13 +31,13 @@ class SealedGenericClassesTest {
// Test that compilation and retrieval is successful
@Test
fun testQuery() {
val serial1 = Query.SimpleQuery.serializer(String.serializer())
val serial2 = Query.serializer(UnitSerializer)
Query.SimpleQuery.serializer(String.serializer())
Query.serializer(UnitSerializer)
}

@Test
fun testFetcher() {
val serial1 = Fetcher.SomethingFetcher.serializer()
val serial2 = Fetcher.serializer(Something.serializer())
Fetcher.SomethingFetcher.serializer()
Fetcher.serializer(Something.serializer())
}
}
@@ -0,0 +1,41 @@
/*
* Copyright 2017-2022 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/

package kotlinx.serialization.features

import kotlinx.serialization.*
import kotlinx.serialization.builtins.*
import kotlinx.serialization.json.Json
import kotlinx.serialization.test.*
import kotlin.test.*

class CollectionSerializerTest {

@Serializable
data class CollectionWrapper(
val collection: Collection<String>
)

@Test
fun testListJson() {
val list = listOf("foo", "bar", "foo", "bar")

val string = Json.encodeToString(CollectionWrapper(list))
assertEquals("""{"collection":["foo","bar","foo","bar"]}""", string)

val wrapper = Json.decodeFromString<CollectionWrapper>(string)
assertEquals(list, wrapper.collection)
}

@Test
fun testSetJson() {
val set = setOf("foo", "bar", "foo", "bar")

val string = Json.encodeToString(CollectionWrapper(set))
assertEquals("""{"collection":["foo","bar"]}""", string)

val wrapper = Json.decodeFromString<CollectionWrapper>(string)
assertEquals(set.toList(), wrapper.collection)
}
}