refactor: Introduce ZIO HTTP (DEV-1425) (#2256)

Co-authored-by: Balduin Landolt <33053745+BalduinLandolt@users.noreply.github.com>

build.sbt

@@ -261,6 +261,18 @@ lazy val webapiJavaTestOptions = Seq(
 // DSP's new codebase
 //////////////////////////////////////
 
+// dsp-api-main project
+
+lazy val dspApiMain = project
+  .in(file("dsp-api-main"))
+  .settings(
+    scalacOptions ++= customScalacOptions,
+    name := "dspApiMain",
+    libraryDependencies ++= Dependencies.dspApiMainLibraryDependencies,
+    testFrameworks := Seq(new TestFramework("zio.test.sbt.ZTestFramework"))
+  )
+  .dependsOn(userInterface, userHandler, userRepo)
+
 // Role projects
 
 lazy val roleInterface = project
@@ -317,7 +329,7 @@ lazy val userInterface = project
     libraryDependencies ++= Dependencies.userInterfaceLibraryDependencies,
     testFrameworks := Seq(new TestFramework("zio.test.sbt.ZTestFramework"))
   )
-  .dependsOn(shared, userHandler)
+  .dependsOn(shared % "compile->compile;test->test", userHandler, userRepo % "test->test")
 
 lazy val userHandler = project
   .in(file("dsp-user/handler"))
@@ -328,7 +340,7 @@ lazy val userHandler = project
     testFrameworks := Seq(new TestFramework("zio.test.sbt.ZTestFramework"))
   )
   .dependsOn(
-    shared,
+    shared   % "compile->compile;test->test",
     userCore % "compile->compile;test->test",
     userRepo % "test->test" // userHandler tests need mock implementation of UserRepo
   )

dsp-api-main/src/main/resources/logback.xml

@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!DOCTYPE configuration>
+
+<configuration >
+    <import class="ch.qos.logback.core.ConsoleAppender"/>
+    <import class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"/>
+    <import class="ch.qos.logback.contrib.json.classic.JsonLayout"/>
+    <import class="ch.qos.logback.contrib.jackson.JacksonJsonFormatter"/>
+
+    <appender name="STDOUT" class="ConsoleAppender">
+        <encoder class="PatternLayoutEncoder">
+            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg [%mdc]%n</pattern>
+        </encoder>
+    </appender>
+
+    <appender name="JSON" class="ConsoleAppender">
+        <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
+            <layout class="JsonLayout">
+                <jsonFormatter class="JacksonJsonFormatter">
+                    <prettyPrint>true</prettyPrint>
+                </jsonFormatter>
+                <timestampFormat>yyyy-MM-dd' 'HH:mm:ss.SSS</timestampFormat>
+            </layout>
+        </encoder>
+    </appender>
+
+    <root level="INFO">
+        <appender-ref ref="STDOUT"/>
+        <!-- <appender-ref ref="JSON"/> -->
+    </root>
+
+    <!-- for logging during tests, please see/use logback-test.xml under test/resources -->
+
+</configuration>

dsp-api-main/src/main/scala/dsp/api/main/DspMain.scala

@@ -0,0 +1,35 @@
+package dsp.api.main
+
+import zio._
+import dsp.user.route.UserRoutes
+import dsp.user.handler.UserHandler
+import dsp.user.repo.impl.UserRepoLive
+import zio.logging.removeDefaultLoggers
+import zio.logging.backend.SLF4J
+import dsp.config.AppConfig
+import dsp.util.UuidGeneratorLive
+
+object DspMain extends ZIOAppDefault {
+
+  override val run: Task[Unit] =
+    ZIO
+      .serviceWithZIO[DspServer](_.start)
+      .provide(
+        // ZLayer.Debug.mermaid,
+        // server
+        DspServer.layer,
+        // configuration
+        AppConfig.live,
+        // routes
+        UserRoutes.layer,
+        // handlers
+        UserHandler.layer,
+        // repositories
+        UserRepoLive.layer,
+        // slf4j facade, we use it with logback.xml
+        removeDefaultLoggers,
+        SLF4J.slf4j,
+        UuidGeneratorLive.layer
+      )
+
+}

dsp-api-main/src/main/scala/dsp/api/main/DspMiddleware.scala

