feat: Handle Error in Background Jobs - Improve the way we store erro…

…rs and defects in DB (#1218) For ATL-6931 Signed-off-by: FabioPinheiro <[email protected]>
hyperledger · Jun 27, 2024 · e3cadc9 · e3cadc9
1 parent e5e3411
commit e3cadc9
Show file tree

Hide file tree

Showing 42 changed files with 336 additions and 187 deletions.
diff --git a/build.sbt b/build.sbt
@@ -34,7 +34,7 @@ inThisBuild(
       "-unchecked",
       "-Dquill.macro.log=false", // disable quill macro logs
       "-Wunused:all",
-      "-Wconf:any:warning" // TODO: change unused imports to errors, Wconf configuration string is different from scala 2, figure out how!
+      "-Wconf:any:warning", // TODO: change unused imports to errors, Wconf configuration string is different from scala 2, figure out how!
       // TODO "-feature",
       // TODO "-Xfatal-warnings",
       // TODO "-Yexplicit-nulls",
@@ -502,7 +502,8 @@ lazy val models = project
     ), // TODO try to remove this from this module
     // libraryDependencies += D.didScala
   )
-  .settings(libraryDependencies += D.nimbusJwt) //FIXME just for the DidAgent
+  .settings(libraryDependencies += D.nimbusJwt) // FIXME just for the DidAgent
+  .dependsOn(shared)
 
 /* TODO move code from agentDidcommx to here
 models implementation for didcommx () */

diff --git a/.../server/src/main/scala/org/hyperledger/identus/agent/server/jobs/BackgroundJobError.scala b/.../server/src/main/scala/org/hyperledger/identus/agent/server/jobs/BackgroundJobError.scala
@@ -1,15 +1,40 @@
 package org.hyperledger.identus.agent.server.jobs
 
 import org.hyperledger.identus.mercury.HttpResponse
+import org.hyperledger.identus.shared.models._
 
-sealed trait BackgroundJobError
+sealed trait BackgroundJobError(
+    override val statusCode: org.hyperledger.identus.shared.models.StatusCode,
+    override val userFacingMessage: String
+) extends Failure {
+  override val namespace: String = "BackgroundJobError"
+}
 
 object BackgroundJobError {
-  final case class InvalidState(cause: String) extends BackgroundJobError
 
-  final case class ErrorSendingMessage(cause: String) extends BackgroundJobError
-  case object NotImplemented extends BackgroundJobError
-  final case class ErrorResponseReceivedFromPeerAgent(response: HttpResponse) extends BackgroundJobError {
+  final case class InvalidState(cause: String)
+      extends BackgroundJobError(
+        statusCode = StatusCode.InternalServerError,
+        userFacingMessage = s"Invalid State: cause='$cause'"
+      )
+
+  final case class ErrorSendingMessage(cause: String)
+      extends BackgroundJobError(
+        statusCode = StatusCode.BadRequest,
+        userFacingMessage = s"ErrorSendingMessage"
+      )
+
+  case object NotImplemented
+      extends BackgroundJobError(
+        statusCode = StatusCode.UnexpectedNotImplemented,
+        userFacingMessage = s"NotImplemented"
+      )
+  final case class ErrorResponseReceivedFromPeerAgent(response: HttpResponse)
+      extends BackgroundJobError(
+        statusCode = StatusCode.BadRequest,
+        userFacingMessage = s"DIDComm sending error: [${response.status}] - ${response.bodyAsString}"
+      ) {
+
     override def toString: String = s"DIDComm sending error: [${response.status}] - ${response.bodyAsString}"
   }
 }
diff --git a/...rver/src/main/scala/org/hyperledger/identus/agent/server/jobs/ConnectBackgroundJobs.scala b/...rver/src/main/scala/org/hyperledger/identus/agent/server/jobs/ConnectBackgroundJobs.scala
@@ -6,10 +6,13 @@ import org.hyperledger.identus.agent.walletapi.model.error.DIDSecretStorageError
 import org.hyperledger.identus.agent.walletapi.model.error.DIDSecretStorageError.{KeyNotFoundError, WalletNotFoundError}
 import org.hyperledger.identus.agent.walletapi.service.ManagedDIDService
 import org.hyperledger.identus.agent.walletapi.storage.DIDNonSecretStorage
+import org.hyperledger.identus.connect.core.model.error.ConnectionServiceError.InvalidStateForOperation
+import org.hyperledger.identus.connect.core.model.error.ConnectionServiceError.RecordIdNotFound
 import org.hyperledger.identus.connect.core.model.ConnectionRecord
 import org.hyperledger.identus.connect.core.model.ConnectionRecord.*
 import org.hyperledger.identus.connect.core.service.ConnectionService
 import org.hyperledger.identus.mercury.*
+import org.hyperledger.identus.mercury.model.error.SendMessageError
 import org.hyperledger.identus.resolvers.DIDResolver
 import org.hyperledger.identus.shared.models.WalletAccessContext
 import org.hyperledger.identus.shared.utils.aspects.CustomMetricsAspect
@@ -182,11 +185,11 @@ object ConnectBackgroundJobs extends BackgroundJobsHelper {
             s"Connect - Error processing record: ${record.id}",
             Cause.fail(walletNotFound)
           )
-        case ((walletAccessContext, e)) =>
+        case ((walletAccessContext, errorResponse)) =>
           for {
             connectService <- ZIO.service[ConnectionService]
             _ <- connectService
-              .reportProcessingFailure(record.id, Some(e.toString))
+              .reportProcessingFailure(record.id, Some(errorResponse))
               .provideSomeLayer(ZLayer.succeed(walletAccessContext))
           } yield ()
       })

