Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.7.0 #710
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
1.6.3
->1.7.0
Release Notes
Kotlin/kotlinx.serialization (org.jetbrains.kotlinx:kotlinx-serialization-json)
v1.7.0
==================
This is a release candidate for the next version. It is based on Kotlin 2.0.0-RC3 and is fully compatible with a stable Kotlin 2.0 release.
Due to a potential breaking change (see below), it requires a compiler plugin with a version at least of 2.0.0-RC1.
Important change: priority of PolymorphicSerializer for interfaces during call to serializer() function
Non-sealed interfaces in kotlinx.serialization are always serializable with a polymorphic serializer,
even if they do not have
@Serializable
annotation. This also means thatserializersModule.serializer<SomeInterface>()
call will return you a serializer capable of polymorphism.This function was written in a way that it unconditionally returns a
PolymorphicSerializer
if type argument is a non-sealed interface.This caused problems with
SerializersModule
functionality, because actual module was not taken into consideration, and therefore it was impossibleto override serializer for interface using 'contextual serialization' feature. The problem is described in details here.
To overcome these problems, we had to change the behavior of this function regarding interfaces. It now looks into
SerializersModule
first ifT
is a non-sealed interface,and only if there is no registered contextual serializer for
T
, it returns a polymorphic serializer.Behavior before 1.7.0-RC:
Behavior in 1.7.0-RC, 1.7.0, and higher:
We expect minimal impact from this change but be aware of it anyway.
Implementation details are available in this PR.
Due to the serializer() function being also a compiler intrinsic, code
of kotlinx.serialization compiler plugin also accommodates for this change in 2.0 branch. To get a consistent result from both plugin and runtime,
kotlinx.serialization compiler plugin should be at least of 2.0.0-RC1 version.
To verify so, 1.7.0-RC runtime will be rejected by older plugins.
Json configuration flag to allow commentaries
While JSON standard does not allow any kind of commentaries, they are one of the most popular extensions — for example,
commentaries are widely used in configuration files.
To support this use-case, we added a new configuration flag,
allowComments
.This flag allows the parser to skip over C/Java-style commentaries in JSON input.
Note that commentaries cannot affect decoding or encoding in any way and are not stored anywhere.
See details in the PR.
Promote
JsonConfiguration.explicitNulls
to a stable APIThis configuration flag has been around for a long time and got positive feedback.
Therefore, we are promoting it to a stable state.
It also received functionality enhancements when used with
JsonConfiguration.coerceInputValues
(#2586).See related PR for details.
oneof
support in ProtoBufoneof
fields in protobuf messages represent a set of optional fields, where the only one of them is present.With the help of the new
@ProtoOneOf
annotation, you can naturally map them to Kotlin's sealed class hierarchy.Check out the comprehensive guide for this feature here.
This functionality was contributed to us by xzk.
Other improvements and bugfixes
encodeJsonElement
(#2628)Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Mend Renovate. View repository job log here.