Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Implement codec error handling #3204

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Implement codec error handling #3204

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f75748c
Implement codec error handling
asr2003 Nov 9, 2024
9824fdf
Make Mima happier
asr2003 Nov 11, 2024
b050aba
alter approach to make mima happier
asr2003 Nov 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 42 additions & 4 deletions zio-http/shared/src/main/scala/zio/http/ErrorResponseConfig.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,19 +22,57 @@ final case class ErrorResponseConfig(
withStackTrace: Boolean = false,
maxStackTraceDepth: Int = 10,
errorFormat: ErrorResponseConfig.ErrorFormat = ErrorResponseConfig.ErrorFormat.Html,
)
logCodecErrors: Boolean = false
) {

/**
* Backward-compatible copy method for compatibility with older code.
*
* Omits the new `logCodecErrors` parameter, which defaults to `false` in
* older usage scenarios.
*/
def copy(
withErrorBody: Boolean = this.withErrorBody,
withStackTrace: Boolean = this.withStackTrace,
maxStackTraceDepth: Int = this.maxStackTraceDepth,
errorFormat: ErrorResponseConfig.ErrorFormat = this.errorFormat
): ErrorResponseConfig =
new ErrorResponseConfig(withErrorBody, withStackTrace, maxStackTraceDepth, errorFormat, logCodecErrors)

/**
* Full copy method including all parameters.
*/
def copyWithLog(
withErrorBody: Boolean = this.withErrorBody,
withStackTrace: Boolean = this.withStackTrace,
maxStackTraceDepth: Int = this.maxStackTraceDepth,
errorFormat: ErrorResponseConfig.ErrorFormat = this.errorFormat,
logCodecErrors: Boolean = this.logCodecErrors
): ErrorResponseConfig =
new ErrorResponseConfig(withErrorBody, withStackTrace, maxStackTraceDepth, errorFormat, logCodecErrors)
}

