Merge pull request #112 from innFactory/feature/update-smithy4s

chore: update smithy4s version from 0.17.2 to 0.17.4

build.sbt

@@ -21,8 +21,10 @@ val githubSettings = Seq(
     )
 )
 
+scalaVersion := "2.13.8"
+
 val defaultProjectSettings = Seq(
-  scalaVersion := "2.13.10",
+  scalaVersion := "2.13.8",
   organization := "de.innfactory",
   version      := releaseVersion
 ) ++ githubSettings

project/Dependencies.scala

@@ -7,7 +7,7 @@ object Dependencies {
   val typesafePlay = "com.typesafe.play" %% "play" % playVersion
 
   val scalaVersion       = "2.13.8"
-  val smithy4sVersion    = "0.17.2"
+  val smithy4sVersion    = "0.17.4"
   val smithyCore         = "com.disneystreaming.smithy4s" %% "smithy4s-core"             % smithy4sVersion
   val smithyJson         = "com.disneystreaming.smithy4s" %% "smithy4s-json"             % smithy4sVersion
   val smithy4sCompliance = "com.disneystreaming.smithy4s" %% "smithy4s-compliance-tests" % smithy4sVersion

project/build.properties

@@ -1 +1,2 @@
-sbt.version = 1.7.2
+sbt.version = 1.8.2
+scala.version = 2.13.2

project/plugins.sbt

@@ -1,6 +1,10 @@
-addSbtPlugin("com.codecommit"               % "sbt-github-packages"  % "0.5.3")
-addSbtPlugin("org.wartremover"              % "sbt-wartremover"      % "3.0.11")
-addSbtPlugin("org.scalameta"                % "sbt-scalafmt"         % "2.5.0")
-addSbtPlugin("com.disneystreaming.smithy4s" % "smithy4s-sbt-codegen" % "0.17.2")
-addSbtPlugin("com.typesafe.play"            % "sbt-plugin"           % "2.8.19")
-addSbtPlugin("org.scoverage"                % "sbt-scoverage"        % "1.9.3")
+addSbtPlugin("com.codecommit"               %% "sbt-github-packages"  % "0.5.3")
+addSbtPlugin("org.wartremover"              %% "sbt-wartremover"      % "3.0.11")
+addSbtPlugin("org.scalameta"                %% "sbt-scalafmt"         % "2.5.0")
+addSbtPlugin("com.disneystreaming.smithy4s" %% "smithy4s-sbt-codegen" % "0.17.4")
+addSbtPlugin("com.typesafe.play"            %% "sbt-plugin"           % "2.8.19")
+addSbtPlugin("org.scoverage"                %% "sbt-scoverage"        % "1.9.3")
+
+ThisBuild / dependencyOverrides ++= Seq(
+  "org.scala-lang.modules" %% "scala-xml" % "1.3.0"
+)

smithy4play/src/main/scala/de/innfactory/smithy4play/CodecUtils.scala

@@ -0,0 +1,35 @@
+package de.innfactory.smithy4play
+
+import smithy4s.{ HintMask, Schema }
+import smithy4s.http.{ CodecAPI, PayloadError }
+import smithy4s.http.json.codecs
+import smithy4s.internals.InputOutput
+
+object CodecUtils {
+
+  private val codecs: codecs =
+    smithy4s.http.json.codecs(alloy.SimpleRestJson.protocol.hintMask ++ HintMask(InputOutput))
+
+  def writeInputToBody[I](input: I, inputSchema: Schema[I], codecAPI: CodecAPI): Array[Byte] = {
+    val codec = codecAPI.compileCodec(inputSchema)
+    codecAPI.writeToArray(codec, input)
+  }
+
+  def readFromBytes[E](data: Array[Byte], inputSchema: Schema[E], codecAPI: CodecAPI): Either[PayloadError, E] =
+    codecAPI.decodeFromByteArray(codecAPI.compileCodec(inputSchema), data)
+
+  def writeEntityToJsonBytes[E](e: E, schema: Schema[E]) = writeInputToBody[E](e, schema, codecs)
+
+  def readFromJsonBytes[E](bytes: Array[Byte], schema: Schema[E]): Option[E] =
+    readFromBytes(bytes, schema, codecs).toOption
+
+  def extractCodec(headers: Map[String, Seq[String]]): CodecAPI = {
+    val contentType =
+      headers.getOrElse("content-type", List("application/json"))
+    val codecApi    = contentType match {
+      case List("application/json") => codecs
+      case _                        => CodecAPI.nativeStringsAndBlob(codecs)
+    }
+    codecApi
+  }
+}

smithy4play/src/main/scala/de/innfactory/smithy4play/client/SmithyPlayClientEndpoint.scala

@@ -1,11 +1,9 @@
 package de.innfactory
 package smithy4play
 package client
-import smithy4s.http.json.codecs
-import smithy4s.{ Endpoint, HintMask, Schema }
+import smithy4s.{ Endpoint, Schema }
 import smithy4s.http.{ CaseInsensitive, CodecAPI, HttpEndpoint, Metadata, MetadataError, PayloadError }
 import cats.implicits._
-import smithy4s.internals.InputOutput
 
 import scala.concurrent.{ ExecutionContext, Future }
 
@@ -18,9 +16,6 @@ private[smithy4play] class SmithyPlayClientEndpoint[Op[_, _, _, _, _], I, E, O,
   client: RequestClient
 )(implicit executionContext: ExecutionContext) {
 
-  private val codecs: codecs =
-    smithy4s.http.json.codecs(alloy.SimpleRestJson.protocol.hintMask ++ HintMask(InputOutput))
-
   private val inputSchema: Schema[I]  = endpoint.input
   private val outputSchema: Schema[O] = endpoint.output
 
@@ -38,7 +33,7 @@ private[smithy4play] class SmithyPlayClientEndpoint[Op[_, _, _, _, _], I, E, O,
     val headers            = metadata.headers.map(x => (x._1.toString.toLowerCase, x._2))
     val headersWithAuth    = if (additionalHeaders.isDefined) headers.combine(additionalHeaders.get) else headers
     val code               = httpEndpoint.code
-    val codecApi: CodecAPI = extractCodec(headers)
+    val codecApi: CodecAPI = CodecUtils.extractCodec(headers)
     val send               = client.send(httpEndpoint.method.toString, path, headersWithAuth, _)
     val response           = if (inputHasBody) {
       val codec       = codecApi.compileCodec(inputSchema)
@@ -48,16 +43,6 @@ private[smithy4play] class SmithyPlayClientEndpoint[Op[_, _, _, _, _], I, E, O,
     decodeResponse(response, code)
   }
 
-  private def extractCodec(headers: Map[String, Seq[String]]): CodecAPI = {
-    val contentType =
-      headers.getOrElse("content-type", List("application/json"))
-    val codecApi    = contentType match {
-      case List("application/json") => codecs
-      case _                        => CodecAPI.nativeStringsAndBlob(codecs)
-    }
-    codecApi
-  }
-
   private def decodeResponse(
     response: Future[SmithyClientResponse],
     expectedCode: Int
@@ -77,7 +62,7 @@ private[smithy4play] class SmithyPlayClientEndpoint[Op[_, _, _, _, _], I, E, O,
       case None               =>
         for {
           metadataPartial <- outputMetadataDecoder.decode(metadata)
-          codecApi         = extractCodec(headers)
+          codecApi         = CodecUtils.extractCodec(headers)
           bodyPartial     <-
             codecApi.decodeFromByteArrayPartial(codecApi.compileCodec(outputSchema), response.body.get)
         } yield metadataPartial.combine(bodyPartial)

smithy4playTest/app/controller/TestController.scala

@@ -2,7 +2,7 @@ package controller
 
 import cats.data.{ EitherT, Kleisli }
 import controller.models.TestError
-import de.innfactory.smithy4play.{ AutoRouting, ContextRoute, ContextRouteError }
+import de.innfactory.smithy4play.{ AutoRouting, CodecUtils, ContextRoute, ContextRouteError }
 import play.api.mvc.ControllerComponents
 import smithy4s.ByteArray
 import testDefinitions.test._

smithy4playTest/test/TestControllerTest.scala

@@ -1,17 +1,19 @@
 import controller.models.TestError
+import de.innfactory.smithy4play.CodecUtils
 import de.innfactory.smithy4play.client.GenericAPIClient.EnhancedGenericAPIClient
-import de.innfactory.smithy4play.client.{ RequestClient, SmithyClientResponse }
+import de.innfactory.smithy4play.client.{RequestClient, SmithyClientResponse}
 import de.innfactory.smithy4play.client.SmithyPlayTestUtils._
 import de.innfactory.smithy4play.compliancetests.ComplianceClient
-import org.scalatestplus.play.{ BaseOneAppPerSuite, FakeApplicationFactory, PlaySpec }
+import models.TestJson
+import org.scalatestplus.play.{BaseOneAppPerSuite, FakeApplicationFactory, PlaySpec}
 import play.api.Application
 import play.api.Play.materializer
 import play.api.inject.guice.GuiceApplicationBuilder
-import play.api.libs.json.{ Json, OWrites }
-import play.api.mvc.{ AnyContentAsEmpty, Result }
+import play.api.libs.json.{Json, OWrites}
+import play.api.mvc.{AnyContentAsEmpty, Result}
 import play.api.test.FakeRequest
 import play.api.test.Helpers._
-import testDefinitions.test.{ TestControllerServiceGen, TestRequestBody }
+import testDefinitions.test.{SimpleTestResponse, TestControllerServiceGen, TestRequestBody}
 import smithy4s.ByteArray
 
 import java.io.File
@@ -149,5 +151,20 @@ class TestControllerTest extends PlaySpec with BaseOneAppPerSuite with FakeAppli
 
       result.statusCode mustBe 401
     }
+
+    "manual writing json" in {
+
+      val writtenData = CodecUtils.writeEntityToJsonBytes(SimpleTestResponse(Some("Test")), SimpleTestResponse.schema)
+
+      val writtenJson = Json.parse(writtenData).as[TestJson]
+
+      val readData = CodecUtils.readFromJsonBytes(
+        Json.toBytes(Json.toJson(TestJson(Some("Test")))),
+        SimpleTestResponse.schema
+      )
+
+      writtenJson.message mustBe Some("Test")
+      readData.get.message mustBe Some("Test")
+    }
   }
 }

smithy4playTest/test/models/TestJson.scala

@@ -0,0 +1,9 @@
+package models
+
+import play.api.libs.json.Json
+
+case class TestJson(message: Option[String])
+
+object TestJson {
+  implicit val format = Json.format[TestJson]
+}