Migrate from java.util.Date to kotlinx.datetime

Author: gianluz

danger-kotlin-library/src/main/kotlin/systems/danger/kotlin/models/github/GitHub.kt

@@ -2,10 +2,10 @@
 
 package systems.danger.kotlin.models.github
 
+import kotlinx.datetime.Instant
 import systems.danger.kotlin.models.serializers.DateSerializer
 import kotlinx.serialization.*
 import systems.danger.kotlin.models.git.GitCommit
-import java.util.*
 
 /**
  * The GitHub metadata for your pull request.
@@ -69,10 +69,10 @@ data class GitHubPR(
     val user: GitHubUser,
     val assignee: GitHubUser?,
     val assignees: List<GitHubUser>,
-    @SerialName("created_at") val createdAt: Date,
-    @SerialName("updated_at") val updatedAt: Date,
-    @SerialName("closed_at") val closedAt: Date? = null,
-    @SerialName("merged_at") val mergedAt: Date? = null,
+    @SerialName("created_at") val createdAt: Instant,
+    @SerialName("updated_at") val updatedAt: Instant,
+    @SerialName("closed_at") val closedAt: Instant? = null,
+    @SerialName("merged_at") val mergedAt: Instant? = null,
     val head: GitHubMergeRef,
     val base: GitHubMergeRef,
     val state: GitHubPullRequestState,
@@ -252,9 +252,9 @@ data class GitHubIssue(
     val assignee: GitHubUser?,
     val assignees: List<GitHubUser>,
     val milestone: GitHubMilestone?,
-    @SerialName("created_at") val createdAt: Date,
-    @SerialName("updated_at") val updatedAt: Date,
-    @SerialName("closed_at") val closedAt: Date? = null,
+    @SerialName("created_at") val createdAt: Instant,
+    @SerialName("updated_at") val updatedAt: Instant,
+    @SerialName("closed_at") val closedAt: Instant? = null,
     val labels: List<GitHubIssueLabel>
 )
 
@@ -338,8 +338,8 @@ data class GitHubMilestone(
     val creator: GitHubUser,
     @SerialName("open_issues") val openIssues: Int,
     @SerialName("closed_issues") val closedIssues: Int,
-    @SerialName("created_at") val createdAt: Date,
-    @SerialName("updated_at") val updatedAt: Date,
-    @SerialName("closed_at") val closedAt: Date? = null,
-    @SerialName("due_on") val dueOn: Date? = null
+    @SerialName("created_at") val createdAt: Instant,
+    @SerialName("updated_at") val updatedAt: Instant,
+    @SerialName("closed_at") val closedAt: Instant? = null,
+    @SerialName("due_on") val dueOn: Instant? = null
 )

danger-kotlin-library/src/main/kotlin/systems/danger/kotlin/models/gitlab/GitLab.kt

@@ -2,11 +2,11 @@
 
 package systems.danger.kotlin.models.gitlab
 
+import kotlinx.datetime.Instant
 import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
 import kotlinx.serialization.UseSerializers
 import systems.danger.kotlin.models.serializers.DateSerializer
-import java.util.*
 
 @Serializable
 data class GitLab(
@@ -44,30 +44,30 @@ data class GitLabMergeRequest(
     @SerialName("changes_count")
     val changesCount: String,
     @SerialName("closed_at")
-    val closedAt: Date? = null,
+    val closedAt: Instant? = null,
     @SerialName("closed_by")
     val closedBy: GitLabUser?,
     val description: String,
     @SerialName("diff_refs")
     val diffRefs: GitLabDiffRefs,
     val downvotes: Int,
     @SerialName("first_deployed_to_production_at")
-    val firstDeployedToProductionAt: Date? = null,
+    val firstDeployedToProductionAt: Instant? = null,
     @SerialName("force_remove_source_branch")
     val forceRemoveSourceBranch: Boolean,
     val id: Int,
     val iid: Int,
     @SerialName("latest_build_finished_at")
 
-    val latestBuildFinishedAt: Date? = null,
+    val latestBuildFinishedAt: Instant? = null,
     @SerialName("latest_build_started_at")
 
-    val latestBuildStartedAt: Date? = null,
+    val latestBuildStartedAt: Instant? = null,
     val labels: List<String>,
     @SerialName("merge_commit_sha")
     val mergeCommitSha: String? = null,
     @SerialName("merged_at")
-    val mergedAt: Date? = null,
+    val mergedAt: Instant? = null,
     @SerialName("merged_by")
     val mergedBy: GitLabUser?,
     @SerialName("merge_when_pipeline_succeeds")
@@ -141,20 +141,20 @@ enum class GitLabMergeRequestState {
 @Serializable
 data class GitLabMilestone(
     @SerialName("created_at")
-    val createdAt: Date,
+    val createdAt: Instant,
     val description: String,
     @SerialName("due_date")
-    val dueDate: Date,
+    val dueDate: Instant,
     val id: Int,
     val iid: Int,
     @SerialName("project_id")
     val projectID: Int,
     @SerialName("start_date")
-    val startDate: Date,
+    val startDate: Instant,
     val state: GitLabMilestoneState,
     val title: String,
     @SerialName("updated_at")
-    val updatedAt: Date,
+    val updatedAt: Instant,
     @SerialName("web_url")
     val webUrl: String
 )

danger-kotlin-library/src/main/kotlin/systems/danger/kotlin/models/serializers/DateSerializer.kt

@@ -1,5 +1,6 @@
 package systems.danger.kotlin.models.serializers
 
+import kotlinx.datetime.Instant
 import kotlinx.serialization.ExperimentalSerializationApi
 import kotlinx.serialization.KSerializer
 import kotlinx.serialization.Serializer
@@ -8,20 +9,19 @@ import kotlinx.serialization.descriptors.PrimitiveSerialDescriptor
 import kotlinx.serialization.descriptors.SerialDescriptor
 import kotlinx.serialization.encoding.Decoder
 import kotlinx.serialization.encoding.Encoder
-import java.util.*
 
 @ExperimentalSerializationApi
 @Serializer(forClass = DateSerializer::class)
-object DateSerializer : KSerializer<Date> {
+object DateSerializer : KSerializer<Instant> {
 
     override val descriptor: SerialDescriptor
-        get() = PrimitiveSerialDescriptor("java.util.Date", PrimitiveKind.STRING)
+        get() = PrimitiveSerialDescriptor("kotlinx.datetime.Instant", PrimitiveKind.STRING)
 
-    override fun serialize(encoder: Encoder, value: Date) {
+    override fun serialize(encoder: Encoder, value: Instant) {
         // Implementation not needed for now
     }
 
-    override fun deserialize(decoder: Decoder): Date {
-        return fromISO8601UTC(decoder.decodeString())!!
+    override fun deserialize(decoder: Decoder): Instant {
+        return Instant.parse(decoder.decodeString())
     }
 }

danger-kotlin-library/src/main/kotlin/systems/danger/kotlin/models/serializers/DateUtils.kt

@@ -4,6 +4,7 @@ import java.text.ParseException
 import java.text.SimpleDateFormat
 import java.util.*
 
+@SuppressWarnings("unused")
 internal fun fromISO8601UTC(dateStr: String): Date? {
     val tz = TimeZone.getTimeZone("UTC")
     val df = SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'")

danger-kotlin-library/src/test/kotlin/systems/danger/kotlin/models/github/GitHubParsingTests.kt

@@ -1,5 +1,6 @@
 package systems.danger.kotlin.models.github
 
+import kotlinx.datetime.Instant
 import kotlinx.serialization.decodeFromString
 import kotlinx.serialization.json.Json
 import org.junit.Assert.*
@@ -9,7 +10,6 @@ import systems.danger.kotlin.models.git.GitCommit
 import systems.danger.kotlin.models.git.GitCommitAuthor
 import systems.danger.kotlin.utils.TestUtils.JSONFiles
 import systems.danger.kotlin.utils.TestUtils
-import java.util.*
 
 class GitHubParsingTests {
     private val dsl: DSL = TestUtils.Json.decodeFromString(JSONFiles.githubDangerJSON)
@@ -26,10 +26,10 @@ class GitHubParsingTests {
                         "\n" + "I tried updating to CocoaPods 1.0, but things went quickly awry. It's a large job, but not necessary for now. \n",
                 body
             )
-            assertEquals(1469563050000, createdAt.time)
-            assertEquals(1471447575000, updatedAt.time)
-            assertEquals(1471447574000, closedAt?.time)
-            assertEquals(1471447574000, mergedAt?.time)
+            assertEquals(1469563050000, createdAt.toEpochMilliseconds())
+            assertEquals(1471447575000, updatedAt.toEpochMilliseconds())
+            assertEquals(1471447574000, closedAt?.toEpochMilliseconds())
+            assertEquals(1471447574000, mergedAt?.toEpochMilliseconds())
             assertEquals(false, isLocked)
             assertEquals(true, isMerged)
             assertEquals(15, commitCount)
@@ -149,8 +149,8 @@ class GitHubParsingTests {
             assertEquals(GitHubIssueState.CLOSED, state)
             assertEquals(false, isLocked)
             assertEquals(8, commentCount)
-            assertEquals(Date(1469563050000), createdAt)
-            assertEquals(Date(1471447574000), updatedAt)
+            assertEquals(Instant.fromEpochMilliseconds(1469563050000), createdAt)
+            assertEquals(Instant.fromEpochMilliseconds(1471447574000), updatedAt)
             assertEquals(null, closedAt)
             assertTrue(labels.isEmpty())
 
@@ -169,10 +169,10 @@ class GitHubParsingTests {
                 expectedCreator,
                 4,
                 8,
-                Date(1302466171000),
-                Date(1393873090000),
-                Date(1360675321000),
-                Date(1349825941000)
+                Instant.fromEpochMilliseconds(1302466171000),
+                Instant.fromEpochMilliseconds(1393873090000),
+                Instant.fromEpochMilliseconds(1360675321000),
+                Instant.fromEpochMilliseconds(1349825941000)
             )
             assertEquals(expectedMilestone, milestone)
         }

danger-kotlin-library/src/test/kotlin/systems/danger/kotlin/models/gitlab/GitLabParsingTests.kt

@@ -1,12 +1,12 @@
 package systems.danger.kotlin.models.gitlab
 
+import kotlinx.datetime.Instant
 import kotlinx.serialization.decodeFromString
 import org.junit.Assert.*
 import org.junit.Test
 import systems.danger.kotlin.models.danger.DSL
 import systems.danger.kotlin.utils.TestUtils.JSONFiles
 import systems.danger.kotlin.utils.TestUtils
-import java.util.*
 
 class GitLabParsingTests {
     private val dsl: DSL
@@ -46,28 +46,28 @@ class GitLabParsingTests {
             )
             assertEquals(expectedDiffRefs, diffRefs)
             assertEquals(0, downvotes)
-            assertEquals(Date(1554942622492), firstDeployedToProductionAt)
+            assertEquals(Instant.fromEpochMilliseconds(1554942622492), firstDeployedToProductionAt)
             assertEquals(true, forceRemoveSourceBranch)
             assertEquals(27469633, id)
             assertEquals(182, iid)
-            assertEquals(Date(1554942802492), latestBuildFinishedAt)
-            assertEquals(Date(1554942022492), latestBuildStartedAt)
+            assertEquals(Instant.fromEpochMilliseconds(1554942802492), latestBuildFinishedAt)
+            assertEquals(Instant.fromEpochMilliseconds(1554942022492), latestBuildStartedAt)
             assertEquals(listOf<String>(), labels)
             assertEquals("377a24fb7a0f30364f089f7bca67752a8b61f477", mergeCommitSha)
-            assertEquals(Date(1554943042492), mergedAt)
+            assertEquals(Instant.fromEpochMilliseconds(1554943042492), mergedAt)
             assertEquals(orta, mergedBy)
             assertEquals(false, mergeOnPipelineSuccess)
             val expectedMilestone = GitLabMilestone(
-                Date(1554933465346),
+                Instant.fromEpochMilliseconds(1554933465346),
                 "Test Description",
-                Date(1560124800000),
+                Instant.fromEpochMilliseconds(1560124800000),
                 1,
                 2,
                 1000,
-                Date(1554933465346),
+                Instant.fromEpochMilliseconds(1554933465346),
                 GitLabMilestoneState.CLOSED,
                 "Test Milestone",
-                Date(1554933465346),
+                Instant.fromEpochMilliseconds(1554933465346),
                 "https://gitlab.com/milestone"
             )
             assertEquals(expectedMilestone, milestone)

dependencyVersions.gradle

@@ -32,14 +32,12 @@ project.ext.versionKotlinDatetime = '0.1.0'
 ext.kotlin = [
         mainKts: "$groupIdKotlin:$artifactIdKotlinMain:$versionKotlin",
         serialization: "$groupIdKotlinx:$artifactIdKotlinSerializationJson:$versionKotlinSerializationJson",
-        // Migrate to kotlin-datetime and replace java.util.Date
-        //datetime: "$groupIdKotlinx:$artifactIdKotlinDatetime:$versionKotlinDatetime"
+        datetime: "$groupIdKotlinx:$artifactIdKotlinDatetime:$versionKotlinDatetime"
 ]
 ext.kotlinDependencies = group {
     includeJar kotlin.mainKts
     includeRecursiveJar kotlin.serialization
-    // Migrate to kotlin-datetime and replace java.util.Date
-    //includeRecursiveJar kotlin.datetime
+    includeRecursiveJar kotlin.datetime
 }
 
 // Testing