Skip to content

Commit

Permalink
refactor: simplify health route setup (#2337)
Browse files Browse the repository at this point in the history
  • Loading branch information
@seakayone
seakayone committed Dec 12, 2022
1 parent 3a222bb commit 26e9596
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 114 deletions.
9 changes: 5 additions & 4 deletions webapi/src/main/scala/org/knora/webapi/core/HttpServerWithZIOHttp.scala
View file
Expand Up @@ -10,15 +10,16 @@ import zio.ZLayer
import zio._

import org.knora.webapi.config.AppConfig
import org.knora.webapi.core._
import org.knora.webapi.routing.ApiRoutesWithZIOHttp
import org.knora.webapi.routing.HealthRouteWithZIOHttp

object HttpServerWithZIOHttp {
val layer: ZLayer[AppConfig & State & ApiRoutesWithZIOHttp, Nothing, Unit] =

val routes = HealthRouteWithZIOHttp()

val layer: ZLayer[AppConfig & State, Nothing, Unit] =
ZLayer {
for {
appConfig <- ZIO.service[AppConfig]
routes <- ZIO.service[ApiRoutesWithZIOHttp].map(_.routes)
port = appConfig.knoraApi.externalZioPort
_ <- Server.start(port, routes).forkDaemon
_ <- ZIO.logInfo(">>> Acquire ZIO HTTP Server <<<")
Expand Down
4 changes: 0 additions & 4 deletions webapi/src/main/scala/org/knora/webapi/core/LayersLive.scala
View file
Expand Up @@ -11,8 +11,6 @@ import zio.ZLayer
import org.knora.webapi.auth.JWTService
import org.knora.webapi.config.AppConfig
import org.knora.webapi.routing.ApiRoutes
import org.knora.webapi.routing.ApiRoutesWithZIOHttp
import org.knora.webapi.routing.HealthRouteWithZIOHttp
import org.knora.webapi.store.cache.CacheServiceManager
import org.knora.webapi.store.cache.api.CacheService
import org.knora.webapi.store.cache.impl.CacheServiceInMemImpl
Expand Down Expand Up @@ -52,8 +50,6 @@ object LayersLive {
ZLayer.make[DspEnvironmentLive](
ActorSystem.layer,
ApiRoutes.layer,
ApiRoutesWithZIOHttp.layer, // this is the new layer that composes all new routes
HealthRouteWithZIOHttp.layer, // this is the new health route
AppConfig.live,
AppRouter.layer,
CacheServiceManager.layer,
Expand Down
33 changes: 0 additions & 33 deletions webapi/src/main/scala/org/knora/webapi/routing/ApiRoutesWithZIOHttp.scala
View file

This file was deleted.

106 changes: 33 additions & 73 deletions webapi/src/main/scala/org/knora/webapi/routing/HealthRouteWithZIOHttp.scala
View file
Expand Up @@ -14,55 +14,42 @@ import org.knora.webapi.core.State
import org.knora.webapi.core.domain.AppState

/**
* Provides health check logic
* Provides the '/healthZ' endpoint serving the health status.
*/
trait HealthCheckWithZIOHttp {
object HealthRouteWithZIOHttp {

/**
* gets the application state from a state service called `State`
*
* @param state the state service
* @return a response with the application state
*/
protected def healthCheck(state: State): UIO[Response] =
for {
_ <- ZIO.logDebug("get application state")
state <- state.getAppState
result <- setHealthState(state)
_ <- ZIO.logDebug("set health state")
response <- createResponse(result)
_ <- ZIO.logDebug("getting application state done")
} yield response
def apply(): HttpApp[State, Nothing] =
Http.collectZIO[Request] { case Method.GET -> !! / "healthZ" =>
State.getAppState.map(toHealthCheckResult).flatMap(createResponse)
}

/**
* sets the application's health state to healthy or unhealthy according to the provided state
* Transforms the [[AppState]] into a [[HealthCheckResult]]
*
* @param state the application's state
* @return the result which is either unhealthy or healthy
* @return the result which is either unhealthy or healthy, containing a human readable explanation in case of unhealthy
*/
private def setHealthState(state: AppState): UIO[HealthCheckResult] =
ZIO.succeed(
state match {
case AppState.Stopped => unhealthy("Stopped. Please retry later.")
case AppState.StartingUp => unhealthy("Starting up. Please retry later.")
case AppState.WaitingForTriplestore => unhealthy("Waiting for triplestore. Please retry later.")
case AppState.TriplestoreReady => unhealthy("Triplestore ready. Please retry later.")
case AppState.UpdatingRepository => unhealthy("Updating repository. Please retry later.")
case AppState.RepositoryUpToDate => unhealthy("Repository up to date. Please retry later.")
case AppState.CreatingCaches => unhealthy("Creating caches. Please retry later.")
case AppState.CachesReady => unhealthy("Caches ready. Please retry later.")
case AppState.UpdatingSearchIndex => unhealthy("Updating search index. Please retry later.")
case AppState.SearchIndexReady => unhealthy("Search index ready. Please retry later.")
case AppState.LoadingOntologies => unhealthy("Loading ontologies. Please retry later.")
case AppState.OntologiesReady => unhealthy("Ontologies ready. Please retry later.")
case AppState.WaitingForIIIFService => unhealthy("Waiting for IIIF service. Please retry later.")
case AppState.IIIFServiceReady => unhealthy("IIIF service ready. Please retry later.")
case AppState.WaitingForCacheService => unhealthy("Waiting for cache service. Please retry later.")
case AppState.CacheServiceReady => unhealthy("Cache service ready. Please retry later.")
case AppState.MaintenanceMode => unhealthy("Application is in maintenance mode. Please retry later.")
case AppState.Running => healthy
}
)
private def toHealthCheckResult(state: AppState): HealthCheckResult =
state match {
case AppState.Stopped => unhealthy("Stopped. Please retry later.")
case AppState.StartingUp => unhealthy("Starting up. Please retry later.")
case AppState.WaitingForTriplestore => unhealthy("Waiting for triplestore. Please retry later.")
case AppState.TriplestoreReady => unhealthy("Triplestore ready. Please retry later.")
case AppState.UpdatingRepository => unhealthy("Updating repository. Please retry later.")
case AppState.RepositoryUpToDate => unhealthy("Repository up to date. Please retry later.")
case AppState.CreatingCaches => unhealthy("Creating caches. Please retry later.")
case AppState.CachesReady => unhealthy("Caches ready. Please retry later.")
case AppState.UpdatingSearchIndex => unhealthy("Updating search index. Please retry later.")
case AppState.SearchIndexReady => unhealthy("Search index ready. Please retry later.")
case AppState.LoadingOntologies => unhealthy("Loading ontologies. Please retry later.")
case AppState.OntologiesReady => unhealthy("Ontologies ready. Please retry later.")
case AppState.WaitingForIIIFService => unhealthy("Waiting for IIIF service. Please retry later.")
case AppState.IIIFServiceReady => unhealthy("IIIF service ready. Please retry later.")
case AppState.WaitingForCacheService => unhealthy("Waiting for cache service. Please retry later.")
case AppState.CacheServiceReady => unhealthy("Cache service ready. Please retry later.")
case AppState.MaintenanceMode => unhealthy("Application is in maintenance mode. Please retry later.")
case AppState.Running => healthy
}

/**
* creates the HTTP response from the health check result (healthy/unhealthy)
Expand Down Expand Up @@ -103,10 +90,10 @@ trait HealthCheckWithZIOHttp {
/**
* The result of a health check which is either unhealthy or healthy.
*
* @param name ???
* @param severity ???
* @param status the status (either false = unhealthy or true = healthy)
* @param message the message
* @param name ???
* @param severity ???
* @param status the status (either false = unhealthy or true = healthy)
* @param message the message
*/
private case class HealthCheckResult(name: String, severity: String, status: Boolean, message: String)

Expand All @@ -126,30 +113,3 @@ trait HealthCheckWithZIOHttp {
message = "Application is healthy"
)
}

/**
* Provides the '/healthZ' endpoint serving the health status.
*/
final case class HealthRouteWithZIOHttp(state: State) extends HealthCheckWithZIOHttp {

/**
* Returns the route.
*/
val route: HttpApp[State, Nothing] =
Http.collectZIO[Request] { case Method.GET -> !! / "healthZ" =>
for {
// ec <- ZIO.executor.map(_.asExecutionContext) // leave this for reference about how to get the execution context
state <- ZIO.service[State]
response <- healthCheck(state)
} yield response

}
}

/**
* Companion object providing the layer
*/
object HealthRouteWithZIOHttp {
val layer: ZLayer[State, Nothing, HealthRouteWithZIOHttp] =
ZLayer.fromFunction(HealthRouteWithZIOHttp.apply _)
}

0 comments on commit 26e9596

Please sign in to comment.