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

Optimize some zio.http.endpoint.Endpoint code #3213

Merged
merged 8 commits into from
Dec 24, 2024
Merged

Optimize some zio.http.endpoint.Endpoint code #3213

Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
0f11e9a
Optimize some `zio.http.endpoint.Endpoint` code
guizmaii Nov 19, 2024
ab6e100
fix compilation && fmt
guizmaii Nov 26, 2024
e5d11f4
Merge branch 'main' into optimise/handlers
guizmaii Dec 3, 2024
e7b1afb
Review: fix formatting
guizmaii Dec 5, 2024
112aba7
Merge branch 'main' into optimise/handlers
987Nabil Dec 14, 2024
f284275
Merge branch 'main' into optimise/handlers
guizmaii Dec 14, 2024
e453ac9
Merge branch 'main' into optimise/handlers
guizmaii Dec 16, 2024
5647dd6
Merge branch 'main' into optimise/handlers
987Nabil Dec 24, 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
102 changes: 52 additions & 50 deletions zio-http/shared/src/main/scala/zio/http/endpoint/Endpoint.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,8 @@ final case class Endpoint[PathInput, Input, Err, Output, Auth <: AuthType](
codecError: HttpCodec[HttpCodecType.ResponseType, HttpCodecError],
documentation: Doc,
authType: Auth,
) { self =>
) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unrelated and unnecessary format change

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

self =>

val authCombiner: Combiner[Input, authType.ClientRequirement] =
implicitly[Combiner[Input, authType.ClientRequirement]]
Expand All @@ -67,6 +68,7 @@ final case class Endpoint[PathInput, Input, Err, Output, Auth <: AuthType](
): HttpCodec[HttpCodecType.RequestType, AuthedInput] = {
input ++ authCodec
}.asInstanceOf[HttpCodec[HttpCodecType.RequestType, AuthedInput]]

type AuthedInput = authCombiner.Out

