Add @FormUrlEncoded and filter data which have null value

lejard-h · Feb 29, 2024 · af17af0 · af17af0
1 parent 4a1de44
commit af17af0
Show file tree

Hide file tree

Showing 6 changed files with 410 additions and 1 deletion.
diff --git a/chopper/lib/src/annotations.dart b/chopper/lib/src/annotations.dart
@@ -533,6 +533,30 @@ final class PartFileMap {
   const PartFileMap();
 }
 
+/// {@template FormUrlEncoded}
+///
+///
+//  Denotes that the request body will use form URL encoding. Fields should be declared as parameters
+//  and annotated with [Field]/[FieldMap].
+//
+//  Requests made with this annotation will have application/x-www-form-urlencoded MIME
+//  type. Field names and values will be UTF-8 encoded before being URI-encoded in accordance to <a
+//  href="https://datatracker.ietf.org/doc/html/rfc3986">RFC-3986</a>.
+//
+///
+/// ```dart
+/// @Post(path: '/something')
+/// @FormUrlEncoded
+/// Future<Response> fetch(@Field("param") String? param);
+/// ```
+/// {@endtemplate}
+@immutable
+@Target({TargetKind.method})
+final class FormUrlEncoded  {
+  /// {@macro FormUrlEncoded}
+  const FormUrlEncoded();
+}
+
 /// {@macro ChopperApi}
 const chopperApi = ChopperApi();
 

diff --git a/chopper_generator/lib/src/generator.dart b/chopper_generator/lib/src/generator.dart
@@ -150,6 +150,7 @@ final class ChopperGenerator
   ) {
     final ConstantReader? method = _getMethodAnnotation(m);
     final bool multipart = _hasAnnotation(m, chopper.Multipart);
+    final bool formUrlEncoded = _hasAnnotation(m, chopper.FormUrlEncoded);
     final ConstantReader? factoryConverter = _getFactoryConverterAnnotation(m);
 
     final Map<String, ConstantReader> body = _getAnnotation(m, chopper.Body);
@@ -172,7 +173,7 @@ final class ChopperGenerator
     final Map<String, ConstantReader> fileFieldMap =
         _getAnnotation(m, chopper.PartFileMap);
 
-    final Code? headers = _generateHeaders(m, method!);
+    final Code? headers = _generateHeaders(m, method!, formUrlEncoded);
     final Expression url = _generateUrl(
       method,
       paths,
@@ -288,6 +289,10 @@ final class ChopperGenerator
 
       final bool hasQuery = hasQueryMap || queries.isNotEmpty;
 
+      if (hasQuery) {
+        _filterNullValue(blocks, Vars.parameters.toString());
+      }
+
       if (headers != null) {
         blocks.add(headers);
       }
@@ -331,6 +336,11 @@ final class ChopperGenerator
 
       hasBody = hasBody || hasFieldMap;
 
+      if (hasBody) {
+        _filterNullValue(blocks, Vars.body.toString(),
+            valueToString: formUrlEncoded);
+      }
+
       bool hasParts = multipart && (parts.isNotEmpty || fileFields.isNotEmpty);
       if (hasParts) {
         blocks.add(
@@ -466,6 +476,22 @@ final class ChopperGenerator
     });
   }
 
+  static void _filterNullValue(List<Code> blocks, String refName,
+      {bool valueToString = false}) {
+    final filterName = '${refName}filter';
+    blocks.add(Code('if ($refName is Map) {'));
+    blocks.add(Code('final Map<String, dynamic> $filterName = {};'));
+    blocks.add(Code('($refName as Map).forEach((key, value) {'));
+    blocks.add(Code('if (value != null) {'));
+    blocks.add(Code(
+        "$filterName[key] = ${valueToString ? "value.toString()" : "value"};"));
+    blocks.add(Code('}'));
+    blocks.add(Code('});'));
+    blocks.add(Code('($refName as Map).clear();'));
+    blocks.add(Code('($refName as Map).addAll($filterName);'));
+    blocks.add(Code('}'));
+  }
+
   static String _factoryForFunction(FunctionTypedElement function) =>
       // ignore: deprecated_member_use
       function.enclosingElement is ClassElement
@@ -718,6 +744,7 @@ final class ChopperGenerator
   static Code? _generateHeaders(
     MethodElement methodElement,
     ConstantReader method,
+    bool formUrlEncoded,
   ) {
     final StringBuffer codeBuffer = StringBuffer('')..writeln('{');
 
@@ -756,6 +783,11 @@ final class ChopperGenerator
       }
     });
 
+    if (formUrlEncoded) {
+      codeBuffer
+          .writeln("'content-type': 'application/x-www-form-urlencoded',");
+    }
+
     codeBuffer.writeln('}');
     final String code = codeBuffer.toString();
 

diff --git a/chopper_generator/test/test_service.chopper.dart b/chopper_generator/test/test_service.chopper.dart
diff --git a/chopper_generator/test/test_service.dart b/chopper_generator/test/test_service.dart
@@ -113,6 +113,14 @@ abstract class HttpTestService extends ChopperService {
     @Part('2') Map b,
   );
 
+  @Post(path: 'formUrlEncoded')
+  @FormUrlEncoded()
+  Future<Response> postFormUrlEncode(
+    @Field('a') String a,
+    @Field('a1') String a2,
+    @FieldMap() Map<String, dynamic> b,
+  );
+
   @Post(path: 'file')
   @multipart
   Future<Response> postFile(