fix compile errors after sttp upgrade, fix missing enum import in operations, fix file response. change serialization from Map to Seq to avoid deleting duplicate keys

Kamil-Lontkowski · Kamil-Lontkowski · commit 135ecbd7c9ad · 2025-02-14T15:41:12.000+01:00
diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/ScalaSttp4JsoniterClientCodegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/ScalaSttp4JsoniterClientCodegen.java
@@ -430,10 +430,14 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo
                 Map<String, String> item = new HashMap<>();
                 if (isEnumClass(importPath, enumRefs)) {
                     item.put("import", importPath.concat(".*"));
+                    Map<String, String> enumClassImport = new HashMap<>();
+                    enumClassImport.put("import", importPath);
+                    newImports.add(item);
+                    newImports.add(enumClassImport);
                 } else {
                     item.put("import", importPath);
+                    newImports.add(item);
                 }
-                newImports.add(item);
             }
         }
 
@@ -691,7 +695,7 @@ private static class HandleDownloadLambda extends CustomLambda {
         @Override
         public String formatFragment(String fragment) {
             if (fragment.equals("asJson[File]")) {
-                return "asFile(File.createTempFile(\"download\", \".tmp\")).mapLeft(errStr => DeserializationException(errStr, new Exception(errStr)))";
+                return "asFile(File.createTempFile(\"download\", \".tmp\")).mapWithMetadata((result, metadata) => result.left.map(errStr => ResponseException.DeserializationException(errStr, new Exception(errStr), metadata)))";
             } else {
                 return fragment;
             }
diff --git a/modules/openapi-generator/src/main/resources/scala-sttp4-jsoniter/api.mustache b/modules/openapi-generator/src/main/resources/scala-sttp4-jsoniter/api.mustache
@@ -21,10 +21,10 @@ class {{classname}}(baseUrl: String):
 {{#javadocRenderer}}
 {{>javadoc}}
 {{/javadocRenderer}}
-  def {{operationId}}{{>methodParameters}}: sttp.client4.Request[{{#separateErrorChannel}}Either[ResponseException[String, Exception], {{>operationReturnType}}]{{/separateErrorChannel}}{{^separateErrorChannel}}{{>operationReturnType}}{{/separateErrorChannel}}] =
+  def {{operationId}}{{>methodParameters}}: sttp.client4.Request[{{#separateErrorChannel}}Either[ResponseException[String], {{>operationReturnType}}]{{/separateErrorChannel}}{{^separateErrorChannel}}{{>operationReturnType}}{{/separateErrorChannel}}] =
     val requestURL =
       uri"$baseUrl{{{path}}}"{{#queryParams}}
-        .addParams(FormSerializable.serialize("{{baseName}}", {{{paramName}}}{{#style}}, FormStyleFormat.{{style.toUpperCase}}{{/style}}{{^style}}, FormStyleFormat.FORM{{/style}}, {{isExplode}})){{/queryParams}}{{#isApiKey}}{{#isKeyInQuery}}
+        .addParams(FormSerializable.serialize("{{baseName}}", {{{paramName}}}{{#style}}, FormStyleFormat.{{style.toUpperCase}}{{/style}}{{^style}}, FormStyleFormat.FORM{{/style}}, {{isExplode}}): _*){{/queryParams}}{{#isApiKey}}{{#isKeyInQuery}}
         .addParams("{{keyParamName}}" -> apiKey.value){{/isKeyInQuery}}{{/isApiKey}}
 
     basicRequest
@@ -35,16 +35,14 @@ class {{classname}}(baseUrl: String):
       .auth.bearer(bearerToken){{/isBasicBearer}}{{/isBasic}}{{#isApiKey}}{{#isKeyInHeader}}
       .header("{{keyParamName}}", apiKey){{/isKeyInHeader}}{{#isKeyInCookie}}
       .cookie("{{keyParamName}}", apiKey){{/isKeyInCookie}}{{/isApiKey}}{{/authMethods}}{{#formParams.0}}{{^isMultipart}}
-      .body(Map({{#formParams}}
-        {{>paramFormCreation}}{{^-last}},{{/-last}}{{/formParams}}
-      ).collect {
-        case (key, Some(value)) => key -> value.toString
-        case (key, value) if value != None => key -> value.toString
-      }){{/isMultipart}}{{#isMultipart}}
+      .body({{#formParams}}
+        {{>paramFormCreation}}{{^-last}} ++ {{/-last}}{{/formParams}},
+        "utf-8"
+      ){{/isMultipart}}{{#isMultipart}}
       .multipartBody(Seq({{#formParams}}
         {{>paramMultipartCreation}}{{/formParams}}
       ).flatten){{/isMultipart}}{{/formParams.0}}{{#bodyParam}}
-      {{^isFile}}.body({{paramName}}){{/isFile}}{{#isFile}}.fileBody({{paramName}}){{/isFile}}{{/bodyParam}}
+      {{^isFile}}.body(asJson({{paramName}})){{/isFile}}{{#isFile}}.fileBody({{paramName}}){{/isFile}}{{/bodyParam}}
       .response({{#separateErrorChannel}}{{^returnType}}asString.mapWithMetadata(ResponseAs.deserializeRightWithError(_ => Right(()))){{/returnType}}{{#fnHandleDownload}}{{#returnType}}asJson[{{>operationReturnType}}]{{/returnType}}{{/fnHandleDownload}}{{/separateErrorChannel}}{{^separateErrorChannel}}{{^returnType}}asString.mapWithMetadata(ResponseAs.deserializeRightWithError(_ => Right(()))).getRight{{/returnType}}{{#returnType}}asJson[{{>operationReturnType}}].getRight{{/returnType}}{{/separateErrorChannel}})
 
 {{/operation}}
diff --git a/modules/openapi-generator/src/main/resources/scala-sttp4-jsoniter/helpers.mustache b/modules/openapi-generator/src/main/resources/scala-sttp4-jsoniter/helpers.mustache
@@ -19,13 +19,13 @@ object FormSerializable:
       obj: T,
       inline format: FormStyleFormat = FormStyleFormat.FORM,
       inline explode: Boolean = true
-  ): Map[String, String]  =
+  ): Seq[(String, String)]  =
     inline obj match
       case primitive: Primitive => serializePrimitive(name, primitive, format, explode)
       case array: Seq[Primitive] => serializeArray(name, array, format, explode)
-      case optPrimitive: Option[Primitive] => optPrimitive.map(value => serializePrimitive(name, value, format, explode)).getOrElse(Map.empty[String, String])
-      case optArray: Option[Seq[Primitive]] => optArray.map(serializeArray(name, _, format, explode)).getOrElse(Map.empty[String, String])
-      case freeObj: Map[String, Primitive] => freeObj.map((key, value) => (key, value.toString))
+      case optPrimitive: Option[Primitive] => optPrimitive.map(value => serializePrimitive(name, value, format, explode)).getOrElse(Seq.empty[(String, String)])
+      case optArray: Option[Seq[Primitive]] => optArray.map(serializeArray(name, _, format, explode)).getOrElse(Seq.empty[(String, String)])
+      case freeObj: Map[String, Primitive] => freeObj.map((key, value) => (key, value.toString)).toSeq
       case optObj: Option[t] =>
         inline summonInline[Mirror.Of[t]] match
           case mirror: Mirror.ProductOf[t] =>
@@ -34,7 +34,7 @@ object FormSerializable:
             optObj.map{ obj =>
               val keyVals = labels.zip(obj.asInstanceOf[Product].productIterator.toSeq.asInstanceOf[Seq[Primitive]]).toSeq
               serializeModel(name, keyVals, format, explode)
-            }.getOrElse(Map.empty[String, String])
+            }.getOrElse(Seq.empty[(String, String)])
           case _ => error("ERROR") // TODO - support for enums
       case obj =>
         inline summonInline[Mirror.Of[T]] match
@@ -47,7 +47,6 @@ object FormSerializable:
             serializeModel(name, keyVals, format, explode)
 
 
-
   private inline def allLabels[T <: Tuple]: List[String] =
     constValueTuple[T].toList.asInstanceOf[List[String]]
 
@@ -68,10 +67,10 @@ object FormSerializable:
       value: Primitive,
       inline format: FormStyleFormat,
       inline explode: Boolean
-  ): Map[String, String] = {
+  ): Seq[(String, String)] = {
     inline format match
       case FormStyleFormat.FORM =>
-        Map(paramName -> value.toString) // for primitve values explode does not change anything
+        Seq(paramName -> value.toString) // for primitve values explode does not change anything
       case FormStyleFormat.SPACEDELIMITED =>
         error(
           "FormStyleFormat.SpaceDelimited does not support primitive values"
@@ -87,37 +86,37 @@ object FormSerializable:
       values: Seq[Primitive],
       inline format: FormStyleFormat,
       inline explode: Boolean
-  ): Map[String, String] = {
+  ): Seq[(String, String)]  = {
     inline format match
       case FormStyleFormat.FORM =>
-        inline if explode then values.map(s => (paramName, s.toString)).toMap
-        else Map(paramName -> values.mkString(","))
+        inline if explode then values.map(s => (paramName, s.toString))
+        else Seq(paramName -> values.mkString(","))
       case FormStyleFormat.SPACEDELIMITED =>
-        inline if explode then values.map(s => (paramName, s.toString)).toMap
-        else Map(paramName -> values.mkString(" ")) // Sttp will encode space as +, from https://swagger.io/docs/specification/v3_0/serialization/#query-parameters it is not clear if it should be + or %20
+        inline if explode then values.map(s => (paramName, s.toString))
+        else Seq(paramName -> values.mkString(" ")) // Sttp will encode space as +, from https://swagger.io/docs/specification/v3_0/serialization/#query-parameters it is not clear if it should be + or %20
       case FormStyleFormat.PIPEDELIMITED =>
-        inline if explode then values.map(s => (paramName, s.toString)).toMap
-        else Map(paramName -> values.mkString("|"))
+        inline if explode then values.map(s => (paramName, s.toString))
+        else Seq(paramName -> values.mkString("|"))
       case FormStyleFormat.DEEPOBJECT =>
         error("FormStyleFormat.DeepObject does not support arrays")
   }
-  inline def serializeModel(
+  private inline def serializeModel(
       paramName: String,
       keyValPairs: Seq[(String, Primitive)],
       inline format: FormStyleFormat,
       inline explode: Boolean
-  ): Map[String, String] = {
+  ): Seq[(String, String)]  = {
     inline format match
       case FormStyleFormat.FORM =>
-        inline if explode then keyValPairs.map((key, value) => (key, value.toString)).toMap
-        else Map(paramName -> keyValPairs.flatMap((key,value) => Seq(key, value.toString)).mkString(","))
+        inline if explode then keyValPairs.map((key, value) => (key, value.toString))
+        else Seq(paramName -> keyValPairs.flatMap((key,value) => Seq(key, value.toString)).mkString(","))
       case FormStyleFormat.SPACEDELIMITED =>
         error("FormStyleFormat.SpaceDelimited does not support objects")
       case FormStyleFormat.PIPEDELIMITED =>
         error("FormStyleFormat.PipeDelimited does not support objects")
       case FormStyleFormat.DEEPOBJECT =>
         inline if explode then
-          keyValPairs.map((key, value) => (s"$paramName[$key]", value.toString)).toMap
+          keyValPairs.map((key, value) => (s"$paramName[$key]", value.toString))
         else error("FormStyleFormat.DeepObject does not support explode=false")
   }
 end FormSerializable
diff --git a/modules/openapi-generator/src/main/resources/scala-sttp4-jsoniter/jsonSupport.mustache b/modules/openapi-generator/src/main/resources/scala-sttp4-jsoniter/jsonSupport.mustache
@@ -4,6 +4,7 @@ package {{invokerPackage}}
 {{#models.0}}
 import {{modelPackage}}.*
 {{/models.0}}
+import java.time.*
 import com.github.plokhotnyuk.jsoniter_scala.macros.*
 import com.github.plokhotnyuk.jsoniter_scala.core.*
 import com.github.plokhotnyuk.jsoniter_scala.circe.JsoniterScalaCodec.*
diff --git a/modules/openapi-generator/src/main/resources/scala-sttp4-jsoniter/methodParameters.mustache b/modules/openapi-generator/src/main/resources/scala-sttp4-jsoniter/methodParameters.mustache
@@ -1 +1 @@
-{{#authMethods.0}}({{#authMethods}}{{#isApiKey}}apiKey: String{{/isApiKey}}{{#isBasic}}{{#isBasicBasic}}username: String, password: String{{/isBasicBasic}}{{#isBasicBearer}}bearerToken: String{{/isBasicBearer}}{{/isBasic}}{{^-last}}, {{/-last}}{{/authMethods}}){{/authMethods.0}}{{#allParams.0}}({{#allParams}}{{paramName}}: {{#required}}{{dataType}}{{/required}}{{^required}}{{#isContainer}}{{dataType}}{{/isContainer}}{{^isContainer}}Option[{{dataType}}]{{/isContainer}}{{/required}}{{^defaultValue}}{{^required}}{{^isContainer}} = None{{/isContainer}}{{/required}}{{/defaultValue}}{{^-last}}, {{/-last}}{{/allParams}}){{/allParams.0}}
+{{#authMethods.0}}({{#authMethods}}{{#isApiKey}}apiKey: String{{/isApiKey}}{{#isBasic}}{{#isBasicBasic}}username: String, password: String{{/isBasicBasic}}{{#isBasicBearer}}bearerToken: String{{/isBasicBearer}}{{/isBasic}}{{^-last}}, {{/-last}}{{/authMethods}}){{/authMethods.0}}{{#allParams.0}}({{#allParams}}{{paramName}}: {{#required}}{{dataType}}{{/required}}{{^required}}{{#isContainer}}{{dataType}}{{/isContainer}}{{^isContainer}}Option[{{dataType}}]{{/isContainer}}{{/required}}{{^defaultValue}}{{^required}}{{^isContainer}} = scala.None{{/isContainer}}{{/required}}{{/defaultValue}}{{^-last}}, {{/-last}}{{/allParams}}){{/allParams.0}}
diff --git a/modules/openapi-generator/src/main/resources/scala-sttp4-jsoniter/model.mustache b/modules/openapi-generator/src/main/resources/scala-sttp4-jsoniter/model.mustache
@@ -22,7 +22,7 @@ case class {{classname}}(
   {{#description}}
   /* {{{.}}} */
   {{/description}}
-  @named("{{baseName}}") {{{name}}}: {{^required}}Option[{{/required}}{{^isEnum}}{{dataType}}{{/isEnum}}{{#isEnum}}{{^isArray}}{{classname}}Enums.{{datatypeWithEnum}}{{/isArray}}{{#isArray}}Seq[{{classname}}Enums.{{datatypeWithEnum}}]{{/isArray}}{{/isEnum}}{{^required}}] = None{{/required}}{{^-last}},{{/-last}}
+  @named("{{baseName}}") {{{name}}}: {{^required}}Option[{{/required}}{{^isEnum}}{{dataType}}{{/isEnum}}{{#isEnum}}{{^isArray}}{{classname}}Enums.{{datatypeWithEnum}}{{/isArray}}{{#isArray}}Seq[{{classname}}Enums.{{datatypeWithEnum}}]{{/isArray}}{{/isEnum}}{{^required}}] = scala.None{{/required}}{{^-last}},{{/-last}}
   {{/vars}}
 )
 {{/isEnum}}
diff --git a/modules/openapi-generator/src/main/resources/scala-sttp4-jsoniter/paramFormCreation.mustache b/modules/openapi-generator/src/main/resources/scala-sttp4-jsoniter/paramFormCreation.mustache
@@ -1 +1 @@
-"{{baseName}}" -> {{#isContainer}}FormStyleFormat.serialize({{{paramName}}}{{#collectionFormat}}, FormStyleFormat.{{style.toUpperCase}}{{/collectionFormat}}){{/isContainer}}{{^isContainer}}{{^required}}{{{paramName}}}{{/required}}{{#required}}Some({{{paramName}}}){{/required}}{{/isContainer}}
+FormSerializable.serialize("{{baseName}}", {{{paramName}}}{{#style}}, FormStyleFormat.{{style.toUpperCase}}{{/style}}{{^style}}, FormStyleFormat.FORM{{/style}}, {{isExplode}})

Original file line number	Diff line number	Diff line change
`@@ -430,10 +430,14 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo`
`430`	`430`	`Map<String, String> item = new HashMap<>();`
`431`	`431`	`if (isEnumClass(importPath, enumRefs)) {`
`432`	`432`	`item.put("import", importPath.concat(".*"));`
	`433`	`+ Map<String, String> enumClassImport = new HashMap<>();`
	`434`	`+ enumClassImport.put("import", importPath);`
	`435`	`+ newImports.add(item);`
	`436`	`+ newImports.add(enumClassImport);`
`433`	`437`	`} else {`
`434`	`438`	`item.put("import", importPath);`
	`439`	`+ newImports.add(item);`
`435`	`440`	`}`
`436`		`- newImports.add(item);`
`437`	`441`	`}`
`438`	`442`	`}`
`439`	`443`
`@@ -691,7 +695,7 @@ private static class HandleDownloadLambda extends CustomLambda {`
`691`	`695`	`@Override`
`692`	`696`	`public String formatFragment(String fragment) {`
`693`	`697`	`if (fragment.equals("asJson[File]")) {`
`694`		`- return "asFile(File.createTempFile(\"download\", \".tmp\")).mapLeft(errStr => DeserializationException(errStr, new Exception(errStr)))";`
	`698`	`+ return "asFile(File.createTempFile(\"download\", \".tmp\")).mapWithMetadata((result, metadata) => result.left.map(errStr => ResponseException.DeserializationException(errStr, new Exception(errStr), metadata)))";`
`695`	`699`	`} else {`
`696`	`700`	`return fragment;`
`697`	`701`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		-{{#authMethods.0}}({{#authMethods}}{{#isApiKey}}apiKey: String{{/isApiKey}}{{#isBasic}}{{#isBasicBasic}}username: String, password: String{{/isBasicBasic}}{{#isBasicBearer}}bearerToken: String{{/isBasicBearer}}{{/isBasic}}{{^-last}}, {{/-last}}{{/authMethods}}){{/authMethods.0}}{{#allParams.0}}({{#allParams}}{{paramName}}: {{#required}}{{dataType}}{{/required}}{{^required}}{{#isContainer}}{{dataType}}{{/isContainer}}{{^isContainer}}Option[{{dataType}}]{{/isContainer}}{{/required}}{{^defaultValue}}{{^required}}{{^isContainer}} = None{{/isContainer}}{{/required}}{{/defaultValue}}{{^-last}}, {{/-last}}{{/allParams}}){{/allParams.0}}
	`1`	+{{#authMethods.0}}({{#authMethods}}{{#isApiKey}}apiKey: String{{/isApiKey}}{{#isBasic}}{{#isBasicBasic}}username: String, password: String{{/isBasicBasic}}{{#isBasicBearer}}bearerToken: String{{/isBasicBearer}}{{/isBasic}}{{^-last}}, {{/-last}}{{/authMethods}}){{/authMethods.0}}{{#allParams.0}}({{#allParams}}{{paramName}}: {{#required}}{{dataType}}{{/required}}{{^required}}{{#isContainer}}{{dataType}}{{/isContainer}}{{^isContainer}}Option[{{dataType}}]{{/isContainer}}{{/required}}{{^defaultValue}}{{^required}}{{^isContainer}} = scala.None{{/isContainer}}{{/required}}{{/defaultValue}}{{^-last}}, {{/-last}}{{/allParams}}){{/allParams.0}}
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ case class {{classname}}(`
`22`	`22`	`{{#description}}`
`23`	`23`	`/* {{{.}}} */`
`24`	`24`	`{{/description}}`
`25`		`- @named("{{baseName}}") {{{name}}}: {{^required}}Option[{{/required}}{{^isEnum}}{{dataType}}{{/isEnum}}{{#isEnum}}{{^isArray}}{{classname}}Enums.{{datatypeWithEnum}}{{/isArray}}{{#isArray}}Seq[{{classname}}Enums.{{datatypeWithEnum}}]{{/isArray}}{{/isEnum}}{{^required}}] = None{{/required}}{{^-last}},{{/-last}}`
	`25`	`+ @named("{{baseName}}") {{{name}}}: {{^required}}Option[{{/required}}{{^isEnum}}{{dataType}}{{/isEnum}}{{#isEnum}}{{^isArray}}{{classname}}Enums.{{datatypeWithEnum}}{{/isArray}}{{#isArray}}Seq[{{classname}}Enums.{{datatypeWithEnum}}]{{/isArray}}{{/isEnum}}{{^required}}] = scala.None{{/required}}{{^-last}},{{/-last}}`
`26`	`26`	`{{/vars}}`
`27`	`27`	`)`
`28`	`28`	`{{/isEnum}}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-"{{baseName}}" -> {{#isContainer}}FormStyleFormat.serialize({{{paramName}}}{{#collectionFormat}}, FormStyleFormat.{{style.toUpperCase}}{{/collectionFormat}}){{/isContainer}}{{^isContainer}}{{^required}}{{{paramName}}}{{/required}}{{#required}}Some({{{paramName}}}){{/required}}{{/isContainer}}`
	`1`	`+FormSerializable.serialize("{{baseName}}", {{{paramName}}}{{#style}}, FormStyleFormat.{{style.toUpperCase}}{{/style}}{{^style}}, FormStyleFormat.FORM{{/style}}, {{isExplode}})`