Redesigned model (#1916)

* Initial changes

* Removed HExit.empty

* Separation of Total/Partial Https, work in progress

* wrap

* Web middlewares and request logging

* More work on middlewares

* Core project compiles

* Fixed many tests

* Fixes

* Core tests passing

* Fix 2.12.

* Fix Scala 3

* Reintroduced declarative middleware application

* Eliminated redundant middleware-for-total

* Fixes for Scala 2.12 and 3

* Readded @nowarn

* Fix

* Updated CI

* Attempts to improve performance

* Attempts to improve performance

* Attempts to improve performance

* Fix error handling

* Linux

* OS dependent sed

* Attempts to improve performance

* Remove commented out code

* Http extends PartialFunction

* Fix middleware bounds

* Fix

* Middleware input transformation tracking

* Fix Scala 2.12 and 3.2.1

* Redesigned route/handler/middleware models

* Adjusting tests and examples to the new model, WIP

* Adjusting tests and examples to the new model, WIP

* Everything compiles

* Fixes

* All tests pass

* Restored the fallback feature of fromFile/fromStream

* Fix scaladoc reference

* Format

* Unsafe API

* Using Unhandled instead of null in Route

* sealed traits Route and Handler

* Renamed toXXX(in) to runXXX(in)

* Renamed Route to Http and made it a tree

* HandlerMiddleware is Middleware

* toRoute renamed to toHttp

* Fix tests

* Use Exit instead of HExit

* Readded most of the old ScalaDoc comments

* Cleaned up traces

* Clean up type aliases

Author: vigoo

.github/workflows/ci.yml

@@ -24,7 +24,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        scala: [2.12.16, 2.13.8, 3.2.0]
+        scala: [2.12.16, 2.13.8, 3.2.1]
         java: [graal_21.1.0@11, temurin@8]
     runs-on: ${{ matrix.os }}
     steps:
@@ -144,12 +144,12 @@ jobs:
           tar xf targets.tar
           rm targets.tar
 
-      - name: Download target directories (3.2.0)
+      - name: Download target directories (3.2.1)
         uses: actions/download-artifact@v2
         with:
-          name: target-${{ matrix.os }}-3.2.0-${{ matrix.java }}
+          name: target-${{ matrix.os }}-3.2.1-${{ matrix.java }}
 
-      - name: Inflate target directories (3.2.0)
+      - name: Inflate target directories (3.2.1)
         run: |
           tar xf targets.tar
           rm targets.tar

benchmark-zio-http.sh

@@ -23,7 +23,11 @@ rm ../FrameworkBenchMarks/frameworks/Scala/zio-http/src/main/scala/Main.scala
 cp ../FrameworkBenchMarks/frameworks/Scala/zio-http/base.build.sbt ../FrameworkBenchMarks/frameworks/Scala/zio-http/build.sbt
 cp ./zio-http-example/src/main/scala/example/$SERVER.scala ../FrameworkBenchMarks/frameworks/Scala/zio-http/src/main/scala/Main.scala
 cd ../FrameworkBenchMarks
-sed -i '' "s|---COMMIT_SHA---|${ZIO_HTTP}|g" frameworks/Scala/zio-http/build.sbt
+if [ "$OS" = 'Darwin' ]; then
+  sed -i '' "s|---COMMIT_SHA---|${ZIO_HTTP}|g" frameworks/Scala/zio-http/build.sbt
+else
+  sed -i "s|---COMMIT_SHA---|${ZIO_HTTP}|g" frameworks/Scala/zio-http/build.sbt
+fi
 ./tfb --test zio-http | tee result
 RESULT_REQUEST=$(echo $(grep -B 1 -A 17 "Concurrency: 256 for plaintext" result) | grep -oiE "requests/sec: [0-9]+.[0-9]+")
 RESULT_CONCURRENCY=$(echo $(grep -B 1 -A 17 "Concurrency: 256 for plaintext" result) | grep -oiE "concurrency: [0-9]+")

project/BuildHelper.scala

@@ -6,7 +6,7 @@ import xerial.sbt.Sonatype.autoImport._
 object BuildHelper extends ScalaSettings {
   val Scala212         = "2.12.16"
   val Scala213         = "2.13.8"
-  val ScalaDotty       = "3.2.0"
+  val ScalaDotty       = "3.2.1"
   val ScoverageVersion = "1.9.3"
   val JmhVersion       = "0.4.3"
 

zio-http-benchmarks/src/main/scala-2.13/zio/http/benchmarks/ApiBenchmark.scala

@@ -169,13 +169,13 @@ class ApiBenchmark {
   @Benchmark
   def benchmarkSmallDataZioApi(): Unit =
     unsafeRun {
-      apiHttpApp(smallDataRequest).repeatN(REPEAT_N)
+      apiHttpApp.runZIO(smallDataRequest).repeatN(REPEAT_N)
     }
 
   @Benchmark
   def benchmarkSmallDataZioCollect(): Unit =
     unsafeRun {
-      collectHttpApp(smallDataRequest).repeatN(REPEAT_N)
+      collectHttpApp.runZIO(smallDataRequest).repeatN(REPEAT_N)
     }
 
 //  @Benchmark
@@ -277,13 +277,13 @@ class ApiBenchmark {
   @Benchmark
   def benchmarkDeepPathZioApi(): Unit =
     unsafeRun {
-      deepPathHttpApp(deepPathRequest).repeatN(REPEAT_N)
+      deepPathHttpApp.runZIO(deepPathRequest).repeatN(REPEAT_N)
     }
 
   @Benchmark
   def benchmarkDeepPathZioCollect(): Unit =
     unsafeRun {
-      deepPathCollectHttpApp(deepPathRequest).repeatN(REPEAT_N)
+      deepPathCollectHttpApp.runZIO(deepPathRequest).repeatN(REPEAT_N)
     }
 
 //  @Benchmark
@@ -638,13 +638,13 @@ class ApiBenchmark {
   @Benchmark
   def benchmarkBroadZioApi(): Unit =
     unsafeRunResult {
-      ZIO.foreachDiscard(broadZioRequests)(broadApiApp(_))
+      ZIO.foreachDiscard(broadZioRequests)(broadApiApp.runZIO(_))
     }
 
   @Benchmark
   def benchmarkBroadZioCollect(): Unit =
     unsafeRun {
-      ZIO.foreachDiscard(broadZioRequests)(broadCollectApp(_))
+      ZIO.foreachDiscard(broadZioRequests)(broadCollectApp.runZIO(_))
     }
 
 //  @Benchmark

zio-http-benchmarks/src/main/scala/zhttp.benchmarks/HttpCollectEval.scala

@@ -2,28 +2,43 @@ package zio.benchmarks
 
 import org.openjdk.jmh.annotations._
 import zio.http._
+import zio.{Trace, Unsafe}
 
 import java.util.concurrent.TimeUnit
 
 @State(Scope.Thread)
 @BenchmarkMode(Array(Mode.Throughput))
 @OutputTimeUnit(TimeUnit.SECONDS)
 class HttpCollectEval {
-  private val MAX  = 10000
-  private val app  = Http.collect[Int] { case 0 => 1 }
-  private val http = Http.collect[Request] { case _ -> !! / "text" => 1 }
+  private val MAX       = 10000
+  private val app       = Http.collect[Int] { case 0 => 1 }
+  private val http      = Http.collect[Request] { case _ -> !! / "text" => 1 }
+  private val httpTotal = Handler
+    .fromFunction[Request] {
+      case _ -> !! / "text" => 1
+      case _                => 0 // representing "not found"
+    }
 
-  private val base: Int => Int = _ => 1
+  private val base: PartialFunction[Int, Int] = { case 0 => 1 }
+  private val baseTotal: Int => Int           = _ => 1
 
   @Benchmark
   def benchmarkApp(): Unit = {
-    (0 to MAX).foreach(_ => app.execute(0))
+    (0 to MAX).foreach(_ => app.runZIOOrNull(0)(Unsafe.unsafe, Trace.empty))
     ()
   }
 
   @Benchmark
   def benchmarkHttp(): Unit = {
-    (0 to MAX).foreach(_ => http.execute(Request.get(url = URL(!! / "text"))))
+    (0 to MAX).foreach(_ => http.runZIOOrNull(Request.get(url = URL(!! / "text")))(Unsafe.unsafe, Trace.empty))
+    ()
+  }
+
+  @Benchmark
+  def benchmarkHttpTotal(): Unit = {
+    (0 to MAX).foreach(_ =>
+      httpTotal.toHttp.runZIOOrNull(Request.get(url = URL(!! / "text")))(Unsafe.unsafe, Trace.empty),
+    )
     ()
   }
 
@@ -32,4 +47,10 @@ class HttpCollectEval {
     (0 to MAX).foreach(_ => base(0))
     ()
   }
+
+  @Benchmark
+  def benchmarkBaseTotal(): Unit = {
+    (0 to MAX).foreach(_ => baseTotal(0))
+    ()
+  }
 }

zio-http-benchmarks/src/main/scala/zhttp.benchmarks/HttpCombineEval.scala

@@ -2,6 +2,7 @@ package zio.benchmarks
 
 import org.openjdk.jmh.annotations._
 import zio.http._
+import zio.{Trace, Unsafe}
 
 import java.util.concurrent.TimeUnit
 
@@ -15,13 +16,13 @@ class HttpCombineEval {
 
   @Benchmark
   def empty(): Unit = {
-    spec.execute(-1)
+    spec.runZIOOrNull(-1)(Unsafe.unsafe, Trace.empty)
     ()
   }
 
   @Benchmark
   def ok(): Unit = {
-    spec.execute(0)
+    spec.runZIOOrNull(0)(Unsafe.unsafe, Trace.empty)
     ()
   }
 }

zio-http-benchmarks/src/main/scala/zhttp.benchmarks/HttpNestedFlatMapEval.scala

@@ -2,6 +2,7 @@ package zio.benchmarks
 
 import org.openjdk.jmh.annotations._
 import zio.http._
+import zio.{Trace, Unsafe}
 
 import java.util.concurrent.TimeUnit
 
@@ -12,12 +13,12 @@ class HttpNestedFlatMapEval {
 
   private val MAX = 1000
 
-  val programFlatMap: Http[Any, Nothing, Int, Int] =
-    (0 to MAX).foldLeft(Http.identity[Int])((a, _) => a.flatMap(i => Http.succeed(i + 1)))
+  val programFlatMap: Handler[Any, Nothing, Int, Int] =
+    (0 to MAX).foldLeft(Handler.identity[Int])((a, _) => a.flatMap(i => Handler.succeed(i + 1)))
 
   @Benchmark
   def benchmarkHttpFlatMap(): Unit = {
-    programFlatMap.execute(0)
+    programFlatMap.toHttp.runZIOOrNull(0)(Unsafe.unsafe, Trace.empty)
     ()
   }
 }

zio-http-benchmarks/src/main/scala/zhttp.benchmarks/HttpRouteTextPerf.scala

@@ -14,9 +14,9 @@ class HttpRouteTextPerf {
   private val runtime = Runtime.default
 
   private val res          = Response.text("HELLO WORLD")
-  private val app          = Http.succeed(res)
+  private val app          = Handler.succeed(res)
   private val req: Request = Request.get(URL(!!))
-  private val httpProgram  = ZIO.foreachDiscard(0 to 1000) { _ => app.execute(req).toZIO }
+  private val httpProgram  = ZIO.foreachDiscard(0 to 1000) { _ => app(req) }
   private val UIOProgram   = ZIO.foreachDiscard(0 to 1000) { _ => ZIO.succeed(res) }
 
   @Benchmark

zio-http-example/src/main/scala/example/AuthenticationServer.scala

@@ -7,6 +7,7 @@ import zio.http._
 import zio.http.model.{Method, Status}
 
 import java.time.Clock
+import javax.management.MBeanNotificationInfo
 
 object AuthenticationServer extends ZIOAppDefault {
 
@@ -39,19 +40,19 @@ object AuthenticationServer extends ZIOAppDefault {
   }
 
   // Http app that is accessible only via a jwt token
-  def user: UHttpApp = Http.collect[Request] { case Method.GET -> !! / "user" / name / "greet" =>
+  def user: HttpApp[Any, Nothing] = Http.collect[Request] { case Method.GET -> !! / "user" / name / "greet" =>
     Response.text(s"Welcome to the ZIO party! ${name}")
   } @@ bearerAuth(jwtDecode(_).isDefined)
 
   // App that let's the user login
   // Login is successful only if the password is the reverse of the username
-  def login: UHttpApp = Http.collect[Request] { case Method.GET -> !! / "login" / username / password =>
+  def login: HttpApp[Any, Nothing] = Http.collect[Request] { case Method.GET -> !! / "login" / username / password =>
     if (password.reverse.hashCode == username.hashCode) Response.text(jwtEncode(username))
     else Response.text("Invalid username or password.").setStatus(Status.Unauthorized)
   }
 
   // Composing all the HttpApps together
-  val app: UHttpApp = login ++ user
+  val app: HttpApp[Any, Nothing] = login ++ user
 
   // Run it like any simple app
   override val run = Server.serve(app).provide(Server.default)

zio-http-example/src/main/scala/example/BasicAuth.scala

@@ -8,12 +8,12 @@ import zio.http.model.Method
 object BasicAuth extends ZIOAppDefault {
 
   // Http app that requires a JWT claim
-  val user: UHttpApp = Http.collect[Request] { case Method.GET -> !! / "user" / name / "greet" =>
+  val user: HttpApp[Any, Nothing] = Http.collect[Request] { case Method.GET -> !! / "user" / name / "greet" =>
     Response.text(s"Welcome to the ZIO party! ${name}")
   }
 
   // Composing all the HttpApps together
-  val app: UHttpApp = user @@ basicAuth("admin", "admin")
+  val app: HttpApp[Any, Nothing] = user @@ basicAuth("admin", "admin")
 
   // Run it like any simple app
   val run = Server.serve(app).provide(Server.default)

zio-http-example/src/main/scala/example/CSRF.scala

@@ -17,7 +17,7 @@ object CSRF extends ZIOAppDefault {
     }
     .withMiddleware(api.Middleware.csrfGenerate()) // set x-csrf token cookie
 
-  val app = publicApp ++ privateApp
+  val app = (publicApp ++ privateApp).withDefaultErrorResponse
 
   def run = Server.serve(app).provide(Server.default)
 }

zio-http-example/src/main/scala/example/ClientServer.scala

@@ -16,6 +16,6 @@ object ClientServer extends ZIOAppDefault {
   }
 
   val run = {
-    Server.serve(app).provide(Server.default, Client.default).exitCode
+    Server.serve(app.withDefaultErrorResponse).provide(Server.default, Client.default).exitCode
   }
 }

zio-http-example/src/main/scala/example/ConcreteEntity.scala

@@ -13,17 +13,17 @@ object ConcreteEntity extends ZIOAppDefault {
   // Response
   case class UserCreated(id: Long)
 
-  val user: Http[Any, Nothing, CreateUser, UserCreated] =
-    Http.collect[CreateUser] { case CreateUser(_) =>
+  val user: Handler[Any, Nothing, CreateUser, UserCreated] =
+    Handler.fromFunction[CreateUser] { case CreateUser(_) =>
       UserCreated(2)
     }
 
-  val app: HttpApp[Any, Nothing] =
+  val app: RequestHandler[Any, Nothing] =
     user
       .contramap[Request](req => CreateUser(req.path.encode))     // Http[Any, Nothing, Request, UserCreated]
       .map(userCreated => Response.text(userCreated.id.toString)) // Http[Any, Nothing, Request, Response]
 
   // Run it like any simple app
   val run =
-    Server.serve(app).provide(Server.default)
+    Server.serve(app.toHttp.withDefaultErrorResponse).provide(Server.default)
 }

zio-http-example/src/main/scala/example/FileStreaming.scala

@@ -11,12 +11,12 @@ import java.nio.file.Paths
 object FileStreaming extends ZIOAppDefault {
 
   // Create HTTP route
-  val app = Http.collectHttp[Request] {
-    case Method.GET -> !! / "health" => Http.ok
+  val app = Http.collectRoute[Request] {
+    case Method.GET -> !! / "health" => Handler.ok.toHttp
 
     // Read the file as ZStream
     // Uses the blocking version of ZStream.fromFile
-    case Method.GET -> !! / "blocking" => Http.fromStream(ZStream.fromPath(Paths.get("README.md")))
+    case Method.GET -> !! / "blocking" => Handler.fromStream(ZStream.fromPath(Paths.get("README.md"))).toHttp
 
     // Uses netty's capability to write file content to the Channel
     // Content-type response headers are automatically identified and added
@@ -27,5 +27,5 @@ object FileStreaming extends ZIOAppDefault {
 
   // Run it like any simple app
   val run =
-    Server.serve(app).provide(Server.default)
+    Server.serve(app.withDefaultErrorResponse).provide(Server.default)
 }

zio-http-example/src/main/scala/example/HelloWorldWithMiddlewares.scala

@@ -2,30 +2,27 @@ package example
 
 import zio._
 import zio.http._
-import zio.http.middleware.HttpMiddleware
 import zio.http.model.Method
 
 import java.io.IOException
 import java.util.concurrent.TimeUnit
 
 object HelloWorldWithMiddlewares extends ZIOAppDefault {
 
-  val app: HttpApp[Any, Nothing] = Http.collectZIO[Request] { request =>
-    request match {
-      // this will return result instantly
-      case Method.GET -> !! / "text"         => ZIO.succeed(Response.text("Hello World!"))
-      // this will return result after 5 seconds, so with 3 seconds timeout it will fail
-      case Method.GET -> !! / "long-running" => ZIO.succeed(Response.text("Hello World!")).delay(5 seconds)
-    }
+  val app: HttpApp[Any, Nothing] = Http.collectZIO[Request] {
+    // this will return result instantly
+    case Method.GET -> !! / "text"         => ZIO.succeed(Response.text("Hello World!"))
+    // this will return result after 5 seconds, so with 3 seconds timeout it will fail
+    case Method.GET -> !! / "long-running" => ZIO.succeed(Response.text("Hello World!")).delay(5 seconds)
   }
 
-  val serverTime: HttpMiddleware[Any, Nothing] = Middleware.patchZIO(_ =>
+  val serverTime: RequestHandlerMiddleware[Any, Nothing] = Middleware.patchZIO(_ =>
     for {
       currentMilliseconds <- Clock.currentTime(TimeUnit.MILLISECONDS)
       withHeader = Patch.addHeader("X-Time", currentMilliseconds.toString)
     } yield withHeader,
   )
-  val middlewares: HttpMiddleware[Any, IOException] =
+  val middlewares: RequestHandlerMiddleware[Any, IOException] =
     // print debug info about request and response
     Middleware.debug ++
       // close connection if request takes more than 3 seconds
@@ -36,5 +33,5 @@ object HelloWorldWithMiddlewares extends ZIOAppDefault {
       serverTime
 
   // Run it like any simple app
-  val run = Server.serve(app @@ middlewares).provide(Server.default)
+  val run = Server.serve((app @@ middlewares).withDefaultErrorResponse).provide(Server.default)
 }

zio-http-example/src/main/scala/example/HtmlTemplating.scala

@@ -7,9 +7,9 @@ object HtmlTemplating extends ZIOAppDefault {
   // Importing everything from `zio.html`
   import zio.http.html._
 
-  def app: HttpApp[Any, Nothing] = {
+  def app: Handler[Any, Nothing, Any, Response] = {
     // Html response takes in a `Html` instance.
-    Http.html {
+    Handler.html {
 
       // Support for default Html tags
       html(
@@ -46,5 +46,5 @@ object HtmlTemplating extends ZIOAppDefault {
     }
   }
 
-  def run = Server.serve(app).provide(Server.default)
+  def run = Server.serve(app.toHttp.withDefaultErrorResponse).provide(Server.default)
 }