Implement Retry functionality

Author: iRevive

core/shared/src/main/scala/cats/effect/IO.scala

@@ -40,18 +40,17 @@ import cats.data.Ior
 import cats.effect.instances.spawn
 import cats.effect.kernel.CancelScope
 import cats.effect.kernel.GenTemporal.handleDuration
-import cats.effect.std.{Backpressure, Console, Env, Supervisor, UUIDGen}
+import cats.effect.std.{Backpressure, Console, Env, Retry, Supervisor, UUIDGen}
 import cats.effect.tracing.{Tracing, TracingEvent}
 import cats.effect.unsafe.IORuntime
-import cats.syntax._
-import cats.syntax.all._
+import cats.syntax.*
+import cats.syntax.all.*
 
 import scala.annotation.unchecked.uncheckedVariance
-import scala.concurrent._
-import scala.concurrent.duration._
+import scala.concurrent.*
+import scala.concurrent.duration.*
 import scala.util.{Failure, Success, Try}
 import scala.util.control.NonFatal
-
 import java.util.UUID
 import java.util.concurrent.Executor
 
@@ -632,6 +631,45 @@ sealed abstract class IO[+A] private () extends IOPlatform[A] {
     (FiberIO[A @uncheckedVariance], OutcomeIO[B])]] =
     IO.racePair(this, that)
 
+  /**
+   * Evaluates the current IO with the given retry `policy`.
+   *
+   * @example
+   *   {{{
+   * val policy = Retry.exponentialBackoff[IO, Throwable](1.second).withMaxRetries(10)
+   * io.retry(policy)
+   *   }}}
+   *
+   * @param policy
+   *   the policy to use
+   */
+  def retry(policy: Retry[IO, Throwable]): IO[A] =
+    Retry.retry(policy)(this)
+
+  /**
+   * Evaluates the current IO with the given retry `policy`.
+   *
+   * @example
+   *   {{{
+   * val policy = Retry.exponentialBackoff[IO, Throwable](1.second).withMaxRetries(10)
+   * io.retry(
+   *   policy,
+   *   (status, err, decision) => IO.println(s"Attempt ${status.retriesTotal}, error: ${err.getMessage}, next: $decision")
+   * )
+   *   }}}
+   *
+   * @param policy
+   *   the policy to use
+   *
+   * @param onRetry
+   *   the effect to invoke on every retry decision
+   */
+  def retry(
+      policy: Retry[IO, Throwable],
+      onRetry: (Retry.Status, Throwable, Retry.Decision) => IO[Unit]
+  ): IO[A] =
+    Retry.retry(policy, onRetry)(this)
+
   /**
    * Inverse of `attempt`
    *

core/shared/src/main/scala/cats/effect/syntax/package.scala

@@ -29,5 +29,6 @@ package object syntax {
   object clock extends kernel.syntax.ClockSyntax
 
   object supervisor extends std.syntax.SupervisorSyntax
+  object retry extends std.syntax.RetrySyntax
   object dispatcher extends DispatcherSyntax
 }