🔖 release v7.0.6 (#496)

# chopper ## 7.0.6 - #493 - #497 - #495 # chopper_built_value ## 2.0.1 - #495 # chopper_generator ## 7.0.3 - #493 - #495 --------- Co-authored-by: Klemen Tusar <techouse@gmail.com> Co-authored-by: Martin Alejandro Escobar Espinel <56127727+martinale14@users.noreply.github.com>
lejard-h · Sep 2, 2023 · 7833e70 · 7833e70
1 parent c0133d7
commit 7833e70
Show file tree

Hide file tree

Showing 18 changed files with 2,028 additions and 36 deletions.
diff --git a/chopper/CHANGELOG.md b/chopper/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## 7.0.6
+
+- The @ChopperApi annotation's baseUrl property can be used as a top level constant string variable ([#493](https://github.com/lejard-h/chopper/pull/493))
+- Fix ChopperClient.send() sending wrong request when using an Authenticator ([#497](https://github.com/lejard-h/chopper/pull/497))
+- Add pub.dev topics to package metadata ([#495](https://github.com/lejard-h/chopper/pull/495))
+
 ## 7.0.5
 
 - Fix documentation links in README ([#488](https://github.com/lejard-h/chopper/pull/488))

diff --git a/chopper/lib/src/annotations.dart b/chopper/lib/src/annotations.dart
@@ -22,6 +22,8 @@ import 'package:meta/meta.dart';
 @immutable
 final class ChopperApi {
   /// A part of a URL that every request defined inside a class annotated with [ChopperApi] will be prefixed with.
+  ///
+  /// The `baseUrl` can be a top level constant string variable.
   final String baseUrl;
 
   const ChopperApi({

diff --git a/chopper/lib/src/base.dart b/chopper/lib/src/base.dart
@@ -309,11 +309,8 @@ base class ChopperClient {
     dynamic res = Response(response, response.body);
 
     if (authenticator != null) {
-      final Request? updatedRequest = await authenticator!.authenticate(
-        request,
-        res,
-        request,
-      );
+      final Request? updatedRequest =
+          await authenticator!.authenticate(req, res, request);
 
       if (updatedRequest != null) {
         res = await send<BodyType, InnerType>(

diff --git a/chopper/lib/src/interceptor.dart b/chopper/lib/src/interceptor.dart
@@ -193,9 +193,12 @@ class JsonConverter implements Converter, ErrorConverter {
   Request encodeJson(Request request) {
     final String? contentType = request.headers[contentTypeKey];
 
-    return (contentType?.contains(jsonHeaders) ?? false)
-        ? request.copyWith(body: json.encode(request.body))
-        : request;
+    if ((contentType?.contains(jsonHeaders) ?? false) &&
+        (request.body.runtimeType != String || !isJson(request.body))) {
+      return request.copyWith(body: json.encode(request.body));
+    }
+
+    return request;
   }
 
   FutureOr<Response> decodeJson<BodyType, InnerType>(Response response) async {
@@ -255,6 +258,16 @@ class JsonConverter implements Converter, ErrorConverter {
 
   static Request requestFactory(Request request) =>
       const JsonConverter().convertRequest(request);
+
+  @visibleForTesting
+  static bool isJson(dynamic data) {
+    try {
+      json.decode(data);
+      return true;
+    } catch (_) {
+      return false;
+    }
+  }
 }
 
 /// A [Converter] implementation that converts only [Request]s having a [Map] as their body.

diff --git a/chopper/pubspec.yaml b/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.5
+version: 7.0.6
 documentation: https://hadrien-lejard.gitbook.io/chopper
 repository: https://github.com/lejard-h/chopper
 
@@ -30,3 +30,9 @@ dev_dependencies:
 dependency_overrides:
   chopper_generator:
     path: ../chopper_generator
+
+topics:
+  - api
+  - client
+  - http
+  - rest
diff --git a/chopper/test/base_test.dart b/chopper/test/base_test.dart
@@ -9,8 +9,10 @@ import 'package:http/testing.dart';
 import 'package:test/test.dart';
 
 import 'test_service.dart';
+import 'test_service_variable.dart';
 
 final baseUrl = Uri.parse('http://localhost:8000');
+const String testEnv = 'https://localhost:4000';
 
 void main() {
   ChopperClient buildClient([
@@ -22,6 +24,7 @@ void main() {
         services: [
           // the generated service
           HttpTestService.create(),
+          HttpTestServiceVariable.create(),
         ],
         client: httpClient,
         errorConverter: errorConverter,
@@ -35,9 +38,12 @@ void main() {
 
       final chopper = buildClient(httpClient);
       final service = chopper.getService<HttpTestService>();
+      final serviceVariable = chopper.getService<HttpTestServiceVariable>();
 
       expect(service, isNotNull);
+      expect(serviceVariable, isNotNull);
       expect(service, isA<HttpTestService>());
+      expect(serviceVariable, isA<HttpTestServiceVariable>());
     });
 
     test('get service errors', () async {
@@ -86,6 +92,28 @@ void main() {
       httpClient.close();
     });
 
+    test('GET Variable', () async {
+      final httpClient = MockClient((request) async {
+        expect(
+          request.url.toString(),
+          equals('$testEnv/get/1234'),
+        );
+        expect(request.method, equals('GET'));
+
+        return http.Response('get response', 200);
+      });
+
+      final chopper = buildClient(httpClient);
+      final service = chopper.getService<HttpTestServiceVariable>();
+
+      final response = await service.getTest('1234', dynamicHeader: '');
+
+      expect(response.body, equals('get response'));
+      expect(response.statusCode, equals(200));
+
+      httpClient.close();
+    });
+
     test('GET stream', () async {
       final httpClient = MockClient.streaming((request, stream) async {
         expect(
@@ -231,6 +259,29 @@ void main() {
       httpClient.close();
     });
 
+    test('POST Variable', () async {
+      final httpClient = MockClient((request) async {
+        expect(
+          request.url.toString(),
+          equals('$testEnv/post'),
+        );
+        expect(request.method, equals('POST'));
+        expect(request.body, equals('post body'));
+
+        return http.Response('post response', 200);
+      });
+
+      final chopper = buildClient(httpClient);
+      final service = chopper.getService<HttpTestServiceVariable>();
+
+      final response = await service.postTest('post body');
+
+      expect(response.body, equals('post response'));
+      expect(response.statusCode, equals(200));
+
+      httpClient.close();
+    });
+
     test('POST with streamed body', () async {
       final httpClient = MockClient((request) async {
         expect(
@@ -282,6 +333,29 @@ void main() {
       httpClient.close();
     });
 
+    test('PUT Variable', () async {
+      final httpClient = MockClient((request) async {
+        expect(
+          request.url.toString(),
+          equals('$testEnv/put/1234'),
+        );
+        expect(request.method, equals('PUT'));
+        expect(request.body, equals('put body'));
+
+        return http.Response('put response', 200);
+      });
+
+      final chopper = buildClient(httpClient);
+      final service = chopper.getService<HttpTestServiceVariable>();
+
+      final response = await service.putTest('1234', 'put body');
+
+      expect(response.body, equals('put response'));
+      expect(response.statusCode, equals(200));
+
+      httpClient.close();
+    });
+
     test('PATCH', () async {
       final httpClient = MockClient((request) async {
         expect(
@@ -305,6 +379,29 @@ void main() {
       httpClient.close();
     });
 
+    test('PATCH Variable', () async {
+      final httpClient = MockClient((request) async {
+        expect(
+          request.url.toString(),
+          equals('$testEnv/patch/1234'),
+        );
+        expect(request.method, equals('PATCH'));
+        expect(request.body, equals('patch body'));
+
+        return http.Response('patch response', 200);
+      });
+
+      final chopper = buildClient(httpClient);
+      final service = chopper.getService<HttpTestServiceVariable>();
+
+      final response = await service.patchTest('1234', 'patch body');
+
+      expect(response.body, equals('patch response'));
+      expect(response.statusCode, equals(200));
+
+      httpClient.close();
+    });
+
     test('DELETE', () async {
       final httpClient = MockClient((request) async {
         expect(
@@ -327,6 +424,28 @@ void main() {
       httpClient.close();
     });
 
+    test('DELETE Variable', () async {
+      final httpClient = MockClient((request) async {
+        expect(
+          request.url.toString(),
+          equals('$testEnv/delete/1234'),
+        );
+        expect(request.method, equals('DELETE'));
+
+        return http.Response('delete response', 200);
+      });
+
+      final chopper = buildClient(httpClient);
+      final service = chopper.getService<HttpTestServiceVariable>();
+
+      final response = await service.deleteTest('1234');
+
+      expect(response.body, equals('delete response'));
+      expect(response.statusCode, equals(200));
+
+      httpClient.close();
+    });
+
     test('Head', () async {
       final httpClient = MockClient((request) async {
         expect(
@@ -349,6 +468,28 @@ void main() {
       httpClient.close();
     });
 
+    test('Head Variable', () async {
+      final httpClient = MockClient((request) async {
+        expect(
+          request.url.toString(),
+          equals('$testEnv/head'),
+        );
+        expect(request.method, equals('HEAD'));
+
+        return http.Response('head response', 200);
+      });
+
+      final chopper = buildClient(httpClient);
+      final service = chopper.getService<HttpTestServiceVariable>();
+
+      final response = await service.headTest();
+
+      expect(response.body, equals('head response'));
+      expect(response.statusCode, equals(200));
+
+      httpClient.close();
+    });
+
     test('const headers', () async {
       final client = MockClient((http.Request req) async {
         expect(req.headers.containsKey('foo'), isTrue);

diff --git a/chopper/test/converter_test.dart b/chopper/test/converter_test.dart
@@ -111,6 +111,25 @@ void main() {
 
       expect(converted.body, equals({'foo': 'bar'}));
     });
+
+    test('JsonConverter.isJson', () {
+      expect(JsonConverter.isJson('{"foo":"bar"}'), isTrue);
+      expect(JsonConverter.isJson('foo'), isFalse);
+      expect(JsonConverter.isJson(''), isFalse);
+      expect(JsonConverter.isJson(null), isFalse);
+      expect(JsonConverter.isJson(42), isFalse);
+      expect(JsonConverter.isJson([]), isFalse);
+      expect(JsonConverter.isJson([1, 2, 3]), isFalse);
+      expect(JsonConverter.isJson(['a', 'b', 'c']), isFalse);
+      expect(JsonConverter.isJson({}), isFalse);
+      expect(
+        JsonConverter.isJson({
+          'foo': 'bar',
+          'list': [1, 2, 3],
+        }),
+        isFalse,
+      );
+    });
   });
 
   test('respects content-type headers', () {

diff --git a/chopper/test/ensure_build_test.dart b/chopper/test/ensure_build_test.dart
@@ -6,11 +6,19 @@ import 'package:test/test.dart';
 void main() {
   test(
     'ensure_build',
-    () => expectBuildClean(
-      packageRelativeDirectory: 'chopper',
-      gitDiffPathArguments: [
-        'test/test_service.chopper.dart',
-      ],
-    ),
+    () {
+      expectBuildClean(
+        packageRelativeDirectory: 'chopper',
+        gitDiffPathArguments: [
+          'test/test_service.chopper.dart',
+        ],
+      );
+      expectBuildClean(
+        packageRelativeDirectory: 'chopper',
+        gitDiffPathArguments: [
+          'test/test_service_variable.chopper.dart',
+        ],
+      );
+    },
   );
 }