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 #20

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented May 16, 2022

Mend Renovate

This PR contains the following updates:

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

Warning

Some dependencies could not be looked up. Check the Dependency Dashboard for more information.


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)

v1.6.3

==================

This release provides a couple of new features and uses Kotlin 1.9.22 as default.

Class discriminator output mode

Class discriminator provides information for serializing and deserializing polymorphic class hierarchies.
In case you want to encode more or less information for various third party APIs about types in the output, it is possible to control
addition of the class discriminator with the JsonBuilder.classDiscriminatorMode property.
For example, ClassDiscriminatorMode.NONE does not add class discriminator at all, in case the receiving party is not interested in Kotlin types.
You can learn more about this feature in the documentation and corresponding PR.

Other features
Bugfixes and improvements
  • Fix: Hocon polymorphic serialization in containers (#​2151) (thanks to LichtHund)
  • Actualize lenient mode documentation (#​2568)
  • Slightly improve error messages thrown from serializer() function (#​2533)
  • Do not try to coerce input values for properties (#​2530)
  • Make empty objects and arrays collapsed in pretty print mode (#​2506)
  • Update Gradle dokka configuration to make sure "source" button is visible in all API docs (#​2518, #​2524)

v1.6.2

v1.6.1

==================

This release uses Kotlin 1.9.20 by default, while upcoming 1.9.21 is also supported.

Trailing commas in Json

Trailing commas are one of the most popular non-spec Json variations.
A new configuration flag, allowTrailingComma, makes Json parser accept them instead of throwing an exception.
Note that it does not affect encoding, so kotlinx.serialization always produces Json without trailing commas.
See details in the corresponding PR

Support of WasmJs target

Kotlin/Wasm has been experimental for some time and gained enough maturity to be added to the kotlinx libraries.
Starting with 1.6.1, kotlinx.serialization provides a wasm-js flavor, so your projects with Kotlin/Wasm can have even more
functionality.
As usual, just add serialization dependencies to your build
and declare wasmJs target.
Please remember that Kotlin/Wasm is still experimental, so changes are expected.

Bugfixes and improvements

v1.6.0

==================

This release contains all features and bugfixes from 1.6.0-RC plus some bugfixes on its own (see below).
Kotlin 1.9.0 is used as a default, while 1.9.10 is also supported.

Bugfixes

v1.5.1

==================
This release contains an important Native targets overhaul, as well as numerous enhancements and bugfixes.
Kotlin 1.8.21 is used by default.

New set of Native targets

The official Kotlin target support policy has recently been published
describing new target policy: each target belongs to a certain tier, and different tiers have different stability guarantees.
The official recommendation for library authors is to support targets up to Tier 3,
and kotlinx.serialization now follows it.
It means that in this release, there are a lot of new targets added from this tier,
such as androidNativeX86 or watchosDeviceArm64.
Note that since they belong to Tier 3, they're not auto-tested on CI.

kotlinx.serialization also ships some deprecated Kotlin/Native targets that do not belong to any tier (e.g. iosArm32, mingwX86).
We'll continue to release them, but we do not provide support for them, nor do we plan to add new targets from the deprecated list.

Improvements in Json elements

There are two new function sets that should make creating raw Json elements easier.
First one contains overloads for JsonPrimitive constructor-like function
that accept unsigned types: JsonPrimitive(1u).
Second one adds new addAll functions to JsonArrayBuilder to be used with collections
of numbers, booleans or strings: buildJsonArray { addAll(listOf(1, 2, 3)) }
Both were contributed to us by aSemy.

Other enhancements
  • Potential source-breaking change: Rename json-okio target variables to sink (#​2226)
  • Function to retrieve KSerializer by KClass and type arguments serializers (#​2291)
  • Added FormatLanguage annotation to Json methods (#​2234)
  • Properties Format: Support sealed/polymorphic classes as class properties (#​2255)
Bugfixes
  • KeyValueSerializer: Fix missing call to endStructure() (#​2272)
  • ObjectSerializer: Respect sequential decoding (#​2273)
  • Fix value class encoding in various corner cases (#​2242)
  • Fix incorrect json decoding iterator's .hasNext() behavior on array-wrapped inputs (#​2268)
  • Fix memory leak caused by invalid KTypeWrapper's equals method (#​2274)
  • Fixed NoSuchMethodError when parsing a JSON stream on Java 8 (#​2219)
  • Fix MissingFieldException duplication (#​2213)

v1.5.0

==================

This release contains all features and bugfixes from 1.5.0-RC plus some experimental features and bugfixes on its own (see below).
Kotlin 1.8.10 is used as a default.

HoconEncoder and HoconDecoder interfaces and HOCON-specific serializers

These interfaces work in a way similar to JsonEncoder and JsonDecoder: they allow intercepting (de)serialization process,
making writing if custom HOCON-specific serializers easier. New ConfigMemorySizeSerializer and JavaDurationSerializer already make use of them.
See more details in the PR.
Big thanks to Alexander Mikhailov for contributing this!

Ability to read buffered huge strings in custom Json deserializers

New interface ChunkedDecoder allows you to read huge strings that may not fit in memory by chunks.
Currently, this interface is only implemented by Json decoder that works with strings and streams,
but we may expand it later, if there's a demand for it.
See more details in the PR authored by Alexey Sviridov.

Bugfixes
  • Improve runtime exceptions messages (#​2180)
  • Added support for null values for nullable enums in lenient mode (#​2176)
  • Prevent class loaders from leaking when using ClassValue cache (#​2175)

v1.4.1

==================

This is patch release contains several bugfixes and improvements.
Kotlin 1.7.20 is used by default.

Improvements
  • Add @​MustBeDocumented to certain annotations (#​2059)
  • Deprecate .isNullable in SerialDescriptor builder (#​2040)
  • Unsigned primitives and unsigned arrays serializers can be retrieved as built-ins (#​1992)
  • Serializers are now cached inside reflective lookup, leading to faster serializer retrieval (#​2015)
  • Compiler plugin can create enum serializers using static factories for better speed (#​1851) (Kotlin 1.7.20 required)
  • Provide foundation for compiler plugin intrinsics available in Kotlin 1.8.0 (#​2031)
Bugfixes

v1.4.0

==================

This release contains all features and bugfixes from 1.4.0-RC plus some bugfixes on its own (see below).
Kotlin 1.7.10 is used as a default.

Bugfixes
  • Fixed decoding of huge JSON data for okio streams (#​2006)

v1.3.3

==================

This release contains support for Protocol Buffers packed fields, as well as several bugfixes.
It uses Kotlin 1.6.21 by default.

Protobuf packed fields

It is now possible to encode and decode Kotlin classes to/from Protobuf messages with packed repeated fields.
To mark the field as packed, use @ProtoPacked annotation on it.
Note it affects only List and primitive collection such as IntArray types.
With this feature, it is now possible to decode Proto3 messages, where all repeated fields are packed by default.
Protobuf schema generator also supports new @ProtoPacked annotation.

Many thanks to Paul de Vrieze for his valuable contribution!

Other improvements & small features
  • Incorporate JsonPath into exception messages (#​1841)
  • Mark block in corresponding encodeStructure/decodeStructure extensions as crossinline to reduce amount of bytecode (#​1917)
  • Support serialization of compile-time Collection<E> properties that are not lists at the runtime (#​1821)
  • Best-effort kotlin reflect avoidance in serializer(Type) (#​1819)
Bugfixes
  • Iterate over element indices in ObjectSerializer in order to let the format skip unknown keys (#​1916)
  • Correctly support registering both default polymorphic serializer & deserializer (#​1849)
  • Make error message for captured generic type parameters much more straightforward (#​1863)

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Enabled.

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 force-pushed the renovate/org.jetbrains.kotlinx-kotlinx-serialization-json-1.x branch from 62ea506 to 193f22c Compare September 25, 2022 21:08
@renovate renovate bot changed the title Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.3.3 Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.4.0 Sep 25, 2022
@renovate renovate bot force-pushed the renovate/org.jetbrains.kotlinx-kotlinx-serialization-json-1.x branch from 193f22c to b58f9ef Compare November 20, 2022 08:54
@renovate renovate bot changed the title Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.4.0 Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.4.1 Nov 20, 2022
@renovate renovate bot force-pushed the renovate/org.jetbrains.kotlinx-kotlinx-serialization-json-1.x branch from b58f9ef to 2ce841b Compare March 18, 2023 14:04
@renovate renovate bot changed the title Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.4.1 Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.5.0 Mar 18, 2023
@renovate renovate bot changed the title Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.5.0 Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.5.1 May 28, 2023
@renovate renovate bot force-pushed the renovate/org.jetbrains.kotlinx-kotlinx-serialization-json-1.x branch from 2ce841b to 292be55 Compare May 28, 2023 10:55
@renovate renovate bot changed the title Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.5.1 Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.6.0 Aug 22, 2023
@renovate renovate bot force-pushed the renovate/org.jetbrains.kotlinx-kotlinx-serialization-json-1.x branch from 292be55 to 5f9f58f Compare August 22, 2023 20:20
@renovate renovate bot force-pushed the renovate/org.jetbrains.kotlinx-kotlinx-serialization-json-1.x branch from 5f9f58f to fce98c0 Compare November 13, 2023 15:15
@renovate renovate bot changed the title Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.6.0 Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.6.1 Nov 15, 2023
@renovate renovate bot force-pushed the renovate/org.jetbrains.kotlinx-kotlinx-serialization-json-1.x branch from fce98c0 to a948290 Compare November 15, 2023 16:03
@renovate renovate bot changed the title Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.6.1 Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.6.2 Nov 30, 2023
@renovate renovate bot force-pushed the renovate/org.jetbrains.kotlinx-kotlinx-serialization-json-1.x branch from a948290 to 548a391 Compare November 30, 2023 17:39
@renovate renovate bot force-pushed the renovate/org.jetbrains.kotlinx-kotlinx-serialization-json-1.x branch from 548a391 to 1abf8d2 Compare February 16, 2024 19:15
@renovate renovate bot changed the title Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.6.2 Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.6.3 Feb 16, 2024
@renovate renovate bot force-pushed the renovate/org.jetbrains.kotlinx-kotlinx-serialization-json-1.x branch from 1abf8d2 to e18da29 Compare June 6, 2024 16:54
@renovate renovate bot changed the title Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.6.3 Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.7.0 Jun 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

0 participants