[Dart-Dio-Next]#9082 Add json_serializable serialization option (#9980)

* PoC json_serializable in dart-dio-next

* Move build.yaml template into json_serializable dir

* Undo implicit-dynamic change

* Fix automatic formatting

* Treat non-required fields as nullable

* Make class properties final

* Fix error introduced by merging in master

* Fix map creation when deserializing

* Exclude built files from analysis

* Add new dio import props

* Fix broken merge

* Fix configuration of nullable properties

* Only add api_util import if using built value

* Add config param to set properties as final

* Fix syntax error due to merge

* Update to simplified dio configuration

* Add missing api constructor template

* Fix import for multipart files

* Fix inclusion of library deserialize template

* Update docs

* Remove trailing newline from class

* Fix whitespace in generated templates

* FIx built value generation problem caused by merge conflicts

* Escape dollar signs in strings

* Handle enums

* Config for json_serializable sample

* Generate sample for json_serializable

* Revert "Escape dollar signs in strings"

This reverts commit 6e2a3ae.

* Use raw strings when dealing with enum values

* Add json_serializable Maven module ind fix number based enums

* regenerate all tests

* Update docs and fix wrong maven module

* add a beta hint to json_serializable option

* Update minimum dart sdk with json serializable

* Use dart 2.14 when testing Dart samples

* Update codegen to remove analysis errors in output

Co-authored-by: Peter Leibiger <kuhnroyal@gmail.com>

Author: MichaelMarner

.github/workflows/samples-dart.yaml

@@ -40,7 +40,7 @@ jobs:
           key: ${{ runner.os }}-${{ github.job }}-${{ env.cache-name }}-${{ hashFiles('samples/**/pubspec.yaml') }}
       - uses: dart-lang/setup-dart@v1
         with:
-          sdk: 2.13.0
+          sdk: 2.14.0
       - name: Run tests
         uses: ./.github/actions/run-samples
         with:

bin/configs/dart-dio-next-petstore-client-lib-fake-json_serializable.yaml

@@ -0,0 +1,12 @@
+generatorName: dart-dio-next
+outputDir: samples/openapi3/client/petstore/dart-dio-next/petstore_client_lib_fake-json_serializable
+inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore-with-fake-endpoints-models-for-testing.yaml
+templateDir: modules/openapi-generator/src/main/resources/dart/libraries/dio
+typeMappings:
+  Client: "ModelClient"
+  File: "ModelFile"
+  EnumClass: "ModelEnumClass"
+additionalProperties:
+  hideGenerationTimestamp: "true"
+  enumUnknownDefaultCase: "true"
+  serializationLibrary: "json_serializable"

docs/generators/dart-dio-next.md

@@ -23,6 +23,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |disallowAdditionalPropertiesIfNotPresent|If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.|<dl><dt>**false**</dt><dd>The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.</dd><dt>**true**</dt><dd>Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.</dd></dl>|true|
 |ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
 |enumUnknownDefaultCase|If the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.|<dl><dt>**false**</dt><dd>No changes to the enum's are made, this is the default option.</dd><dt>**true**</dt><dd>With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.</dd></dl>|false|
+|finalProperties|Whether properties are marked as final when using Json Serializable for serialization| |true|
 |legacyDiscriminatorBehavior|Set to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C#have this enabled by default).|<dl><dt>**true**</dt><dd>The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.</dd><dt>**false**</dt><dd>The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.</dd></dl>|true|
 |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
 |pubAuthor|Author name in generated pubspec| |Author|
@@ -32,7 +33,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |pubLibrary|Library name in generated code| |openapi.api|
 |pubName|Name in generated pubspec| |openapi|
 |pubVersion|Version in generated pubspec| |1.0.0|
-|serializationLibrary|Specify serialization library|<dl><dt>**built_value**</dt><dd>[DEFAULT] built_value</dd></dl>|built_value|
+|serializationLibrary|Specify serialization library|<dl><dt>**built_value**</dt><dd>[DEFAULT] built_value</dd><dt>**json_serializable**</dt><dd>[BETA] json_serializable</dd></dl>|built_value|
 |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
 |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
 |sourceFolder|source folder for generated code| |src|

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/DartDioNextClientCodegen.java