object ErrorResponseConfig {
sealed trait ErrorFormat { val mediaType: MediaType }
object ErrorFormat {
object ErrorFormat {
case object Text extends ErrorFormat { val mediaType: MediaType = MediaType.text.`plain` }
case object Html extends ErrorFormat { val mediaType: MediaType = MediaType.text.html }
case object Json extends ErrorFormat { val mediaType: MediaType = MediaType.application.json }
}

val default: ErrorResponseConfig = ErrorResponseConfig()
// Backward-compatible apply method for older usage, without logCodecErrors
def apply(
withErrorBody: Boolean,
withStackTrace: Boolean,
maxStackTraceDepth: Int,
errorFormat: ErrorFormat
): ErrorResponseConfig =
new ErrorResponseConfig(withErrorBody, withStackTrace, maxStackTraceDepth, errorFormat, logCodecErrors = false)

val default: ErrorResponseConfig = ErrorResponseConfig()

val debugConfig: ErrorResponseConfig =
ErrorResponseConfig(withErrorBody = true, withStackTrace = true, maxStackTraceDepth = 0)
ErrorResponseConfig(withErrorBody = true, withStackTrace = true, maxStackTraceDepth = 0, logCodecErrors = true)

private[http] val configRef: FiberRef[ErrorResponseConfig] =
FiberRef.unsafe.make(default)(Unsafe)
Expand Down
53 changes: 45 additions & 8 deletions zio-http/shared/src/main/scala/zio/http/codec/HttpContentCodec.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,23 @@ sealed trait HttpContentCodec[A] { self =>
lookup(contentType) match {
case Some((_, codec)) =>
request.body.asChunk.flatMap { bytes =>
ZIO.fromEither(codec.codec(config).decode(bytes))
ZIO
.fromEither(codec.codec(config).decode(bytes))
.mapError(_ => CodecDecodeError(s"Failed to decode request body for media type: $contentType"))
.tapError(error =>
ErrorResponseConfig.configRef.get.flatMap { errConfig =>
if (errConfig.logCodecErrors) ZIO.logWarning(error.getMessage) else ZIO.unit
},
)
}
case None =>
ZIO.fail(throw new IllegalArgumentException(s"No codec found for content type $contentType"))
ZIO
.fail(UnsupportedMediaTypeError(contentType))
.tapError(error =>
ErrorResponseConfig.configRef.get.flatMap { errConfig =>
if (errConfig.logCodecErrors) ZIO.logWarning(error.getMessage) else ZIO.unit
},
)
}
}

Expand All @@ -47,10 +60,23 @@ sealed trait HttpContentCodec[A] { self =>
lookup(contentType) match {
case Some((_, codec)) =>
response.body.asChunk.flatMap { bytes =>
ZIO.fromEither(codec.codec(config).decode(bytes))
ZIO
.fromEither(codec.codec(config).decode(bytes))
.mapError(_ => CodecDecodeError(s"Failed to decode response body for media type: $contentType"))
.tapError(error =>
ErrorResponseConfig.configRef.get.flatMap { errConfig =>
if (errConfig.logCodecErrors) ZIO.logWarning(error.getMessage) else ZIO.unit
},
)
}
case None =>
ZIO.fail(throw new IllegalArgumentException(s"No codec found for content type $contentType"))
ZIO
.fail(UnsupportedMediaTypeError(contentType))
.tapError(error =>
ErrorResponseConfig.configRef.get.flatMap { errConfig =>
if (errConfig.logCodecErrors) ZIO.logWarning(error.getMessage) else ZIO.unit
},
)
}
}

Expand Down Expand Up @@ -112,9 +138,9 @@ sealed trait HttpContentCodec[A] { self =>

private[http] def chooseFirstOrDefault(
mediaTypes: Chunk[MediaTypeWithQFactor],
): (MediaType, BinaryCodecWithSchema[A]) =
): Either[UnsupportedMediaTypeError, (MediaType, BinaryCodecWithSchema[A])] =
if (mediaTypes.isEmpty) {
(defaultMediaType, defaultBinaryCodecWithSchema)
Right((defaultMediaType, defaultBinaryCodecWithSchema))
} else {
var i = 0
var result: (MediaType, BinaryCodecWithSchema[A]) = null
Expand All @@ -124,8 +150,10 @@ sealed trait HttpContentCodec[A] { self =>
if (lookupResult.isDefined) result = lookupResult.get
i += 1
}
if (result == null) (defaultMediaType, defaultBinaryCodecWithSchema)
else result
if (result == null) {
ZIO.logWarning(s"Unsupported media type: ${mediaTypes.head.mediaType}")
Right((defaultMediaType, defaultBinaryCodecWithSchema))
} else Right(result)
}

def lookup(mediaType: MediaType): Option[(MediaType, BinaryCodecWithSchema[A])]
Expand Down Expand Up @@ -180,6 +208,15 @@ sealed trait HttpContentCodec[A] { self =>

}

sealed trait CodecError extends Throwable
case class UnsupportedMediaTypeError(mediaType: MediaType) extends CodecError {
override def getMessage: String = s"Unsupported media type: $mediaType"
}

case class CodecDecodeError(details: String) extends CodecError {
override def getMessage: String = s"Codec decode error: $details"
}

object HttpContentCodec {
final case class Choices[A](
choices: ListMap[MediaType, BinaryCodecWithSchema[A]],
Expand Down
77 changes: 49 additions & 28 deletions zio-http/shared/src/main/scala/zio/http/codec/internal/BodyCodec.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,9 +109,11 @@ private[http] object BodyCodec {

final case class Single[A](codec: HttpContentCodec[A], name: Option[String]) extends BodyCodec[A] {

def mediaType(accepted: Chunk[MediaTypeWithQFactor]): Option[MediaType] =
Some(codec.chooseFirstOrDefault(accepted)._1)

def mediaType(accepted: Chunk[MediaTypeWithQFactor]): Option[MediaType] =
codec.chooseFirstOrDefault(accepted) match {
case Right((mediaType, _)) => Some(mediaType)
case Left(_) => None
}
def decodeFromField(field: FormField, config: CodecConfig)(implicit trace: Trace): IO[Throwable, A] = {
val codec0 = codec
.lookup(field.contentType)
Expand Down Expand Up @@ -139,27 +141,36 @@ private[http] object BodyCodec {
def encodeToField(value: A, mediaTypes: Chunk[MediaTypeWithQFactor], name: String, config: CodecConfig)(implicit
trace: Trace,
): FormField = {
val (mediaType, bc @ BinaryCodecWithSchema(_, _)) = codec.chooseFirstOrDefault(mediaTypes)
if (mediaType.binary) {
FormField.binaryField(
name,
bc.codec(config).encode(value),
mediaType,
)
} else {
FormField.textField(
name,
bc.codec(config).encode(value).asString,
mediaType,
)
codec.chooseFirstOrDefault(mediaTypes) match {

case Right((mediaType, bc @ BinaryCodecWithSchema(_, _))) =>
if (mediaType.binary) {
FormField.binaryField(
name,
bc.codec(config).encode(value),
mediaType,
)
} else {
FormField.textField(
name,
bc.codec(config).encode(value).asString,
mediaType,
)
}
case Left(error) =>
throw new IllegalArgumentException(s"Unsupported media type: ${error.mediaType}")
}
}

def encodeToBody(value: A, mediaTypes: Chunk[MediaTypeWithQFactor], config: CodecConfig)(implicit
trace: Trace,
): Body = {
val (mediaType, bc @ BinaryCodecWithSchema(_, _)) = codec.chooseFirstOrDefault(mediaTypes)
Body.fromChunk(bc.codec(config).encode(value), mediaType)
codec.chooseFirstOrDefault(mediaTypes) match {
case Right((mediaType, bc @ BinaryCodecWithSchema(_, _))) =>
Body.fromChunk(bc.codec(config).encode(value), mediaType)
case Left(error) =>
throw new IllegalArgumentException(s"Unsupported media type: ${error.mediaType}")
}
}

type Element = A
Expand All @@ -169,8 +180,10 @@ private[http] object BodyCodec {
extends BodyCodec[ZStream[Any, Nothing, E]] {

def mediaType(accepted: Chunk[MediaTypeWithQFactor]): Option[MediaType] =
Some(codec.chooseFirstOrDefault(accepted)._1)

codec.chooseFirstOrDefault(accepted) match {
case Right((mediaType, _)) => Some(mediaType)
case Left(_) => None
}
override def decodeFromField(field: FormField, config: CodecConfig)(implicit
trace: Trace,
): IO[Throwable, ZStream[Any, Nothing, E]] =
Expand Down Expand Up @@ -200,12 +213,16 @@ private[http] object BodyCodec {
)(implicit
trace: Trace,
): FormField = {
val (mediaType, bc) = codec.chooseFirstOrDefault(mediaTypes)
FormField.streamingBinaryField(
name,
value >>> bc.codec(config).streamEncoder,
mediaType,
)
codec.chooseFirstOrDefault(mediaTypes) match {
case Right((mediaType, bc)) =>
FormField.streamingBinaryField(
name,
value >>> bc.codec(config).streamEncoder,
mediaType,
)
case Left(error) =>
throw new IllegalArgumentException(s"Unsupported media type: ${error.mediaType}")
}
}

override def encodeToBody(
Expand All @@ -215,8 +232,12 @@ private[http] object BodyCodec {
)(implicit
trace: Trace,
): Body = {
val (mediaType, bc @ BinaryCodecWithSchema(_, _)) = codec.chooseFirstOrDefault(mediaTypes)
Body.fromStreamChunked(value >>> bc.codec(config).streamEncoder).contentType(mediaType)
codec.chooseFirstOrDefault(mediaTypes) match {
case Right((mediaType, bc @ BinaryCodecWithSchema(_, _))) =>
Body.fromStreamChunked(value >>> bc.codec(config).streamEncoder).contentType(mediaType)
case Left(error) =>
throw new IllegalArgumentException(s"Unsupported media type: ${error.mediaType}")
}
}

type Element = E
Expand Down
Loading