Move retry policy in another package and add attempt info in the callback

Author: aleksandar-apostolov

stream-android-core/src/main/java/io/getstream/android/core/api/model/retry/StreamRetryAttemptInfo.kt

@@ -0,0 +1,28 @@
+package io.getstream.android.core.api.model.retry
+
+import io.getstream.android.core.annotations.StreamInternalApi
+import io.getstream.android.core.api.model.retry.StreamRetryPolicy
+
+/**
+ * Snapshot describing the state of the current retry loop iteration.
+ *
+ * Instances are delivered to the `block` passed into
+ * [StreamRetryProcessor.retry][io.getstream.android.core.api.processing.StreamRetryProcessor.retry]
+ * before each attempt so callers can log, alter metrics, or branch based on the retry count.
+ *
+ * @property attempt 1-based attempt index. `1` represents the first invocation after the initial
+ *   failure.
+ * @property currentDelay Delay (in milliseconds) that was applied before this attempt. Equals the
+ *   policy's `initialDelayMillis` for the first retry.
+ * @property previousAttemptError The error thrown by the previous attempt, if any. `null` for the
+ *   first attempt.
+ * @property policy The retry policy governing this run; useful if callers need to inspect limits
+ *   (max retries, back-off window, etc.).
+ */
+@StreamInternalApi
+public data class StreamRetryAttemptInfo(
+    val attempt: Int,
+    val currentDelay: Long,
+    val previousAttemptError: Throwable? = null,
+    val policy: StreamRetryPolicy,
+)

…roid/core/api/model/StreamRetryPolicy.kt …ore/api/model/retry/StreamRetryPolicy.ktstream-android-core/src/main/java/io/getstream/android/core/api/model/StreamRetryPolicy.kt renamed to stream-android-core/src/main/java/io/getstream/android/core/api/model/retry/StreamRetryPolicy.kt stream-android-core/src/main/java/io/getstream/android/core/api/model/StreamRetryPolicy.kt renamed to stream-android-core/src/main/java/io/getstream/android/core/api/model/retry/StreamRetryPolicy.kt

@@ -1,20 +1,4 @@
-/*
- * Copyright (c) 2014-2025 Stream.io Inc. All rights reserved.
- *
- * Licensed under the Stream License;
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    https://github.com/GetStream/stream-core-android/blob/main/LICENSE
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package io.getstream.android.core.api.model
+package io.getstream.android.core.api.model.retry
 
 import io.getstream.android.core.annotations.StreamInternalApi
 
@@ -234,4 +218,4 @@ private constructor(
             return this
         }
     }
-}
+}

stream-android-core/src/main/java/io/getstream/android/core/api/processing/StreamRetryProcessor.kt

@@ -18,7 +18,8 @@ package io.getstream.android.core.api.processing
 
 import io.getstream.android.core.annotations.StreamInternalApi
 import io.getstream.android.core.api.log.StreamLogger
-import io.getstream.android.core.api.model.StreamRetryPolicy
+import io.getstream.android.core.api.model.retry.StreamRetryPolicy
+import io.getstream.android.core.api.model.retry.StreamRetryAttemptInfo
 import io.getstream.android.core.internal.processing.StreamRetryProcessorImpl
 
 /**
@@ -54,7 +55,7 @@ public interface StreamRetryProcessor {
      * @param block The suspending operation to execute. It should throw on failure; the processor
      *   handles re-invocation.
      */
-    public suspend fun <T> retry(policy: StreamRetryPolicy, block: suspend () -> T): Result<T>
+    public suspend fun <T> retry(policy: StreamRetryPolicy, block: suspend (attempt: StreamRetryAttemptInfo) -> T): Result<T>
 }
 
 /**

stream-android-core/src/main/java/io/getstream/android/core/internal/processing/StreamRetryProcessorImpl.kt

@@ -17,30 +17,38 @@
 package io.getstream.android.core.internal.processing
 
 import io.getstream.android.core.api.log.StreamLogger
-import io.getstream.android.core.api.model.StreamRetryPolicy
+import io.getstream.android.core.api.model.retry.StreamRetryPolicy
+import io.getstream.android.core.api.model.retry.StreamRetryAttemptInfo
 import io.getstream.android.core.api.processing.StreamRetryProcessor
 import io.getstream.android.core.api.utils.runCatchingCancellable
 import kotlin.coroutines.cancellation.CancellationException
 import kotlinx.coroutines.delay
 
 internal class StreamRetryProcessorImpl(private val logger: StreamLogger) : StreamRetryProcessor {
-    override suspend fun <T> retry(policy: StreamRetryPolicy, block: suspend () -> T): Result<T> =
+    override suspend fun <T> retry(policy: StreamRetryPolicy, block: suspend (attempt: StreamRetryAttemptInfo) -> T): Result<T> =
         runCatchingCancellable {
             var delayMs = policy.initialDelayMillis
             var attempt = 1
+            var previousError: Throwable? = null
             while (attempt <= policy.maxRetries) {
                 if (delayMs > 0) {
                     delay(delayMs)
                 }
                 try {
-                    return@runCatchingCancellable block()
+                    return@runCatchingCancellable block(StreamRetryAttemptInfo(
+                        attempt,
+                        delayMs,
+                        previousError,
+                        policy
+                    ))
                 } catch (c: CancellationException) {
                     throw c
                 } catch (t: Throwable) {
                     logger.v { "Retry attempt $attempt failed: ${t.message}" }
                     val checkGiveUp = attempt >= policy.minRetries
                     val shouldGiveUp = checkGiveUp && policy.giveUpFunction(attempt, t)
                     val isLastAttempt = attempt == policy.maxRetries
+                    previousError = t
                     if (shouldGiveUp || isLastAttempt) {
                         logger.v { "Retry attempt $attempt failed: ${t.message}. Giving up." }
                         throw t

stream-android-core/src/test/java/io/getstream/android/core/internal/processing/StreamRetryProcessorImplTest.kt

@@ -18,7 +18,7 @@
 
 package io.getstream.android.core.internal.processing
 
-import io.getstream.android.core.api.model.StreamRetryPolicy
+import io.getstream.android.core.api.model.retry.StreamRetryPolicy
 import io.mockk.mockk
 import java.util.concurrent.atomic.AtomicInteger
 import kotlinx.coroutines.ExperimentalCoroutinesApi