Setting options for AkkaHttpServerInterpreter as explicit parameter #1321

ghost · 2021-06-15T10:17:44Z

No description provided.

adamw · 2021-06-18T09:50:08Z

README.md

@@ -54,7 +54,7 @@ val booksListing: Endpoint[(BooksFromYear, Limit, AuthToken), String, List[Book]
 import sttp.tapir.docs.openapi.OpenAPIDocsInterpreter
 import sttp.tapir.openapi.circe.yaml._

-val docs = OpenAPIDocsInterpreter.toOpenAPI(booksListing, "My Bookshop", "1.0")
+val docs = OpenAPIDocsInterpreter()().toOpenAPI(booksListing, "My Bookshop", "1.0")


hm this doesn't look nice - why do we need the double ()?

adamw · 2021-06-18T09:58:22Z

client/sttp-client/src/main/scala/sttp/tapir/client/sttp/package.scala

@@ -1,3 +1,9 @@
 package sttp.tapir.client

-package object sttp extends TapirSttpClient
+package object sttp {
+  def apply(clientOptions: SttpClientOptions = SttpClientOptions.default): TapirSttpClient = {


hm I think this might be confusing. Maybe it's time to remove the deprecated TapirSttpClient simply

adamw · 2021-06-18T09:59:28Z

...nt/sttp-client/src/main/scalajs/sttp/tapir/client/sttp/SttpClientInterpreterExtensions.scala

@@ -8,6 +8,8 @@ import scala.concurrent.Future

 trait SttpClientInterpreterExtensions {

+  def sttpClientOptions: SttpClientOptions = SttpClientOptions.default


since this is always extended by SttpClientInterpreter, we might use self-types here and avoid the additional definiton of sttpClientOptions.

Sth like: trait SttpClientInterpreterExtensions { this: SttpClientInterpreter =>

adamw · 2021-06-18T10:10:15Z

server/http4s-server/src/main/scala/sttp/tapir/server/http4s/Http4sServerInterpreter.scala

-      eClassTag: ClassTag[E],
-      timer: Timer[F]
-  ): HttpRoutes[F] = toRoutes(e.serverLogicRecoverErrors(logic))
+trait Http4sServerInterpreter[F[_], G[_]] {


I think the toRoutes variant is the one that is predominantly used. So maybe we could rename this one to Http4sServerToHttpInterpreter, and the routes one would keep the simpler Http4sServerInterpreter name?

adamw · 2021-06-18T10:16:58Z

server/vertx/src/main/scala/sttp/tapir/server/vertx/package.scala


 package object vertx {

-  object VertxZioServerInterpreter extends VertxZioServerInterpreter
+  object VertxZioServerInterpreter {


I think the companion could be defined in the same file as the class?

adamw · 2021-06-18T10:17:39Z

One more thing (apart from merge conflicts :) ) - the various XyzOptions.default should no longer be implicit values/definitions

# Conflicts: # client/http4s-client/src/test/scala/sttp/tapir/client/http4s/Http4sClientTests.scala # docs/openapi-docs/src/test/scala/sttp/tapir/docs/openapi/VerifyYamlValidatorTest.scala # server/finatra-server/src/main/scala/sttp/tapir/server/finatra/FinatraServerInterpreter.scala # server/http4s-server/src/main/scala/sttp/tapir/server/http4s/Http4sServerInterpreter.scala # server/play-server/src/main/scala/sttp/tapir/server/play/PlayServerInterpreter.scala # server/vertx/src/main/scala/sttp/tapir/server/vertx/interpreters/VertxCatsServerInterpreter.scala # server/vertx/src/main/scala/sttp/tapir/server/vertx/interpreters/VertxFutureServerInterpreter.scala # server/vertx/src/test/scala/sttp/tapir/server/vertx/CatsVertxServerTest.scala # serverless/aws/lambda/src/main/scala/sttp/tapir/serverless/aws/lambda/AwsToResponseBody.scala

adamw · 2021-06-22T11:45:56Z

examples/src/main/scala/sttp/tapir/examples/MultipleEndpointsDocumentationHttp4sServer.scala

@@ -43,6 +42,7 @@ object MultipleEndpointsDocumentationHttp4sServer extends App {
  implicit val ec: ExecutionContext = scala.concurrent.ExecutionContext.Implicits.global
  implicit val contextShift: ContextShift[IO] = IO.contextShift(ec)
  implicit val timer: Timer[IO] = IO.timer(ec)
+  implicit val concurrent: Concurrent[IO] = IO.ioConcurrentEffect


why do we need a concurrent instance now, as we didn't need one before?

It is used implicitly by Http4sServerToHttpInterpreter's apply method

But ... it wasn't needed before, so it shouldn't be needed now?

You are right I am missing type parameter for Http4sServerInterpreter

adamw · 2021-06-22T13:29:58Z

doc/server/http4s.md

@@ -60,10 +63,11 @@ implicit val cs: ContextShift[IO] =
  IO.contextShift(scala.concurrent.ExecutionContext.global)
 implicit val t: Timer[IO] =
  IO.timer(scala.concurrent.ExecutionContext.global)
+implicit val concurrent: Concurrent[IO] = IO.ioConcurrentEffect


so do we need this? :)

adamw · 2021-06-22T13:30:55Z

doc/server/vertx.md

@@ -14,7 +14,7 @@ to use this interpreter with `Future`.

 Then import the object:
 ```scala mdoc:compile-only
-import sttp.tapir.server.vertx.VertxFutureServerInterpreter._
+import sttp.tapir.server.vertx.interpreters.VertxFutureServerInterpreter._


I think I'd keep the interpreters in the "root" package, that is sttp.tapir.server.vertx. Easier for users :)

adamw · 2021-06-22T13:34:47Z

generated-doc/out/server/http4s.md

-val countCharactersRoutes: HttpRoutes[IO] = 
-  Http4sServerInterpreter.toRoutes(countCharactersEndpoint)(countCharacters _)
+val countCharactersRoutes: HttpRoutes[IO] =
+  Http4sServerToHttpInterpreter.toRoutes(countCharactersEndpoint)(countCharacters _)


shouldn't this be the "normal" interpreter?

adamw · 2021-06-22T13:36:18Z

server/http4s-server/src/test/scala/sttp/tapir/server/http4s/Http4sServerTest.scala

@@ -47,7 +47,7 @@ class Http4sServerTest[R >: Fs2Streams[IO] with WebSockets] extends TestSuite wi
    def additionalTests(): List[Test] = List(
      Test("should work with a router and routes in a context") {
        val e = endpoint.get.in("test" / "router").out(stringBody).serverLogic(_ => IO.pure("ok".asRight[Unit]))
-        val routes = Http4sServerInterpreter.toRoutes(e)
+        val routes = Http4sServerInterpreter()(interpreter.concurrent, cs, timer).toRoutes(e)


do we need to provide these implicits explicitly now?

adamw · 2021-06-22T13:40:59Z

server/vertx/src/test/scala/sttp/tapir/server/vertx/CatsVertxTestServerInterpreter.scala

-  ): Router => Route =
-    VertxCatsServerInterpreter.routeRecoverErrors(e)(fn)
+  ): Router => Route = {
+    val fs: Sync[IO] = Sync[IO]


this should be inferred by the compiler?

adamw · 2021-06-22T13:42:50Z

.../aws/examples/src/main/scala/sttp/tapir/serverless/aws/examples/TerraformConfigExample.scala

-  val apiGateway: AwsTerraformApiGateway = AwsTerraformInterpreter.toTerraformConfig(helloEndpoint)
+  val apiGateway: AwsTerraformApiGateway = AwsTerraformInterpreter(terraformOptions).toTerraformConfig(helloEndpoint)
+
+  implicit val encoder: Encoder[AwsTerraformApiGateway] = encoderAwsTerraformApiGateway(terraformOptions)


we need an encoder now? :)

yeah because options are no longer implicit and encoder requires them as implicit parameter.
I can change encoder to explicit def with explicit parameters what do you think ?

hm and where do we use the encoder? Maybe at the point of use, we can import the encoder as an implicit value

From what I see encoder is required by asJson method from AwsTerraformApiGatewa class

- Removed not needed implicit Concurrent[IO] - Moved Vertex based interpreters to root package - Replace usage of toHttp interpreter with normal interpreter

- Removed additional test which do not exists on master - Fixed calls to Http4sClientInterpreter - Removed unused imports

leoniv · 2022-04-01T07:59:11Z

...er/http4s-server/src/main/scala/sttp/tapir/server/http4s/Http4sServerToHttpInterpreter.scala

+
+  def toHttp(
+      serverEndpoints: List[ServerEndpoint[_, _, _, Fs2Streams[F] with WebSockets, G]]
+  )(fToG: F ~> G)(gToF: G ~> F): Http[OptionT[G, *], F] = {


Hi @adamw! Can you explain purpose of gToF: G ~> F? Just toHttp: Http[OptionT[G, *], F] was added by #683 and in original it has only fToG: F ~> G but addition of gToF: G ~> F absolutely destroy the original idea.

in Http4sBodyListener, we need to know when the body has finished streaming - hence we need a way to translate the effect of the callback (in which the response is returned) to the effect in which the body is returned.

If you'd have a better idea how to model this, I'm open to suggestions :)

There are a lot of changes was made. I'll try to see what you mean ASAP :)

I've seen that the ServerInterpriter was generalized and as as result ServerInterpriter should support transformation F ~> G but unfortunately it didn't happen. It was an mistake to propagate G in the Http4sBodyListener and others because F is an effect-full computation not G. G is just a monad needed only in the Http[OptionT[G, *], F]. It would be better to remove G and F ~> G at all because it only confuse :)

@leoniv yeah you're right, unfortunately keeping tapir general & abstract enough to support multiple frameworks has its price

see #2042

Setting options for AkkaHttpServerInterpreter as explicit parameter

29add8d

ghost requested a review from adamw June 15, 2021 10:17

ghost self-assigned this Jun 15, 2021

ghost linked an issue Jun 15, 2021 that may be closed by this pull request

Consider converting *ServerOptions to an explicit parameter #1256

Closed

bartekzylinski added 11 commits June 15, 2021 12:37

Fixes in docs after changes in handling options

dba6ec5

Fixed compilation issue in AkkaHttpServerTest

35baac7

Setting options for Finatra based servers as explicit parameter

3bc60b4

Setting options for Http4s based servers as explicit parameter

54f9e13

Setting options for PlayServerInterpreter as explicit parameter

f776b00

Setting options for Vertx based servers as explicit parameter

3e1df5e

Setting options for Http4sClientInterpreter as explicit parameter

2a86735

Setting options for PlayClientInterpreter as explicit parameter

b59f54c

Setting options for Sttp based clients as explicit parameter

416e181

Setting options for OpenApiDocsInterpreter as explicit parameter

bec9900

Setting options for AsyncAPIInterpreter as explicit parameter

b12b3cf

adamw reviewed Jun 18, 2021

View reviewed changes

bartekzylinski added 9 commits June 21, 2021 09:33

Removed duplicated brakes from README

67fe428

Removed depreacted traits

f489684

Move options to SttpClientInterpreter and used self-type in Extensions

013da1f

Renames for Http4s based servers

1a54628

Moved compation objects for Vertx based servers to traits

828b60b

Removed implicit keyword for default options

520556c

Setting options for AwsCatsEffectServerInterpreter as explicit parameter

9eda3b1

Setting options for AwsSamInterpreter as explicit parameter

259c215

Setting options for AwsTerraformInterpreter as explicit parameter

1434366

bartekzylinski added 3 commits June 22, 2021 09:15

Fixes after resolving merge conflicts

1746528

Change zioReadStreamCompatible to explicit

84b3c53

adamw reviewed Jun 22, 2021

View reviewed changes

bartekzylinski added 2 commits June 22, 2021 14:21

Fixes after failed CI

d4de859

Added type parameter to Http4sServerInterpreter usage

5a5e6f6

adamw reviewed Jun 22, 2021

View reviewed changes

bartekzylinski and others added 8 commits June 23, 2021 08:53

Fixes after review

b53705f

- Removed not needed implicit Concurrent[IO] - Moved Vertex based interpreters to root package - Replace usage of toHttp interpreter with normal interpreter

Change implicit ReadStremCompatibiles to explicit

8676e8b

Fixes after failed CI

2de3ef7

- Removed additional test which do not exists on master - Fixed calls to Http4sClientInterpreter - Removed unused imports

Adjust docs

c7857c7

Simplify example in docs

11675b3

Remove whitespace, formatting

7a43abb

Remove implicit options & simplify aws terraform example

1f84695

Fix test compilation

e074b99

adamw merged commit 9ee85e1 into softwaremill:master Jun 23, 2021

leoniv reviewed Apr 1, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Setting options for AkkaHttpServerInterpreter as explicit parameter #1321

Setting options for AkkaHttpServerInterpreter as explicit parameter #1321

ghost commented Jun 15, 2021

adamw Jun 18, 2021

adamw Jun 18, 2021

adamw Jun 18, 2021

adamw Jun 18, 2021

adamw Jun 18, 2021

adamw commented Jun 18, 2021

adamw Jun 22, 2021

ghost Jun 22, 2021

adamw Jun 22, 2021

ghost Jun 22, 2021

adamw Jun 22, 2021

adamw Jun 22, 2021

adamw Jun 22, 2021

adamw Jun 22, 2021

adamw Jun 22, 2021

adamw Jun 22, 2021

ghost Jun 23, 2021

adamw Jun 23, 2021

ghost Jun 23, 2021

leoniv Apr 1, 2022

adamw Apr 1, 2022

leoniv Apr 2, 2022

leoniv Apr 6, 2022 •

edited

Loading

adamw Apr 11, 2022

		@@ -8,6 +8,8 @@ import scala.concurrent.Future

		trait SttpClientInterpreterExtensions {

		def sttpClientOptions: SttpClientOptions = SttpClientOptions.default

Setting options for AkkaHttpServerInterpreter as explicit parameter #1321

Setting options for AkkaHttpServerInterpreter as explicit parameter #1321

Conversation

ghost commented Jun 15, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adamw commented Jun 18, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

leoniv Apr 6, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

leoniv Apr 6, 2022 •

edited

Loading