Allow data in all request methods (cfug#32)

dio/CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## 5.0.0-dev.1
 
+- Allow `data` in all request methods.
 - A platform independent `HttpClientAdapter` can now be instantiated by doing
   `dio.httpClientAdapter = HttpClientAdapter();`.
 - Add `ValidateCertificate` to handle certificate pinning better.

dio/lib/src/dio.dart

@@ -61,6 +61,7 @@ abstract class Dio {
   /// Handy method to make http GET request, which is a alias of  [dio.fetch(RequestOptions)].
   Future<Response<T>> get<T>(
     String path, {
+    Object? data,
     Map<String, dynamic>? queryParameters,
     Options? options,
     CancelToken? cancelToken,
@@ -70,6 +71,7 @@ abstract class Dio {
   /// Handy method to make http GET request, which is a alias of [dio.fetch(RequestOptions)].
   Future<Response<T>> getUri<T>(
     Uri uri, {
+    Object? data,
     Options? options,
     CancelToken? cancelToken,
     ProgressCallback? onReceiveProgress,

dio/lib/src/dio_mixin.dart

@@ -51,12 +51,14 @@ abstract class DioMixin implements Dio {
   Future<Response<T>> get<T>(
     String path, {
     Map<String, dynamic>? queryParameters,
+    Object? data,
     Options? options,
     CancelToken? cancelToken,
     ProgressCallback? onReceiveProgress,
   }) {
     return request<T>(
       path,
+      data: data,
       queryParameters: queryParameters,
       options: checkOptions('GET', options),
       onReceiveProgress: onReceiveProgress,
@@ -68,12 +70,14 @@ abstract class DioMixin implements Dio {
   @override
   Future<Response<T>> getUri<T>(
     Uri uri, {
+    Object? data,
     Options? options,
     CancelToken? cancelToken,
     ProgressCallback? onReceiveProgress,
   }) {
     return requestUri<T>(
       uri,
+      data: data,
       options: checkOptions('GET', options),
       onReceiveProgress: onReceiveProgress,
       cancelToken: cancelToken,
@@ -683,16 +687,19 @@ abstract class DioMixin implements Dio {
       throw ArgumentError.value(options.method, "method");
     }
     final data = options.data;
-    List<int> bytes;
-    Stream<List<int>> stream;
-    const allowPayloadMethods = ['POST', 'PUT', 'PATCH', 'DELETE'];
-    if (data != null && allowPayloadMethods.contains(options.method)) {
+    if (data != null) {
+      final Stream<List<int>> stream;
       // Handle the FormData
       int? length;
       if (data is Stream) {
-        assert(data is Stream<List>,
-            'Stream type must be `Stream<List>`, but ${data.runtimeType} is found.');
-        stream = data as Stream<List<int>>;
+        if (data is! Stream<List<int>>) {
+          throw ArgumentError.value(
+            data.runtimeType,
+            'data',
+            'Stream type must be `Stream<List<int>>`',
+          );
+        }
+        stream = data;
         options.headers.keys.any((String key) {
           if (key.toLowerCase() == Headers.contentLengthHeader) {
             length = int.parse(options.headers[key].toString());
@@ -708,6 +715,7 @@ abstract class DioMixin implements Dio {
         length = data.length;
         options.headers[Headers.contentLengthHeader] = length.toString();
       } else {
+        final List<int> bytes;
         // Call request transformer.
         final data = await transformer.transformRequest(options);
         if (options.requestEncoder != null) {

dio/lib/src/options.dart

@@ -99,7 +99,6 @@ class BaseOptions extends _RequestConfig with OptionsMixin {
     RequestEncoder? requestEncoder,
     ResponseDecoder? responseDecoder,
     ListFormat? listFormat,
-    this.setRequestContentTypeWhenNoPayload = false,
   })  : assert(connectTimeout == null || !connectTimeout.isNegative),
         assert(baseUrl.isEmpty || Uri.parse(baseUrl).host.isNotEmpty),
         super(
@@ -145,7 +144,6 @@ class BaseOptions extends _RequestConfig with OptionsMixin {
     RequestEncoder? requestEncoder,
     ResponseDecoder? responseDecoder,
     ListFormat? listFormat,
-    bool? setRequestContentTypeWhenNoPayload,
   }) {
     return BaseOptions(
       method: method ?? this.method,
@@ -167,23 +165,8 @@ class BaseOptions extends _RequestConfig with OptionsMixin {
       requestEncoder: requestEncoder ?? this.requestEncoder,
       responseDecoder: responseDecoder ?? this.responseDecoder,
       listFormat: listFormat ?? this.listFormat,
-      setRequestContentTypeWhenNoPayload: setRequestContentTypeWhenNoPayload ??
-          this.setRequestContentTypeWhenNoPayload,
     );
   }
-
-  static const _allowPayloadMethods = ['POST', 'PUT', 'PATCH', 'DELETE'];
-
-  /// if false, content-type in request header will be deleted when method is not on of `_allowPayloadMethods`
-  bool setRequestContentTypeWhenNoPayload;
-
-  String? contentTypeWithRequestBody(String method) {
-    if (setRequestContentTypeWhenNoPayload) {
-      return contentType;
-    } else {
-      return _allowPayloadMethods.contains(method) ? contentType : null;
-    }
-  }
 }
 
 mixin OptionsMixin {
@@ -312,7 +295,7 @@ class Options {
     if (this.headers != null) {
       headers.addAll(this.headers!);
     }
-    String? contentType = this.headers?[Headers.contentTypeHeader];
+    final String? contentType = this.headers?[Headers.contentTypeHeader];
     final extra = Map<String, dynamic>.from(baseOpt.extra);
     if (this.extra != null) {
       extra.addAll(this.extra!);
@@ -341,14 +324,11 @@ class Options {
       responseDecoder: responseDecoder ?? baseOpt.responseDecoder,
       listFormat: listFormat ?? baseOpt.listFormat,
     );
-
     requestOptions.onReceiveProgress = onReceiveProgress;
     requestOptions.onSendProgress = onSendProgress;
     requestOptions.cancelToken = cancelToken;
-
-    requestOptions.contentType = contentType ??
-        this.contentType ??
-        baseOpt.contentTypeWithRequestBody(method);
+    requestOptions.contentType =
+        contentType ?? this.contentType ?? baseOpt.contentType;
     return requestOptions;
   }
 
@@ -661,7 +641,7 @@ class _RequestConfig {
         };
     this.responseType = responseType ?? ResponseType.json;
     if (!contentTypeInHeader) {
-      this.contentType = contentType ?? Headers.jsonContentType;
+      this.contentType = contentType;
     }
   }
 

dio/migration_guide.md

@@ -17,6 +17,8 @@ When new content need to be added to the migration guide, make sure they're foll
 
 ### Summary
 
+- `BaseOptions.setRequestContentTypeWhenNoPayload` has been removed.
+- `get` and `getUri` in `Dio` has different signature.
 - `DefaultHttpClientAdapter` is now named `IOHttpClientAdapter`,
   and the platform independent adapter can be initiated by `HttpClientAdapter()` which is a factory method.
 - Adapters that extends `HttpClientAdapter` must now `implements` instead of `extends`.
@@ -29,6 +31,30 @@ When new content need to be added to the migration guide, make sure they're foll
 
 ### Details
 
+#### `get` and `getUri`
+
+```diff
+ Future<Response<T>> get<T>(
+   String path, {
++  Object? data,
+   Map<String, dynamic>? queryParameters,
+   Options? options,
+   CancelToken? cancelToken,
+   ProgressCallback? onReceiveProgress,
+ });
+```
+
+```diff
+ Future<Response<T>> getUri<T>(
+   Uri uri, {
++  Object? data,
+   Map<String, dynamic>? queryParameters,
+   Options? options,
+   CancelToken? cancelToken,
+   ProgressCallback? onReceiveProgress,
+ });
+```
+
 #### `HttpClientAdapter`
 
 Before:

dio/test/options_test.dart

@@ -124,7 +124,7 @@ void main() {
 
     assert(bo1.headers['content-type'] == contentType);
     assert(bo2.headers['content-type'] == contentType);
-    assert(bo3.headers['content-type'] == Headers.jsonContentType);
+    assert(bo3.headers['content-type'] == null);
 
     try {
       bo1.copyWith(headers: headers);
@@ -213,27 +213,19 @@ void main() {
     dio.options.baseUrl = EchoAdapter.mockBase;
     dio.httpClientAdapter = EchoAdapter();
 
-    Response r1 = await dio.get('');
-    assert(r1.requestOptions.headers[Headers.contentTypeHeader] == null);
-
-    dio.options.setRequestContentTypeWhenNoPayload = true;
-
-    r1 = await dio.get('');
-    assert(
-      r1.requestOptions.headers[Headers.contentTypeHeader] ==
-          Headers.jsonContentType,
+    final r1 = await dio.get('');
+    expect(
+      r1.requestOptions.headers[Headers.contentTypeHeader],
+      null,
     );
 
-    dio.options.setRequestContentTypeWhenNoPayload = false;
-
     final r2 = await dio.get(
       '',
       options: Options(contentType: Headers.jsonContentType),
     );
-
-    assert(
-      r2.requestOptions.headers[Headers.contentTypeHeader] ==
-          Headers.jsonContentType,
+    expect(
+      r2.requestOptions.headers[Headers.contentTypeHeader],
+      Headers.jsonContentType,
     );
 
     final r3 = await dio.get(
@@ -242,21 +234,20 @@ void main() {
         Headers.contentTypeHeader: Headers.jsonContentType,
       }),
     );
-    assert(
-      r3.requestOptions.headers[Headers.contentTypeHeader] ==
-          Headers.jsonContentType,
+    expect(
+      r3.requestOptions.headers[Headers.contentTypeHeader],
+      Headers.jsonContentType,
     );
 
     final r4 = await dio.post('', data: '');
-    assert(
-      r4.requestOptions.headers[Headers.contentTypeHeader] ==
-          Headers.jsonContentType,
+    expect(
+      r4.requestOptions.headers[Headers.contentTypeHeader],
+      null,
     );
   });
 
   test('#test default content-type 2', () async {
     final dio = Dio();
-    dio.options.setRequestContentTypeWhenNoPayload = true;
     dio.options.baseUrl = 'https://www.example.com';
 
     final r1 = Options(method: 'GET').compose(dio.options, '/test').copyWith(
@@ -280,7 +271,6 @@ void main() {
       );
       assert(false);
     } catch (_) {}
-    dio.options.setRequestContentTypeWhenNoPayload = false;
 
     final r3 = Options(method: 'GET').compose(dio.options, '/test');
     assert(r3.uri.toString() == 'https://www.example.com/test');
@@ -349,4 +339,29 @@ void main() {
       testInvalidArgumentException("CONNECT$separator");
     }
   });
+
+  test('Transform data correctly with requests', () async {
+    final dio = Dio()
+      ..httpClientAdapter = EchoAdapter()
+      ..options.baseUrl = EchoAdapter.mockBase;
+    const methods = [
+      'CONNECT',
+      'HEAD',
+      'GET',
+      'POST',
+      'PUT',
+      'PATCH',
+      'DELETE',
+      'OPTIONS',
+      'TRACE',
+    ];
+    for (final method in methods) {
+      final response = await dio.request(
+        '/test',
+        data: 'test',
+        options: Options(method: method),
+      );
+      expect(response.data, 'test');
+    }
+  });
 }

dio/test/request_test.dart

@@ -19,6 +19,7 @@ void main() {
       dio = Dio();
       dio.options
         ..baseUrl = serverUrl.toString()
+        ..contentType = Headers.jsonContentType
         ..connectTimeout = Duration(seconds: 1)
         ..receiveTimeout = Duration(seconds: 5)
         ..headers = {'User-Agent': 'dartisan'};

plugins/http2_adapter/lib/src/http2_adapter.dart

@@ -50,7 +50,7 @@ class Http2Adapter implements HttpClientAdapter {
       path = '/' + path;
     }
     if (uri.query.trim().isNotEmpty) {
-      path += ('?' + uri.query);
+      path += '?' + uri.query;
     }
     final headers = [
       Header.ascii(':method', options.method),