commonMain.arrow.resilience.flow.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of arrow-resilience-jvm Show documentation

Functional companion to Kotlin's Standard Library

There is a newer version: 2.0.1-alpha.1

package arrow.resilience

import kotlinx.coroutines.delay
import kotlinx.coroutines.flow.Flow
import kotlinx.coroutines.flow.retryWhen
import kotlin.time.Duration.Companion.ZERO

/**
 * Retries collection of the given flow when an exception occurs in the upstream flow based on a decision by the [schedule].
 * This operator is *transparent* to exceptions that occur in downstream flow and does not retry on exceptions that are thrown
 * to cancel the flow.
 *
 * @see [Schedule] for how to build a schedule.
 *
 * ```kotlin
 * import arrow.resilience.*
 * import kotlinx.coroutines.flow.*
 *
 * suspend fun main(): Unit {
 *   var counter = 0
 *   val flow = flow {
 *    emit(counter)
 *    if (++counter <= 5) throw RuntimeException("Bang!")
 *   }
 *   //sampleStart
 *  val sum = flow.retry(Schedule.recurs(5))
 *    .reduce(Int::plus)
 *   //sampleEnd
 *   println(sum)
 * }
 * ```
 * 
 *
 * @param schedule - the [Schedule] used for retrying the collection of the flow
 */
public fun  Flow.retry(schedule: Schedule): Flow {
  var step = schedule.step
  return retryWhen { cause, _ ->
    when (val dec = step(cause)) {
      is Schedule.Decision.Continue -> {
        if (dec.delay != ZERO) delay(dec.delay)
        step = dec.step
        true
      }

      is Schedule.Decision.Done -> false
    }
  }
}