fix: ci actions, docs and issues with requestTimeout configs (#147)

.github/actions/setup-flutter/action.yaml

@@ -0,0 +1,27 @@
+name: "Init Flutter"
+description: "Initializes Flutter repo"
+runs:
+  using: "composite"
+  steps:
+    - name: 📚 Checkout repository
+      uses: actions/checkout@v4
+
+    - name: 🐦 Setup Flutter
+      uses: subosito/flutter-action@v2
+      with:
+        flutter-version: '3.22.2'
+        cache: true
+
+    - name: 📦 Get dependencies
+      shell: bash
+      run: flutter pub get
+
+    - name: ☕️ Set up JDK 17
+      uses: actions/setup-java@v1
+      with:
+        java-version: '17'
+        distribution: 'temurin'
+
+    - name: 🔎 Check Flutter environment
+      shell: bash
+      run: flutter doctor -v

.github/workflows/publish.yml

@@ -3,9 +3,12 @@ name: Publish to pub.dev
 on:
   push:
     tags:
-      - '[0-9]+.[0-9]+.[0-9]+*'
-  workflow_dispatch:
+      - "[0-9]+.[0-9]+.[0-9]+*"
 
 jobs:
   publish:
-    uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/flutter_pub_publish.yml@v1
+    permissions:
+      id-token: write # Required for authentication using OIDC
+    uses: dart-lang/setup-dart/.github/workflows/publish.yml@v1
+    # with:
+    #   working-directory: path/to/package/within/repository

.github/workflows/validate.yaml

@@ -0,0 +1,29 @@
+name: validate
+
+on:
+  workflow_dispatch:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  analyze:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 📚 Checkout repository
+        uses: actions/checkout@v4
+
+      - name: 📦 Setup Flutter & Deps
+        uses: ./.github/actions/setup-flutter
+
+      - name: 📝 Format
+        run: dart format . --set-exit-if-changed
+
+      - name: 📊 Analyze
+        run: flutter analyze
+
+      - name: 🧪 Test
+        run: flutter test --coverage
+
+      - name: 🔎 Check Publish Warnings
+        run: flutter pub publish --dry-run

example/ios/Podfile.lock

@@ -22,8 +22,8 @@ EXTERNAL SOURCES:
 SPEC CHECKSUMS:
   Flutter: e0871f40cf51350855a761d2e70bf5af5b9b5de7
   image_picker_ios: 4a8aadfbb6dc30ad5141a2ce3832af9214a705b5
-  shared_preferences_foundation: 5b919d13b803cadd15ed2dc053125c68730e5126
+  shared_preferences_foundation: fcdcbc04712aee1108ac7fda236f363274528f78
 
 PODFILE CHECKSUM: c4c93c5f6502fe2754f48404d3594bf779584011
 
-COCOAPODS: 1.11.3
+COCOAPODS: 1.15.2

example/ios/Runner.xcodeproj/project.pbxproj

@@ -156,7 +156,7 @@
 		97C146E61CF9000F007C117D /* Project object */ = {
 			isa = PBXProject;
 			attributes = {
-				LastUpgradeCheck = 1430;
+				LastUpgradeCheck = 1510;
 				ORGANIZATIONNAME = "";
 				TargetAttributes = {
 					97C146ED1CF9000F007C117D = {

example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"

example/lib/common.dart

@@ -10,6 +10,7 @@ class LoggerInterceptor extends InterceptorContract {
     log('----- Request -----');
     log(request.toString());
     log(request.headers.toString());
+    log('Request type: ${request.runtimeType}');
     return request;
   }
 
@@ -19,6 +20,7 @@ class LoggerInterceptor extends InterceptorContract {
   }) async {
     log('----- Response -----');
     log('Code: ${response.statusCode}');
+    log('Response type: ${response.runtimeType}');
     if (response is Response) {
       log((response).body);
     }

example/pubspec.yaml

@@ -11,11 +11,11 @@ dependencies:
     sdk: flutter
   http_interceptor:
     path: ../
-  image_picker: ^0.8.9
-  shared_preferences: ^2.2.2
+  image_picker: ^1.1.2
+  shared_preferences: ^2.2.3
 
 dev_dependencies:
-  flutter_lints: ^3.0.1
+  flutter_lints: ^4.0.0
   flutter_test:
     sdk: flutter
 

guides/migration_guide_2.0.0.md

@@ -39,7 +39,7 @@ v2.0.0 and up
 ```dart
 class WeatherApiInterceptor extends InterceptorContract {
   @override
-  Future<BaseRequest> interceptRequest({required BaseRequest request}) async {
+  FutureOr<BaseRequest> interceptRequest({required BaseRequest request}) async {
     final cache = await SharedPreferences.getInstance();
 
     final Map<String, String>? headers = Map.from(request.headers);
@@ -55,7 +55,7 @@ class WeatherApiInterceptor extends InterceptorContract {
   }
 
   @override
-  Future<BaseResponse> interceptResponse(
+  FutureOr<BaseResponse> interceptResponse(
           {required BaseResponse response}) async =>
       response;
 }
@@ -92,7 +92,7 @@ v2.0.0 and up
 class ExpiredTokenRetryPolicy extends RetryPolicy {
 
   @override
-  Future<bool> shouldAttemptRetryOnResponse(BaseResponse response) async {
+  FutureOr<bool> shouldAttemptRetryOnResponse(BaseResponse response) async {
     if (response.statusCode == 401) {
       log("Retrying request...");
       final cache = await SharedPreferences.getInstance();
@@ -111,7 +111,7 @@ If you are using `shouldAttemptRetryOnException` then you will also have to conv
 
 ```dart
 @override
-Future<bool> shouldAttemptRetryOnException(
+FutureOr<bool> shouldAttemptRetryOnException(
   Exception reason,
   BaseRequest request,
 ) async {

lib/http/intercepted_client.dart

@@ -45,7 +45,7 @@ class InterceptedClient extends BaseClient {
   final List<InterceptorContract> interceptors;
 
   /// Maximum duration of a request.
-  final Duration? requestTimeout;
+  Duration? requestTimeout;
 
   /// Request timeout handler
   TimeoutCallback? onRequestTimeout;

pubspec.yaml

@@ -11,8 +11,8 @@ environment:
   sdk: ">=3.0.3 <4.0.0"
 
 dependencies:
-  http: ^1.1.0
+  http: ^1.2.1
 
 dev_dependencies:
-  lints: ^3.0.0
-  test: ^1.25.2
+  lints: ^4.0.0
+  test: ^1.25.8