-
Notifications
You must be signed in to change notification settings - Fork 0
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-core to v1.8.0 #11
base: main
Are you sure you want to change the base?
Conversation
Important Review skippedBot user detected. To trigger a single review, invoke the You can disable this status message by setting the WalkthroughThe project has been updated to use version Changes
Sequence Diagram(s)sequenceDiagram
participant Project
participant Library as kotlinx-serialization
Project->>Library: Use version 1.7.2
Library-->>Project: Serialization features
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
6a0aeec
to
276a79f
Compare
276a79f
to
a04ebbc
Compare
a04ebbc
to
5096523
Compare
This PR contains the following updates:
1.7.0
->1.8.0
Release Notes
Kotlin/kotlinx.serialization (org.jetbrains.kotlinx:kotlinx-serialization-core)
v1.8.0
==================
This is a release candidate for the next version. It is based on Kotlin 2.1.0 and includes a few new features, as well
as bugfixes and improvements:
@JsonIgnoreUnknownKeys
annotationPreviously, only global setting
JsonBuilder.ignoreUnknownKeys
controlled whether Json parser would throw exception ifinput contained a property that was not declared in a
@Serializable
class.There were a lot of complaints that this setting is not
flexible enough.
To address them, we added new
@JsonIgnoreUnknownKeys
annotation that can be applied on a per-class basis.With this annotation, it is possible to allow unknown properties for annotated classes, while
general decoding methods (such as
Json.decodeFromString
and others) would still reject them for everything else.See details in the corresponding PR.
Stabilization of
SerialDescriptor
API and@SealedSerializationApi
annotationSerialDescriptor
,SerialKind
, and related API has been around for a long time and has proven itself useful.The main reason
@ExperimentalSerializationApi
was on SerialDescriptor's properties is that we wanted to discouragepeople from subclassing it.
Fortunately, Kotlin 2.1 provides a special mechanism for such a
case — SubclassOptInRequired.
New
kotlinx.serialization.SealedSerializationApi
annotation designates APIsas public for use, but closed for implementation — the case for SerialDescriptor, which is a non-sealed interface for
technical reasons.
Now you can use most of
SerialDescriptor
and its builders API without the need to opt-in into experimentalserialization API.
See the PR for more details.
Note: All
SerialKind
s are stable API now, exceptPolymorphicKind
— we may want to expand it in the future.Generate Java 8's default method implementations in interfaces
TL;DR This change ensures better binary compatibility in the future for library. You should not experience any
difference from it.
kotlinx.serialization library contains a lot of interfaces with default method implementations. Historically, Kotlin
compiled a synthetic
DefaultImpls
class for them.Starting from Kotlin 1.4,
it was possible to compile them using as Java 8's
default
methods to ensurethat new methods can still be added to interfaces without the need for implementors to recompile.
To preserve binary compatibility with existing clients, a special
all-compatbility
mode is supported in compilerto generate both
default
methods and syntheticDefaultImpls
class.Now, kotlinx.serialization finally makes use of this
all-compatibility
mode,which potentially allows us to add new methods to interfaces such as
SerialDescriptor
,Encoder
,Decoder
, etc.,without breaking existing clients. This change is expected to have no effect on existing clients, and no action from
your side is required.
Note that Kotlin 2.2 plans to enable
all-compatibility
mode by default.
Other bugfixes and improvements
is set to NONE (#2833)
v1.7.3
==================
This release aims to fix important issues that were discovered in the 1.7.2 release,
including the inability to sync certain projects into Android Studio/IntelliJ IDEA and exceptions from custom Uuid serializers.
It uses Kotlin 2.0.20 by default.
v1.7.2
==================
This release provides several new features, including a major Cbor configuration rework.
It uses Kotlin 2.0.20 by default.
Cbor feature set for COSE compliance
This change brings a lot of features to the CBOR format, namely:
@CborLabel
annotation andpreferCborLabelsOverNames
flag.encode*Tags
andverify*Tags
set of flagsuseDefiniteLengthEncoding
. This flag affects object encoding, since decoding of arrays with definite lenghts is automatically supported.alwaysUseByteString
flag.Since there are quite a lot of flags now, they were restructured to a separate
CborConfiguration
class, similarly toJsonConfiguration
.It is possible to retrieve this configuration from
CborEncoder/CborDecoder
interfaces in your custom serializers (see their documentation for details).All of these features make it possible to serialize and parse COSE-compliant CBOR, for example, ISO/IEC 18013-5:2021-compliant mobile driving license data.
In case you want to make use of them, there is a predefined
Cbor.CoseCompliant
instance.However, some canonicalization steps (such as sorting keys) still need to be performed manually.
This functionality was contributed to us by Bernd Prünster.
Keeping generated serializers
One of the most requested features for serialization plugin was to continue to generate a serializer even if a custom one is specified for the class.
It allows using a plugin-generated serializer in a fallback or delegate strategy, accessing type structure via descriptor, using default serialization behavior in inheritors that do not use custom serializers.
Starting with this release, you can specify the
@KeepGeneratedSerializer
annotation on the class declaration to instruct the plugin to continue generating the serializer.In this case, the serializer will be accessible using the
.generatedSerializer()
function on the class's companion object.You can check out the examples in the documentation and in the PRs: #2758, #2669.
Serializer for kotlin.uuid.Uuid
Kotlin 2.0.20 added a common class to represent UUIDs in a multiplatform code.
kotlinx.serialization 1.7.2 provides a corresponding
Uuid.serializer()
for it, making it possible to use it in@Serializable
classes.Note that for now, serializer should be provided manually with
@Contextual
annotation.Plugin will be able to automatically insert
Uuid
serializer in Kotlin 2.1.0.See more details in the corresponding PR.
Other bugfixes and improvements
v1.7.1
==================
This is a bugfix release that aims to fix missing
kotlinx-serialization-hocon
artifact.It also contains experimental integration with
kotlinx-io
library.Kotlin 2.0.0 is used by default.
Fixed HOCON publication
Sadly, 1.7.0 release was published incomplete:
kotlinx-serialization-hocon
artifact is missing from 1.7.0 and 1.7.0-RC releases.This release fixes this problem and now
kotlinx-serialization-hocon
is available again with 1.7.1 version.No other changes were made to this artifact. Related ticket: #2717.
Add integration with a kotlinx-io library
kotlinx-io
is an official multiplatform library that provides basic IO primitives, similar to Okio.kotlinx.serialization integration is now available in a separate artifact, located at the
kotlinx-serialization-json-io
coordinates.Integration artifact provides functions similar to existing Okio integration:
encodeToSink
,decodeFromSource
, anddecodeSourceToSequence
.Check out the PR for more details.
Other bugfixes
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 was generated by Mend Renovate. View the repository job log.