sttp.tapir.server.akkahttp.AkkaStreamSizeExceptionInterceptor.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tapir-akka-http-server_2.13 Show documentation

tapir-akka-http-server

There is a newer version: 1.11.9

Show newest version

package sttp.tapir.server.akkahttp

import akka.http.scaladsl.model.EntityStreamSizeException
import sttp.capabilities.StreamMaxLengthExceededException
import sttp.monad.MonadError
import sttp.tapir.server.interceptor.exception.{ExceptionContext, ExceptionHandler, ExceptionInterceptor}
import sttp.tapir.server.model.ValuedEndpointOutput

import scala.concurrent.Future

/** Used by AkkaHttpServerInterpreter to catch specific scenarios related to exceeding max content length in requests:
  *   - EntityStreamSizeException thrown when InputBody is an Akka Stream, which exceeds max length limit during processing in serverLogic.
  *   - A wrapped EntityStreamSizeException failure, a variant of previous scenario where additional stage (like FileIO sink) wraps the
  *     underlying cause into another exception.
  *   - An InputStreamBody throws an IOException(EntityStreamSizeException) when reading the input stream fails due to exceeding max length
  *     limit in the underlying Akka Stream.
  *
  * All these scenarios mean basically the same, so we'll fail with our own StreamMaxLengthExceededException, a general mechanism intended
  * to be handled by Tapir and result in a HTTP 413 Payload Too Large response.
  */
private[akkahttp] object AkkaStreamSizeExceptionInterceptor
    extends ExceptionInterceptor[Future](new ExceptionHandler[Future] {
      override def apply(ctx: ExceptionContext)(implicit monad: MonadError[Future]): Future[Option[ValuedEndpointOutput[_]]] = {
        ctx.e match {
          case ex: Exception if ex.getCause().isInstanceOf[EntityStreamSizeException] =>
            monad.error(StreamMaxLengthExceededException(ex.getCause().asInstanceOf[EntityStreamSizeException].limit))
          case EntityStreamSizeException(limit, _) =>
            monad.error(StreamMaxLengthExceededException(limit))
          case other =>
            monad.error(other)
        }
      }
    })