Initial Commit

Signed-off-by: Valery Piashchynski <piashchynski.valery@gmail.com>

Author: rustatian

.gitignore

@@ -13,3 +13,4 @@
 
 # Dependency directories (remove the comment below to include it)
 # vendor/
+.idea

README.md

@@ -1,2 +1,182 @@
-# grpc
-RRv2 gRPC plugin
+## PHP Client
+
+[Roadrunner GRPC](https://github.com/spiral/roadrunner-grpc)
+
+### Compiling proto sample:
+```
+protoc --plugin=protoc-gen-php-grpc --php-grpc_out=<OUTPUT DIRECTORY> simple.proto
+```
+
+- `protoc-gen-php-grpc` plugin can be downloaded from the `roadrunner-binary` releases page.
+
+## Configuration
+
+```yaml
+grpc:
+  # GRPC address to listen
+  #
+  # This option is required
+  listen: "tcp://localhost:9001"
+
+  # Proto files to use
+  #
+  # This option is required. At least one proto file must be specified.
+  proto:
+      - "proto/test/test.proto"
+      - "proto/health/health.proto"
+
+  # GRPC TLS configuration
+  #
+  # This section is optional
+  tls:
+    # Path to the key file
+    #
+    # This option is required
+    key: ""
+
+    # Path to the certificate
+    #
+    # This option is required
+    cert: ""
+
+    # Path to the CA certificate
+    #
+    # This option is optional
+    root_ca: ""
+
+    # Client auth type
+    #
+    # This option is optional. Default value: no_client_certs. Possible values: request_client_cert, require_any_client_cert, verify_client_cert_if_given, require_and_verify_client_cert, no_client_certs
+    client_auth_type: ""
+
+  # Maximum send message size
+  #
+  # This option is optional. Default value: 50 (MB)
+  max_send_msg_size: 50
+
+  # Maximum receive message size
+  #
+  # This option is optional. Default value: 50 (MB)
+  max_recv_msg_size: 50
+
+  # MaxConnectionIdle is a duration for the amount of time after which an
+  #	idle connection would be closed by sending a GoAway. Idleness duration is
+  #	defined since the most recent time the number of outstanding RPCs became
+  #	zero or the connection establishment.
+  #
+  # This option is optional. Default value: infinity.
+  max_connection_idle: 0s
+
+  # MaxConnectionAge is a duration for the maximum amount of time a
+  #	connection may exist before it will be closed by sending a GoAway. A
+  #	random jitter of +/-10% will be added to MaxConnectionAge to spread out
+  #	connection storms.
+  #
+  # This option is optional. Default value: infinity.
+  max_connection_age: 0s
+
+  # MaxConnectionAgeGrace is an additive period after MaxConnectionAge after
+  #	which the connection will be forcibly closed.
+  max_connection_age_grace: 0s
+
+  # MaxConnectionAgeGrace is an additive period after MaxConnectionAge after
+  #	which the connection will be forcibly closed.
+  #
+  # This option is optional: Default value: 10
+  max_concurrent_streams: 10
+
+  # After a duration of this time if the server doesn't see any activity it
+  #	pings the client to see if the transport is still alive.
+  #	If set below 1s, a minimum value of 1s will be used instead.
+  #
+  # This option is optional. Default value: 2h
+  ping_time: 1s
+
+  # After having pinged for keepalive check, the server waits for a duration
+  #	of Timeout and if no activity is seen even after that the connection is
+  #	closed.
+  #
+  # This option is optional. Default value: 20s
+  timeout: 200s
+
+  # Usual workers pool configuration
+  pool:
+    num_workers: 2
+    max_jobs: 0
+    allocate_timeout: 60s
+    destroy_timeout: 60
+```
+
+## Minimal dependencies:
+
+1. `Server` plugin for the workers pool.
+2. `Logger` plugin to show log messages.
+3. `Config` plugin to read and populate plugin's configuration.
+
+## GRPC worker sample:
+
+```php
+<?php
+
+/**
+ * Sample GRPC PHP server.
+ */
+
+use Service\EchoInterface;
+use Spiral\RoadRunner\GRPC\Server;
+use Spiral\RoadRunner\Worker;
+
+require __DIR__ . '/vendor/autoload.php';
+
+$server = new Server(null, [
+    'debug' => false, // optional (default: false)
+]);
+
+$server->registerService(EchoInterface::class, new EchoService());
+
+$server->serve(Worker::create());
+
+```
+
+#### Proto file sample:
+
+```protobuf
+syntax = "proto3";
+
+package service;
+option go_package = "./;test";
+
+service Test {
+    rpc Echo (Message) returns (Message) {
+    }
+
+    rpc Throw (Message) returns (Message) {
+    }
+
+    rpc Die (Message) returns (Message) {
+    }
+
+    rpc Info (Message) returns (Message) {
+    }
+
+    rpc Ping (EmptyMessage) returns (EmptyMessage) {
+    }
+}
+
+message Message {
+    string msg = 1;
+}
+
+message EmptyMessage {
+}
+
+message DetailsMessageForException {
+    uint64 code = 1;
+    string message = 2;
+}
+```
+
+Test certificates (including `root ca`) located [here](../../tests/plugins/grpc/configs/test-certs).
+
+## Common issues:
+1. Registering two services with the same name is not allowed. GRPC server will panic after that.

codec/codec.go

@@ -0,0 +1,46 @@
+package codec
+
+import "google.golang.org/grpc/encoding"
+
+type RawMessage []byte
+
+// By default, gRPC registers and uses the "proto" codec, so it is not necessary to do this in your own code to send and receive proto messages.
+// https://github.com/grpc/grpc-go/blob/master/Documentation/encoding.md#using-a-codec
+const Name string = "proto"
+const rm string = "rawMessage"
+
+func (r RawMessage) Reset()       {}
+func (RawMessage) ProtoMessage()  {}
+func (RawMessage) String() string { return rm }
+
+type Codec struct {
+	Base encoding.Codec
+}
+
+// Marshal returns the wire format of v. rawMessages would be returned without encoding.
+func (c *Codec) Marshal(v interface{}) ([]byte, error) {
+	if raw, ok := v.(RawMessage); ok {
+		return raw, nil
+	}
+
+	return c.Base.Marshal(v)
+}
+
+// Unmarshal parses the wire format into v. rawMessages would not be unmarshalled.
+func (c *Codec) Unmarshal(data []byte, v interface{}) error {
+	if raw, ok := v.(*RawMessage); ok {
+		*raw = data
+		return nil
+	}
+
+	return c.Base.Unmarshal(data, v)
+}
+
+func (c *Codec) Name() string {
+	return Name
+}
+
+// String return codec name.
+func (c *Codec) String() string {
+	return "raw:" + c.Base.Name()
+}

codec/codec_test.go

@@ -0,0 +1,79 @@
+package codec
+
+import (
+	"testing"
+
+	json "github.com/json-iterator/go"
+	"github.com/stretchr/testify/assert"
+)
+
+type jsonCodec struct{}
+
+func (jsonCodec) Marshal(v interface{}) ([]byte, error) {
+	return json.Marshal(v)
+}
+
+func (jsonCodec) Unmarshal(data []byte, v interface{}) error {
+	return json.Unmarshal(data, v)
+}
+
+func (jsonCodec) Name() string {
+	return "json"
+}
+
+func TestCodec_String(t *testing.T) {
+	c := Codec{jsonCodec{}}
+
+	assert.Equal(t, "raw:json", c.String())
+
+	r := RawMessage{}
+	r.Reset()
+	r.ProtoMessage()
+	assert.Equal(t, "rawMessage", r.String())
+}
+
+func TestCodec_Unmarshal_ByPass(t *testing.T) {
+	c := Codec{jsonCodec{}}
+
+	s := struct {
+		Name string
+	}{}
+
+	assert.NoError(t, c.Unmarshal([]byte(`{"name":"name"}`), &s))
+	assert.Equal(t, "name", s.Name)
+}
+
+func TestCodec_Marshal_ByPass(t *testing.T) {
+	c := Codec{jsonCodec{}}
+
+	s := struct {
+		Name string
+	}{
+		Name: "name",
+	}
+
+	d, err := c.Marshal(s)
+	assert.NoError(t, err)
+
+	assert.Equal(t, `{"Name":"name"}`, string(d))
+}
+
+func TestCodec_Unmarshal_Raw(t *testing.T) {
+	c := Codec{jsonCodec{}}
+
+	s := RawMessage{}
+
+	assert.NoError(t, c.Unmarshal([]byte(`{"name":"name"}`), &s))
+	assert.Equal(t, `{"name":"name"}`, string(s))
+}
+
+func TestCodec_Marshal_Raw(t *testing.T) {
+	c := Codec{jsonCodec{}}
+
+	s := RawMessage(`{"Name":"name"}`)
+
+	d, err := c.Marshal(s)
+	assert.NoError(t, err)
+
+	assert.Equal(t, `{"Name":"name"}`, string(d))
+}