feat: add request to retry on exception policy (#106)

* feat: add request to shouldAttemptRetryOnException

* test: update test

* chore: cleanup

* example: update shouldAttemptRetryOnException in example

* docs: updated changelog

* ver: 2.0.0-beta.4

Author: vixez

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 2.0.0-beta.4
+
+- ❗️🛠  Changed: `shouldAttemptRetryOnException` will now also pass the `BaseRequest`.
+- 🚦  Tests: Updated tests.
+
 ## 2.0.0-beta.3
 
 - 🐞  Fixed: `MultipartRequest` does not get intercepted correctly (has missing fields).

example/lib/main.dart

@@ -355,7 +355,7 @@ class ExpiredTokenRetryPolicy extends RetryPolicy {
   int get maxRetryAttempts => 2;
 
   @override
-  bool shouldAttemptRetryOnException(Exception reason) {
+  bool shouldAttemptRetryOnException(Exception reason, BaseRequest request) {
     log(reason.toString());
 
     return false;

lib/http/intercepted_client.dart

@@ -278,7 +278,7 @@ class InterceptedClient extends BaseClient {
     } on Exception catch (error) {
       if (retryPolicy != null &&
           retryPolicy!.maxRetryAttempts > _retryCount &&
-          retryPolicy!.shouldAttemptRetryOnException(error)) {
+          retryPolicy!.shouldAttemptRetryOnException(error, request)) {
         _retryCount += 1;
         return _attemptRequest(request);
       } else {

lib/models/retry_policy.dart

@@ -36,7 +36,8 @@ import 'package:http/http.dart';
 abstract class RetryPolicy {
   /// Defines whether the request should be retried when an Exception occurs
   /// while making said request to the server.
-  bool shouldAttemptRetryOnException(Exception reason) => false;
+  bool shouldAttemptRetryOnException(Exception reason, BaseRequest request) =>
+      false;
 
   /// Defines whether the request should be retried after the request has
   /// received `response` from the server.

pubspec.yaml

@@ -1,6 +1,6 @@
 name: http_interceptor
 description: A lightweight, simple plugin that allows you to intercept request and response objects and modify them if desired.
-version: 2.0.0-beta.3
+version: 2.0.0-beta.4
 homepage: https://github.com/CodingAleCR/http_interceptor
 issue_tracker: https://github.com/CodingAleCR/http_interceptor/issues
 repository: https://github.com/CodingAleCR/http_interceptor

test/models/retry_policy_test.dart

@@ -17,8 +17,13 @@ main() {
   group("shouldAttemptRetryOnException", () {
     test("returns false by default", () {
       expect(
-          testObject
-              .shouldAttemptRetryOnException(Exception("Test Exception.")),
+          testObject.shouldAttemptRetryOnException(
+            Exception("Test Exception."),
+            Request(
+              'GET',
+              Uri(),
+            ),
+          ),
           false);
     });
   });