/**
Expand Down Expand Up @@ -257,34 +259,35 @@ final case class Endpoint[PathInput, Input, Err, Output, Auth <: AuthType](
def implementHandler[Env](original: Handler[Env, Err, Input, Output])(implicit trace: Trace): Route[Env, Nothing] = {
import HttpCodecError.asHttpCodecError

def authCodec(authType: AuthType): HttpCodec[HttpCodecType.RequestType, Unit] = authType match {
case AuthType.None => HttpCodec.empty
case AuthType.Basic =>
HeaderCodec.authorization.transformOrFail {
case Header.Authorization.Basic(_, _) => Right(())
case _ => Left("Basic auth required")
} { case () =>
Left("Unsupported")
}
case AuthType.Bearer =>
HeaderCodec.authorization.transformOrFail {
case Header.Authorization.Bearer(_) => Right(())
case _ => Left("Bearer auth required")
} { case () =>
Left("Unsupported")
}
case AuthType.Digest =>
HeaderCodec.authorization.transformOrFail {
case _: Header.Authorization.Digest => Right(())
case _ => Left("Digest auth required")
} { case () =>
Left("Unsupported")
}
case AuthType.Custom(codec) =>
codec.transformOrFailRight[Unit](_ => ())(_ => Left("Unsupported"))
case AuthType.Or(auth1, auth2, _) =>
authCodec(auth1).orElseEither(authCodec(auth2))(Alternator.leftRightEqual[Unit])
}
def authCodec(authType: AuthType): HttpCodec[HttpCodecType.RequestType, Unit] =
authType match {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unrelated and unnecessary format change

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

case AuthType.None => HttpCodec.empty
case AuthType.Basic =>
HeaderCodec.authorization.transformOrFail {
case Header.Authorization.Basic(_, _) => Right(())
case _ => Left("Basic auth required")
} { case () =>
Left("Unsupported")
}
case AuthType.Bearer =>
HeaderCodec.authorization.transformOrFail {
case Header.Authorization.Bearer(_) => Right(())
case _ => Left("Bearer auth required")
} { case () =>
Left("Unsupported")
}
case AuthType.Digest =>
HeaderCodec.authorization.transformOrFail {
case _: Header.Authorization.Digest => Right(())
case _ => Left("Digest auth required")
} { case () =>
Left("Unsupported")
}
case AuthType.Custom(codec) =>
codec.transformOrFailRight[Unit](_ => ())(_ => Left("Unsupported"))
case AuthType.Or(auth1, auth2, _) =>
authCodec(auth1).orElseEither(authCodec(auth2))(Alternator.leftRightEqual[Unit])
}

val maybeUnauthedResponse = authType.asInstanceOf[AuthType] match {
case AuthType.None => None
Expand All @@ -295,13 +298,11 @@ final case class Endpoint[PathInput, Input, Err, Output, Auth <: AuthType](
self.alternatives.map { case (endpoint, condition) =>
Handler.fromFunctionZIO { (request: zio.http.Request) =>
val outputMediaTypes =
NonEmptyChunk
.fromChunk(
request.headers
.getAll(Header.Accept)
.flatMap(_.mimeTypes),
)
.getOrElse(defaultMediaTypes)
request.headers
.getAll(Header.Accept)
.flatMap(_.mimeTypes)
.nonEmptyOrElse(defaultMediaTypes)(ZIO.identityFn)

(endpoint.input ++ authCodec(endpoint.authType)).decodeRequest(request, config).orDie.flatMap { value =>
original(value).map(endpoint.output.encodeResponse(_, outputMediaTypes, config)).catchAll { error =>
ZIO.succeed(endpoint.error.encodeResponse(error, outputMediaTypes, config))
Expand All @@ -311,15 +312,17 @@ final case class Endpoint[PathInput, Input, Err, Output, Auth <: AuthType](
}

// TODO: What to do if there are no endpoints??
def handlers2(handlers: Chunk[(Handler[Env, Nothing, Request, Response], HttpCodec.Fallback.Condition)]) =
NonEmptyChunk
.fromChunk(handlers)
.getOrElse(
NonEmptyChunk(
Handler.fail(zio.http.Response(status = Status.NotFound)) -> HttpCodec.Fallback.Condition.IsHttpCodecError,
),
def handlers2(
handlers: Chunk[(Handler[Env, Nothing, Request, Response], HttpCodec.Fallback.Condition)],
): NonEmptyChunk[(Handler[Env, Response, Request, Response], HttpCodec.Fallback.Condition)] = {
def noFound: NonEmptyChunk[(Handler[Env, Response, Request, Response], HttpCodec.Fallback.Condition)] =
NonEmptyChunk(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't we make this a constant?

Handler.fail(zio.http.Response(status = Status.NotFound)) -> HttpCodec.Fallback.Condition.IsHttpCodecError,
)

handlers.nonEmptyOrElse(ifEmpty = noFound)(ZIO.identityFn)
}

val handler =
Handler.fromZIO(CodecConfig.codecRef.get).flatMap { config =>
val hdlrs = handlers(config)
Expand All @@ -343,13 +346,12 @@ final case class Endpoint[PathInput, Input, Err, Output, Auth <: AuthType](
val error = cause.defects.head.asInstanceOf[HttpCodecError]
val response = {
val outputMediaTypes =
NonEmptyChunk
.fromChunk(
request.headers
.getAll(Header.Accept)
.flatMap(_.mimeTypes) :+ MediaTypeWithQFactor(MediaType.application.`json`, Some(0.0)),
)
.getOrElse(defaultMediaTypes)
(
request.headers
.getAll(Header.Accept)
.flatMap(_.mimeTypes) :+ MediaTypeWithQFactor(MediaType.application.`json`, Some(0.0))
).nonEmptyOrElse(defaultMediaTypes)(ZIO.identityFn)

codecError.encodeResponse(error, outputMediaTypes, config)
}
ZIO.succeed(response)
Expand Down
Loading