diff --git a/...server/src/main/scala/org/hyperledger/identus/agent/server/jobs/IssueBackgroundJobs.scala b/...server/src/main/scala/org/hyperledger/identus/agent/server/jobs/IssueBackgroundJobs.scala
@@ -9,6 +9,7 @@ import org.hyperledger.identus.mercury.protocol.issuecredential.*
 import org.hyperledger.identus.pollux.core.model.*
 import org.hyperledger.identus.pollux.core.model.error.CredentialServiceError
 import org.hyperledger.identus.pollux.core.service.CredentialService
+import org.hyperledger.identus.shared.models.Failure
 import org.hyperledger.identus.shared.utils.aspects.CustomMetricsAspect
 import org.hyperledger.identus.shared.utils.DurationOps.toMetricsSeconds
 import zio.*
@@ -618,11 +619,12 @@ object IssueBackgroundJobs extends BackgroundJobsHelper {
           case walletNotFound: WalletNotFoundError            => ZIO.unit
           case CredentialServiceError.RecordNotFound(_, _)    => ZIO.unit
           case CredentialServiceError.UnsupportedDidFormat(_) => ZIO.unit
-          case ((walletAccessContext, e)) =>
+          case failure: Failure                               => ??? // FIXME
+          case ((walletAccessContext, failure)) =>
             for {
               credentialService <- ZIO.service[CredentialService]
               _ <- credentialService
-                .reportProcessingFailure(record.id, Some(e.toString))
+                .reportProcessingFailure(record.id, Some(failure))
                 .provideSomeLayer(ZLayer.succeed(walletAccessContext))
             } yield ()
         }

diff --git a/...rver/src/main/scala/org/hyperledger/identus/agent/server/jobs/PresentBackgroundJobs.scala b/...rver/src/main/scala/org/hyperledger/identus/agent/server/jobs/PresentBackgroundJobs.scala
@@ -17,7 +17,6 @@ import org.hyperledger.identus.castor.core.model.error.DIDResolutionError as Cas
 import org.hyperledger.identus.castor.core.service.DIDService
 import org.hyperledger.identus.mercury.*
 import org.hyperledger.identus.mercury.model.*
-import org.hyperledger.identus.mercury.model.error.TransportError
 import org.hyperledger.identus.mercury.protocol.presentproof.*
 import org.hyperledger.identus.mercury.protocol.reportproblem.v2.{ProblemCode, ReportProblem}
 import org.hyperledger.identus.pollux.core.model.*
