Query Parameters for unencoded date/times (#69)

rvowles · web-flow · commit c77f13110641 · 2021-10-02T16:36:55.000+13:00
DateTimes and Dates in Query parameters should not be url encoded
as Dio is also doing this, which is double encoding them.

5.2.1 of OpenAPI has also introduced some issues.
diff --git a/README.adoc b/README.adoc
@@ -267,6 +267,8 @@ The source for the tests is located in src/k8s** folders. The generated test out
 
 ==== Changelog
 
+- 5.11 - fix date/datetime strings in queries to not be encoded. Updated to use 5.2.1 of OpenAPI. Fixed a bunch
+of templating issues that arose because of it.
 - 5.10 - removal of an unnecessary date/time typecast for null safety
 - 5.9 - fix for null safe 2d APIs (via PiotrMitkowski)
 - 5.8 - slew of different fixes for the generator from different people, particular thanks to NANASHI0X74 for sticky ones!
diff --git a/pom.xml b/pom.xml
@@ -34,7 +34,7 @@
 	</scm>
 
 	<properties>
-		<openapi-codegen-version>5.1.0</openapi-codegen-version>
+		<openapi-codegen-version>5.2.1</openapi-codegen-version>
     <maven.compiler.target>1.8</maven.compiler.target>
     <maven.compiler.source>1.8</maven.compiler.source>
 	</properties>
diff --git a/src/it/k8s/pom.xml b/src/it/k8s/pom.xml
@@ -51,7 +51,7 @@
       <plugin>
         <groupId>org.openapitools</groupId>
         <artifactId>openapi-generator-maven-plugin</artifactId>
-        <version>5.1.0</version>
+        <version>5.2.1</version>
         <dependencies>
           <dependency>
             <groupId>com.bluetrainsoftware.maven</groupId>
diff --git a/src/it/k8s/test.yaml b/src/it/k8s/test.yaml
@@ -68,6 +68,12 @@ paths:
           schema:
             type: string
             format: date-time
+        - name: queryDateTime
+          in: query
+          required: false
+          schema:
+            type: string
+            format: date-time
       operationId: getSampleWithAllTypes
       tags:
         - ControlService
diff --git a/src/it/k8s_null/pom.xml b/src/it/k8s_null/pom.xml
@@ -51,7 +51,7 @@
       <plugin>
         <groupId>org.openapitools</groupId>
         <artifactId>openapi-generator-maven-plugin</artifactId>
-        <version>5.1.0</version>
+        <version>5.2.1</version>
         <dependencies>
           <dependency>
             <groupId>com.bluetrainsoftware.maven</groupId>
diff --git a/src/it/k8s_null/test.yaml b/src/it/k8s_null/test.yaml
@@ -68,6 +68,12 @@ paths:
           schema:
             type: string
             format: date-time
+        - name: queryDateTime
+          in: query
+          required: false
+          schema:
+            type: string
+            format: date-time
       operationId: getSampleWithAllTypes
       tags:
         - ControlService
diff --git a/src/main/java/cd/connect/openapi/DartV3ApiGenerator.java b/src/main/java/cd/connect/openapi/DartV3ApiGenerator.java
@@ -216,6 +216,10 @@ private String listOrMapSuffix(CodegenProperty cp) {
   }
 
   private void correctInternals(CodegenModel model, CodegenProperty cp, boolean classLevelField) {
+    if ("otherDeps".equals(cp.baseName)) {
+      System.out.println("here");
+    }
+
     if ("DateTime".equals(cp.complexType) || "Date".equals(cp.complexType)) {
       cp.isDateTime = "date-time".equals(cp.getDataFormat());
       cp.isDate = "date".equals(cp.getDataFormat());
diff --git a/src/main/resources/dart2-v3template/_array_from_json.mustache b/src/main/resources/dart2-v3template/_array_from_json.mustache
@@ -26,5 +26,6 @@
           (data as List<dynamic>?)?.cast<{{{dataType}}}>() ?? <{{{dataType}}}>[]
       {{/nullSafe}}
     {{/isPrimitiveType}}
+    {{#isAnyType}}data{{/isAnyType}}
   {{/items}}
 {{/items}}
diff --git a/src/main/resources/dart2-v3template/_copy.mustache b/src/main/resources/dart2-v3template/_copy.mustache
@@ -13,4 +13,5 @@
     {{^vendorExtensions.x-not-nullable}}data == null ? null : data.copyWith(){{/vendorExtensions.x-not-nullable}}
   {{/isModel}}
   {{#isPrimitiveType}}data{{/isPrimitiveType}}
+  {{#isAnyType}}data{{/isAnyType}}
 {{/items}}
diff --git a/src/main/resources/dart2-v3template/_from_json.mustache b/src/main/resources/dart2-v3template/_from_json.mustache
@@ -47,4 +47,5 @@
   {{#isPrimitiveType}}
     data as {{{dataType}}}
   {{/isPrimitiveType}}
+  {{#isAnyType}}data{{/isAnyType}}
 {{/items}}
diff --git a/src/main/resources/dart2-v3template/_map_from_json.mustache b/src/main/resources/dart2-v3template/_map_from_json.mustache
@@ -1,25 +1,28 @@
 {{#items}}
   {{#isMap}}
-    (data as Map).cast<String, dynamic{{^required}}{{#nullSafe}}?{{/nullSafe}}{{/required}}>(){{#nullSafe}}.fromNull(){{/nullSafe}}.map((String key, dynamic{{^required}}{{#nullSafe}}?{{/nullSafe}}{{/required}} data) => MapEntry<String, {{{dataType}}}>(key, (dynamic{{^required}}{{#nullSafe}}?{{/nullSafe}}{{/required}} data) { return {{>_from_json}}; }(data) ))
+    (data as Map).cast<String, dynamic>(){{#nullSafe}}.fromNull(){{/nullSafe}}.map((String key, dynamic data) => MapEntry<String, {{{dataType}}}>(key, (dynamic data) { return {{>_from_json}}; }(data) ))
   {{/isMap}}
   {{#isArray}}
-    (data as Map).cast<String, dynamic{{^required}}{{#nullSafe}}?{{/nullSafe}}{{/required}}>(){{#nullSafe}}.fromNull(){{/nullSafe}}.map((String key, dynamic{{^required}}{{#nullSafe}}?{{/nullSafe}}{{/required}} data) => MapEntry<String, {{{dataType}}}>(key, (dynamic{{^required}}{{#nullSafe}}?{{/nullSafe}}{{/required}} data) { return {{>_from_json}}; }(data) ))
+    (data as Map).cast<String, dynamic>(){{#nullSafe}}.fromNull(){{/nullSafe}}.map((String key, dynamic data) => MapEntry<String, {{{dataType}}}>(key, (dynamic data) { return {{>_from_json}}; }(data) ))
   {{/isArray}}
   {{^items}}
     {{#isEnum}}
-      (data as Map).cast<String, dynamic{{^required}}{{#nullSafe}}?{{/nullSafe}}{{/required}}>(){{#nullSafe}}.fromNull(){{/nullSafe}}.map((String key, dynamic{{^required}}{{#nullSafe}}?{{/nullSafe}}{{/required}} data) => MapEntry<String, {{{vendorExtensions.x-innerType}}}>(key, {{>_from_json}} ))
+      (data as Map).cast<String, dynamic>(){{#nullSafe}}.fromNull(){{/nullSafe}}.map((String key, dynamic data) => MapEntry<String, {{{vendorExtensions.x-innerType}}}>(key, {{>_from_json}} ))
     {{/isEnum}}
     {{#isDateTime}}
-      (data as Map).cast<String, dynamic{{^required}}{{#nullSafe}}?{{/nullSafe}}{{/required}}>(){{#nullSafe}}.fromNull(){{/nullSafe}}.map((String key, dynamic{{^required}}{{#nullSafe}}?{{/nullSafe}}{{/required}} data) => MapEntry<String, {{{vendorExtensions.x-innerType}}}>(key, {{>_from_json}} ))
+      (data as Map).cast<String, dynamic>(){{#nullSafe}}.fromNull(){{/nullSafe}}.map((String key, dynamic data) => MapEntry<String, {{{vendorExtensions.x-innerType}}}>(key, {{>_from_json}} ))
     {{/isDateTime}}
     {{#isDate}}
-      (data as Map).cast<String, dynamic{{^required}}{{#nullSafe}}?{{/nullSafe}}{{/required}}>(){{#nullSafe}}.fromNull(){{/nullSafe}}.map((String key, dynamic{{^required}}{{#nullSafe}}?{{/nullSafe}}{{/required}} data) => MapEntry<String, {{{vendorExtensions.x-innerType}}}>(key, {{>_from_json}} ))
+      (data as Map).cast<String, dynamic>(){{#nullSafe}}.fromNull(){{/nullSafe}}.map((String key, dynamic data) => MapEntry<String, {{{vendorExtensions.x-innerType}}}>(key, {{>_from_json}} ))
     {{/isDate}}
     {{#isModel}}
-      (data as Map).cast<String, dynamic{{^required}}{{#nullSafe}}?{{/nullSafe}}{{/required}}>(){{#nullSafe}}.fromNull(){{/nullSafe}}.map((String key, dynamic{{^required}}{{#nullSafe}}?{{/nullSafe}}{{/required}} data) => MapEntry<String, {{{vendorExtensions.x-innerType}}}>(key, {{>_from_json}} ))
+      (data as Map).cast<String, dynamic>(){{#nullSafe}}.fromNull(){{/nullSafe}}.map((String key, dynamic data) => MapEntry<String, {{{vendorExtensions.x-innerType}}}>(key, {{>_from_json}} ))
     {{/isModel}}
     {{#isPrimitiveType}}
       (data as Map).cast<String, {{{dataType}}}>(){{#nullSafe}}.fromNull(){{/nullSafe}}
     {{/isPrimitiveType}}
+    {{#isAnyType}}
+      (data as Map).cast<String, dynamic>(){{#nullSafe}}.fromNull(){{/nullSafe}}
+    {{/isAnyType}}
   {{/items}}
 {{/items}}
diff --git a/src/main/resources/dart2-v3template/_simple_from_json.mustache b/src/main/resources/dart2-v3template/_simple_from_json.mustache
@@ -1 +1 @@
-{{{name}}} = (json[r'{{{baseName}}}'] == null) ? null : {{#isEnum}}{{enumName}}Extension.fromJson(json[r'{{{baseName}}}']);{{/isEnum}}{{#isDateTime}}DateTime.parse(json[r'{{{baseName}}}']);{{/isDateTime}}{{#isDate}}DateTime.parse(json[r'{{{baseName}}}'] + 'T00:00:00.000Z');{{/isDate}}{{#isModel}}{{{complexType}}}.fromJson(json[r'{{{baseName}}}']);{{/isModel}}{{#isPrimitiveType}}(json[r'{{{baseName}}}'] as {{{dataType}}});{{/isPrimitiveType}}
+{{{name}}} = {{#isAnyType}}json[r'{{{baseName}}}'];{{/isAnyType}}{{^isAnyType}} (json[r'{{{baseName}}}'] == null) ? null : {{#isEnum}}{{enumName}}Extension.fromJson(json[r'{{{baseName}}}']);{{/isEnum}}{{#isDateTime}}DateTime.parse(json[r'{{{baseName}}}']);{{/isDateTime}}{{#isDate}}DateTime.parse(json[r'{{{baseName}}}'] + 'T00:00:00.000Z');{{/isDate}}{{#isModel}}{{{complexType}}}.fromJson(json[r'{{{baseName}}}']);{{/isModel}}{{#isPrimitiveType}}(json[r'{{{baseName}}}'] as {{{dataType}}});{{/isPrimitiveType}}{{/isAnyType}}
diff --git a/src/main/resources/dart2-v3template/api.mustache b/src/main/resources/dart2-v3template/api.mustache
@@ -136,8 +136,8 @@ part of {{pubName}}.api;
           if({{paramName}} != null) {
       {{/required}}
         queryParams.addAll(convertParametersForCollectionFormat(
-      {{#nullSafe}}(p) => {{/nullSafe}}
-      {{#isDateTime}}openApiDateTimeParameterToString{{#nullSafe}}(p){{/nullSafe}}{{/isDateTime}}{{^isDateTime}}{{#isDate}}openApiDateParameterToString{{#nullSafe}}(p){{/nullSafe}}{{/isDate}}{{^isDate}}LocalApiClient.parameterToString{{#nullSafe}}(p)!{{/nullSafe}}{{/isDate}}{{/isDateTime}},
+      (p) =>
+      {{#isDateTime}}openApiDateTimeParameterToString(p, false){{/isDateTime}}{{^isDateTime}}{{#isDate}}openApiDateParameterToString(p, false){{/isDate}}{{^isDate}}LocalApiClient.parameterToString(p)!{{/isDate}}{{/isDateTime}},
           '{{collectionFormat}}', '{{baseName}}', {{paramName}}));
       {{^required}}
           }
diff --git a/src/main/resources/dart2-v3template/pubspec.mustache b/src/main/resources/dart2-v3template/pubspec.mustache
@@ -17,14 +17,14 @@ environment:
 dependencies:
 {{#nullSafe}}
   dio: '^4.0.0'
-  openapi_dart_common: ^4.1.0
+  openapi_dart_common: ^4.1.1
 #  openapi_dart_common:
 #    path: /Users/richard/projects/dart/openapi_dart_common
   collection: '^1.15.0'
 {{/nullSafe}}
 {{^nullSafe}}
   dio: '>=3.0.10 <4.0.0'
-  openapi_dart_common: ^3.2.0
+  openapi_dart_common: ^3.3.1
 #  openapi_dart_common:
 #    path: /Users/richard/projects/dart/openapi_dart_common_3x
   collection: ^1.14.11
diff --git a/src/test/java/cd/connect/openapi/SampleRunner.java b/src/test/java/cd/connect/openapi/SampleRunner.java
@@ -25,50 +25,51 @@ public void runGenerator() {
 //      "--global-property", "skipFormModel=false",
       "--additional-properties", "nullSafe=true",
       "--additional-properties", "nullSafe-array-default=true",
+        "--additional-properties", "listAnyOf=true",
       "--output", "target/" + getClass().getSimpleName())
       .toArray(new String[0]));
   }
 
-  @Test
-  public void runGeneratorWithListAnyOfNNBD() {
-    // given
-    String schemaLocation = getClass().getResource("/list_any_of_test.yml").getFile();
-    String outputFolder = "target/" + getClass().getSimpleName()+"_list_any_of_test_NNBD";
-
-    // when
-    OpenAPIGenerator.main(Arrays.asList("generate",
-      "--input-spec", schemaLocation,
-      "--generator-name", "dart2-api",
-      "--additional-properties", "pubName=sample_app",
-      "--additional-properties", "nullSafe=true",
-      "--additional-properties", "nullSafe-array-default=true",
-      "--additional-properties", "listAnyOf=true",
-      "--output", outputFolder)
-      .toArray(new String[0]));
-
-    // then
-    verifyIsDartPackage(outputFolder);
-  }
-
-  @Test
-  public void runGeneratorWithListAnyOfNoNullSafety() {
-    // given
-    String schemaLocation = getClass().getResource("/list_any_of_test.yml").getFile();
-    String outputFolder = "target/" + getClass().getSimpleName()+"_list_any_of_test_no_null_safety";
-
-    // when
-    OpenAPIGenerator.main(Arrays.asList("generate",
-      "--input-spec", schemaLocation,
-      "--generator-name", "dart2-api",
-      "--additional-properties", "pubName=sample_app",
-      // "--additional-properties", "nullSafe=false", // passing anything turns null safety on
-      "--additional-properties", "listAnyOf=true",
-      "--output", outputFolder)
-      .toArray(new String[0]));
-
-    // then
-    verifyIsDartPackage(outputFolder);
-  }
+//  @Test
+//  public void runGeneratorWithListAnyOfNNBD() {
+//    // given
+//    String schemaLocation = getClass().getResource("/list_any_of_test.yml").getFile();
+//    String outputFolder = "target/" + getClass().getSimpleName()+"_list_any_of_test_NNBD";
+//
+//    // when
+//    OpenAPIGenerator.main(Arrays.asList("generate",
+//      "--input-spec", schemaLocation,
+//      "--generator-name", "dart2-api",
+//      "--additional-properties", "pubName=sample_app",
+//      "--additional-properties", "nullSafe=true",
+//      "--additional-properties", "nullSafe-array-default=true",
+//      "--additional-properties", "listAnyOf=true",
+//      "--output", outputFolder)
+//      .toArray(new String[0]));
+//
+//    // then
+//    verifyIsDartPackage(outputFolder);
+//  }
+//
+//  @Test
+//  public void runGeneratorWithListAnyOfNoNullSafety() {
+//    // given
+//    String schemaLocation = getClass().getResource("/list_any_of_test.yml").getFile();
+//    String outputFolder = "target/" + getClass().getSimpleName()+"_list_any_of_test_no_null_safety";
+//
+//    // when
+//    OpenAPIGenerator.main(Arrays.asList("generate",
+//      "--input-spec", schemaLocation,
+//      "--generator-name", "dart2-api",
+//      "--additional-properties", "pubName=sample_app",
+//      // "--additional-properties", "nullSafe=false", // passing anything turns null safety on
+//      "--additional-properties", "listAnyOf=true",
+//      "--output", outputFolder)
+//      .toArray(new String[0]));
+//
+//    // then
+//    verifyIsDartPackage(outputFolder);
+//  }
 
 //  @Test
 //  public void runExpedia() {
diff --git a/src/test/resources/test.yaml b/src/test/resources/test.yaml
@@ -68,6 +68,12 @@ paths:
           schema:
             type: string
             format: date-time
+        - name: queryDateTime
+          in: query
+          required: false
+          schema:
+            type: string
+            format: date-time
       operationId: getSampleWithAllTypes
       tags:
         - ControlService
