🔖 release chopper v7.0.9

chopper/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 7.0.9
+
+- Add success/failure callback hooks to Authenticator ([#527](https://github.com/lejard-h/chopper/pull/527))
+- Add mock mixins of Chopper components ([#529](https://github.com/lejard-h/chopper/pull/529))
+
 ## 7.0.8
 
 - Encode DateTime query parameters in ISO8601 format ([#516](https://github.com/lejard-h/chopper/pull/516))

chopper/Makefile

@@ -48,7 +48,7 @@ sure:
 show_test_coverage:
 	@# Help: Run Dart unit tests for the current project and show the coverage.
 	dart pub global activate coverage && dart pub global run coverage:test_with_coverage
-	lcov --remove coverage/lcov.info '**.g.dart' '**.mock.dart' '**.chopper.dart' -o coverage/lcov_without_generated_code.info
+	lcov --remove coverage/lcov.info '**.g.dart' '**.mock.dart' '**.chopper.dart' -o coverage/lcov_without_generated_code.info --ignore-errors unused
 	genhtml coverage/lcov_without_generated_code.info -o coverage/html
 	source ../tool/makefile_helpers.sh && open_link "coverage/html/index.html"
 

chopper/lib/src/authenticator.dart

@@ -2,12 +2,62 @@
 
 import 'package:chopper/chopper.dart';
 
-/// This method should return a [Request] that includes credentials to satisfy an authentication challenge received in
-/// [response]. It should return `null` if the challenge cannot be satisfied.
+///
+/// Callback that is called when an authentication challenge is received
+/// based on the given [request], [response], and optionally the
+/// [originalRequest].
+///
+typedef AuthenticationCallback = FutureOr<void> Function(
+  Request request,
+  Response response, [
+  Request? originalRequest,
+]);
+
+///
+/// Handles authentication challenges raised by the [ChopperClient].
+///
+/// Optionally, you can override either [onAuthenticationSuccessful] or
+/// [onAuthenticationFailed] in order to listen to when a particular
+/// authentication request succeeds or fails.
+///
+/// For example, you can use these in order to reset or mutate your
+/// instance's internal state for the purposes of keeping track of
+/// the number of retries made to authenticate a request.
+///
+/// Furthermore, you can use these callbacks to determine whether
+/// your authentication [Request] from [authenticate] actually succeeded
+/// or failed.
+///
 abstract class Authenticator {
+  ///
+  /// Returns a [Request] that includes credentials to satisfy
+  /// an authentication challenge received in [response], based on
+  /// the incoming [request] or optionally, the [originalRequest]
+  /// (which was not modified with any previous [RequestInterceptor]s).
+  ///
+  /// Otherwise, return `null` if the challenge cannot be satisfied.
+  ///
   FutureOr<Request?> authenticate(
     Request request,
     Response response, [
     Request? originalRequest,
   ]);
+
+  ///
+  /// Optional callback called by [ChopperClient] when the outgoing
+  /// request from [authenticate] was successful.
+  ///
+  /// You can use this to determine whether that request actually succeeded
+  /// in authenticating the user.
+  ///
+  AuthenticationCallback? get onAuthenticationSuccessful => null;
+
+  ///
+  /// Optional callback called by [ChopperClient] when the outgoing
+  /// request from [authenticate] failed to authenticate.
+  ///
+  /// You can use this to determine whether that request failed to recover
+  /// the user's session.
+  ///
+  AuthenticationCallback? get onAuthenticationFailed => null;
 }

chopper/lib/src/base.dart

@@ -320,10 +320,13 @@ base class ChopperClient {
         );
         // To prevent double call with typed response
         if (_responseIsSuccessful(res.statusCode)) {
+          await authenticator!.onAuthenticationSuccessful
+              ?.call(updatedRequest, res, request);
           return _processResponse(res);
         } else {
           res = await _handleErrorResponse<BodyType, InnerType>(res);
-
+          await authenticator!.onAuthenticationFailed
+              ?.call(updatedRequest, res, request);
           return _processResponse(res);
         }
       }
@@ -515,6 +518,17 @@ base class ChopperClient {
   Stream<Response> get onResponse => _responseController.stream;
 }
 
+///
+/// [ChopperClient] mixin for the purposes of creating mocks
+/// using a mocking framework such as Mockito or Mocktail.
+///
+/// ```dart
+/// base class MockChopperClient extends Mock with MockChopperClientMixin {}
+/// ```
+///
+@visibleForTesting
+base mixin MockChopperClientMixin implements ChopperClient {}
+
 /// A marker and helper class used by `chopper_generator` to generate network
 /// call implementations.
 ///

chopper/lib/src/chopper_log_record.dart

@@ -1,5 +1,6 @@
 import 'package:chopper/src/request.dart';
 import 'package:chopper/src/response.dart';
+import 'package:meta/meta.dart';
 
 final class ChopperLogRecord {
   const ChopperLogRecord(this.message, {this.request, this.response});
@@ -11,3 +12,14 @@ final class ChopperLogRecord {
   @override
   String toString() => message;
 }
+
+///
+/// [ChopperLogRecord] mixin for the purposes of creating mocks
+/// using a mocking framework such as Mockito or Mocktail.
+///
+/// ```dart
+/// base class MockChopperLogRecord extends Mock with MockChopperLogRecordMixin {}
+/// ```
+///
+@visibleForTesting
+base mixin MockChopperLogRecordMixin implements ChopperLogRecord {}

chopper/lib/src/request.dart

@@ -237,6 +237,17 @@ base class Request extends http.BaseRequest with EquatableMixin {
       ];
 }
 
+///
+/// [Request] mixin for the purposes of creating mocks
+/// using a mocking framework such as Mockito or Mocktail.
+///
+/// ```dart
+/// base class MockRequest extends Mock with MockRequestMixin {}
+/// ```
+///
+@visibleForTesting
+base mixin MockRequestMixin implements Request {}
+
 /// Represents a part in a multipart request.
 @immutable
 final class PartValue<T> with EquatableMixin {
@@ -263,8 +274,30 @@ final class PartValue<T> with EquatableMixin {
       ];
 }
 
+///
+/// [PartValue] mixin for the purposes of creating mocks
+/// using a mocking framework such as Mockito or Mocktail.
+///
+/// ```dart
+/// base class MockPartValue<T> extends Mock with MockPartValueMixin<T> {}
+/// ```
+///
+@visibleForTesting
+base mixin MockPartValueMixin<T> implements PartValue<T> {}
+
 /// Represents a file [PartValue] in a multipart request.
 @immutable
 final class PartValueFile<T> extends PartValue<T> {
   const PartValueFile(super.name, super.value);
 }
+
+///
+/// [PartValueFile] mixin for the purposes of creating mocks
+/// using a mocking framework such as Mockito or Mocktail.
+///
+/// ```dart
+/// base class MockPartValueFile<T> extends Mock with MockPartValueFileMixin<T> {}
+/// ```
+///
+@visibleForTesting
+base mixin MockPartValueFileMixin<T> implements PartValueFile<T> {}

chopper/lib/src/response.dart

@@ -74,3 +74,14 @@ base class Response<BodyType> with EquatableMixin {
         error,
       ];
 }
+
+///
+/// [Response] mixin for the purposes of creating mocks
+/// using a mocking framework such as Mockito or Mocktail.
+///
+/// ```dart
+/// base class MockResponse<BodyType> extends Mock with MockResponseMixin<BodyType> {}
+/// ```
+///
+@visibleForTesting
+base mixin MockResponseMixin<BodyType> implements Response<BodyType> {}

chopper/pubspec.yaml

@@ -1,6 +1,6 @@
 name: chopper
 description: Chopper is an http client generator using source_gen, inspired by Retrofit
-version: 7.0.8
+version: 7.0.9
 documentation: https://hadrien-lejard.gitbook.io/chopper
 repository: https://github.com/lejard-h/chopper
 
@@ -22,7 +22,7 @@ dev_dependencies:
   data_fixture_dart: ^2.2.0
   faker: ^2.1.0
   http_parser: ^4.0.2
-  lints: ^2.1.1
+  lints: ">=2.1.1 <4.0.0"
   test: ^1.24.4
   transparent_image: ^2.0.1
   chopper_generator: ^7.0.0