Merge remote-tracking branch 'tapir/master' into http4s-migrate-to-ember

Author: ivan-klass

README.md

@@ -251,4 +251,4 @@ We offer commercial support for tapir and related technologies, as well as devel
 
 ## Copyright
 
-Copyright (C) 2018-2024 SoftwareMill [https://softwaremill.com](https://softwaremill.com).
+Copyright (C) 2018-2025 SoftwareMill [https://softwaremill.com](https://softwaremill.com).

build.sbt

@@ -1000,7 +1000,7 @@ lazy val pekkoGrpcExamples: ProjectMatrix = (projectMatrix in file("grpc/pekko-e
   .settings(
     name := "tapir-pekko-grpc-examples",
     libraryDependencies ++= Seq(
-      "org.apache.pekko" %% "pekko-discovery" % "1.1.2",
+      "org.apache.pekko" %% "pekko-discovery" % "1.1.3",
       slf4j
     ),
     fork := true
@@ -2077,7 +2077,9 @@ lazy val examples: ProjectMatrix = (projectMatrix in file("examples"))
       "io.opentelemetry" % "opentelemetry-sdk" % Versions.openTelemetry,
       "io.opentelemetry" % "opentelemetry-sdk-metrics" % Versions.openTelemetry,
       "io.opentelemetry" % "opentelemetry-exporter-otlp" % Versions.openTelemetry,
+      "io.opentelemetry" % "opentelemetry-sdk-extension-autoconfigure" % Versions.openTelemetry,
       "com.github.plokhotnyuk.jsoniter-scala" %%% "jsoniter-scala-macros" % Versions.jsoniter,
+      "org.typelevel" %% "otel4s-oteljava" % Versions.otel4s,
       scalaTest.value,
       logback
     ),
@@ -2110,6 +2112,7 @@ lazy val examples: ProjectMatrix = (projectMatrix in file("examples"))
     sttpStubServer,
     swaggerUiBundle,
     redocBundle,
+    vertxServer,
     zioHttpServer,
     zioJson,
     zioMetrics

doc/endpoint/websockets.md

@@ -34,6 +34,22 @@ When creating a `webSocketBody`, we need to provide the following parameters:
 By default, ping-pong frames are handled automatically, fragmented frames are combined, and close frames aren't
 decoded, but this can be customised through methods on `webSocketBody`.
 
+## Close frames
+
+If you are using the default codecs between `WebSocketFrame` and your high-level types, and you'd like to either be
+notified that a websocket has been closed by the client, or close it from the server side, then you should wrap your
+high-level type into an `Option`.
+
+The default codecs map close frames to `None`, and regular (decoded text/binary) frames to `Some`. Hence, using the 
+following definition:
+
+```scala
+webSocketBody[Option[String], CodecFormat.TextPlain, Option[Response], CodecFormat.Json](PekkoStreams)
+```
+
+the websocket-processing pipe will receive a `None: Option[String]` when the client closes the web socket. Moreover, 
+if the pipe emits a `None: Option[Response]`, the web socket will be closed by the server.
+
 ## Raw web sockets
 
 Alternatively, it's possible to obtain a raw pipe transforming `WebSocketFrame`s: 

doc/server/zio-http4s.md

@@ -174,4 +174,4 @@ val routes: HttpRoutes[Task] =
 
 ## Examples
 
-There's a couple of [examples](../examples.md) of using the ZIO integration available.\
+There's a couple of [examples](../examples.md) of using the ZIO integration available.

doc/support.md

@@ -2,7 +2,7 @@
 
 ## Sponsors
 
-Development and maintenance of sttp tapir is sponsored by [SoftwareMill](https://softwaremill.com), a software development and consulting company. We help clients scale their business through software. We offer services around migrating and maintaining Java and Scala projects (e.g. to Java 21, or across Scala versions), ML/AI discovery workshops, introducing developer platforms (based on Kubernetes and observability technologies), and others. Our areas of expertise include performant backends, distributed systems, machine learning and data analytics, with a focus on Java, Scala, Kafka, TypeScript and Rust.
+Development and maintenance of Tapir is sponsored by [SoftwareMill](https://softwaremill.com), a software development and consulting company. We help clients scale their business through software. We offer services around migrating and maintaining Java and Scala projects (e.g. to Java 21, or across Scala versions), ML/AI discovery workshops, introducing developer platforms (based on Kubernetes and observability technologies), and others. Our areas of expertise include performant backends, distributed systems, machine learning and data analytics, with a focus on Java, Scala, Kafka, TypeScript and Rust.
 
 [![](https://files.softwaremill.com/logo/logo.png "SoftwareMill")](https://softwaremill.com)
 

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

@@ -3,7 +3,7 @@
 //> using dep com.softwaremill.sttp.tapir::tapir-core:1.11.11
 //> using dep com.softwaremill.sttp.tapir::tapir-http4s-server:1.11.11
 //> using dep com.softwaremill.sttp.client3::core:3.9.8
-//> using dep org.http4s::http4s-ember-server:0.23.16
+//> using dep org.http4s::http4s-ember-server:0.23.30
 
 package sttp.tapir.examples
 

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

@@ -5,7 +5,7 @@
 //> using dep com.softwaremill.sttp.tapir::tapir-http4s-server-zio:1.11.11
 //> using dep com.softwaremill.sttp.tapir::tapir-zio:1.11.11
 //> using dep org.http4s::http4s-ember-server:0.23.30
-//> using dep com.softwaremill.sttp.client3::async-http-client-backend-zio:3.10.1
+//> using dep com.softwaremill.sttp.client3::async-http-client-backend-zio:3.10.2
 
 package sttp.tapir.examples
 

examples/src/main/scala/sttp/tapir/examples/observability/Otel4sTracingExample.scala

@@ -0,0 +1,118 @@
+// {cat=Observability; effects=cats-effect; server=Netty; json=circe}: Otel4s collecting traces
+
+//> using dep com.softwaremill.sttp.tapir::tapir-core:1.11.11
+//> using dep com.softwaremill.sttp.tapir::tapir-netty-server-cats:1.11.11
+//> using dep com.softwaremill.sttp.tapir::tapir-json-circe:1.11.11
+//> using dep com.softwaremill.sttp.tapir::tapir-opentelemetry-metrics:1.11.11
+//> using dep "org.typelevel::otel4s-oteljava:0.11.2"
+//> using dep "io.opentelemetry:opentelemetry-sdk-extension-autoconfigure:1.45.0"
+//> using dep org.slf4j:slf4j-api:2.0.16
+
+package sttp.tapir.examples.observability
+
+import cats.effect
+import cats.effect.std.{Console, Random}
+import cats.effect.{Async, IO, IOApp}
+import io.circe.generic.auto.*
+import sttp.tapir.*
+import sttp.tapir.generic.auto.*
+import sttp.tapir.json.circe.jsonBody
+import sttp.tapir.server.netty.cats.NettyCatsServer
+import org.slf4j.{Logger, LoggerFactory}
+import org.typelevel.otel4s.Attribute
+import org.typelevel.otel4s.trace.Tracer
+import cats.syntax.all.*
+import io.opentelemetry.api.common.Attributes
+import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdkBuilder as AutoConfigOtelSdkBuilder
+import org.typelevel.otel4s.oteljava.OtelJava
+import io.opentelemetry.sdk.resources.Resource
+
+import scala.concurrent.duration.*
+import sttp.tapir.server.ServerEndpoint
+
+import scala.io.StdIn
+
+/** This example application demonstrates how to implement distributed tracing in a Scala application using the <a
+  * href="https://github.com/typelevel/otel4s"> otel4s library </a>. More info about oltel4s you may find <a
+  * href="https://typelevel.org/otel4s/">here</a>
+  *
+  * In order to collect and visualize traces, you can run Jaeger using Docker with the following command:
+  * {{{
+  *   docker run --name jaeger -e COLLECTOR_OTLP_ENABLED=true -p 16686:16686 -p 4317:4317 -p 4318:4318 jaegertracing/all-in-one:1.35
+  * }}}
+  * Jaeger UI is available at http://localhost:16686. You can find the collected traces there.
+  */
+object Otel4sTracingExample extends IOApp.Simple:
+  private val logger: Logger = LoggerFactory.getLogger(this.getClass.getName)
+
+  override def run: IO[Unit] = otel
+    .use { otel4s =>
+      otel4s.tracerProvider
+        .get("sttp.tapir.examples.observability")
+        .flatMap { case given Tracer[IO] => server(HttpApi[IO](Service[IO])) }
+    }
+
+  private def server(httpApi: HttpApi[IO]): IO[Unit] =
+    NettyCatsServer
+      .io()
+      .use { server =>
+        for {
+          bind <- server
+            .port(9090)
+            .host("localhost")
+            .addEndpoint(httpApi.doWorkServerEndpoint)
+            .start()
+          _ <- IO
+            .blocking {
+              logger.info(s"""Server started. Try it with: curl -X POST ${bind.hostName}:${bind.port}/work -d '{"steps": 10}'""")
+              logger.info("Press ENTER key to exit.")
+              StdIn.readLine()
+
+            }
+            .guarantee(bind.stop())
+        } yield ()
+      }
+
+  private def otel: effect.Resource[IO, OtelJava[IO]] = {
+    // We implemented customization here to set service name.
+    // Please notice in your, production cases could be better to use env variable instead.
+    // Under following link you may find more details about configuration https://typelevel.org/otel4s/sdk/configuration.html
+    def customize(a: AutoConfigOtelSdkBuilder): AutoConfigOtelSdkBuilder = {
+      val customResource = Resource.getDefault.merge(
+        Resource.create(Attributes.of(io.opentelemetry.api.common.AttributeKey.stringKey("service.name"), "Otel4s-Tracing-Example"))
+      )
+      a.addResourceCustomizer((resource, config) => customResource)
+      a
+    }
+    OtelJava.autoConfigured[IO](customize)
+  }
+
+class Service[F[_]: Async: Tracer: Console]:
+  def doWork(steps: Int): F[Unit] = {
+    val step = Tracer[F]
+      .span("internal-work", Attribute("step", steps.toLong))
+      .surround {
+        for {
+          random <- Random.scalaUtilRandom
+          delay <- random.nextIntBounded(1000)
+          _ <- Async[F].sleep(delay.millis)
+          _ <- Console[F].println("Do work ...")
+        } yield ()
+      }
+
+    if (steps > 0) step *> doWork(steps - 1) else step
+  }
+
+class HttpApi[F[_]: Async: Tracer](service: Service[F]):
+  private case class Work(steps: Int)
+
+  val doWorkServerEndpoint: ServerEndpoint[Any, F] = endpoint.post
+    .in("work")
+    .in(jsonBody[Work])
+    .serverLogicSuccess(work => {
+      Tracer[F].span("DoWorkRequest").use { span =>
+        span.addEvent("Do the work request received") *>
+          service.doWork(work.steps) *>
+          span.addEvent("Finished working.")
+      }
+    })

examples/src/main/scala/sttp/tapir/examples/security/OAuth2GithubHttp4sServer.scala

@@ -3,7 +3,7 @@
 //> using dep com.softwaremill.sttp.tapir::tapir-core:1.11.11
 //> using dep com.softwaremill.sttp.tapir::tapir-http4s-server:1.11.11
 //> using dep com.softwaremill.sttp.tapir::tapir-json-circe:1.11.11
-//> using dep com.softwaremill.sttp.client3::async-http-client-backend-cats:3.10.1
+//> using dep com.softwaremill.sttp.client3::async-http-client-backend-cats:3.10.2
 //> using dep org.http4s::http4s-ember-server:0.23.30
 //> using dep com.github.jwt-scala::jwt-circe:10.0.1
 

examples/src/main/scala/sttp/tapir/examples/security/ServerSecurityLogicZio.scala

@@ -2,7 +2,7 @@
 
 //> using dep com.softwaremill.sttp.tapir::tapir-core:1.11.11
 //> using dep com.softwaremill.sttp.tapir::tapir-zio-http-server:1.11.11
-//> using dep com.softwaremill.sttp.client3::async-http-client-backend-zio:3.10.1
+//> using dep com.softwaremill.sttp.client3::async-http-client-backend-zio:3.10.2
 
 package sttp.tapir.examples.security
 

examples/src/main/scala/sttp/tapir/examples/security/corsInterceptorVertxServer.scala

@@ -0,0 +1,97 @@
+// {cat=Security; effects=Future; server=Vert.x}: CORS interceptor
+
+//> using dep com.softwaremill.sttp.tapir::tapir-vertx-server:1.11.11
+//> using dep com.softwaremill.sttp.client3::core:3.10.2
+
+package sttp.tapir.examples.security
+
+import io.vertx.core.Vertx
+import io.vertx.ext.web.*
+import sttp.client3.*
+import sttp.model.headers.Origin
+import sttp.model.{Header, HeaderNames, Method, StatusCode}
+import sttp.tapir.*
+import sttp.tapir.server.interceptor.cors.{CORSConfig, CORSInterceptor}
+import sttp.tapir.server.vertx.VertxFutureServerInterpreter.*
+import sttp.tapir.server.vertx.{VertxFutureServerInterpreter, VertxFutureServerOptions}
+
+import scala.concurrent.duration.*
+import scala.concurrent.{Await, ExecutionContext, Future}
+
+@main def corsInterceptorVertxServer() =
+  given ExecutionContext = scala.concurrent.ExecutionContext.Implicits.global
+  val vertx = Vertx.vertx()
+
+  val server = vertx.createHttpServer()
+  val router = Router.router(vertx)
+
+  val myEndpoint = endpoint.get
+    .in("path")
+    .out(plainBody[String])
+    .serverLogic(_ => Future(Right("OK")))
+
+  val corsInterceptor = VertxFutureServerOptions.customiseInterceptors
+    .corsInterceptor(
+      CORSInterceptor.customOrThrow(
+        CORSConfig.default
+          .allowOrigin(Origin.Host("http", "my.origin"))
+          .allowMethods(Method.GET)
+      )
+    )
+    .options
+
+  val attach = VertxFutureServerInterpreter(corsInterceptor).route(myEndpoint)
+  attach(router)
+
+  // starting the server
+  val bindAndCheck = server.requestHandler(router).listen(9000).asScala.map { binding =>
+    val backend = HttpClientSyncBackend()
+
+    // Sending preflight request with allowed origin
+    val preflightResponse = basicRequest
+      .options(uri"http://localhost:9000/path")
+      .headers(
+        Header.origin(Origin.Host("http", "my.origin")),
+        Header.accessControlRequestMethod(Method.GET)
+      )
+      .send(backend)
+
+    assert(preflightResponse.code == StatusCode.NoContent)
+    assert(preflightResponse.headers.contains(Header.accessControlAllowOrigin("http://my.origin")))
+    assert(preflightResponse.headers.contains(Header.accessControlAllowMethods(Method.GET)))
+
+    println("Got expected response for preflight request")
+
+    // Sending preflight request with disallowed origin
+    val preflightResponseForDisallowedOrigin = basicRequest
+      .options(uri"http://localhost:9000/path")
+      .headers(
+        Header.origin(Origin.Host("http", "disallowed.com")),
+        Header.accessControlRequestMethod(Method.GET)
+      )
+      .send(backend)
+
+    // Check response does not contain allowed origin header
+    assert(preflightResponseForDisallowedOrigin.code == StatusCode.NoContent)
+    assert(!preflightResponseForDisallowedOrigin.headers.contains(Header.accessControlAllowOrigin("http://example.com")))
+
+    println("Got expected response for preflight request for wrong origin. No allowed origin header in response")
+
+    // Sending regular request from allowed origin
+    val requestResponse = basicRequest
+      .response(asStringAlways)
+      .get(uri"http://localhost:9000/path")
+      .headers(Header.origin(Origin.Host("http", "my.origin")))
+      .send(backend)
+
+    assert(requestResponse.code == StatusCode.Ok)
+    assert(requestResponse.body == "OK")
+    assert(requestResponse.headers.contains(Header.vary(HeaderNames.Origin)))
+    assert(requestResponse.headers.contains(Header.accessControlAllowOrigin("http://my.origin")))
+
+    println("Got expected response for regular request")
+
+    binding
+  }
+
+  Await.result(bindAndCheck.flatMap(_.close().asScala), 1.minute)

examples/src/main/scala/sttp/tapir/examples/status_code/statusCodeNettyServer.scala

@@ -1,4 +1,4 @@
-// {cat=Status code; effects=Direct; server=Netty}: Serving static files from a directory
+// {cat=Status code; effects=Direct; server=Netty}: Responding with fixed or dynamic status code
 
 //> using dep com.softwaremill.sttp.tapir::tapir-core:1.11.11
 //> using dep com.softwaremill.sttp.tapir::tapir-netty-server-sync:1.11.11

examples/src/main/scala/sttp/tapir/examples/websocket/WebSocketHttp4sServer.scala

@@ -5,8 +5,8 @@
 //> using dep com.softwaremill.sttp.tapir::tapir-asyncapi-docs:1.11.11
 //> using dep com.softwaremill.sttp.tapir::tapir-json-circe:1.11.11
 //> using dep com.softwaremill.sttp.apispec::asyncapi-circe-yaml:0.10.0
-//> using dep com.softwaremill.sttp.client3::async-http-client-backend-fs2:3.10.1
-//> using dep org.http4s::http4s-ember-server:0.23.16
+//> using dep com.softwaremill.sttp.client3::async-http-client-backend-fs2:3.10.2
+//> using dep org.http4s::http4s-ember-server:0.23.30
 
 package sttp.tapir.examples.websocket
 

openapi-codegen/sbt-plugin/src/sbt-test/sbt-openapi-codegen/caching/project/build.properties

@@ -1 +1 @@
-sbt.version=1.10.6
+sbt.version=1.10.7

openapi-codegen/sbt-plugin/src/sbt-test/sbt-openapi-codegen/minimal/project/build.properties

@@ -1 +1 @@
-sbt.version=1.10.6
+sbt.version=1.10.7

openapi-codegen/sbt-plugin/src/sbt-test/sbt-openapi-codegen/oneOf-json-roundtrip/project/build.properties

@@ -1 +1 @@
-sbt.version=1.10.6
+sbt.version=1.10.7

openapi-codegen/sbt-plugin/src/sbt-test/sbt-openapi-codegen/oneOf-json-roundtrip_jsoniter/build.sbt

@@ -11,8 +11,8 @@ libraryDependencies ++= Seq(
   "com.softwaremill.sttp.tapir" %% "tapir-openapi-docs" % "1.10.0",
   "com.softwaremill.sttp.apispec" %% "openapi-circe-yaml" % "0.8.0",
   "com.beachape" %% "enumeratum" % "1.7.5",
-  "com.github.plokhotnyuk.jsoniter-scala" %% "jsoniter-scala-core" % "2.32.0",
-  "com.github.plokhotnyuk.jsoniter-scala" %% "jsoniter-scala-macros" % "2.32.0" % "compile-internal",
+  "com.github.plokhotnyuk.jsoniter-scala" %% "jsoniter-scala-core" % "2.33.0",
+  "com.github.plokhotnyuk.jsoniter-scala" %% "jsoniter-scala-macros" % "2.33.0" % "compile-internal",
   "org.scalatest" %% "scalatest" % "3.2.19" % Test,
   "com.softwaremill.sttp.tapir" %% "tapir-sttp-stub-server" % "1.10.0" % Test
 )

openapi-codegen/sbt-plugin/src/sbt-test/sbt-openapi-codegen/oneOf-json-roundtrip_jsoniter/project/build.properties

@@ -1 +1 @@
-sbt.version=1.10.6
+sbt.version=1.10.7

openapi-codegen/sbt-plugin/src/sbt-test/sbt-openapi-codegen/oneOf-json-roundtrip_jsoniter_scala3/build.sbt

@@ -11,8 +11,8 @@ libraryDependencies ++= Seq(
   "com.softwaremill.sttp.tapir" %% "tapir-openapi-docs" % "1.10.0",
   "com.softwaremill.sttp.apispec" %% "openapi-circe-yaml" % "0.8.0",
   "com.beachape" %% "enumeratum" % "1.7.5",
-  "com.github.plokhotnyuk.jsoniter-scala" %% "jsoniter-scala-core" % "2.32.0",
-  "com.github.plokhotnyuk.jsoniter-scala" %% "jsoniter-scala-macros" % "2.32.0" % "compile-internal",
+  "com.github.plokhotnyuk.jsoniter-scala" %% "jsoniter-scala-core" % "2.33.0",
+  "com.github.plokhotnyuk.jsoniter-scala" %% "jsoniter-scala-macros" % "2.33.0" % "compile-internal",
   "org.scalatest" %% "scalatest" % "3.2.19" % Test,
   "com.softwaremill.sttp.tapir" %% "tapir-sttp-stub-server" % "1.10.0" % Test
 )

openapi-codegen/sbt-plugin/src/sbt-test/sbt-openapi-codegen/oneOf-json-roundtrip_jsoniter_scala3/project/build.properties

@@ -1 +1 @@
-sbt.version=1.10.6
+sbt.version=1.10.7

openapi-codegen/sbt-plugin/src/sbt-test/sbt-openapi-codegen/oneOf-json-roundtrip_scala3/project/build.properties

@@ -1 +1 @@
-sbt.version=1.10.6
+sbt.version=1.10.7

openapi-codegen/sbt-plugin/src/sbt-test/sbt-openapi-codegen/option-overrides/project/build.properties

@@ -1 +1 @@
-sbt.version=1.10.6
+sbt.version=1.10.7