feat: adds timeout callback function

javiermrz · javier.marzan1 · CodingAleCR · web-flow · commit 7b65e4fe7c4c · 2022-03-11T01:30:40.000-06:00
Co-authored-by: javier.marzan1 &lt;javier.marzan@novatalent.com&gt;
Co-authored-by: Alejandro Ulate &lt;me@codingale.dev&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 2.0.0-beta.5
+
+- ✨&nbsp;&nbsp;Added: Support for `onRequestTimeout` when setting up `requestTimeout` on the interceptor.
+
 ## 2.0.0-beta.4
 
 - ❗️🛠&nbsp;&nbsp;Changed: `shouldAttemptRetryOnException` will now also pass the `BaseRequest`.
diff --git a/README.md b/README.md
@@ -56,6 +56,7 @@ http_interceptor: ^1.0.1
 - 🖋 Supports self-signed certificates (except on Flutter Web).
 - 🍦 Compatible with vanilla Dart projects or Flutter projects.
 - 🎉 Null-safety.
+- ⏲ Timeout configuration with duration and timeout functions.
 
 ## Usage
 
diff --git a/lib/http/intercepted_client.dart b/lib/http/intercepted_client.dart
@@ -9,6 +9,8 @@ import 'package:http_interceptor/models/models.dart';
 import 'http_methods.dart';
 import 'interceptor_contract.dart';
 
+typedef TimeoutCallback = FutureOr<StreamedResponse> Function();
+
 /// Class to be used by the user to set up a new `http.Client` with interceptor
 /// support.
 ///
@@ -44,6 +46,9 @@ class InterceptedClient extends BaseClient {
   /// Maximum duration of a request.
   final Duration? requestTimeout;
 
+  /// Request timeout handler
+  TimeoutCallback? onRequestTimeout;
+
   /// A policy that defines whether a request or response should trigger a
   /// retry. This is useful for implementing JWT token expiration
   final RetryPolicy? retryPolicy;
@@ -54,6 +59,7 @@ class InterceptedClient extends BaseClient {
   InterceptedClient._internal({
     required this.interceptors,
     this.requestTimeout,
+    this.onRequestTimeout,
     this.retryPolicy,
     Client? client,
   }) : _inner = client ?? Client();
@@ -78,12 +84,14 @@ class InterceptedClient extends BaseClient {
   factory InterceptedClient.build({
     required List<InterceptorContract> interceptors,
     Duration? requestTimeout,
+    TimeoutCallback? onRequestTimeout,
     RetryPolicy? retryPolicy,
     Client? client,
   }) =>
       InterceptedClient._internal(
         interceptors: interceptors,
         requestTimeout: requestTimeout,
+        onRequestTimeout: onRequestTimeout,
         retryPolicy: retryPolicy,
         client: client,
       );
@@ -264,7 +272,9 @@ class InterceptedClient extends BaseClient {
 
       var stream = requestTimeout == null
           ? await _inner.send(interceptedRequest)
-          : await _inner.send(interceptedRequest).timeout(requestTimeout!);
+          : await _inner
+              .send(interceptedRequest)
+              .timeout(requestTimeout!, onTimeout: onRequestTimeout);
 
       response =
           request is Request ? await Response.fromStream(stream) : stream;
diff --git a/lib/http/intercepted_http.dart b/lib/http/intercepted_http.dart
@@ -41,6 +41,9 @@ class InterceptedHttp {
   /// Maximum duration of a request.
   final Duration? requestTimeout;
 
+  /// Request timeout handler
+  TimeoutCallback? onRequestTimeout;
+
   /// A policy that defines whether a request or response should trigger a
   /// retry. This is useful for implementing JWT token expiration
   final RetryPolicy? retryPolicy;
@@ -54,6 +57,7 @@ class InterceptedHttp {
   InterceptedHttp._internal({
     required this.interceptors,
     this.requestTimeout,
+    this.onRequestTimeout,
     this.retryPolicy,
     this.client,
   });
@@ -79,12 +83,14 @@ class InterceptedHttp {
   factory InterceptedHttp.build({
     required List<InterceptorContract> interceptors,
     Duration? requestTimeout,
+    TimeoutCallback? onRequestTimeout,
     RetryPolicy? retryPolicy,
     Client? client,
   }) =>
       InterceptedHttp._internal(
         interceptors: interceptors,
         requestTimeout: requestTimeout,
+        onRequestTimeout: onRequestTimeout,
         retryPolicy: retryPolicy,
         client: client,
       );
@@ -222,6 +228,7 @@ class InterceptedHttp {
     final client = InterceptedClient.build(
       interceptors: interceptors,
       requestTimeout: requestTimeout,
+      onRequestTimeout: onRequestTimeout,
       retryPolicy: retryPolicy,
       client: this.client,
     );
diff --git a/pubspec.yaml b/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.4
+version: 2.0.0-beta.5
 homepage: https://github.com/CodingAleCR/http_interceptor
 issue_tracker: https://github.com/CodingAleCR/http_interceptor/issues
 repository: https://github.com/CodingAleCR/http_interceptor
