Change default retry() behavior, and bump to 3.0.0

Author: jonasfj

retry/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v3.0.0
+ * When `retryIf` is not given, we default to retry any `Exception` thrown.
+   This is breaking, but provides a more useful default behavior.
+
 ## v2.0.0
  * Expect complete API break.
  * Initial release started from scratch, lifted from code in

retry/lib/retry.dart

@@ -113,6 +113,10 @@ class RetryOptions {
   ///
   /// At every retry the [onRetry] function will be called (if given). The
   /// function [fn] will be invoked at-most [this.attempts] times.
+  ///
+  /// If no [retryIf] function is given this will retry any for any [Exception]
+  /// thrown. To retry on an [Error], the error must be caught and _rethrown_
+  /// as an [Exception].
   Future<T> retry<T>(
     FutureOr<T> Function() fn, {
     FutureOr<bool> Function(Exception) retryIf,
@@ -125,7 +129,8 @@ class RetryOptions {
       try {
         return await fn();
       } on Exception catch (e) {
-        if (attempt >= maxAttempts || retryIf == null || !(await retryIf(e))) {
+        if (attempt >= maxAttempts ||
+            (retryIf != null && !(await retryIf(e)))) {
           rethrow;
         }
         if (onRetry != null) {
@@ -161,6 +166,10 @@ class RetryOptions {
 /// );
 /// print(response.body);
 /// ```
+///
+/// If no [retryIf] function is given this will retry any for any [Exception]
+/// thrown. To retry on an [Error], the error must be caught and _rethrown_
+/// as an [Exception].
 Future<T> retry<T>(
   FutureOr<T> Function() fn, {
   Duration delayFactor = const Duration(milliseconds: 200),

retry/pubspec.yaml

@@ -1,10 +1,10 @@
 name: retry
-version: 2.0.0
+version: 3.0.0
 authors:
   - Jonas Finnemann Jensen <[email protected]>
 description: |
   Utility for wrapping an asynchronous function in automatic retry logic with
-  exponential backoff, useful when making requests over network.
+  exponential back-off, useful when making requests over network.
 homepage: https://github.com/google/dart-neats/tree/master/retry
 repository: https://github.com/google/dart-neats.git
 issue_tracker: https://github.com/google/dart-neats/labels/pkg:retry

retry/test/retry_test.dart

@@ -57,7 +57,7 @@ void main() {
       final f = r.retry(() {
         count++;
         throw Exception('Retry will fail');
-      });
+      }, retryIf: (e) => false);
       await expectLater(f, throwsA(isException));
       expect(count, equals(1));
     });
@@ -93,6 +93,23 @@ void main() {
       expect(count, equals(2));
     });
 
+    test('retry (no retryIf)', () async {
+      int count = 0;
+      final r = RetryOptions(
+        maxAttempts: 5,
+        maxDelay: Duration(),
+      );
+      final f = r.retry(() {
+        count++;
+        if (count == 1) {
+          throw FormatException('Retry will be okay');
+        }
+        return true;
+      });
+      await expectLater(f, completion(isTrue));
+      expect(count, equals(2));
+    });
+
     test('retry (unhandled on 2nd try)', () async {
       int count = 0;
       final r = RetryOptions(