Skip to content

Add kotlin.time.Instant serializers #2945

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.

Sign up for GitHub

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

Open
wants to merge 9 commits into
base: dev
Choose a base branch
from
Open

Add kotlin.time.Instant serializers #2945

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
288f73c
Update to Dokka 2.0.0 (#2927)
whyoleg Apr 10, 2025
4a0530d
Add kotlin.time.Instant serializers
dkhalanskyjb Mar 4, 2025
dd9909f
Move the tests for the Instant serializers
dkhalanskyjb Mar 4, 2025
eea8b48
Improve the documentation
dkhalanskyjb Mar 7, 2025
9030611
Remove an old workaround for the JS compiler bug
dkhalanskyjb Mar 7, 2025
22a5509
Remove an excessive test
dkhalanskyjb Mar 7, 2025
973a6e8
Revork the Instant serializers tests
dkhalanskyjb Mar 7, 2025
7587980
Address the review
dkhalanskyjb Apr 15, 2025
5efb20f
Check shouldEncodeElementDefault in InstantComponentSerializer
dkhalanskyjb Apr 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion core/commonMain/src/kotlinx/serialization/builtins/InstantComponentSerializer.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ public object InstantComponentSerializer : KSerializer<Instant> {
override fun serialize(encoder: Encoder, value: Instant) {
encoder.encodeStructure(descriptor) {
encodeLongElement(descriptor, 0, value.epochSeconds)
if (value.nanosecondsOfSecond != 0) {
if (value.nanosecondsOfSecond != 0 || shouldEncodeElementDefault(descriptor, 1)) {
encodeIntElement(descriptor, 1, value.nanosecondsOfSecond)
}
}
Expand Down
11 changes: 9 additions & 2 deletions formats/json-tests/commonTest/src/kotlinx/serialization/InstantSerializationTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,21 @@ class InstantSerializationTest: JsonTestBase() {
Pair(Instant.fromEpochSeconds(987654321, 123456789),
"{\"epochSeconds\":987654321,\"nanosecondsOfSecond\":123456789}"),
Pair(Instant.fromEpochSeconds(987654321, 0),
"{\"epochSeconds\":987654321}"),
"{\"epochSeconds\":987654321,\"nanosecondsOfSecond\":0}"),
)) {
assertJsonFormAndRestored(serializer, instant, json)
}
// check that having a `"nanosecondsOfSecond": 0` field doesn't break deserialization
// by default, `nanosecondsOfSecond` is optional
assertJsonFormAndRestored(serializer, Instant.fromEpochSeconds(987654321, 0),
"{\"epochSeconds\":987654321}", Json { })
Comment on lines +52 to +54
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The comment might clarify that the default test json instance has encoding defaults enabled. the nanosecondsOfSecond element is always optional, but the format decides whether to serialize the default value. You might replace Json {} with Json(default) { encodeDefaults = false } to both take in the remainder of the default test configuration and communicate that it set to false here.

// having a `"nanosecondsOfSecond": 0` field doesn't break deserialization
assertEquals(Instant.fromEpochSeconds(987654321, 0),
Json.decodeFromString(serializer,
"{\"epochSeconds\":987654321,\"nanosecondsOfSecond\":0}"))
// as does not having a `"nanosecondsOfSecond"` field if `encodeDefaults` is true
assertEquals(Instant.fromEpochSeconds(987654321, 0),
default.decodeFromString(serializer,
"{\"epochSeconds\":987654321}"))
// "epochSeconds" should always be present
assertFailsWith<SerializationException> { Json.decodeFromString(serializer, "{}") }
assertFailsWith<SerializationException> { Json.decodeFromString(serializer, "{\"nanosecondsOfSecond\":3}") }
Expand Down