@@ -0,0 +1,24 @@
+package dsp.api.main
+
+import zhttp.http.middleware.HttpMiddleware
+import zhttp.http._
+import zio._
+
+object DspMiddleware {
+  // adds a requestId to all logs that were triggered by the same request
+  val logging: HttpMiddleware[Any, Nothing] =
+    new HttpMiddleware[Any, Nothing] {
+      override def apply[R1 <: Any, E1 >: Nothing](
+        http: HttpApp[R1, E1]
+      ): HttpApp[R1, E1] =
+        Http.fromOptionFunction[Request] { request =>
+          Random.nextUUID.flatMap { requestId =>
+            ZIO.logAnnotate("RequestId", requestId.toString) {
+              for {
+                result <- http(request)
+              } yield result
+            }
+          }
+        }
+    }
+}

dsp-api-main/src/main/scala/dsp/api/main/DspServer.scala

@@ -0,0 +1,32 @@
+package dsp.api.main
+
+import dsp.user.route.UserRoutes
+import zio._
+import zhttp.http._
+import zio.ZLayer
+import zhttp.service.Server
+import dsp.api.main.DspMiddleware
+import dsp.config.AppConfig
+import dsp.util.UuidGeneratorLive
+
+final case class DspServer(
+  appConfig: AppConfig,
+  userRoutes: UserRoutes
+) {
+
+  // adds up the routes of all slices
+  val dspRoutes: HttpApp[AppConfig & UuidGeneratorLive, Throwable] =
+    userRoutes.routes // ++ projectRoutes.routes
+
+  // starts the server with the provided settings from the appConfig
+  def start = {
+    val port = appConfig.dspApi.externalPort
+    Server.start(port, dspRoutes @@ DspMiddleware.logging)
+  }
+
+}
+
+object DspServer {
+  val layer: ZLayer[AppConfig & UserRoutes, Nothing, DspServer] =
+    ZLayer.fromFunction(DspServer.apply _)
+}

dsp-project/handler/src/main/scala/dsp/project/handler/ProjectHandler.scala

@@ -154,9 +154,6 @@ final case class ProjectHandler(repo: ProjectRepo) {
 
 }
 
