From 0e819aacdcca624dad76f383a5cc9576c1a8e7f5 Mon Sep 17 00:00:00 2001 From: wojda Date: Tue, 14 Jun 2022 22:58:17 +0100 Subject: [PATCH 1/2] Fix compilation warnings by replacing usages of deprecated methods --- .../kotlin/arrow/fx/coroutines/Schedule.kt | 17 +++---- .../arrow/fx/coroutines/CircuitBreakerTest.kt | 45 ++++++++++--------- .../kotlin/examples/example-schedule-02.kt | 6 +-- 3 files changed, 36 insertions(+), 32 deletions(-) diff --git a/arrow-libs/fx/arrow-fx-coroutines/src/commonMain/kotlin/arrow/fx/coroutines/Schedule.kt b/arrow-libs/fx/arrow-fx-coroutines/src/commonMain/kotlin/arrow/fx/coroutines/Schedule.kt index 6e76aeafebc..7a1efb9dc47 100644 --- a/arrow-libs/fx/arrow-fx-coroutines/src/commonMain/kotlin/arrow/fx/coroutines/Schedule.kt +++ b/arrow-libs/fx/arrow-fx-coroutines/src/commonMain/kotlin/arrow/fx/coroutines/Schedule.kt @@ -18,11 +18,12 @@ import kotlin.math.roundToInt import kotlin.random.Random import kotlin.time.Duration import kotlin.time.ExperimentalTime -import kotlin.time.nanoseconds import kotlinx.coroutines.flow.Flow import kotlinx.coroutines.flow.flow import kotlinx.coroutines.flow.map import kotlinx.coroutines.flow.retry +import kotlin.time.Duration.Companion.nanoseconds +import kotlin.time.DurationUnit.NANOSECONDS /** * # Retrying and repeating effects @@ -273,7 +274,7 @@ public sealed class Schedule { zipDuration: (duration: Duration, otherDuration: Duration) -> Duration, zip: (Output, B) -> C ): Schedule = - combineNanos(other, zipContinue, { a, b -> zipDuration(a.nanoseconds, b.nanoseconds).inNanoseconds }, zip) + combineNanos(other, zipContinue, { a, b -> zipDuration(a.nanoseconds, b.nanoseconds).toDouble(NANOSECONDS) }, zip) /** * Combines with another schedule by combining the result and the delay of the [Decision] with the functions [zipContinue], [zipDuration] and a [zip] function @@ -301,7 +302,7 @@ public sealed class Schedule { */ @ExperimentalTime public fun modify(f: suspend (Output, Duration) -> Duration): Schedule = - modifyNanos { output, d -> f(output, d.nanoseconds).inNanoseconds } + modifyNanos { output, d -> f(output, d.nanoseconds).toDouble(NANOSECONDS) } public abstract fun modifyNanos(f: suspend (Output, Double) -> Double): Schedule @@ -424,7 +425,7 @@ public sealed class Schedule { public fun jittered(genRand: suspend () -> Duration): Schedule = modify { _, duration -> val n = genRand.invoke() - duration.times(n.inNanoseconds) + duration.times(n.toDouble(NANOSECONDS)) } /** @@ -725,7 +726,7 @@ public sealed class Schedule { zip: (B, D) -> E ): Decision, E> = Decision( f(cont, other.cont), - g(delayInNanos.nanoseconds, other.delayInNanos.nanoseconds).inNanoseconds, + g(delayInNanos.nanoseconds, other.delayInNanos.nanoseconds).toDouble(NANOSECONDS), Pair(state, other.state), finish.flatMap { first -> other.finish.map { second -> zip(first, second) } } ) @@ -746,11 +747,11 @@ public sealed class Schedule { @ExperimentalTime public fun cont(d: Duration, a: A, b: Eval): Decision = - cont(d.inNanoseconds, a, b) + cont(d.toDouble(NANOSECONDS), a, b) @ExperimentalTime public fun done(d: Duration, a: A, b: Eval): Decision = - done(d.inNanoseconds, a, b) + done(d.toDouble(NANOSECONDS), a, b) } } @@ -937,7 +938,7 @@ public sealed class Schedule { */ @ExperimentalTime public fun spaced(interval: Duration): Schedule = - forever().delayedNanos { d -> d + interval.inNanoseconds } + forever().delayedNanos { d -> d + interval.toDouble(NANOSECONDS) } /** * Creates a Schedule that continues with increasing delay by adding the last two delays. diff --git a/arrow-libs/fx/arrow-fx-coroutines/src/commonTest/kotlin/arrow/fx/coroutines/CircuitBreakerTest.kt b/arrow-libs/fx/arrow-fx-coroutines/src/commonTest/kotlin/arrow/fx/coroutines/CircuitBreakerTest.kt index 72684fd956b..265b318e453 100644 --- a/arrow-libs/fx/arrow-fx-coroutines/src/commonTest/kotlin/arrow/fx/coroutines/CircuitBreakerTest.kt +++ b/arrow-libs/fx/arrow-fx-coroutines/src/commonTest/kotlin/arrow/fx/coroutines/CircuitBreakerTest.kt @@ -10,9 +10,10 @@ import kotlinx.coroutines.Dispatchers import kotlinx.coroutines.async import kotlinx.coroutines.delay import kotlinx.coroutines.withContext +import kotlin.time.Duration.Companion.milliseconds +import kotlin.time.Duration.Companion.minutes +import kotlin.time.DurationUnit.NANOSECONDS import kotlin.time.ExperimentalTime -import kotlin.time.milliseconds -import kotlin.time.minutes @ExperimentalTime class CircuitBreakerTest : ArrowFxSpec( @@ -24,7 +25,7 @@ class CircuitBreakerTest : ArrowFxSpec( val maxTimeout = 600.milliseconds "should work for successful async tasks" { - val cb = CircuitBreaker.of(maxFailures = maxFailures, resetTimeout = resetTimeout)!! + val cb = CircuitBreaker.of(maxFailures = maxFailures, resetTimeout = resetTimeout) var effect = 0 Schedule.recurs(10_000).repeat { cb.protectOrThrow { withContext(Dispatchers.Default) { effect += 1 } } @@ -33,7 +34,7 @@ class CircuitBreakerTest : ArrowFxSpec( } "should work for successful immediate tasks" { - val cb = CircuitBreaker.of(maxFailures = maxFailures, resetTimeout = resetTimeout)!! + val cb = CircuitBreaker.of(maxFailures = maxFailures, resetTimeout = resetTimeout) var effect = 0 Schedule.recurs(10_000).repeat { cb.protectOrThrow { effect += 1 } @@ -42,7 +43,7 @@ class CircuitBreakerTest : ArrowFxSpec( } "Circuit breaker stays closed after less than maxFailures" { - val cb = CircuitBreaker.of(maxFailures = maxFailures, resetTimeout = resetTimeout)!! + val cb = CircuitBreaker.of(maxFailures = maxFailures, resetTimeout = resetTimeout) recurAndCollect>(3).repeat { Either.catch { cb.protectOrThrow { throw dummy } } @@ -52,7 +53,7 @@ class CircuitBreakerTest : ArrowFxSpec( } "Closed circuit breaker resets failure count after success" { - val cb = CircuitBreaker.of(maxFailures = maxFailures, resetTimeout = resetTimeout)!! + val cb = CircuitBreaker.of(maxFailures = maxFailures, resetTimeout = resetTimeout) recurAndCollect>(3).repeat { Either.catch { cb.protectOrThrow { throw dummy } } @@ -66,7 +67,7 @@ class CircuitBreakerTest : ArrowFxSpec( } "Circuit breaker opens after max failures" { - val cb = CircuitBreaker.of(maxFailures = maxFailures, resetTimeout = resetTimeout)!! + val cb = CircuitBreaker.of(maxFailures = maxFailures, resetTimeout = resetTimeout) recurAndCollect>(3).repeat { Either.catch { cb.protectOrThrow { throw dummy } } @@ -78,7 +79,7 @@ class CircuitBreakerTest : ArrowFxSpec( when (val s = cb.state()) { is CircuitBreaker.State.Open -> { - s.resetTimeoutNanos shouldBe resetTimeout.inNanoseconds + s.resetTimeoutNanos shouldBe resetTimeout.toDouble(NANOSECONDS) } else -> fail("Invalid state: Expect CircuitBreaker.State.Open but found $s") } @@ -95,7 +96,7 @@ class CircuitBreakerTest : ArrowFxSpec( resetTimeout = resetTimeout, exponentialBackoffFactor = exponentialBackoffFactor, maxResetTimeout = maxTimeout - )!!.doOnOpen { openedCount += 1 } + ).doOnOpen { openedCount += 1 } .doOnClosed { closedCount += 1 } .doOnHalfOpen { halfOpenCount += 1 } .doOnRejectedTask { rejectedCount += 1 } @@ -105,7 +106,7 @@ class CircuitBreakerTest : ArrowFxSpec( when (val s = cb.state()) { is CircuitBreaker.State.Open -> { - s.resetTimeoutNanos shouldBe resetTimeout.inNanoseconds + s.resetTimeoutNanos shouldBe resetTimeout.toDouble(NANOSECONDS) } else -> fail("Invalid state: Expect CircuitBreaker.State.Open but found $s") } @@ -120,7 +121,7 @@ class CircuitBreakerTest : ArrowFxSpec( when (val s = cb.state()) { is CircuitBreaker.State.Open -> { - s.resetTimeoutNanos shouldBe resetTimeout.inNanoseconds + s.resetTimeoutNanos shouldBe resetTimeout.toDouble(NANOSECONDS) } else -> fail("Invalid state: Expect CircuitBreaker.State.Open but found $s") } @@ -129,6 +130,7 @@ class CircuitBreakerTest : ArrowFxSpec( val delayProtectLatch = CompletableDeferred() val stateAssertionLatch = CompletableDeferred() + @Suppress("DeferredResultUnused") async { // Successful tasks puts circuit breaker back in HalfOpen cb.protectOrThrow { checkHalfOpen.complete(Unit) @@ -141,7 +143,7 @@ class CircuitBreakerTest : ArrowFxSpec( when (val s = cb.state()) { is CircuitBreaker.State.HalfOpen -> { - s.resetTimeoutNanos shouldBe resetTimeout.inNanoseconds + s.resetTimeoutNanos shouldBe resetTimeout.toDouble(NANOSECONDS) } else -> fail("Invalid state: Expect CircuitBreaker.State.HalfOpen but found $s") } @@ -150,7 +152,7 @@ class CircuitBreakerTest : ArrowFxSpec( shouldThrow { cb.protectOrThrow { throw dummy } } shouldThrow { cb.protectOrThrow { throw dummy } } - // Once we complete `protect`, the circuitbreaker will go back to closer state + // Once we complete `protect`, the circuit breaker will go back to closer state delayProtectLatch.complete(Unit) stateAssertionLatch.await() @@ -174,7 +176,7 @@ class CircuitBreakerTest : ArrowFxSpec( resetTimeout = resetTimeout, exponentialBackoffFactor = 2.0, maxResetTimeout = maxTimeout - )!!.doOnOpen { openedCount += 1 } + ).doOnOpen { openedCount += 1 } .doOnClosed { closedCount += 1 } .doOnHalfOpen { halfOpenCount += 1 } .doOnRejectedTask { rejectedCount += 1 } @@ -184,7 +186,7 @@ class CircuitBreakerTest : ArrowFxSpec( when (val s = cb.state()) { is CircuitBreaker.State.Open -> { - s.resetTimeoutNanos shouldBe resetTimeout.inNanoseconds + s.resetTimeoutNanos shouldBe resetTimeout.toDouble(NANOSECONDS) } else -> fail("Invalid state: Expect CircuitBreaker.State.Open but found $s") } @@ -199,7 +201,7 @@ class CircuitBreakerTest : ArrowFxSpec( when (val s = cb.state()) { is CircuitBreaker.State.Open -> { - s.resetTimeoutNanos shouldBe resetTimeout.inNanoseconds + s.resetTimeoutNanos shouldBe resetTimeout.toDouble(NANOSECONDS) } else -> fail("Invalid state: Expect CircuitBreaker.State.Open but found $s") } @@ -208,6 +210,7 @@ class CircuitBreakerTest : ArrowFxSpec( val delayProtectLatch = CompletableDeferred() val stateAssertionLatch = CompletableDeferred() + @Suppress("DeferredResultUnused") async { // Successful tasks puts circuit breaker back in HalfOpen // Delay protect, to inspect HalfOpen state. Either.catch { @@ -223,7 +226,7 @@ class CircuitBreakerTest : ArrowFxSpec( when (val s = cb.state()) { is CircuitBreaker.State.HalfOpen -> { - s.resetTimeoutNanos shouldBe resetTimeout.inNanoseconds + s.resetTimeoutNanos shouldBe resetTimeout.toDouble(NANOSECONDS) } else -> fail("Invalid state: Expect CircuitBreaker.State.HalfOpen but found $s") } @@ -232,7 +235,7 @@ class CircuitBreakerTest : ArrowFxSpec( shouldThrow { cb.protectOrThrow { throw dummy } } shouldThrow { cb.protectOrThrow { throw dummy } } - // Once we complete `protect`, the circuitbreaker will go back to closer state + // Once we complete `protect`, the circuit breaker will go back to closer state delayProtectLatch.complete(Unit) stateAssertionLatch.await() @@ -240,7 +243,7 @@ class CircuitBreakerTest : ArrowFxSpec( // resetTimeout should've applied when (val s = cb.state()) { is CircuitBreaker.State.Open -> { - s.resetTimeoutNanos shouldBe (resetTimeout * exponentialBackoffFactor).inNanoseconds + s.resetTimeoutNanos shouldBe (resetTimeout * exponentialBackoffFactor).toDouble(NANOSECONDS) } else -> fail("Invalid state: Expect CircuitBreaker.State.Open but found $s") } @@ -253,14 +256,14 @@ class CircuitBreakerTest : ArrowFxSpec( "should be stack safe for successful async tasks" { stackSafeSuspend( - CircuitBreaker.of(maxFailures = 5, resetTimeout = 1.minutes)!!, + CircuitBreaker.of(maxFailures = 5, resetTimeout = 1.minutes), stackSafeIteration(), 0 ) shouldBe stackSafeIteration() } "should be stack safe for successful immediate tasks" { stackSafeImmediate( - CircuitBreaker.of(maxFailures = 5, resetTimeout = 1.minutes)!!, + CircuitBreaker.of(maxFailures = 5, resetTimeout = 1.minutes), stackSafeIteration(), 0 ) shouldBe stackSafeIteration() } diff --git a/arrow-libs/fx/arrow-fx-coroutines/src/jvmTest/kotlin/examples/example-schedule-02.kt b/arrow-libs/fx/arrow-fx-coroutines/src/jvmTest/kotlin/examples/example-schedule-02.kt index dfeaa5372ff..95e5a8c8025 100644 --- a/arrow-libs/fx/arrow-fx-coroutines/src/jvmTest/kotlin/examples/example-schedule-02.kt +++ b/arrow-libs/fx/arrow-fx-coroutines/src/jvmTest/kotlin/examples/example-schedule-02.kt @@ -1,13 +1,13 @@ // This file was automatically generated from Schedule.kt by Knit tool. Do not edit. package arrow.fx.coroutines.examples.exampleSchedule02 -import kotlin.time.seconds -import kotlin.time.milliseconds import kotlin.time.ExperimentalTime import arrow.fx.coroutines.* +import kotlin.time.Duration.Companion.milliseconds +import kotlin.time.Duration.Companion.seconds @ExperimentalTime fun complexPolicy(): Schedule> = - Schedule.exponential(10.milliseconds).whileOutput { it.inNanoseconds < 60.seconds.inNanoseconds } + Schedule.exponential(10.milliseconds).whileOutput { it < 60.seconds } .andThen(Schedule.spaced(60.seconds) and Schedule.recurs(100)).jittered() .zipRight(Schedule.identity().collect()) From 0998e23c569ad8a65a1eb79ec1e175dce135782a Mon Sep 17 00:00:00 2001 From: wojda Date: Tue, 14 Jun 2022 23:21:14 +0100 Subject: [PATCH 2/2] Update Kotlin doc and then generate the example code via Knit tool --- .../src/commonMain/kotlin/arrow/fx/coroutines/Schedule.kt | 6 +++--- .../src/jvmTest/kotlin/examples/example-schedule-02.kt | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/arrow-libs/fx/arrow-fx-coroutines/src/commonMain/kotlin/arrow/fx/coroutines/Schedule.kt b/arrow-libs/fx/arrow-fx-coroutines/src/commonMain/kotlin/arrow/fx/coroutines/Schedule.kt index 7a1efb9dc47..10d06ef1d28 100644 --- a/arrow-libs/fx/arrow-fx-coroutines/src/commonMain/kotlin/arrow/fx/coroutines/Schedule.kt +++ b/arrow-libs/fx/arrow-fx-coroutines/src/commonMain/kotlin/arrow/fx/coroutines/Schedule.kt @@ -49,14 +49,14 @@ import kotlin.time.DurationUnit.NANOSECONDS * A more complex schedule * * ```kotlin - * import kotlin.time.seconds - * import kotlin.time.milliseconds + * import kotlin.time.Duration.Companion.milliseconds + * import kotlin.time.Duration.Companion.seconds * import kotlin.time.ExperimentalTime * import arrow.fx.coroutines.* * * @ExperimentalTime * fun complexPolicy(): Schedule> = - * Schedule.exponential(10.milliseconds).whileOutput { it.inNanoseconds < 60.seconds.inNanoseconds } + * Schedule.exponential(10.milliseconds).whileOutput { it < 60.seconds } * .andThen(Schedule.spaced(60.seconds) and Schedule.recurs(100)).jittered() * .zipRight(Schedule.identity().collect()) * ``` diff --git a/arrow-libs/fx/arrow-fx-coroutines/src/jvmTest/kotlin/examples/example-schedule-02.kt b/arrow-libs/fx/arrow-fx-coroutines/src/jvmTest/kotlin/examples/example-schedule-02.kt index 95e5a8c8025..59702329185 100644 --- a/arrow-libs/fx/arrow-fx-coroutines/src/jvmTest/kotlin/examples/example-schedule-02.kt +++ b/arrow-libs/fx/arrow-fx-coroutines/src/jvmTest/kotlin/examples/example-schedule-02.kt @@ -1,10 +1,10 @@ // This file was automatically generated from Schedule.kt by Knit tool. Do not edit. package arrow.fx.coroutines.examples.exampleSchedule02 -import kotlin.time.ExperimentalTime -import arrow.fx.coroutines.* import kotlin.time.Duration.Companion.milliseconds import kotlin.time.Duration.Companion.seconds +import kotlin.time.ExperimentalTime +import arrow.fx.coroutines.* @ExperimentalTime fun complexPolicy(): Schedule> =