✨ Restructure interceptors

[Guldem]

Restructuring interceptors

This PR/Draft contains the current progress/experimenting on restructuring interceptors. See #544 for more information on the proposal. Any feedback/help is welcome!

Description

Refactor interceptors into a chain of interceptors. This will reduce the amount of different type interceptor interfaces to 1. A Interceptor will be responsible for both the Request and the Response if needed.

Specifying a interceptor would look like this:

class MyInterceptor implements Interceptor {
 @override
 FutureOr<Response<BodyType>> intercept<BodyType>(Chain<BodyType> chain) async {
    final request = chain.request;
    final updatedRequest = // Do something with intercepted request here

    final response = await chain.proceed(updatedRequest);
    final updatedResponse =  // Do something with intercepted response.

    return updatedResponse;
  }
}

All Interceptor are chained so the Request will first go down the chain of interceptors and in the last step the network call is make. The Response will then go back through the chain of interceptors.

Besides user created interceptors some of the internal logic have been refactor into InternalInterceptor.

InternalInterceptors:

• RequestConverterInterceptor: Wrapper interceptor that wraps request converters
• ResponseConverterInterceptor: Wrapper interceptor that wraps response converters
• HttpCallInterceptor: Interceptor that makes the actual http call
• AuthenticatorInterceptor: Wrapper interceptor that wraps the authenticator

Progress

• Setup the actual chain
• Include converters in the chain
• Include authenticator in the chain
• Refactor HeadersInterceptor, CurlInterceptor and HttpLoggingInterceptor to use new interface.
• Update HttpLoggingInterceptor to track call time.
• Check/Fix exception handling
• Update existing tests
• Add new tests
• Add dart doc to code
• Add documentation

Breaking changes

• RequestInterceptor is removed
• Function RequestInterceptors are removed
• ResponseInterceptor is removed
• Function ResponseInterceptors are removed

[codecov]

Codecov Report

Attention: Patch coverage is 96.27329% with 6 lines in your changes are missing coverage. Please review.

Project coverage is 92.85%. Comparing base (84471e4) to head (25f6d71).

Files	Patch %	Lines
chopper/lib/src/chopper_exception.dart	0.00%	3 Missing ⚠️
chopper/lib/src/chain/interceptor_chain.dart	95.45%	1 Missing ⚠️
...er/lib/src/interceptors/http_call_interceptor.dart	90.00%	1 Missing ⚠️
...lib/src/interceptors/http_logging_interceptor.dart	96.87%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop     #547      +/-   ##
===========================================
- Coverage    93.52%   92.85%   -0.67%     
===========================================
  Files           12       22      +10     
  Lines          463      490      +27     
===========================================
+ Hits           433      455      +22     
- Misses          30       35       +5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[techouse]

@Guldem you'll have to resolve some merge conflicts that got generated by #592 it seems ❤️‍🩹

[Guldem]

@Guldem you'll have to resolve some merge conflicts that got generated by #592 it seems ❤️‍🩹

Oooh no! 😱 Thank will take a look at it.

[techouse]

@Guldem I'll prep a pre-release PR for this baby

[techouse]

@Guldem this has now been published as a pre-release v8.0.0-rc.1

Thank you soooo much for your hard work :)

CC/ @JEuler

[Guldem]

@Guldem this has now been published as a pre-release v8.0.0-rc.1

Thank you soooo much for your hard work :)

CC/ @JEuler

Cool! Thanks for the feedback and support :)

[techouse]

@Guldem I've been using this PR in a large scale app for a week now and I just can't reiterate on how amazing this piece of work is. Thanx 🙏

[Guldem]

@Guldem I've been using this PR in a large scale app for a week now and I just can't reiterate on how amazing this piece of work is. Thanx 🙏

Glad to hear, thanks!