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

Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.7.0 #710

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Jun 6, 2024

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
org.jetbrains.kotlinx:kotlinx-serialization-json 1.6.3 -> 1.7.0 age adoption passing confidence

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 that serializersModule.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 impossible
to 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 if T 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:

interface SomeInterface

val module = SerializersModule {
    contextual(SomeInterface::class, CustomSomeInterfaceSerializer)
}

// Prints PolymorphicSerializer<SomeInterface>:
println(module.serializer<SomeInterface>())

Behavior in 1.7.0-RC, 1.7.0, and higher:

interface SomeInterface

val module = SerializersModule {
    contextual(SomeInterface::class, CustomSomeInterfaceSerializer)
}

// Prints CustomSomeInterfaceSerializer:
println(module.serializer<SomeInterface>())

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 API

This 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 ProtoBuf

oneof 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
  • Update okio to 3.9.0 version (#​2671)
  • Add extension to access original descriptor from one made with SerialDescriptor.nullable (#​2633) (thanks to Chuckame)
  • Use @​SerialName of inline polymorphic children in Json (#​2601) (thanks to Tad Fisher)
  • Fix serializing nulls for a property of a parameterized type with a nullable upper bound with Protobuf (#​2561) (thanks to Shreck Ye)
  • Fixed type discriminator value for custom serializer that uses encodeJsonElement (#​2628)
  • Refine exception messages in case of deserializing data from JsonElement. (#​2648)

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.


  • If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

@renovate renovate bot added the dependencies label Jun 6, 2024
@eygraber eygraber enabled auto-merge (squash) June 6, 2024 16:46
@renovate renovate bot force-pushed the renovate/org.jetbrains.kotlinx-kotlinx-serialization-json-1.x branch from ac5c53f to 0ca75cc Compare June 6, 2024 16:51
@eygraber eygraber merged commit d945b08 into master Jun 6, 2024
8 checks passed
@eygraber eygraber deleted the renovate/org.jetbrains.kotlinx-kotlinx-serialization-json-1.x branch June 6, 2024 18:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant