[Issue #417] gRPC design doc and protobuf models (#594)

* [Issue #337] Fix HttpSubscriber startup issue * [Issue #337] test commit * [Issue #337] revert test commit * [Issue #337] Enhance Http Demo Subscriber by using ExecutorService, CountDownLatch and PreDestroy hook * [Issue #337] Enhance Http Demo Subscriber by using ExecutorService, CountDownLatch and PreDestroy hook * [Issue #337] Address code review comment for Subscriber Demo App * adding license headers * adding grpc build file * [Issue#417] update settings.gradle * [Issue#417] fix grpc generated code styles * [Issue#417] fix grpc generated code styles * [Issue#417] fix grpc generated code styles * [Issue#417] fix grpc generated code styles and license issue * [Issue#417] fix license issue * [Issue #417] ignore checkstyle for generated files * [Issue #417] adding allow licensed for grpc protobuf Co-authored-by: j00441484 <[email protected]>
apache · Nov 22, 2021 · dafa5a7 · dafa5a7
1 parent 46f973d
commit dafa5a7
Show file tree

Hide file tree

Showing 22 changed files with 10,774 additions and 0 deletions.
diff --git a/build.gradle b/build.gradle
@@ -87,6 +87,8 @@ allprojects {
         maxWarnings = 0
         configFile = new File("${rootDir}/style/checkStyle.xml")
     }
+
+    checkstyleMain.exclude '**/org/apache/eventmesh/client/grpc/protos**'
 }
 
 task tar(type: Tar) {

diff --git a/docs/cn/instructions/eventmesh-runtime-protocol.md b/docs/cn/instructions/eventmesh-runtime-protocol.md
@@ -258,3 +258,123 @@ public class LiteMessage {
 | 场景               | Server向Client发送消息请求码 | Client回复Server消息响应码 | 说明                   |
 | ------------------ | ---------------------------- | -------------------------- | ---------------------- |
 | 客户端接收异步事件 | HTTP_PUSH_CLIENT_ASYNC(105)  | retCode                    | retCode值为0时代表成功 |
+
+
+## gRPC 协议文档
+
+#### 1. protobuf
+
+在 `eventmesh-protocol-gprc` 模块有 Eventmesh gRPC 客户端的 protobuf 文件. the protobuf 文件路径是 `/src/main/proto/eventmesh-client.proto`.
+
+用gradle build 生成 gRPC 代码在 `/build/generated/source/proto/main`. 生成代码用于 `eventmesh-sdk-java` 模块.
+
+#### 2. gRPC 数据模型
+
+- 消息
+
+以下消息数据模型用于 `publish()`, `requestReply()` 和 `broadcast()` APIs.
+
+```
+message RequestHeader {
+    string env = 1;
+    string region = 2;
+    string idc = 3;
+    string ip = 4;
+    string pid = 5;
+    string sys = 6;
+    string username = 7;
+    string password = 8;
+    string version = 9;
+    string language = 10;
+    string seqNum = 11;
+}
+
+message Message {
+   RequestHeader header = 1;
+   string productionGroup = 2;
+   string topic = 3;
+   string content = 4;
+   string ttl = 5;
+   string uniqueId = 6;
+}
+
+message Response {
+   string respCode = 1;
+   string respMsg = 2;
+   string respTime = 3;
+   string seqNum = 4;
+}
+```
+
+- 订阅
+
+以下订阅数据模型用于 `subscribe()` 和 `unsubscribe()` APIs.
+
+```
+message Subscription {
+   RequestHeader header = 1;
+   string consumerGroup = 2;
+
+   message SubscriptionItem {
+      string topic = 1;
+      string mode = 2;
+      string type = 3;
+      string url = 4;
+   }
+
+   repeated SubscriptionItem subscriptionItems = 3;
+}
+```
+
+- 心跳
+
+以下心跳数据模型用于 `heartbeat()` API.
+
+```
+message Heartbeat {
+  RequestHeader header = 1;
+  string clientType = 2;
+  string producerGroup = 3;
+  string consumerGroup = 4;
+
+  message HeartbeatItem {
+     string topic = 1;
+     string url = 2;
+  }
+
+  repeated HeartbeatItem heartbeatItems = 5;
+}
+```
+
+#### 3. gRPC 服务接口
+
+- 事件生产端服务 APIs
+
+```
+   # 异步事件生产
+   rpc publish(Message) returns (Response);
+
+   # 同步事件生产
+   rpc requestReply(Message) returns (Response);
+
+   # 事件广播
+   rpc broadcast(Message) returns (Response);
+```
+
+- 事件消费端服务 APIs
+
+```
+   # 所消费事件通过 HTTP Webhook推送事件
+   rpc subscribe(Subscription) returns (Response);
+
+   # 所消费事件通过 TCP stream推送事件
+   rpc subscribeStream(Subscription) returns (stream Message);
+
+   rpc unsubscribe(Subscription) returns (Response);
+```
+
+- 客户端心跳服务 API
+
+```
+   rpc heartbeat(Heartbeat) returns (Response);
+```
diff --git a/docs/en/instructions/eventmesh-runtime-protocol.md b/docs/en/instructions/eventmesh-runtime-protocol.md
@@ -259,3 +259,125 @@ same with RequestHeader of Heartbeat Msg
 | Scene                | Server Send | Client Reply | Remark                  |
 | ------------------ | ---------------------------- | -------------------------- | ---------------------- |
 | Push async msg to client | HTTP_PUSH_CLIENT_ASYNC(105)  | retCode              | retCode=0,send success |
+
+## gRPC Protocol Document In Eventmesh-Runtime
+
+#### 1. protobuf
+
+The `eventmesh-protocol-gprc` module contains the protobuf file of the evenmesh client. the protobuf file
+is located as `/src/main/proto/eventmesh-client.proto`.
+
+Run the gradle build to generate the gRPC codes. The generated codes are located at `/build/generated/source/proto/main`.
+
+These generated grpc codes will be used in `eventmesh-sdk-java` module.
+
+#### 2. data models
+
+- message
+
+The following is the message data model, used by `publish()`, `requestReply()` and `broadcast()` APIs.
+
+```
+message RequestHeader {
+    string env = 1;
+    string region = 2;
+    string idc = 3;
+    string ip = 4;
+    string pid = 5;
+    string sys = 6;
+    string username = 7;
+    string password = 8;
+    string version = 9;
+    string language = 10;
+    string seqNum = 11;
+}
+
+message Message {
+   RequestHeader header = 1;
+   string productionGroup = 2;
+   string topic = 3;
+   string content = 4;
+   string ttl = 5;
+   string uniqueId = 6;
+}
+
+message Response {
+   string respCode = 1;
+   string respMsg = 2;
+   string respTime = 3;
+   string seqNum = 4;
+}
+```
+
+- subscription
+
+The following data model is used by `subscribe()` and `unsubscribe()` APIs.
+
+```
+message Subscription {
+   RequestHeader header = 1;
+   string consumerGroup = 2;
+
+   message SubscriptionItem {
+      string topic = 1;
+      string mode = 2;
+      string type = 3;
+      string url = 4;
+   }
+
+   repeated SubscriptionItem subscriptionItems = 3;
+}
+```
+
+- heartbeat
+
+The following data model is used by `heartbeat()` API.
+
+```
+message Heartbeat {
+  RequestHeader header = 1;
+  string clientType = 2;
+  string producerGroup = 3;
+  string consumerGroup = 4;
+
+  message HeartbeatItem {
+     string topic = 1;
+     string url = 2;
+  }
+
+  repeated HeartbeatItem heartbeatItems = 5;
+}
+```
+
+#### 3. service operations
+
+- event publisher service APIs
+
+```
+   # Async event publish
+   rpc publish(Message) returns (Response);
+
+   # Sync event publish
+   rpc requestReply(Message) returns (Response);
+
+   # event broadcast
+   rpc broadcast(Message) returns (Response);
+```
+
+- event consumer service APIs
+
+```
+   # The subscribed event will be delivered by invoking the webhook url in the Subscription
+   rpc subscribe(Subscription) returns (Response);
+
+   # The subscribed event will be delivered through stream of Message
+   rpc subscribeStream(Subscription) returns (stream Message);
+
+   rpc unsubscribe(Subscription) returns (Response);
+```
+
+- client heartbeat service API
+
+```
+   rpc heartbeat(Heartbeat) returns (Response);
+```
diff --git a/eventmesh-protocol-plugin/eventmesh-protocol-grpc/build.gradle b/eventmesh-protocol-plugin/eventmesh-protocol-grpc/build.gradle
@@ -0,0 +1,53 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.
+ */
+
+plugins {
+    id 'java'
+    id 'com.google.protobuf' version '0.8.17'
+}
+
+repositories {
+    mavenCentral()
+}
+
+def grpcVersion = '1.15.0' // CURRENT_GRPC_VERSION
+def protobufVersion = '3.5.1'
+def protocVersion = protobufVersion
+
+dependencies {
+    implementation "io.grpc:grpc-protobuf:${grpcVersion}"
+    implementation "io.grpc:grpc-stub:${grpcVersion}"
+    implementation "com.google.protobuf:protobuf-java-util:${protobufVersion}"
+    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.6.0'
+    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine'
+}
+
+protobuf {
+    protoc { artifact = "com.google.protobuf:protoc:${protocVersion}" }
+    plugins {
+        grpc { artifact = "io.grpc:protoc-gen-grpc-java:${grpcVersion}" }
+    }
+    generateProtoTasks {
+        all()*.plugins {
+            grpc {}
+        }
+    }
+}
+
+test {
+    useJUnitPlatform()
+}