feat(prism-agent): fix DID service URI class and improve validation e…

…rror response message (#389) * fix(prism-agent): upgrade castor to use RFC3986 for URI * fix(prism-agent): add more clarity on Create DID error response * feat(prism-agent): upgrade castor to 0.8.1
hyperledger · Feb 22, 2023 · 3d08996 · 3d08996
1 parent 8c07839
commit 3d08996
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 28 deletions.
diff --git a/prism-agent/service/project/Dependencies.scala b/prism-agent/service/project/Dependencies.scala
@@ -8,8 +8,8 @@ object Dependencies {
     val zioInteropCats = "3.3.0" // scala-steward:off
     val akka = "2.6.20"
     val akkaHttp = "10.2.9"
-    val castor = "0.8.0"
-    val pollux = "0.28.1"
+    val castor = "0.8.1"
+    val pollux = "0.29.0"
     val connect = "0.10.1"
     val bouncyCastle = "1.70"
     val logback = "1.4.5"

diff --git a/...ce/server/src/main/scala/io/iohk/atala/agent/server/http/model/OASDomainModelHelper.scala b/...ce/server/src/main/scala/io/iohk/atala/agent/server/http/model/OASDomainModelHelper.scala
@@ -29,7 +29,7 @@ import io.iohk.atala.shared.models.HexStrings.*
 import io.iohk.atala.shared.models.Base64UrlStrings.*
 import io.iohk.atala.shared.utils.Traverse.*
 
-import java.net.URI
+import io.lemonlabs.uri.Uri
 import scala.util.Try
 import java.time.OffsetDateTime
 import java.time.ZoneOffset
@@ -50,16 +50,18 @@ trait OASDomainModelHelper {
     def toDomain: Either[String, castorDomain.Service] = {
       for {
         serviceEndpoint <- service.serviceEndpoint.traverse(s =>
-          Try(URI.create(s)).toEither.left.map(_ => s"unable to parse serviceEndpoint $s as URI")
+          Uri.parseTry(s).toEither.left.map(_ => s"unable to parse serviceEndpoint $s as URI")
         )
         serviceType <- castorDomain.ServiceType
           .parseString(service.`type`)
           .toRight(s"unsupported serviceType ${service.`type`}")
-      } yield castorDomain.Service(
-        id = service.id,
-        `type` = serviceType,
-        serviceEndpoint = serviceEndpoint
-      )
+      } yield castorDomain
+        .Service(
+          id = service.id,
+          `type` = serviceType,
+          serviceEndpoint = serviceEndpoint
+        )
+        .normalizeServiceEndpoint()
     }
   }
 
@@ -112,7 +114,7 @@ trait OASDomainModelHelper {
       for {
         serviceEndpoint <- servicePatch.serviceEndpoint
           .getOrElse(Nil)
-          .traverse(s => Try(URI.create(s)).toEither.left.map(_ => s"unable to parse serviceEndpoint $s as URI"))
+          .traverse(s => Uri.parseTry(s).toEither.left.map(_ => s"unable to parse serviceEndpoint $s as URI"))
         serviceType <- servicePatch.`type`.fold[Either[String, Option[ServiceType]]](Right(None))(s =>
           castorDomain.ServiceType.parseString(s).toRight(s"unsupported serviceType $s").map(Some(_))
         )

diff --git a/...ice/server/src/main/scala/io/iohk/atala/agent/server/http/model/OASErrorModelHelper.scala b/...ice/server/src/main/scala/io/iohk/atala/agent/server/http/model/OASErrorModelHelper.scala
@@ -10,6 +10,7 @@ import io.iohk.atala.agent.walletapi.model.error.{
 }
 import io.iohk.atala.castor.core.model.did.w3c.DIDResolutionErrorRepr
 import io.iohk.atala.castor.core.model.error.DIDOperationError
+import io.iohk.atala.castor.core.model.error.OperationValidationError
 import io.iohk.atala.castor.core.model.error.DIDResolutionError
 import io.iohk.atala.connect.core.model.error.ConnectionServiceError
 import io.iohk.atala.pollux.core.model.error.CredentialServiceError
@@ -44,18 +45,6 @@ trait OASErrorModelHelper {
     }
   }
 
-  given ToErrorResponse[DIDOperationError] with {
-    override def toErrorResponse(e: DIDOperationError): ErrorResponse = {
-      ErrorResponse(
-        `type` = "error-type",
-        title = "error-title",
-        status = 500,
-        detail = Some(e.toString),
-        instance = "error-instance"
-      )
-    }
-  }
-
   given ToErrorResponse[GetManagedDIDError] with {
     override def toErrorResponse(e: GetManagedDIDError): ErrorResponse = {
       ErrorResponse(
@@ -82,11 +71,18 @@ trait OASErrorModelHelper {
 
   given ToErrorResponse[CreateManagedDIDError] with {
     override def toErrorResponse(e: CreateManagedDIDError): ErrorResponse = {
+      val (status, detail) = e match {
+        case CreateManagedDIDError.InvalidArgument(msg)    => (422, s"Unable to construct a DID operation: $msg")
+        case CreateManagedDIDError.DIDAlreadyExists(did)   => (409, s"DID ${did.toString} already exists")
+        case CreateManagedDIDError.KeyGenerationError(_)   => (500, s"Internal server error (key-pair generation)")
+        case CreateManagedDIDError.WalletStorageError(_)   => (500, s"Internal server error (storage)")
+        case CreateManagedDIDError.InvalidOperation(cause) => (422, s"Create DID payload is invalid: ${cause.toString}")
+      }
       ErrorResponse(
         `type` = "error-type",
         title = "error-title",
-        status = 500,
-        detail = Some(e.toString),
+        status = status,
+        detail = Some(detail),
         instance = "error-instance"
       )
     }

diff --git a/...ce/wallet-api/src/main/scala/io/iohk/atala/agent/walletapi/model/ManagedDIDTemplate.scala b/...ce/wallet-api/src/main/scala/io/iohk/atala/agent/walletapi/model/ManagedDIDTemplate.scala
@@ -2,7 +2,7 @@ package io.iohk.atala.agent.walletapi.model
 
 import io.iohk.atala.castor.core.model.did.{Service, VerificationRelationship, ServiceType}
 
-import java.net.URI
+import io.lemonlabs.uri.Uri
 
 final case class ManagedDIDTemplate(
     publicKeys: Seq[DIDPublicKeyTemplate],
@@ -24,4 +24,4 @@ object UpdateManagedDIDAction {
   final case class UpdateService(patch: UpdateServicePatch) extends UpdateManagedDIDAction
 }
 
-final case class UpdateServicePatch(id: String, serviceType: Option[ServiceType], serviceEndpoints: Seq[URI])
+final case class UpdateServicePatch(id: String, serviceType: Option[ServiceType], serviceEndpoints: Seq[Uri])
diff --git a/...i/src/test/scala/io/iohk/atala/agent/walletapi/util/ManagedDIDTemplateValidatorSpec.scala b/...i/src/test/scala/io/iohk/atala/agent/walletapi/util/ManagedDIDTemplateValidatorSpec.scala
@@ -7,7 +7,7 @@ import zio.*
 import zio.test.*
 import zio.test.Assertion.*
 
-import java.net.URI
+import io.lemonlabs.uri.Uri
 
 object ManagedDIDTemplateValidatorSpec extends ZIOSpecDefault {
 
@@ -28,7 +28,7 @@ object ManagedDIDTemplateValidatorSpec extends ZIOSpecDefault {
           Service(
             id = "service0",
             `type` = ServiceType.LinkedDomains,
-            serviceEndpoint = Seq(URI.create("http://example.com"))
+            serviceEndpoint = Seq(Uri.parse("http://example.com/"))
           )
         )
       )