feat: add onRetryFailure to retry

google · Jul 26, 2023 · 0c0e20c · 0c0e20c
1 parent 545dc09
commit 0c0e20c
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 2 deletions.
diff --git a/retry/lib/retry.dart b/retry/lib/retry.dart
@@ -121,22 +121,27 @@ final class RetryOptions {
   Future<T> retry<T>(
     FutureOr<T> Function() fn, {
     FutureOr<bool> Function(Exception)? retryIf,
+    @Deprecated('Use `onRetryFailure` instead of `onRetry`')
     FutureOr<void> Function(Exception)? onRetry,
+    FutureOr<void> Function(Exception, StackTrace)? onRetryFailure,
   }) async {
     var attempt = 0;
     // ignore: literal_only_boolean_expressions
     while (true) {
       attempt++; // first invocation is the first attempt
       try {
         return await fn();
-      } on Exception catch (e) {
+      } on Exception catch (e, st) {
         if (attempt >= maxAttempts ||
             (retryIf != null && !(await retryIf(e)))) {
           rethrow;
         }
         if (onRetry != null) {
           await onRetry(e);
         }
+        if (onRetryFailure != null) {
+          await onRetryFailure(e, st);
+        }
       }
 
       // Sleep for a delay
@@ -178,11 +183,14 @@ Future<T> retry<T>(
   Duration maxDelay = const Duration(seconds: 30),
   int maxAttempts = 8,
   FutureOr<bool> Function(Exception)? retryIf,
+  @Deprecated('Use `onRetryFailure` instead of `onRetry`')
   FutureOr<void> Function(Exception)? onRetry,
+  FutureOr<void> Function(Exception, StackTrace)? onRetryFailure,
 }) =>
     RetryOptions(
       delayFactor: delayFactor,
       randomizationFactor: randomizationFactor,
       maxDelay: maxDelay,
       maxAttempts: maxAttempts,
-    ).retry(fn, retryIf: retryIf, onRetry: onRetry);
+    ).retry(fn,
+        retryIf: retryIf, onRetry: onRetry, onRetryFailure: onRetryFailure);
diff --git a/retry/test/retry_test.dart b/retry/test/retry_test.dart
@@ -131,5 +131,18 @@ void main() {
       await expectLater(f, throwsA(isException));
       expect(count, equals(2));
     });
+
+    test('call onRetryFailure when exception on retry', () async {
+      var count = 0;
+      await retry(() {
+        count++;
+        if (count == 1) {
+          throw FormatException('Retry will be okay');
+        }
+      }, onRetryFailure: (e, st) {
+        expect(e, isA<FormatException>());
+        expect(st, isA<StackTrace>());
+      });
+    });
   });
 }