airframe-rpc: Add an RPC project example (#1250)

.gitignore

@@ -30,7 +30,6 @@ website/yarn.lock
 website/node_modules
 website/i18n/*
 
-log/*
-airframe-benchmark/log/*
+**/log/*json*
 .vscode/launch.json
 project/metals.sbt

docs/airframe-rpc.md

@@ -486,7 +486,7 @@ sbt-airframe generates ServiceGrpc.scala file to the target API package. You can
 import example.api.ServiceGrpc
 
 // Create a client channel
-val channel = ManagedChannel.forTaget("localhost:8080").usePlaintext().build()
+val channel = ManagedChannelBuilder.forTaget("localhost:8080").usePlaintext().build()
 
 // Create a gRPC blocking client (SyncClient)
 val client = ServiceGrpc.newSyncClient(channel)

examples/rpc-examples/hello-rpc/.scalafmt.conf

@@ -0,0 +1,4 @@
+version = 2.6.4
+maxColumn = 120
+style = defaultWithAlign
+optIn.breaksInsideChains = true

examples/rpc-examples/hello-rpc/build.sbt

@@ -0,0 +1,19 @@
+val AIRFRAME_VERSION = "20.8.0"
+scalaVersion in ThisBuild := "2.12.12"
+
+// RPC API definition. This project should contain only RPC interfaces
+lazy val greeter =
+  project
+    .in(file("."))
+    .enablePlugins(AirframeHttpPlugin, PackPlugin)
+    .settings(
+      // Generates HTTP clients
+      airframeHttpClients := Seq("greeter.api:sync", "greeter.api:grpc"),
+      airframeHttpGeneratorOption := "-l debug",
+      libraryDependencies ++= Seq(
+        "org.wvlet.airframe" %% "airframe-http"         % AIRFRAME_VERSION,
+        "org.wvlet.airframe" %% "airframe-http-finagle" % AIRFRAME_VERSION,
+        "org.wvlet.airframe" %% "airframe-http-grpc"    % AIRFRAME_VERSION,
+        "org.wvlet.airframe" %% "airframe-launcher"     % AIRFRAME_VERSION
+      )
+    )

examples/rpc-examples/hello-rpc/project/build.properties

@@ -0,0 +1 @@
+sbt.version=1.3.13

examples/rpc-examples/hello-rpc/project/plugins.sbt

@@ -0,0 +1,3 @@
+addSbtPlugin("org.xerial.sbt"     % "sbt-pack"     % "0.12")
+addSbtPlugin("org.wvlet.airframe" % "sbt-airframe" % "20.8.0")
+addSbtPlugin("org.scalameta"      % "sbt-scalafmt" % "2.4.2")

examples/rpc-examples/hello-rpc/src/main/scala/greeter/GreeterMain.scala

@@ -0,0 +1,99 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package greeter
+
+import greeter.api.{GreeterApi, ServiceGrpc, ServiceSyncClient}
+import io.grpc.{ManagedChannel, ManagedChannelBuilder}
+import wvlet.airframe.control.Control.withResource
+import wvlet.airframe.http.Router
+import wvlet.airframe.http.finagle.Finagle
+import wvlet.airframe.http.grpc.gRPC
+import wvlet.airframe.launcher.{Launcher, command, option}
+import wvlet.log.{LogSupport, Logger}
+
+/**
+  */
+object GreeterMain {
+  def main(args: Array[String]): Unit = {
+    Launcher.of[GreeterMain].execute(args)
+  }
+}
+
+class GreeterMain(
+    @option(prefix = "-h,--help", description = "show help messages", isHelp = true)
+    help: Boolean,
+    @option(prefix = "-p,--port", description = "server/client port (default:8080)")
+    port: Int = 8080
+) extends LogSupport {
+  Logger.init
+
+  private def router = Router.of[GreeterApi]
+
+  @command(isDefault = true)
+  def default: Unit = {
+    info(s"Type --help to see the list of commands")
+  }
+
+  @command(description = "Start a Finagle server")
+  def finagleServer: Unit = {
+    Finagle.server
+      .withRouter(router)
+      .withPort(port)
+      .start { server =>
+        server.waitServerTermination
+      }
+  }
+
+  @command(description = "Make Finagle RPC requests")
+  def finagleClient(@option(prefix = "-n", description = "request count") n: Int = 3): Unit = {
+    withResource(
+      new ServiceSyncClient(
+        Finagle.client
+          .newSyncClient(s"localhost:${port}")
+      )
+    ) { client =>
+      for (i <- 0 until n) {
+        val response = client.GreeterApi.hello(s"RPC${i}")
+        info(s"Received: ${response}")
+      }
+    }
+  }
+
+  @command(description = "Start a gRPC server")
+  def grpcServer: Unit = {
+    gRPC.server
+      .withRouter(router)
+      .withPort(port)
+      .start { server =>
+        server.awaitTermination
+      }
+  }
+
+  @command(description = "Make gRPC requests")
+  def grpcClient(@option(prefix = "-n", description = "request count") n: Int = 3): Unit = {
+    val channel: ManagedChannel =
+      ManagedChannelBuilder
+        .forTarget(s"localhost:${port}")
+        .usePlaintext()
+        .build()
+
+    val client = ServiceGrpc.newSyncClient(channel)
+    for (i <- 0 until n) {
+      val response = client.GreeterApi.hello(s"RPC${i}")
+      info(s"Received: ${response}")
+    }
+    channel.shutdownNow()
+  }
+
+}

examples/rpc-examples/hello-rpc/src/main/scala/greeter/api/GreeterApi.scala

@@ -0,0 +1,12 @@
+package greeter.api
+
+import wvlet.airframe.http.RPC
+import wvlet.log.LogSupport
+
+@RPC
+class GreeterApi extends LogSupport {
+  def hello(name: String) = {
+    info(s"Received a request from: ${name}")
+    s"Hello ${name}!"
+  }
+}