-/**
- * Companion object providing the layer with an initialized implementation
- */
 object ProjectHandler {
   val layer: ZLayer[ProjectRepo, Nothing, ProjectHandler] =
     ZLayer {

dsp-role/core/src/test/scala/dsp/role/domain/RoleDomainSpec.scala

@@ -7,6 +7,8 @@ package dsp.role.domain
 
 import zio.test._
 
+import java.util.UUID
+
 import dsp.role.sharedtestdata.RoleTestData
 import dsp.valueobjects.Id
 import dsp.valueobjects.Permission
@@ -86,7 +88,7 @@ object RoleDomainSpec extends ZIOSpecDefault {
       (
         for {
           role        <- RoleTestData.role1
-          newValue     = List(RoleUser(Id.UserId.make().fold(e => throw e.head, v => v)))
+          newValue     = List(RoleUser(Id.UserId.make(UUID.randomUUID()).fold(e => throw e.head, v => v)))
           updatedRole <- role.updateUsers(newValue)
         } yield assertTrue(updatedRole.name == role.name) &&
           assertTrue(updatedRole.description == role.description) &&

dsp-role/core/src/test/scala/dsp/role/sharedtestdata/RoleTestData.scala

@@ -5,6 +5,8 @@
 
 package dsp.role.sharedtestdata
 
+import java.util.UUID
+
 import dsp.role.domain.Role
 import dsp.role.domain.RoleUser
 import dsp.valueobjects.Id
@@ -15,10 +17,13 @@ import dsp.valueobjects.Role._
  * Contains shared role test data.
  */
 object RoleTestData {
+  val uuid1 = UUID.randomUUID()
+  val uuid2 = UUID.randomUUID()
+
   val id1          = Id.RoleId.make()
   val name1        = LangString.make("Name", "en")
   val description1 = LangString.make("Description", "en")
-  val users1       = List(RoleUser(Id.UserId.make().fold(e => throw e.head, v => v)))
+  val users1       = List(RoleUser(Id.UserId.make(uuid1).fold(e => throw e.head, v => v)))
   val permission1  = Permission.make(Permission.View)
 
   val role1 = for {
@@ -39,7 +44,7 @@ object RoleTestData {
   val id2          = Id.RoleId.make()
   val name2        = LangString.make("Name 2", "en")
   val description2 = LangString.make("Description 2", "en")
-  val users2       = List(RoleUser(Id.UserId.make().fold(e => throw e.head, v => v)))
+  val users2       = List(RoleUser(Id.UserId.make(uuid2).fold(e => throw e.head, v => v)))
   val permission2  = Permission.make(Permission.Admin)
 
   val role2 = for {

dsp-role/handler/src/main/scala/dsp/role/handler/RoleHandler.scala

@@ -135,9 +135,6 @@ final case class RoleHandler(repo: RoleRepo) {
     } yield id).tap(_ => ZIO.logInfo(s"Deleted role with ID: $id"))
 }
 
-/**
- * Companion object providing the layer with an initialized implementation
- */
 object RoleHandler {
   val layer: ZLayer[RoleRepo, Nothing, RoleHandler] =
     ZLayer {

dsp-role/repo/src/main/scala/dsp/role/repo/impl/RoleRepoLive.scala

@@ -60,9 +60,6 @@ final case class RoleRepoLive(
     } yield id).commit.tap(_ => ZIO.logInfo(s"Deleted role: ${id.uuid}"))
 }
 
-/**
- * Companion object providing the layer with an initialized implementation of [[RoleRepo]]
- */
 object RoleRepoLive {
   val layer: ZLayer[Any, Nothing, RoleRepo] =
     ZLayer {

dsp-role/repo/src/test/scala/dsp/role/repo/impl/RoleRepoMock.scala

@@ -60,9 +60,6 @@ final case class RoleRepoMock(
     } yield id).commit.tap(_ => ZIO.logInfo(s"Deleted role: ${id.uuid}"))
 }
 
-/**
- * Companion object providing the layer with an initialized implementation of [[RoleRepo]]
- */
 object RoleRepoMock {
   val layer: ZLayer[Any, Nothing, RoleRepo] =
     ZLayer {

dsp-shared/src/main/resources/application.conf

@@ -0,0 +1,19 @@
+app {
+    dsp-api {
+        // relevant for direct communication inside the dsp stack
+        internal-host = "0.0.0.0"
+        internal-host = ${?DSP_API_INTERNAL_HOST}
+        internal-port = 4444
+        internal-port = ${?DSP_API_INTERNAL_PORT}
+
+        // relevant for the client, i.e. browser
+        external-protocol = "http" // optional ssl termination needs to be done by the proxy
+        external-protocol = ${?DSP_API_EXTERNAL_PROTOCOL}
+        external-host = "0.0.0.0"
+        external-host = ${?DSP_API_EXTERNAL_HOST}
+        external-port = 4444
+        external-port = ${?DSP_API_EXTERNAL_PORT}
+    }
+
+    bcrypt-password-strength = 12
+}

dsp-shared/src/main/scala/dsp/config/AppConfig.scala

@@ -0,0 +1,46 @@
+package dsp.config
+
+import com.typesafe.config.ConfigFactory
+import zio._
+import zio.config._
+import zio.config.magnolia.descriptor
+import zio.config.typesafe.TypesafeConfigSource
+
+import dsp.valueobjects.User._
+
+/**
+ * Configuration
+ */
+final case class AppConfig(
+  dspApi: DspApi,
+  bcryptPasswordStrength: PasswordStrength
+)
+
+final case class DspApi(
+  internalHost: String,
+  internalPort: Int,
+  externalHost: String,
+  externalPort: Int
+)
+
+object AppConfig {
+
+  /**
+   * Reads in the applicaton configuration using ZIO-Config. ZIO-Config is capable of loading
+   * the Typesafe-Config format. Reads the 'app' configuration from 'application.conf'.
+   */
+  private val source: ConfigSource =
+    TypesafeConfigSource.fromTypesafeConfig(ZIO.attempt(ConfigFactory.load().getConfig("app").resolve))
+
+  /**
+   * Instantiates the config class hierarchy using the data from the 'app' configuration from 'application.conf'.
+   */
+  private val configFromSource: IO[ReadError[String], AppConfig] = read(
+    descriptor[AppConfig].mapKey(toKebabCase) from source
+  )
+
+  /**
+   * Application configuration from application.conf
+   */
+  val live: ULayer[AppConfig] = ZLayer(configFromSource.orDie)
+}

dsp-shared/src/main/scala/dsp/util/UuidGenerator.scala

@@ -0,0 +1,34 @@
+/*
+ * Copyright © 2021 - 2022 Swiss National Data and Service Center for the Humanities and/or DaSCH Service Platform contributors.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package dsp.util
+
+import zio._
+
+import java.util.UUID
+
+/**
+ * Handles UUID creation
+ */
+trait UuidGenerator {
+  def createRandomUuid: UIO[UUID]
+}
+
+/**
+ * Live instance of the UuidGenerator
+ */
+final case class UuidGeneratorLive() extends UuidGenerator {
+
+  /**
+   * Creates a random UUID
+   *
+   * @return a random UUID
+   */
+  override def createRandomUuid: UIO[UUID] = ZIO.succeed(UUID.randomUUID())
+}
+object UuidGeneratorLive {
+  val layer: ULayer[UuidGeneratorLive] =
+    ZLayer.succeed(UuidGeneratorLive())
+}