@@ -30,21 +29,23 @@ import org.hyperledger.identus.pollux.sdjwt.{HolderPrivateKey, IssuerPublicKey,
 import org.hyperledger.identus.pollux.vc.jwt.{DidResolver as JwtDidResolver, Issuer as JwtIssuer, JWT, JwtPresentation}
 import org.hyperledger.identus.resolvers.DIDResolver
 import org.hyperledger.identus.shared.http.*
-import org.hyperledger.identus.shared.models.WalletAccessContext
+import org.hyperledger.identus.shared.models.*
 import org.hyperledger.identus.shared.utils.aspects.CustomMetricsAspect
 import org.hyperledger.identus.shared.utils.DurationOps.toMetricsSeconds
 import zio.*
 import zio.json.*
 import zio.json.ast.Json
 import zio.metrics.*
 import zio.prelude.Validation
-import zio.prelude.ZValidation.*
+import zio.prelude.ZValidation.{Failure => ZFailure, *}
 
 import java.time.{Clock, Instant, ZoneId}
 
 object PresentBackgroundJobs extends BackgroundJobsHelper {
-  type ERROR = DIDSecretStorageError | PresentationError | CredentialServiceError | BackgroundJobError |
-    CastorDIDResolutionError | GetManagedDIDError | TransportError
+
+  private type ERROR =
+    /*DIDSecretStorageError | PresentationError | CredentialServiceError | BackgroundJobError | TransportError | */
+    CastorDIDResolutionError | GetManagedDIDError | Failure
 
   private type RESOURCES = COMMON_RESOURCES & CredentialService & JwtDidResolver & DIDService & AppConfig &
     MESSAGING_RESOURCES
@@ -82,7 +83,7 @@ object PresentBackgroundJobs extends BackgroundJobsHelper {
     aux(record)
       .tapError({
         (error: PresentationError | DIDSecretStorageError | BackgroundJobError | CredentialServiceError |
-          CastorDIDResolutionError | GetManagedDIDError | TransportError) =>
+          CastorDIDResolutionError | GetManagedDIDError | Failure) =>
           ZIO.logErrorCause(
             s"Present Proof - Error processing record: ${record.id}",
             Cause.fail(error)
@@ -533,7 +534,7 @@ object PresentBackgroundJobs extends BackgroundJobsHelper {
           requestPresentation: RequestPresentation
       ): ZIO[
         PresentationService & DIDNonSecretStorage,
-        PresentationError | DIDSecretStorageError | BackgroundJobError,
+        Failure,
         Unit
       ] = {
         maybeCredentialsToUseJson match {
@@ -645,7 +646,7 @@ object PresentBackgroundJobs extends BackgroundJobsHelper {
 
     def handlePresentationGenerated(id: DidCommID, presentation: Presentation): ZIO[
       JwtDidResolver & COMMON_RESOURCES & MESSAGING_RESOURCES,
-      PresentationError | DIDSecretStorageError | BackgroundJobError | TransportError,
+      Failure,
       Unit
     ] = {
 
@@ -712,7 +713,7 @@ object PresentBackgroundJobs extends BackgroundJobsHelper {
 
     def handleRequestPending(id: DidCommID, record: RequestPresentation): ZIO[
       JwtDidResolver & COMMON_RESOURCES & MESSAGING_RESOURCES,
-      PresentationError | DIDSecretStorageError | BackgroundJobError | TransportError,
+      Failure,
       Unit
     ] = {
       val VerifierSendPresentationRequestMsgSuccess = counterMetric(
@@ -800,7 +801,7 @@ object PresentBackgroundJobs extends BackgroundJobsHelper {
           credentialFormat: CredentialFormat
       ): ZIO[
         AppConfig & JwtDidResolver & COMMON_RESOURCES & MESSAGING_RESOURCES,
-        PresentationError | DIDSecretStorageError | TransportError,
+        Failure,
         Unit
       ] = {
         val result =
@@ -814,7 +815,7 @@ object PresentBackgroundJobs extends BackgroundJobsHelper {
 
       private def handleJWT(id: DidCommID, requestPresentation: RequestPresentation, presentation: Presentation): ZIO[
         AppConfig & JwtDidResolver & COMMON_RESOURCES & MESSAGING_RESOURCES,
-        PresentationError | DIDSecretStorageError | TransportError,
+        Failure,
         Unit
       ] = {
         val clock = java.time.Clock.system(ZoneId.systemDefault)
@@ -887,8 +888,8 @@ object PresentBackgroundJobs extends BackgroundJobsHelper {
               case any => ZIO.fail(PresentationReceivedError("Only Base64 Supported"))
             }
             _ <- credentialsClaimsValidationResult match
-              case l @ Failure(_, _) => ZIO.logError(s"CredentialsClaimsValidationResult: $l")
-              case l @ Success(_, _) => ZIO.logInfo(s"CredentialsClaimsValidationResult: $l")
+              case l @ ZFailure(_, _) => ZIO.logError(s"CredentialsClaimsValidationResult: $l")
+              case l @ Success(_, _)  => ZIO.logInfo(s"CredentialsClaimsValidationResult: $l")
             service <- ZIO.service[PresentationService]
             presReceivedToProcessedAspect = CustomMetricsAspect.endRecordingTime(
               s"${id}_present_proof_flow_verifier_presentation_received_to_verification_success_or_failure_ms_gauge",
@@ -899,7 +900,7 @@ object PresentBackgroundJobs extends BackgroundJobsHelper {
                 service
                   .markPresentationVerified(id)
                   .provideSomeLayer(ZLayer.succeed(walletAccessContext)) @@ presReceivedToProcessedAspect
-              case Failure(log, error) =>
+              case ZFailure(log, error) =>
                 for {
                   _ <- service
                     .markPresentationVerificationFailed(id)
@@ -928,7 +929,7 @@ object PresentBackgroundJobs extends BackgroundJobsHelper {
 
       private def handleSDJWT(id: DidCommID, presentation: Presentation): ZIO[
         JwtDidResolver & COMMON_RESOURCES & MESSAGING_RESOURCES,
-        PresentationError | DIDSecretStorageError | TransportError,
+        Failure,
         Unit
       ] = {
         for {
@@ -997,7 +998,7 @@ object PresentBackgroundJobs extends BackgroundJobsHelper {
           presentation: Presentation
       ): ZIO[
         PresentationService & DIDNonSecretStorage & MESSAGING_RESOURCES,
-        PresentationError | DIDSecretStorageError | TransportError,
+        PresentationError | DIDSecretStorageError,
         Unit
       ] = {
         for {

diff --git a/...er/src/main/scala/org/hyperledger/identus/didcomm/controller/DIDCommControllerError.scala b/...er/src/main/scala/org/hyperledger/identus/didcomm/controller/DIDCommControllerError.scala
@@ -3,49 +3,39 @@ package org.hyperledger.identus.didcomm.controller
 import org.hyperledger.identus.mercury.model.DidId
 import org.hyperledger.identus.shared.models.{Failure, StatusCode}
 
-sealed trait DIDCommControllerError(
-    val statusCode: StatusCode,
-    val userFacingMessage: String
-) extends Failure {
-  override val namespace = "DIDCommControllerError"
+sealed trait DIDCommControllerError extends Failure {
+  override def namespace = "DIDCommControllerError"
 }
 
 object DIDCommControllerError {
-  final case class InvalidContentType(maybeContentType: Option[String])
-      extends DIDCommControllerError(
-        StatusCode.BadRequest,
-        maybeContentType match
-          case Some(value) => s"The 'content-type' request header value is invalid: $value"
-          case None        => s"The 'content-type' request header is undefined"
-      )
-
-  final case class RecipientNotFoundError()
-      extends DIDCommControllerError(
-        StatusCode.UnprocessableContent,
-        "Recipient not found in the DIDComm Message"
-      )
-
-  final case class UnexpectedError(override val statusCode: StatusCode)
-      extends DIDCommControllerError(
-        statusCode,
-        "An unexpected error occurred while processing your request"
-      )
-
-  final case class RequestBodyParsingError(cause: String)
-      extends DIDCommControllerError(
-        StatusCode.BadRequest,
-        s"Unable to parse the request body as a valid DIDComm message: $cause"
-      )
-
-  final case class PeerDIDNotFoundError(did: DidId)
-      extends DIDCommControllerError(
-        StatusCode.UnprocessableContent,
-        s"The Peer DID was not found in this agent: ${did.value}"
-      )
-
-  final case class PeerDIDKeyNotFoundError(did: DidId, keyId: String)
-      extends DIDCommControllerError(
-        StatusCode.UnprocessableContent,
-        s"The Peer DID does not contain the required key: DID=$did, keyId=$keyId"
-      )
+  final case class InvalidContentType(maybeContentType: Option[String]) extends DIDCommControllerError {
+    override def statusCode: StatusCode = StatusCode.BadRequest
+    override def userFacingMessage: String = maybeContentType match
+      case Some(value) => s"The 'content-type' request header value is invalid: $value"
+      case None        => s"The 'content-type' request header is undefined"
+  }
+
+  object RecipientNotFoundError extends DIDCommControllerError {
+    override def statusCode: StatusCode = StatusCode.UnprocessableContent
+    override def userFacingMessage: String = "Recipient not found in the DIDComm Message"
+  }
+
+  final case class UnexpectedError(statusCode: StatusCode) extends DIDCommControllerError {
+    override def userFacingMessage: String = "An unexpected error occurred while processing your request"
+  }
+
+  final case class RequestBodyParsingError(cause: String) extends DIDCommControllerError {
+    override def statusCode: StatusCode = StatusCode.BadRequest
+    override def userFacingMessage: String = s"Unable to parse the request body as a valid DIDComm message: $cause"
+  }
+
+  final case class PeerDIDNotFoundError(did: DidId) extends DIDCommControllerError {
+    override def statusCode: StatusCode = StatusCode.UnprocessableContent
+    override def userFacingMessage: String = s"The Peer DID was not found in this agent: ${did.value}"
+  }
+
+  final case class PeerDIDKeyNotFoundError(did: DidId, keyId: String) extends DIDCommControllerError {
+    override def statusCode: StatusCode = StatusCode.UnprocessableContent
+    override def userFacingMessage: String = s"The Peer DID does not contain the required key: DID=$did, keyId=$keyId"
+  }
 }
diff --git a/...ver/src/main/scala/org/hyperledger/identus/didcomm/controller/DIDCommControllerImpl.scala b/...ver/src/main/scala/org/hyperledger/identus/didcomm/controller/DIDCommControllerImpl.scala
@@ -71,7 +71,7 @@ class DIDCommControllerImpl(
     for {
       recipientDid <- ZIO
         .fromOption(msg.recipients.headOption.map(_.header.kid.split("#")(0)))
-        .mapError(_ => RecipientNotFoundError())
+        .mapError(_ => RecipientNotFoundError)
       _ <- ZIO.logInfo(s"Extracted recipient Did => $recipientDid")
       didId = DidId(recipientDid)
       maybePeerDIDRecord <- didNonSecretStorage.getPeerDIDRecord(didId).orDie

diff --git a/...rc/main/scala/org/hyperledger/identus/oid4vci/controller/CredentialIssuerController.scala b/...rc/main/scala/org/hyperledger/identus/oid4vci/controller/CredentialIssuerController.scala
@@ -166,8 +166,9 @@ case class CredentialIssuerControllerImpl(
               ZIO.unit,
               ZIO.fail(OIDCCredentialIssuerService.Errors.InvalidProof("Invalid proof"))
             )
-            .mapError { case InvalidProof(message) =>
-              badRequestInvalidProof(jwt, message)
+            .mapError {
+              case InvalidProof(message)       => badRequestInvalidProof(jwt, message)
+              case DIDResolutionError(message) => badRequestInvalidProof(jwt, message)
             }
           nonce <- getNonceFromJwt(JWT(jwt))
             .mapError(throwable => badRequestInvalidProof(jwt, throwable.getMessage))
@@ -180,15 +181,17 @@ case class CredentialIssuerControllerImpl(
           sessionWithSubjectDid <- credentialIssuerService
             .updateIssuanceSession(session.withSubjectDid(subjectDid))
             .mapError(ue =>
-              serverError(Some(s"Unexpected error while updating issuance session with subject DID: ${ue.message}"))
+              serverError(
+                Some(s"Unexpected error while updating issuance session with subject DID: ${ue.userFacingMessage}")
+              )
             )
           credentialDefinition <- ZIO
             .fromOption(maybeCredentialDefinition)
             .mapError(_ => badRequestUnsupportedCredentialType("No credential definition provided"))
           validatedCredentialDefinition <- credentialIssuerService
             .validateCredentialDefinition(credentialDefinition)
             .mapError(ue =>
-              serverError(Some(s"Unexpected error while validating credential definition: ${ue.message}"))
+              serverError(Some(s"Unexpected error while validating credential definition: ${ue.userFacingMessage}"))
             )
           credential <- credentialIssuerService
             .issueJwtCredential(
@@ -198,9 +201,11 @@ case class CredentialIssuerControllerImpl(
               maybeCredentialIdentifier,
               validatedCredentialDefinition
             )
-            .mapError(ue => serverError(Some(s"Unexpected error while issuing credential: ${ue.message}")))
+            .mapError(ue => serverError(Some(s"Unexpected error while issuing credential: ${ue.userFacingMessage}")))
         } yield ImmediateCredentialResponse(credential.value)
       case None => ZIO.fail(badRequestInvalidProof(jwt = "empty", details = "No proof provided"))
+      // case Some(CwtProof(_, _)) => ??? // TODO
+      // case Some(LdpProof(_, _)) => ??? // TODO
     }
   }
 
@@ -223,7 +228,9 @@ case class CredentialIssuerControllerImpl(
         )
         .map(offer => CredentialOfferResponse(offer.offerUri))
         .mapError(ue =>
-          internalServerError(detail = Some(s"Unexpected error while creating credential offer: ${ue.message}"))
+          internalServerError(detail =
+            Some(s"Unexpected error while creating credential offer: ${ue.userFacingMessage}")
+          )
         )
     } yield resp
   }
@@ -236,7 +243,7 @@ case class CredentialIssuerControllerImpl(
       .getIssuanceSessionByIssuerState(request.issuerState)
       .map(session => NonceResponse(session.nonce))
       .mapError(ue =>
-        internalServerError(detail = Some(s"Unexpected error while creating credential offer: ${ue.message}"))
+        internalServerError(detail = Some(s"Unexpected error while creating credential offer: ${ue.userFacingMessage}"))
       )
   }