Add example of starting both grpc and connectrpc servers together

Author: igor-vovk

build.sbt

@@ -28,6 +28,7 @@ lazy val noPublish = List(
 )
 
 lazy val Versions = new {
+  val cedi      = "0.2.1"
   val grpc      = "1.73.0"
   val http4s    = "0.23.30"
   val logback   = "1.5.18"
@@ -37,7 +38,7 @@ lazy val Versions = new {
   val scalatest = "3.2.19"
 }
 
-lazy val CommonDependencies = Seq(
+lazy val commonDeps = Seq(
   libraryDependencies ++= Seq(
     "org.slf4j"      % "slf4j-api" % Versions.slf4j,
     "org.scalatest" %% "scalatest" % Versions.scalatest % Test,
@@ -53,6 +54,7 @@ lazy val core = project
     Test / PB.targets := Seq(
       scalapb.gen() -> (Test / sourceManaged).value
     ),
+    commonDeps,
     libraryDependencies ++= Seq(
       "com.thesamet.scalapb.common-protos" %% "proto-google-common-protos-scalapb_0.11" % "2.9.6-0" % "protobuf",
       "com.thesamet.scalapb.common-protos" %% "proto-google-common-protos-scalapb_0.11" % "2.9.6-0",
@@ -66,7 +68,6 @@ lazy val core = project
       "org.http4s" %% "http4s-core" % Versions.http4s,
     ),
   )
-  .settings(CommonDependencies)
 
 lazy val http4s = project
   .dependsOn(core)
@@ -75,42 +76,64 @@ lazy val http4s = project
     Test / PB.targets := Seq(
       scalapb.gen() -> (Test / sourceManaged).value
     ),
+    commonDeps,
     libraryDependencies ++= Seq(
       "org.http4s" %% "http4s-dsl"    % Versions.http4s % Test,
       "org.http4s" %% "http4s-client" % Versions.http4s,
     ),
   )
-  .settings(CommonDependencies)
 
 lazy val netty = project
   .dependsOn(core)
   .settings(
     name := "connect-rpc-scala-netty",
+    commonDeps,
     libraryDependencies ++= Seq(
       "io.netty" % "netty-all" % Versions.netty
     ),
   )
-  .settings(CommonDependencies)
 
 lazy val conformance = project
   .dependsOn(http4s, netty)
   .enablePlugins(Fs2Grpc, JavaAppPackaging)
   .settings(
     noPublish,
+    commonDeps,
     libraryDependencies ++= Seq(
       "org.http4s"    %% "http4s-ember-server" % Versions.http4s,
       "org.http4s"    %% "http4s-ember-client" % Versions.http4s,
       "ch.qos.logback" % "logback-classic"     % Versions.logback % Runtime,
     ),
   )
-  .settings(CommonDependencies)
+
+lazy val examples = project.in(file("examples"))
+  .aggregate(
+    example_connectrpc_grpc_servers
+  )
+  .settings(noPublish)
+
+lazy val example_connectrpc_grpc_servers = project.in(file("examples/connectrpc_grpc_servers"))
+  .dependsOn(http4s)
+  .enablePlugins(Fs2Grpc)
+  .settings(
+    noPublish,
+    commonDeps,
+    libraryDependencies ++= Seq(
+      "me.ivovk"      %% "cedi"                % Versions.cedi,
+      "io.grpc"        % "grpc-netty"          % Versions.grpc,
+      "org.http4s"    %% "http4s-ember-server" % Versions.http4s,
+      "ch.qos.logback" % "logback-classic"     % Versions.logback % Runtime,
+    ),
+    Compile / mainClass := Some("examples.connectrpc_grpc_servers.Main"),
+  )
 
 lazy val root = (project in file("."))
   .aggregate(
     core,
     http4s,
     netty,
     conformance,
+    examples,
   )
   .settings(
     name := "connect-rpc-scala",

examples/README.md

@@ -0,0 +1,4 @@
+# List of examples
+
+- **connectrpc_grpc_servers**: Example of starting both a gRPC server and a ConnectRPC server in the same component on
+  different ports.

examples/connectrpc_grpc_servers/README.md

@@ -0,0 +1,19 @@
+# gRPC and ConnectRPC Servers Example
+
+This example demonstrates the pattern of starting both a gRPC server and a ConnectRPC server in the same component on
+different ports.
+
+Example shows that the same service is run by both servers, and the gRPC server is used to handle
+gRPC requests, while the ConnectRPC server is used to handle ConnectRPC requests.
+
+Dependencies are wired using [Cedi](https://github.com/igor-vovk/cedi) library.
+
+Testing the ConnectRPC server:
+1. Start the server by running:
+```bash
+sbt example_connectrpc_grpc_servers/run
+```
+2. Use `curl` to send http requests to the ConnectRPC server:
+```bash
+curl -X POST http://localhost:8080/examples.v1.ElizaService/Say -d '{"sentence": "Hello Connectrpc"}' -H 'Content-Type: application/json'
+```

examples/connectrpc_grpc_servers/build.sbt

@@ -0,0 +1 @@
+Compile / mainClass := Some("examples.connectrpc_grpc_servers.Main")

examples/connectrpc_grpc_servers/src/main/protobuf/examples/v1/eliza.proto

@@ -0,0 +1,15 @@
+syntax = "proto3";
+
+package examples.v1;
+
+message SayRequest {
+  string sentence = 1;
+}
+
+message SayResponse {
+  string sentence = 1;
+}
+
+service ElizaService {
+  rpc Say(SayRequest) returns (SayResponse) {}
+}

examples/connectrpc_grpc_servers/src/main/protobuf/examples/v1/package.proto

@@ -0,0 +1,15 @@
+syntax = "proto3";
+
+package examples.v1;
+
+import "scalapb/scalapb.proto";
+
+option (scalapb.options) = {
+  scope: PACKAGE
+  flat_package: false
+  lenses: false
+  enum_value_naming: CAMEL_CASE
+  enum_strip_prefix: true
+  preserve_unknown_fields: false
+  scala3_sources: true
+};

examples/connectrpc_grpc_servers/src/main/resources/logback.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!DOCTYPE configuration>
+
+<configuration>
+
+    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+        <encoder>
+            <pattern>%-4relative %-5level %logger{5} -%kvp- %msg%n</pattern>
+        </encoder>
+    </appender>
+
+    <root level="INFO">
+        <appender-ref ref="STDOUT"/>
+    </root>
+    <logger name="org.ivovk" level="TRACE"/>
+</configuration>

examples/connectrpc_grpc_servers/src/main/scala/examples/connectrpc_grpc_servers/Dependencies.scala

@@ -0,0 +1,54 @@
+package examples.connectrpc_grpc_servers
+
+import cats.effect.{IO, Resource}
+import com.comcast.ip4s.*
+import examples.v1.eliza.ElizaServiceFs2Grpc
+import fs2.grpc.syntax.all.*
+import io.grpc.ServerServiceDefinition
+import io.grpc.netty.NettyServerBuilder
+import me.ivovk.cedi.Allocator
+import me.ivovk.cedi.syntax.*
+import org.http4s.HttpApp
+import org.http4s.ember.server.EmberServerBuilder
+import org.ivovk.connect_rpc_scala.http4s.ConnectHttp4sRouteBuilder
+
+object Dependencies {
+
+  def create(): Resource[IO, Dependencies] =
+    Allocator.create[IO]().map(Dependencies(using _))
+
+}
+
+class Dependencies(using AllocatorIO) {
+
+  lazy val elizaService: ElizaService[IO] = new ElizaService[IO]
+
+  // This example uses the `fs2.grpc` syntax to allocate resources for the gRPC service, but you can also use
+  // ZIO-gRPC or any other gRPC library for Scala to obtain ServerServiceDefinition of your services.
+  lazy val elizaServiceGrpcDefinition: ServerServiceDefinition = allocate {
+    ElizaServiceFs2Grpc.bindServiceResource[IO](elizaService)
+  }
+
+  lazy val httpApp: org.http4s.HttpApp[IO] = allocate {
+    ConnectHttp4sRouteBuilder.forService[IO](elizaServiceGrpcDefinition).build
+  }
+
+  lazy val connectRpcServer: Resource[IO, org.http4s.server.Server] =
+    EmberServerBuilder.default[IO]
+      .withHost(host"0.0.0.0")
+      .withPort(port"8080")
+      .withHttpApp(httpApp)
+      .build
+
+  lazy val grpcServer: Resource[IO, io.grpc.Server] =
+    NettyServerBuilder.forPort(9090)
+      .addService(elizaServiceGrpcDefinition)
+      .resource[IO]
+      .evalMap { server =>
+        IO(server.start())
+      }
+
+  lazy val run: IO[Unit] =
+    (grpcServer, connectRpcServer).parTupled.useForever
+
+}

examples/connectrpc_grpc_servers/src/main/scala/examples/connectrpc_grpc_servers/ElizaService.scala

@@ -0,0 +1,14 @@
+package examples.connectrpc_grpc_servers
+
+import cats.effect.Sync
+import examples.v1.eliza.{ElizaServiceFs2Grpc, SayRequest, SayResponse}
+import io.grpc.Metadata
+
+class ElizaService[F[_]: Sync] extends ElizaServiceFs2Grpc[F, Metadata] {
+
+  def say(request: SayRequest, ctx: Metadata): F[SayResponse] =
+    Sync[F].delay {
+      SayResponse(s"You've said: ${request.sentence}")
+    }
+
+}

examples/connectrpc_grpc_servers/src/main/scala/examples/connectrpc_grpc_servers/Main.scala

@@ -0,0 +1,10 @@
+package examples.connectrpc_grpc_servers
+
+import cats.effect.{IO, IOApp}
+
+object Main extends IOApp.Simple {
+
+  def run: IO[Unit] =
+    Dependencies.create().use(_.run)
+
+}