update response mapping v2, add script to support testing (#10)

rolang · web-flow · commit 8460001c9c7d · 2025-03-15T13:47:01.000+07:00
* update response mapping v2, add script to support testing

* update jvm in ci
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -15,6 +15,7 @@ jobs:
       - uses: coursier/cache-action@v6
       - uses: VirtusLab/scala-cli-setup@main
         with:
+          jvm: temurin:21
           apps: sbt
           power: true
       - name: Start up emulators
@@ -30,6 +31,7 @@ jobs:
       - uses: coursier/cache-action@v6
       - uses: VirtusLab/scala-cli-setup@main
         with:
+          jvm: temurin:21
           apps: sbt
       - name: Import signing key
         if: env.PGP_SECRET != '' && env.PGP_PASSPHRASE == ''
diff --git a/.gitignore b/.gitignore
@@ -8,4 +8,5 @@ target/
 metals.sbt
 .scala-build
 example/out
-.env
+.env
+test-local
diff --git a/build.sbt b/build.sbt
@@ -46,11 +46,11 @@ lazy val noPublish = Seq(
 
 lazy val sttpClient4Version = "4.0.0-RC1"
 
-lazy val sttpClient3Version = "3.10.2"
+lazy val sttpClient3Version = "3.10.3"
 
-lazy val zioVersion = "2.1.15"
+lazy val zioVersion = "2.1.16"
 
-lazy val zioJsonVersion = "0.7.28"
+lazy val zioJsonVersion = "0.7.39"
 
 lazy val jsoniterVersion = "2.33.2"
 
@@ -67,6 +67,16 @@ lazy val root = (project in file("."))
   .aggregate(testProjects.componentProjects.map(p => LocalProject(p.id)) *)
   .settings(noPublish)
 
+// for supporting code inspection / testing of generated code via test_gen.sh script
+lazy val testLocal = (project in file("test-local"))
+  .settings(
+    libraryDependencies ++= (
+      dependencyByConfig("Sttp4", "Jsoniter", "ZioChunk")
+        ++ dependencyByConfig("Sttp3", "ZioJson", "List")
+    )
+  )
+  .settings(noPublish)
+
 lazy val core = crossProject(JVMPlatform, NativePlatform)
   .in(file("modules/core"))
   .settings(publishSettings)
@@ -92,21 +102,23 @@ lazy val cli = project
     nativeConfig := nativeConfig.value.withMultithreading(false)
   )
 
-def dependencyByConfig(httpSource: String, jsonCodec: String, arrayType: String): List[ModuleID] = {
+def dependencyByConfig(httpSource: String, jsonCodec: String, arrayType: String): Seq[ModuleID] = {
   (httpSource match {
-    case "Sttp3" => List("com.softwaremill.sttp.client3" %% "core" % sttpClient3Version)
-    case "Sttp4" => List("com.softwaremill.sttp.client4" %% "core" % sttpClient4Version)
-    case _       => Nil
-  }) ::: (jsonCodec match {
+    case "Sttp3" => Seq("com.softwaremill.sttp.client3" %% "core" % sttpClient3Version)
+    case "Sttp4" => Seq("com.softwaremill.sttp.client4" %% "core" % sttpClient4Version)
+    case other   => throw new InterruptedException(s"Invalid http source: $other")
+  }) ++ (jsonCodec match {
     case "Jsoniter" =>
-      List(
+      Seq(
         "com.github.plokhotnyuk.jsoniter-scala" %% "jsoniter-scala-core" % jsoniterVersion,
         "com.github.plokhotnyuk.jsoniter-scala" %% "jsoniter-scala-macros" % jsoniterVersion % "compile-internal"
       )
-    case "ZioJson" => List("dev.zio" %% "zio-json" % zioJsonVersion)
-  }) ::: (arrayType match {
-    case "ZioChunk" => List("dev.zio" %% "zio" % zioVersion)
-    case _          => Nil
+    case "ZioJson" => Seq("dev.zio" %% "zio-json" % zioJsonVersion)
+    case other     => throw new InterruptedException(s"Invalid json codec: $other")
+  }) ++ (arrayType match {
+    case "ZioChunk"                  => Seq("dev.zio" %% "zio" % zioVersion)
+    case "List" | "Vector" | "Array" => Nil
+    case other                       => throw new InterruptedException(s"Invalid array type: $other")
   })
 }
 
diff --git a/modules/cli/src/main/scala/cli.scala b/modules/cli/src/main/scala/cli.scala
@@ -1,6 +1,6 @@
 // for test runs using scala-cli
 //> using jvm system
-//> using scala 3.6.3
+//> using scala 3.6.4
 //> using file ../../../../core/shared/src/main/scala/codegen.scala
 //> using dep com.lihaoyi::upickle:4.1.0
 
diff --git a/modules/core/shared/src/main/scala/codegen.scala b/modules/core/shared/src/main/scala/codegen.scala
@@ -154,18 +154,60 @@ def generateBySpec(
                   case Dialect.Scala3 => s"package $resourcesPkg",
                 "",
                 config.httpSource match {
-                  case HttpSource.Sttp4 => "import sttp.model.*\nimport sttp.client4.*"
+                  case HttpSource.Sttp4 =>
+                    "import sttp.model.*\nimport sttp.client4.*, sttp.client4.ResponseException.{DeserializationException, UnexpectedStatusCode}"
                   case HttpSource.Sttp3 => "import sttp.model.*\nimport sttp.client3.*"
                 },
+                config.jsonCodec match {
+                  case JsonCodec.ZioJson  => "import zio.json.*"
+                  case JsonCodec.Jsoniter => "import com.github.plokhotnyuk.jsoniter_scala.core.*"
+                },
                 config.dialect match
                   case Dialect.Scala3 => "",
                 s"val resourceRequest: ${
                     if config.httpSource == HttpSource.Sttp3 then "RequestT[Empty, Either[String, String], Any]"
                     else "PartialRequest[Either[String, String]]"
                   } = basicRequest.headers(Header.contentType(MediaType.ApplicationJson))",
+                "",
                 s"export ${config.outPkg}.QueryParameters",
-                config.dialect match
-                  case Dialect.Scala3 => ""
+                "",
+                (config.httpSource, config.jsonCodec) match
+                  case (HttpSource.Sttp4, JsonCodec.Jsoniter) =>
+                    """|def asJson[T : JsonValueCodec]: ResponseAs[Either[ResponseException[String], T]] =
+                       |  asByteArrayAlways.mapWithMetadata((bytes, metadata) =>
+                       |    if metadata.isSuccess then
+                       |      try {
+                       |        Right(readFromArray[T](bytes))
+                       |      } catch {
+                       |        case e: Exception =>
+                       |          Left(DeserializationException(String(bytes, java.nio.charset.StandardCharsets.UTF_8), e, metadata))
+                       |      }
+                       |    else Left(UnexpectedStatusCode(String(bytes, java.nio.charset.StandardCharsets.UTF_8), metadata))
+                       |  )""".stripMargin
+                  case (HttpSource.Sttp3, JsonCodec.Jsoniter) =>
+                    """|def asJson[T : JsonValueCodec]:  ResponseAs[Either[ResponseException[String, Exception], T], Any] =
+                       |  asByteArrayAlways.mapWithMetadata((bytes, metadata) =>
+                       |    if metadata.isSuccess then
+                       |      try {
+                       |        Right(readFromArray[T](bytes))
+                       |      } catch {
+                       |        case e: Exception =>
+                       |          Left(DeserializationException(String(bytes, java.nio.charset.StandardCharsets.UTF_8), e))
+                       |      }
+                       |    else Left(HttpError(String(bytes, java.nio.charset.StandardCharsets.UTF_8), metadata.code))
+                       |  )""".stripMargin
+                  case (HttpSource.Sttp4, JsonCodec.ZioJson) =>
+                    """|def asJson[T : JsonDecoder]: ResponseAs[Either[ResponseException[String], T]] =
+                       |  asStringAlways.mapWithMetadata((body, metadata) =>
+                       |     if metadata.isSuccess then body.fromJson[T].left.map(e => DeserializationException(body, Exception(e), metadata))
+                       |     else Left(UnexpectedStatusCode(body, metadata))
+                       |  )""".stripMargin
+                  case (HttpSource.Sttp3, JsonCodec.ZioJson) =>
+                    """|def asJson[T : JsonDecoder]: ResponseAs[Either[ResponseException[String, Exception], T], Any] =
+                       |  asStringAlways.mapWithMetadata((body, metadata) =>
+                       |     if metadata.isSuccess then body.fromJson[T].left.map(e => DeserializationException(body, Exception(e)))
+                       |     else Left(HttpError(body, metadata.code))
+                       |  )""".stripMargin
               ).mkString("\n")
             )
             List(path.toFile())
@@ -254,20 +296,17 @@ def resourceCode(
     hasProps: SchemaPath => Boolean,
     commonQueryParams: Map[String, Parameter]
 ) =
+  val sttpClientPkg = httpSource match
+    case HttpSource.Sttp4 => "sttp.client4"
+    case HttpSource.Sttp3 => "sttp.client3"
+
   List(
     s"package $pkg",
     "",
     s"import $schemasPkg.*",
     s"import $resourcesPkg.*",
     "",
-    httpSource match {
-      case HttpSource.Sttp4 => "import sttp.model.Uri, sttp.model.Uri.PathSegment, sttp.client4.*"
-      case HttpSource.Sttp3 => "import sttp.model.Uri, sttp.model.Uri.PathSegment, sttp.client3.*"
-    },
-    jsonCodec match {
-      case JsonCodec.ZioJson  => "import zio.json.*"
-      case JsonCodec.Jsoniter => "import com.github.plokhotnyuk.jsoniter_scala.core.*"
-    },
+    s"import sttp.model.Uri, sttp.model.Uri.PathSegment, $sttpClientPkg.*",
     "",
     s"object ${resourceName} {" +
       resource.methods
@@ -351,35 +390,18 @@ def resourceCode(
 
           def responseType(t: String) =
             httpSource match
-              case HttpSource.Sttp4 => s"Request[Either[String, $t]]"
+              case HttpSource.Sttp4 =>
+                s"Request[Either[${if t == "String" then "String" else "ResponseException[String]"}, $t]]"
               case HttpSource.Sttp3 =>
-                s"RequestT[Identity, Either[String, $t], Any]"
+                s"RequestT[Identity, Either[${if t == "String" then "String" else "ResponseException[String, Exception]"}, $t], Any]"
 
           val (resType, mapResponse) = v.response match
             case Some(r) if r.schemaPath.forall(hasProps) =>
               val bodyType = r.scalaType(arrType)
 
               (
                 responseType(bodyType),
-                jsonCodec match
-                  case JsonCodec.ZioJson =>
-                    s"""|.response(
-                        |  asStringAlways.mapWithMetadata((body, metadata) =>
-                        |    if (metadata.isSuccess) then body.fromJson[$bodyType] else Left(body)
-                        |  )
-                        |)""".stripMargin
-                  case JsonCodec.Jsoniter =>
-                    s"""|.response(
-                        |  asByteArrayAlways.mapWithMetadata((bytes, metadata) =>
-                        |    if (metadata.isSuccess) {
-                        |      try {
-                        |        Right(readFromArray[$bodyType](bytes))
-                        |      } catch {
-                        |        case e: Throwable => Left(e.getMessage())
-                        |      }
-                        |    } else Left(String(bytes, java.nio.charset.StandardCharsets.UTF_8))
-                        |  )
-                        |)""".stripMargin
+                s".response(asJson[$bodyType])"
               )
             case _ => (responseType("String"), "")
 
diff --git a/project/build.properties b/project/build.properties
@@ -1 +1 @@
-sbt.version=1.10.7
+sbt.version=1.10.10
diff --git a/project/plugins.sbt b/project/plugins.sbt
@@ -1,4 +1,4 @@
-addSbtPlugin("org.scala-native" % "sbt-scala-native" % "0.5.6")
+addSbtPlugin("org.scala-native" % "sbt-scala-native" % "0.5.7")
 
 addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.5.2")
 
diff --git a/test_gen.sh b/test_gen.sh
@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+
+# script to support with quick execution and code inspection on generator changes
+# runs code generator via scala-cli for given config
+# will ouput code under test-local/src/main/scala
+
+spec=pubsub
+json_codec=jsoniter
+http_source=sttp4
+array_type=list
+out_dir=test-local/src/main/scala/test-$spec-v1/$http_source/$spec/$json_codec
+rm -rf $out_dir && mkdir -p $out_dir
+
+echo "running generator for $spec to $out_dir"
+scala-cli modules/cli/src/main/scala/cli.scala -- \
+    -specs=modules/test-resources/src/main/resources/${spec}_v1.json \
+    -out-dir=$out_dir \
+    -out-pkg=gcp.${spec}.v1.${http_source}.${json_codec}.$array_type \
+    -http-source=$http_source \
+    -json-codec=$json_codec \
+    -array-type=$array_type && \
+scala-cli fmt $out_dir

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-sbt.version=1.10.7`
	`1`	`+sbt.version=1.10.10`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-addSbtPlugin("org.scala-native" % "sbt-scala-native" % "0.5.6")`
	`1`	`+addSbtPlugin("org.scala-native" % "sbt-scala-native" % "0.5.7")`
`2`	`2`
`3`	`3`	`addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.5.2")`
`4`	`4`