Scope Requests (#2252)

* scope requests * more scopes * format * update documentation
zio · Jun 14, 2023 · 8c54426 · 8c54426
1 parent 1bc6079
commit 8c54426
Show file tree

Hide file tree

Showing 31 changed files with 98 additions and 73 deletions.
diff --git a/docs/dsl/body.md b/docs/dsl/body.md
@@ -30,7 +30,7 @@ On the client-side, `ZIO-HTTP` models content in `ClientRequest` as `Body` with
 To add content while making a request using ZIO HTTP you can use the `Client.request` method:
 
 ```scala mdoc:silent
-  val actual: ZIO[Client, Throwable, Response] = 
+  val actual: ZIO[Client with Scope, Throwable, Response] = 
     Client.request("https://localhost:8073/success", content = Body.fromString("Some string"))
 ```
 

diff --git a/docs/dsl/headers.md b/docs/dsl/headers.md
@@ -175,7 +175,7 @@ object SimpleClientJson extends ZIOAppDefault {
   } yield ()
 
   override def run =
-    program.provide(Client.default)
+    program.provide(Client.default, Scope.default)
 
 }
 ```

diff --git a/docs/examples/basic/http-client.md b/docs/examples/basic/http-client.md
@@ -18,7 +18,7 @@ object SimpleClient extends ZIOAppDefault {
     _    <- Console.printLine(data)
   } yield ()
 
-  override val run = program.provide(Client.default)
+  override val run = program.provide(Client.default, Scope.default)
 
 }
 

diff --git a/docs/examples/basic/https-client.md b/docs/examples/basic/https-client.md
@@ -35,6 +35,7 @@ object HttpsClient extends ZIOAppDefault {
       NettyClientDriver.live,
       DnsResolver.default,
       ZLayer.succeed(NettyConfig.default),
+      Scope.default,
     )
 
 }

diff --git a/zio-http-cli/src/main/scala/zio/http/endpoint/cli/HttpCliApp.scala b/zio-http-cli/src/main/scala/zio/http/endpoint/cli/HttpCliApp.scala
@@ -98,7 +98,7 @@ object HttpCliApp {
                 )
                 .setHeaders(headers),
             )
-            .provide(Client.default)
+            .provide(Client.default, Scope.default)
           _        <- Console.printLine(s"Got response")
           _        <- Console.printLine(s"Status: ${response.status}")
           body     <- response.body.asString

diff --git a/zio-http-example/src/main/scala/example/AuthenticationClient.scala b/zio-http-example/src/main/scala/example/AuthenticationClient.scala
@@ -22,6 +22,6 @@ object AuthenticationClient extends ZIOAppDefault {
     _        <- Console.printLine(body)
   } yield ()
 
-  override val run = program.provide(Client.default)
+  override val run = program.provide(Client.default, Scope.default)
 
 }
diff --git a/zio-http-example/src/main/scala/example/CliExamples.scala b/zio-http-example/src/main/scala/example/CliExamples.scala
@@ -101,9 +101,10 @@ object TestCliClient extends zio.ZIOAppDefault with TestCliEndpoints {
       .provide(
         EndpointExecutor.make(serviceName = "test"),
         Client.default,
+        Scope.default,
       )
 
-  lazy val clientExample: URIO[EndpointExecutor[Unit], Unit] =
+  lazy val clientExample: URIO[EndpointExecutor[Unit] & Scope, Unit] =
     for {
       executor <- ZIO.service[EndpointExecutor[Unit]]
       _        <- executor(getUser(42, Location.parse("some-location").toOption.get)).debug("result1")

diff --git a/zio-http-example/src/main/scala/example/ClientServer.scala b/zio-http-example/src/main/scala/example/ClientServer.scala
@@ -1,6 +1,6 @@
 package example
 
-import zio.{ZIO, ZIOAppDefault}
+import zio.{Scope, ZIO, ZIOAppDefault}
 
 import zio.http._
 
@@ -16,6 +16,6 @@ object ClientServer extends ZIOAppDefault {
   }
 
   val run = {
-    Server.serve(app.withDefaultErrorResponse).provide(Server.default, Client.default).exitCode
+    Server.serve(app.withDefaultErrorResponse).provide(Server.default, Client.default, Scope.default).exitCode
   }
 }
diff --git a/zio-http-example/src/main/scala/example/ClientWithDecompression.scala b/zio-http-example/src/main/scala/example/ClientWithDecompression.scala
@@ -22,6 +22,7 @@ object ClientWithDecompression extends ZIOAppDefault {
       Client.live,
       ZLayer.succeed(NettyConfig.default),
       DnsResolver.default,
+      Scope.default,
     )
 
 }
diff --git a/zio-http-example/src/main/scala/example/EndpointExamples.scala b/zio-http-example/src/main/scala/example/EndpointExamples.scala
@@ -51,8 +51,8 @@ object EndpointExamples extends ZIOAppDefault {
       val x1 = getUser(42)
       val x2 = getUserPosts(42, 200, "adam")
 
-      val result1: UIO[Int]          = executor(x1)
-      val result2: UIO[List[String]] = executor(x2)
+      val result1: ZIO[Scope, Nothing, Int]          = executor(x1)
+      val result2: ZIO[Scope, Nothing, List[String]] = executor(x2)
 
       result1.zip(result2).debug
     }

diff --git a/zio-http-example/src/main/scala/example/GracefulShutdown.scala b/zio-http-example/src/main/scala/example/GracefulShutdown.scala
@@ -52,5 +52,6 @@ object GracefulShutdown extends ZIOAppDefault {
       _        <- Console.printLine(body)
     } yield ()).provide(
       Client.default,
+      Scope.default,
     )
 }
diff --git a/zio-http-example/src/main/scala/example/HttpsClient.scala b/zio-http-example/src/main/scala/example/HttpsClient.scala
@@ -30,6 +30,7 @@ object HttpsClient extends ZIOAppDefault {
       NettyClientDriver.live,
       DnsResolver.default,
       ZLayer.succeed(NettyConfig.default),
+      Scope.default,
     )
 
 }
diff --git a/zio-http-example/src/main/scala/example/Interrupt.scala b/zio-http-example/src/main/scala/example/Interrupt.scala
@@ -45,6 +45,7 @@ object MyClient extends ZIOAppDefault {
         ZLayer.succeed(ZClient.Config.default.withFixedConnectionPool(2)),
         ZLayer.succeed(NettyConfig.default),
         DnsResolver.default,
+        Scope.default,
       )
       // .provide(Client.live, NettyClientDriver.fromConfig, ClientConfig.live(ClientConfig().withFixedConnectionPool(2)))
       .debug("EXIT")

diff --git a/zio-http-example/src/main/scala/example/MultipartFormData.scala b/zio-http-example/src/main/scala/example/MultipartFormData.scala
@@ -38,7 +38,7 @@ object MultipartFormData extends ZIOAppDefault {
         } yield response
     }
 
-  private def program: ZIO[Client with Server, Throwable, Unit] =
+  private def program: ZIO[Client with Server with Scope, Throwable, Unit] =
     for {
       port         <- Server.install(app)
       _            <- ZIO.logInfo(s"Server started on port $port")
@@ -70,5 +70,6 @@ object MultipartFormData extends ZIOAppDefault {
       .provide(
         Server.default,
         Client.default,
+        Scope.default,
       )
 }
diff --git a/zio-http-example/src/main/scala/example/SimpleClient.scala b/zio-http-example/src/main/scala/example/SimpleClient.scala
@@ -13,6 +13,6 @@ object SimpleClient extends ZIOAppDefault {
     _    <- Console.printLine(data)
   } yield ()
 
-  override val run = program.provide(Client.default)
+  override val run = program.provide(Client.default, Scope.default)
 
 }
diff --git a/zio-http-testkit/src/test/scala/zio/http/TestServerSpec.scala b/zio-http-testkit/src/test/scala/zio/http/TestServerSpec.scala
@@ -32,7 +32,7 @@ object TestServerSpec extends ZIOSpecDefault {
           )
       } yield assertTrue(response1.status == Status.Ok) &&
         assertTrue(response2.status == Status.InternalServerError)
-    }.provideSome[Client with Driver](
+    }.provideSome[Client with Driver with Scope](
       TestServer.layer,
     ),
     suite("Exact Request=>Response version")(
@@ -79,13 +79,14 @@ object TestServerSpec extends ZIOSpecDefault {
         } yield assertTrue(finalResponse.status == Status.NotFound)
       },
     )
-      .provideSome[Client with Driver](
+      .provideSome[Client with Driver with Scope](
         TestServer.layer,
       ),
   ).provide(
     ZLayer.succeed(Server.Config.default.onAnyOpenPort),
     Client.default,
     NettyDriver.live,
+    Scope.default,
   )
 
   private def requestToCorrectPort =