Support @Tag

[lwj1994]

Add tag

@Tag parameter annotation for setting tag on the underlying Chopper Request object. These can be read
in Converters or Interceptors for tracing, analytics, varying behavior, and more.

if want to filter null value or empty String for some url. we can make an IncludeBodyNullOrEmptyTag Object as Tag.

class IncludeBodyNullOrEmptyTag {
  bool includeNull = false;
  bool includeEmpty = false;

  IncludeBodyNullOrEmptyTag(this.includeNull, this.includeEmpty);
}

@get(path: '/include')
Future<Response> includeBodyNullOrEmptyTag(
    {@Tag()
    IncludeBodyNullOrEmptyTag tag = const IncludeBodyNullOrEmptyTag()});

get tag via request.tag in Converter or Interceptor:

class TagConverter extends JsonConverter {
  FutureOr<Request> convertRequest(Request request) {
    final tag = request.tag;
    if (tag is IncludeBodyNullOrEmptyTag) {
      if (request.body is Map) {
        final Map body = request.body as Map;
        final Map bodyCopy = {};
        for (final MapEntry entry in body.entries) {
          if (!tag.includeNull && entry.value == null) continue;
          if (!tag.includeEmpty && entry.value == "") continue;
          bodyCopy[entry.key] = entry.value;
        }
        request = request.copyWith(body: bodyCopy);
      }
    }
  }
}

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.17%. Comparing base (8ff4ecd) to head (c5ac0bd).

Additional details and impacted files

@@           Coverage Diff            @@
##           develop     #586   +/-   ##
========================================
  Coverage    94.17%   94.17%           
========================================
  Files           11       11           
  Lines          481      481           
========================================
  Hits           453      453           
  Misses          28       28           

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

[techouse]

Hey,

Thanx for the PR, however, I'm not sure I understand what this @Tag annotation should be used for.

Can you add some concrete examples and/or tests please?

[lwj1994]

Hey,

Thanx for the PR, however, I'm not sure I understand what this @Tag annotation should be used for.

Can you add some concrete examples and/or tests please?

ok. i will add it later.

Let me start with a small example .

some path need check token to trigger refresh token when token is out of date.

we can determine the path in interceptor:

class  TokenInterceptor extends RequestInterceptor{
   request( ) {
      if (path.startWith("/xxx/xx")  
        || path.startWith("/xxx/xx")
        || path.startWith("/xxx/xx")
        || path.startWith("/xxx/xx")
       // ...... more
){
           // wait to refresh token 
          await ensureTokenIsValid();
          request.headers.add["Auth":  token];
      }
   }
}

If those token-dependent requests are tagged, then no judgment is required。

if (request.tags["needToken"] != null){
           // wait to refresh token 
          await ensureTokenIsValid();
          request.headers.add["Auth":  token];
      }

[techouse]

Why don't you simply catch an expired token, refresh it and repeat the call once more?

(request) --> (error 401: token expired) --> (auth interceptor refresh token) --> (repeat request) --> (ok 200)

[lwj1994]

Why don't you simply catch an expired token, refresh it and repeat the call once more?

(request) --> (error 401: token expired) --> (auth interceptor refresh token) --> (repeat request) --> (ok 200)

thx, it looks more simple，but the BodyType will lose type, just as dynamic, how to get origin response's BodyType

class AuthInterceptor implements chopper.ResponseInterceptor {

  @override
  FutureOr<chopper.Response<dynamic>> onResponse(chopper.Response<dynamic> response) async{
    if(response.statusCode == 401){
      await refreshToken();
      // resend
      response = await chopperClient.send<BodyType>(response.base.request as chopper.Request);
    }
    return response;
  }
}

i noticed that 👍🏻 after #547 interceptor can get type.

[techouse]

i noticed that 👍🏻 after #547 interceptor can get type.

Correct! Can you please test #547 and let @Guldem know if everything works for you. It's a bigger/breaking PR so we'd be grateful for any real-world tests. 😇

[Guldem]

It's nice to add meta information to a request but I personally never needed something like this. Like @techouse says in most cases it can be solved with a interceptor. But on the other side it can't really hurt 😄

[lwj1994]

hi guys, i refactored tag, make tag as a Object instead of Map<String, dynamic>. and i add my showcase in chopper/example/tag.dart. Maybe @tag not very useful, but some cases are used as a means of tracking requests.

Add tag

@Tag parameter annotation for setting tag on the underlying Chopper Request object. These can be read
in Converters or Interceptors for tracing, analytics, varying behavior, and more.

if want to filter null value or empty String for some url. we can make an IncludeBodyNullOrEmptyTag Object as Tag.

class IncludeBodyNullOrEmptyTag {
  bool includeNull = false;
  bool includeEmpty = false;

  IncludeBodyNullOrEmptyTag(this.includeNull, this.includeEmpty);
}

@get(path: '/include')
Future<Response> includeBodyNullOrEmptyTag(
    {@Tag()
    IncludeBodyNullOrEmptyTag tag = const IncludeBodyNullOrEmptyTag()});

get tag via request.tag in Converter or Interceptor:

class TagConverter extends JsonConverter {
  FutureOr<Request> convertRequest(Request request) {
    final tag = request.tag;
    if (tag is IncludeBodyNullOrEmptyTag) {
      if (request.body is Map) {
        final Map body = request.body as Map;
        final Map bodyCopy = {};
        for (final MapEntry entry in body.entries) {
          if (!tag.includeNull && entry.value == null) continue;
          if (!tag.includeEmpty && entry.value == "") continue;
          bodyCopy[entry.key] = entry.value;
        }
        request = request.copyWith(body: bodyCopy);
      }
    }
  }
}

[Guldem]

LGTM

[JEuler]

LGTM