refactor: drop usages of java.util.Calendar

In favor of timezone agnostic `kotlin.time.Duration`. It simplifies implementation and removes a need to declare a timezone, which might be confusing.
Parsely · Nov 13, 2023 · 5cbea9f · 5cbea9f
1 parent 47d2303
commit 5cbea9f
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 24 deletions.
diff --git a/parsely/src/main/java/com/parsely/parselyandroid/EngagementManager.kt b/parsely/src/main/java/com/parsely/parselyandroid/EngagementManager.kt
@@ -1,7 +1,6 @@
 package com.parsely.parselyandroid
 
-import java.util.Calendar
-import java.util.TimeZone
+import kotlin.time.Duration
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Job
 import kotlinx.coroutines.delay
@@ -29,20 +28,18 @@ internal class EngagementManager(
 ) {
     private var job: Job? = null
     private var totalTime: Long = 0
-    private var startTime: Calendar
+    private var startTime: Duration
     private var nextScheduledExecution: Long = 0
 
     init {
-        startTime = Calendar.getInstance(TimeZone.getTimeZone("UTC"))
+        startTime =  clock.now
     }
 
     val isRunning: Boolean
         get() = job?.isActive ?: false
 
     fun start() {
-        startTime = Calendar.getInstance(TimeZone.getTimeZone("UTC")).apply {
-            timeInMillis = clock.now.inWholeMilliseconds
-        }
+        startTime = clock.now
         job = coroutineScope.launch {
             while (isActive) {
                 latestDelayMillis = intervalCalculator.calculate(startTime)

diff --git a/parsely/src/main/java/com/parsely/parselyandroid/HeartbeatIntervalCalculator.kt b/parsely/src/main/java/com/parsely/parselyandroid/HeartbeatIntervalCalculator.kt
@@ -1,18 +1,15 @@
 package com.parsely.parselyandroid
 
-import java.util.Calendar
-import kotlin.time.Duration.Companion.hours
-import kotlin.time.Duration.Companion.milliseconds
+import kotlin.time.Duration
 import kotlin.time.Duration.Companion.minutes
 import kotlin.time.Duration.Companion.seconds
 
 internal open class HeartbeatIntervalCalculator(private val clock: Clock) {
 
-    open fun calculate(startTime: Calendar): Long {
-        val startTimeDuration = startTime.time.time.milliseconds
+    open fun calculate(startTime: Duration): Long {
         val nowDuration = clock.now
 
-        val totalTrackedTime = nowDuration - startTimeDuration
+        val totalTrackedTime = nowDuration - startTime
         val totalWithOffset = totalTrackedTime + OFFSET_MATCHING_BASE_INTERVAL
         val newInterval = totalWithOffset * BACKOFF_PROPORTION
         val clampedNewInterval = minOf(MAX_TIME_BETWEEN_HEARTBEATS, newInterval)

diff --git a/parsely/src/test/java/com/parsely/parselyandroid/EngagementManagerTest.kt b/parsely/src/test/java/com/parsely/parselyandroid/EngagementManagerTest.kt
@@ -1,7 +1,6 @@
 package com.parsely.parselyandroid
 
 import androidx.test.core.app.ApplicationProvider
-import java.util.Calendar
 import kotlin.time.Duration
 import kotlin.time.Duration.Companion.milliseconds
 import kotlin.time.Duration.Companion.seconds
@@ -205,7 +204,7 @@ internal class EngagementManagerTest {
     }
 
     class FakeIntervalCalculator : HeartbeatIntervalCalculator(Clock()) {
-        override fun calculate(startTime: Calendar): Long {
+        override fun calculate(startTime: Duration): Long {
             return DEFAULT_INTERVAL.inWholeMilliseconds
         }
     }

diff --git a/parsely/src/test/java/com/parsely/parselyandroid/HeartbeatIntervalCalculatorTest.kt b/parsely/src/test/java/com/parsely/parselyandroid/HeartbeatIntervalCalculatorTest.kt
@@ -22,9 +22,7 @@ internal class HeartbeatIntervalCalculatorTest {
     fun `given the same time of start and current time, when calculating interval, return offset times backoff proportion`() {
         // given
         fakeClock.fakeNow = Duration.ZERO
-        val startTime = Calendar.getInstance().apply {
-            timeInMillis = 0
-        }
+        val startTime = Duration.ZERO
 
         // when
         val result = sut.calculate(startTime)
@@ -45,9 +43,7 @@ internal class HeartbeatIntervalCalculatorTest {
         // (15 minutes / 0.3) - 35 seconds = 2965 seconds. Add 1 second to be over the limit
         val excessiveTime = 2965.seconds + 1.seconds
         fakeClock.fakeNow = excessiveTime
-        val startTime = Calendar.getInstance().apply {
-            timeInMillis = 0
-        }
+        val startTime = Duration.ZERO
 
         // when
         val result = sut.calculate(startTime)
@@ -59,9 +55,7 @@ internal class HeartbeatIntervalCalculatorTest {
     @Test
     fun `given a specific time point, when updating latest interval, it correctly calculates the interval`() {
         // given
-        val startTime = Calendar.getInstance().apply {
-            timeInMillis = 0
-        }
+        val startTime = Duration.ZERO
         fakeClock.fakeNow = 2.seconds
 
         // when