@@ -56,9 +56,13 @@ public class DartDioNextClientCodegen extends AbstractDartCodegen {
     public static final String DATE_LIBRARY_DEFAULT = DATE_LIBRARY_CORE;
 
     public static final String SERIALIZATION_LIBRARY_BUILT_VALUE = "built_value";
+    public static final String SERIALIZATION_LIBRARY_JSON_SERIALIZABLE = "json_serializable";
     public static final String SERIALIZATION_LIBRARY_DEFAULT = SERIALIZATION_LIBRARY_BUILT_VALUE;
 
     private static final String DIO_IMPORT = "package:dio/dio.dart";
+    public static final String FINAL_PROPERTIES = "finalProperties";
+    public static final String FINAL_PROPERTIES_DEFAULT_VALUE = "true";
+
     private static final String CLIENT_NAME = "clientName";
 
     private String dateLibrary;
@@ -85,11 +89,17 @@ public DartDioNextClientCodegen() {
         this.setTemplateDir(embeddedTemplateDir);
 
         supportedLibraries.put(SERIALIZATION_LIBRARY_BUILT_VALUE, "[DEFAULT] built_value");
+        supportedLibraries.put(SERIALIZATION_LIBRARY_JSON_SERIALIZABLE, "[BETA] json_serializable");
         final CliOption serializationLibrary = CliOption.newString(CodegenConstants.SERIALIZATION_LIBRARY, "Specify serialization library");
         serializationLibrary.setEnum(supportedLibraries);
         serializationLibrary.setDefault(SERIALIZATION_LIBRARY_DEFAULT);
         cliOptions.add(serializationLibrary);
 
+        final CliOption finalProperties = CliOption.newBoolean(FINAL_PROPERTIES, "Whether properties are marked as final when using Json Serializable for serialization");
+        finalProperties.setDefault("true");
+        cliOptions.add(finalProperties);
+
+        // Date Library Option
         final CliOption dateOption = CliOption.newString(DATE_LIBRARY, "Specify Date library");
         dateOption.setDefault(DATE_LIBRARY_DEFAULT);
 
@@ -147,6 +157,14 @@ public void processOpts() {
         }
         setDateLibrary(additionalProperties.get(DATE_LIBRARY).toString());
 
+        if (!additionalProperties.containsKey(FINAL_PROPERTIES)) {
+            additionalProperties.put(FINAL_PROPERTIES, Boolean.parseBoolean(FINAL_PROPERTIES_DEFAULT_VALUE));
+            LOGGER.debug("finalProperties not set, using default {}", FINAL_PROPERTIES_DEFAULT_VALUE);
+        }
+        else {
+            additionalProperties.put(FINAL_PROPERTIES, Boolean.parseBoolean(additionalProperties.get(FINAL_PROPERTIES).toString()));
+        }
+
         if (!additionalProperties.containsKey(CLIENT_NAME)) {
             final String name = org.openapitools.codegen.utils.StringUtils.camelize(pubName);
             additionalProperties.put(CLIENT_NAME, name);
@@ -177,6 +195,10 @@ public void processOpts() {
 
     private void configureSerializationLibrary(String srcFolder) {
         switch (library) {
+            case SERIALIZATION_LIBRARY_JSON_SERIALIZABLE:
+                additionalProperties.put("useJsonSerializable", "true");
+                configureSerializationLibraryJsonSerializable(srcFolder);
+                break;
             default:
             case SERIALIZATION_LIBRARY_BUILT_VALUE:
                 additionalProperties.put("useBuiltValue", "true");
@@ -229,6 +251,18 @@ private void configureSerializationLibraryBuiltValue(String srcFolder) {
         imports.put("MultipartFile", DIO_IMPORT);
     }
 
+    private void configureSerializationLibraryJsonSerializable(String srcFolder) {
+        supportingFiles.add(new SupportingFile("serialization/json_serializable/build.yaml.mustache", "" /* main project dir */, "build.yaml"));
+        supportingFiles.add(new SupportingFile("serialization/json_serializable/deserialize.mustache", srcFolder,
+                "deserialize.dart"));
+
+        // most of these are defined in AbstractDartCodegen, we are overriding
+        // just the binary / file handling
+        languageSpecificPrimitives.add("Object");
+        imports.put("Uint8List", "dart:typed_data");
+        imports.put("MultipartFile", DIO_IMPORT);
+    }
+
     private void configureDateLibrary(String srcFolder) {
         switch (dateLibrary) {
             case DATE_LIBRARY_TIME_MACHINE:
@@ -362,27 +396,30 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo
                 op.imports.remove("Uint8List");
             }
 
-            for (CodegenParameter param : op.allParams) {
-                // Generate serializer factories for all container type parameters.
-                // But skip binary and file parameters, JSON serializers don't make sense there.
-                if (param.isContainer && !(param.isBinary || param.isFile )) {
-                    addBuiltValueSerializer(new BuiltValueSerializer(
-                            param.isArray,
-                            param.uniqueItems,
-                            param.isMap,
-                            param.items.isNullable,
-                            param.baseType
-                    ));
+            resultImports.addAll(rewriteImports(op.imports, false));
+
+            if (SERIALIZATION_LIBRARY_BUILT_VALUE.equals(library)) {
+
+                for (CodegenParameter param : op.allParams) {
+                    // Generate serializer factories for all container type parameters.
+                    // But skip binary and file parameters, JSON serializers don't make sense there.
+                    if (param.isContainer && !(param.isBinary || param.isFile )) {
+                        addBuiltValueSerializer(new BuiltValueSerializer(
+                                param.isArray,
+                                param.uniqueItems,
+                                param.isMap,
+                                param.items.isNullable,
+                                param.baseType
+                        ));
+                    }
                 }
             }
 
             resultImports.addAll(rewriteImports(op.imports, false));
-            if (op.getHasFormParams() || op.getHasQueryParams()) {
+            if (SERIALIZATION_LIBRARY_BUILT_VALUE.equals(library) && (op.getHasFormParams() || op.getHasQueryParams())) {
                 resultImports.add("package:" + pubName + "/" + sourceFolder + "/api_util.dart");
             }
 
-            // Generate serializer factories for response types.
-            // But skip binary and file response, JSON serializers don't make sense there.
             if (op.returnContainer != null && !(op.isResponseBinary || op.isResponseFile)) {
                 addBuiltValueSerializer(new BuiltValueSerializer(
                         Objects.equals("array", op.returnContainer) || Objects.equals("set", op.returnContainer),
@@ -393,7 +430,6 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo
                 ));
             }
         }
-
         // for some reason "import" structure is changed ..
         objs.put("imports", resultImports.stream().sorted().collect(Collectors.toList()));
 

modules/openapi-generator/src/main/resources/dart/libraries/dio/analysis_options.mustache

@@ -6,4 +6,5 @@ analyzer:
     implicit-dynamic: false
     implicit-casts: false
   exclude:
-    - test/*.dart
+    - test/*.dart{{#useJsonSerializable}}
+    - lib/src/model/*.g.dart{{/useJsonSerializable}}

modules/openapi-generator/src/main/resources/dart/libraries/dio/model_test.mustache

@@ -7,8 +7,7 @@ import 'package:{{pubName}}/{{pubName}}.dart';
 void main() {
   {{^isEnum}}
   {{! Due to required vars without default value we can not create a full instance here }}
-  final instance = {{{classname}}}Builder();
-  // TODO add properties to the builder and call build()
+{{#includeLibraryTemplate}}test_instance{{/includeLibraryTemplate}}
   {{/isEnum}}
 
   group({{{classname}}}, () {

modules/openapi-generator/src/main/resources/dart/libraries/dio/pubspec.mustache

@@ -4,14 +4,22 @@ description: {{pubDescription}}
 homepage: {{pubHomepage}}
 
 environment:
+{{#useBuiltValue}}
   sdk: '>=2.12.0 <3.0.0'
+{{/useBuiltValue}}
+{{#useJsonSerializable}}
+  sdk: '>=2.14.0 <3.0.0'
+{{/useJsonSerializable}}
 
 dependencies:
   dio: '>=4.0.0 <5.0.0'
 {{#useBuiltValue}}
   built_value: '>=8.1.0 <9.0.0'
   built_collection: '>=5.1.0 <6.0.0'
 {{/useBuiltValue}}
+{{#useJsonSerializable}}
+  json_annotation: '^4.4.0'
+{{/useJsonSerializable}}
 {{#useDateLibTimeMachine}}
   time_machine: ^0.9.16
 {{/useDateLibTimeMachine}}
@@ -21,4 +29,8 @@ dev_dependencies:
   built_value_generator: '>=8.1.0 <9.0.0'
   build_runner: any
 {{/useBuiltValue}}
+{{#useJsonSerializable}}
+  build_runner: any
+  json_serializable: '^6.1.5'
+{{/useJsonSerializable}}
   test: ^1.16.0

modules/openapi-generator/src/main/resources/dart/libraries/dio/serialization/built_value/test_instance.mustache

@@ -0,0 +1,2 @@
+  final instance = {{{classname}}}Builder();
+  // TODO add properties to the builder and call build()

modules/openapi-generator/src/main/resources/dart/libraries/dio/serialization/json_serializable/api/constructor.mustache

@@ -0,0 +1 @@
+  const {{classname}}(this._dio);

modules/openapi-generator/src/main/resources/dart/libraries/dio/serialization/json_serializable/api/deserialize.mustache

@@ -0,0 +1 @@
+_responseData = deserialize<{{{returnType}}}, {{{returnBaseType}}}>(_response.data!, '{{{returnType}}}', growable: true);