Remove kotlinx.datetime.Instant while preserving binary compatibility
#506
+3,010
−1,279
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR updates the README documentation to reflect the removal of kotlinx.datetime.Instant in favor of kotlin.time.Instant while maintaining binary compatibility.
- Updated documentation examples to use kotlin.time.Instant and kotlin.time.Clock.
- Revised migration instructions and compatibility notes regarding the deprecation of kotlinx.datetime.Instant and kotlinx.datetime.Clock.
- Adjusted library version compatibility and clarified usage notes for different platforms.
Files not reviewed (19)
- core/api/kotlinx-datetime.api: Language not supported
- core/api/kotlinx-datetime.klib.api: Language not supported
- core/build.gradle.kts: Language not supported
- core/common/src/Clock.kt: Language not supported
- core/common/src/DeprecatedClock.kt: Language not supported
- core/common/src/TimeZone.kt: Language not supported
- core/common/src/format/DateTimeComponents.kt: Language not supported
- core/common/src/serializers/DeprecatedInstantSerializers.kt: Language not supported
- core/common/test/ClockTimeSourceTest.kt: Language not supported
- core/common/test/DeprecatedClockTimeSourceTest.kt: Language not supported
- core/common/test/InstantTest.kt: Language not supported
- core/common/test/LocalDateTest.kt: Language not supported
- core/common/test/LocalDateTimeTest.kt: Language not supported
- core/common/test/ReadmeTest.kt: Language not supported
- core/common/test/TimeZoneTest.kt: Language not supported
- core/common/test/format/DateTimeComponentsFormatTest.kt: Language not supported
- core/common/test/format/DateTimeComponentsTest.kt: Language not supported
- core/common/test/samples/ClockSamples.kt: Language not supported
- core/common/test/samples/DayOfWeekSamples.kt: Language not supported
lukellmann
reviewed
Apr 2, 2025
| @@ -12,9 +12,14 @@ public final class kotlinx/datetime/Clock$System : kotlinx/datetime/Clock { | |||
| } | |||
|
|
|||
| public final class kotlinx/datetime/ClockKt { | |||
| public static final fun asClock (Lkotlin/time/TimeSource;Lkotlinx/datetime/Instant;)Lkotlinx/datetime/Clock; | |||
There was a problem hiding this comment.
This seems to be missing in DeprecatedClock.kt.
There was a problem hiding this comment.
It is, but this is okay, since we never published a release with 73aad58
There was a problem hiding this comment.
Not any longer! Sorry for missing the obvious, and thanks for picking up my slack.
ilya-g
reviewed
Apr 24, 2025
Comment on lines
54
to
55
| assertFailsWith<DateTimeArithmeticException> { (Instant.fromEpochSeconds(Long.MAX_VALUE) - 3.days).toLocalDateTime(TimeZone.UTC) } | ||
| assertFailsWith<DateTimeArithmeticException> { (Instant.fromEpochSeconds(Long.MIN_VALUE) + 6.hours).toLocalDateTime(TimeZone.UTC) } |
There was a problem hiding this comment.
Are such changes required if you already defined Instant.MIN/MAX extension properties for tests?
ilya-g
approved these changes
Apr 24, 2025
dkhalanskyjb
force-pushed
the
kotlin-2.1.20
branch
from
36aa9c3 to
3f409fe
Compare
dkhalanskyjb
force-pushed
the
remove-instant-compat
branch
2 times, most recently
from
ca49943 to
5581303
Compare
dkhalanskyjb
force-pushed
the
remove-instant-compat
branch
from
5581303 to
9a5a5e0
Compare
The DateTimeFormat-based FormattedInstantSerializer would be introduced in this release for `kotlinx.datetime.Instant` if that wasn't going to be removed. Now, instead, we support the new, `kotlin.time.Instant` in this serializer.
dkhalanskyjb
force-pushed
the
remove-instant-compat
branch
from
9a5a5e0 to
9bebcf4
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Original implementation: #465.