micro/server/rpc_codec.go

355 lines
7.5 KiB
Go
Raw Normal View History

package server
import (
"bytes"
"sync"
2015-11-25 22:50:05 +03:00
"github.com/micro/go-micro/codec"
raw "github.com/micro/go-micro/codec/bytes"
2019-01-02 15:55:06 +03:00
"github.com/micro/go-micro/codec/grpc"
"github.com/micro/go-micro/codec/json"
2015-11-28 21:54:38 +03:00
"github.com/micro/go-micro/codec/jsonrpc"
2019-01-02 15:55:06 +03:00
"github.com/micro/go-micro/codec/proto"
2015-11-28 21:54:38 +03:00
"github.com/micro/go-micro/codec/protorpc"
2019-07-09 20:41:26 +03:00
"github.com/micro/go-micro/transport"
"github.com/oxtoacart/bpool"
"github.com/pkg/errors"
)
2018-11-23 23:05:31 +03:00
type rpcCodec struct {
2019-08-26 14:33:59 +03:00
socket transport.Socket
codec codec.Codec
protocol string
req *transport.Message
buf *readWriteCloser
// check if we're the first
sync.RWMutex
first chan bool
}
type readWriteCloser struct {
sync.RWMutex
wbuf *bytes.Buffer
rbuf *bytes.Buffer
}
var (
DefaultContentType = "application/protobuf"
DefaultCodecs = map[string]codec.NewCodec{
2019-01-02 15:55:06 +03:00
"application/grpc": grpc.NewCodec,
"application/grpc+json": grpc.NewCodec,
"application/grpc+proto": grpc.NewCodec,
2019-01-01 01:01:16 +03:00
"application/json": json.NewCodec,
2015-11-28 21:54:38 +03:00
"application/json-rpc": jsonrpc.NewCodec,
2019-01-01 01:01:16 +03:00
"application/protobuf": proto.NewCodec,
2015-11-28 21:54:38 +03:00
"application/proto-rpc": protorpc.NewCodec,
"application/octet-stream": raw.NewCodec,
}
2019-01-18 13:12:57 +03:00
// TODO: remove legacy codec list
defaultCodecs = map[string]codec.NewCodec{
"application/json": jsonrpc.NewCodec,
"application/json-rpc": jsonrpc.NewCodec,
"application/protobuf": protorpc.NewCodec,
"application/proto-rpc": protorpc.NewCodec,
"application/octet-stream": protorpc.NewCodec,
}
// the local buffer pool
bufferPool = bpool.NewSizedBufferPool(32, 1)
)
func (rwc *readWriteCloser) Read(p []byte) (n int, err error) {
rwc.RLock()
defer rwc.RUnlock()
return rwc.rbuf.Read(p)
}
func (rwc *readWriteCloser) Write(p []byte) (n int, err error) {
rwc.Lock()
defer rwc.Unlock()
return rwc.wbuf.Write(p)
}
func (rwc *readWriteCloser) Close() error {
return nil
}
2019-01-24 13:11:02 +03:00
func getHeader(hdr string, md map[string]string) string {
if hd := md[hdr]; len(hd) > 0 {
return hd
}
return md["X-"+hdr]
}
func getHeaders(m *codec.Message) {
set := func(v, hdr string) string {
2019-01-24 13:11:02 +03:00
if len(v) > 0 {
return v
}
return m.Header[hdr]
2019-01-24 13:11:02 +03:00
}
m.Id = set(m.Id, "Micro-Id")
m.Error = set(m.Error, "Micro-Error")
m.Endpoint = set(m.Endpoint, "Micro-Endpoint")
m.Method = set(m.Method, "Micro-Method")
m.Target = set(m.Target, "Micro-Service")
2019-01-24 13:11:02 +03:00
// TODO: remove this cruft
if len(m.Endpoint) == 0 {
m.Endpoint = m.Method
}
}
func setHeaders(m, r *codec.Message) {
set := func(hdr, v string) {
if len(v) == 0 {
return
}
m.Header[hdr] = v
m.Header["X-"+hdr] = v
}
// set headers
set("Micro-Id", r.Id)
set("Micro-Service", r.Target)
set("Micro-Method", r.Method)
set("Micro-Endpoint", r.Endpoint)
set("Micro-Error", r.Error)
}
2019-01-18 13:12:57 +03:00
// setupProtocol sets up the old protocol
func setupProtocol(msg *transport.Message) codec.NewCodec {
2019-01-24 13:11:02 +03:00
service := getHeader("Micro-Service", msg.Header)
method := getHeader("Micro-Method", msg.Header)
endpoint := getHeader("Micro-Endpoint", msg.Header)
protocol := getHeader("Micro-Protocol", msg.Header)
target := getHeader("Micro-Target", msg.Header)
topic := getHeader("Micro-Topic", msg.Header)
2019-01-18 13:43:41 +03:00
// if the protocol exists (mucp) do nothing
if len(protocol) > 0 {
2019-01-18 13:12:57 +03:00
return nil
}
// newer method of processing messages over transport
if len(topic) > 0 {
return nil
}
2019-01-18 13:43:41 +03:00
// if no service/method/endpoint then it's the old protocol
if len(service) == 0 && len(method) == 0 && len(endpoint) == 0 {
return defaultCodecs[msg.Header["Content-Type"]]
}
2019-01-18 13:12:57 +03:00
2019-01-18 13:43:41 +03:00
// old target method specified
if len(target) > 0 {
return defaultCodecs[msg.Header["Content-Type"]]
}
2019-01-18 13:12:57 +03:00
2019-01-18 13:43:41 +03:00
// no method then set to endpoint
if len(method) == 0 {
2019-01-24 13:11:02 +03:00
msg.Header["Micro-Method"] = endpoint
2019-01-18 13:12:57 +03:00
}
2019-01-18 13:43:41 +03:00
// no endpoint then set to method
if len(endpoint) == 0 {
2019-01-24 13:11:02 +03:00
msg.Header["Micro-Endpoint"] = method
2019-01-18 13:43:41 +03:00
}
return nil
2019-01-18 13:12:57 +03:00
}
2019-01-08 18:38:25 +03:00
func newRpcCodec(req *transport.Message, socket transport.Socket, c codec.NewCodec) codec.Codec {
2015-11-25 22:50:05 +03:00
rwc := &readWriteCloser{
rbuf: bufferPool.Get(),
wbuf: bufferPool.Get(),
2015-11-25 22:50:05 +03:00
}
2019-08-26 14:33:59 +03:00
2018-11-23 23:05:31 +03:00
r := &rpcCodec{
2019-08-26 14:33:59 +03:00
buf: rwc,
codec: c(rwc),
req: req,
socket: socket,
protocol: "mucp",
first: make(chan bool),
2019-08-26 14:33:59 +03:00
}
// if grpc pre-load the buffer
// TODO: remove this terrible hack
switch r.codec.String() {
case "grpc":
// write the body
rwc.rbuf.Write(req.Body)
// set the protocol
r.protocol = "grpc"
default:
// first is not preloaded
close(r.first)
}
2019-08-26 14:33:59 +03:00
return r
}
2019-01-08 18:38:25 +03:00
func (c *rpcCodec) ReadHeader(r *codec.Message, t codec.MessageType) error {
2019-01-24 13:11:02 +03:00
// the initial message
2019-01-09 19:20:57 +03:00
m := codec.Message{
Header: c.req.Header,
Body: c.req.Body,
}
2019-08-26 14:33:59 +03:00
// first message could be pre-loaded
select {
case <-c.first:
// not the first
2019-08-26 14:33:59 +03:00
var tm transport.Message
2019-01-08 18:38:25 +03:00
2019-08-26 14:33:59 +03:00
// read off the socket
if err := c.socket.Recv(&tm); err != nil {
return err
}
// reset the read buffer
c.buf.rbuf.Reset()
2019-01-15 00:30:43 +03:00
2019-08-26 14:33:59 +03:00
// write the body to the buffer
if _, err := c.buf.rbuf.Write(tm.Body); err != nil {
return err
}
// set the message header
m.Header = tm.Header
// set the message body
m.Body = tm.Body
2015-12-16 05:15:09 +03:00
2019-08-26 14:33:59 +03:00
// set req
c.req = &tm
default:
// we need to lock here to prevent race conditions
// and we make use of a channel otherwise because
// this does not result in a context switch
// locking to check c.first on every call to ReadHeader
// would otherwise drastically slow the code execution
c.Lock()
// recheck before closing because the select statement
// above is not thread safe, so thread safety here is
// mandatory
select {
case <-c.first:
default:
// disable first
close(c.first)
}
// now unlock and we never need this again
c.Unlock()
2019-08-26 14:33:59 +03:00
}
2019-08-15 22:08:49 +03:00
2019-01-01 01:01:16 +03:00
// set some internal things
2019-01-24 13:11:02 +03:00
getHeaders(&m)
2019-01-07 12:11:36 +03:00
// read header via codec
2019-01-24 13:11:02 +03:00
if err := c.codec.ReadHeader(&m, codec.Request); err != nil {
return err
2019-01-18 13:23:36 +03:00
}
2019-02-01 18:57:34 +03:00
// fallback for 0.14 and older
if len(m.Endpoint) == 0 {
m.Endpoint = m.Method
}
2019-01-24 13:11:02 +03:00
// set message
*r = m
return nil
}
2019-01-07 21:20:47 +03:00
func (c *rpcCodec) ReadBody(b interface{}) error {
2019-01-15 00:30:43 +03:00
// don't read empty body
if len(c.req.Body) == 0 {
return nil
}
// read raw data
if v, ok := b.(*raw.Frame); ok {
v.Data = c.req.Body
return nil
}
// decode the usual way
return c.codec.ReadBody(b)
}
2019-01-09 19:20:57 +03:00
func (c *rpcCodec) Write(r *codec.Message, b interface{}) error {
c.buf.wbuf.Reset()
2019-01-08 18:38:25 +03:00
// create a new message
m := &codec.Message{
2019-01-18 13:12:57 +03:00
Target: r.Target,
Method: r.Method,
2019-01-11 00:25:31 +03:00
Endpoint: r.Endpoint,
Id: r.Id,
Error: r.Error,
Type: r.Type,
2019-01-15 00:30:43 +03:00
Header: r.Header,
}
if m.Header == nil {
m.Header = map[string]string{}
2019-01-11 16:44:47 +03:00
}
2019-01-24 13:11:02 +03:00
setHeaders(m, r)
2019-01-08 18:38:25 +03:00
2019-01-09 19:20:57 +03:00
// the body being sent
var body []byte
// is it a raw frame?
if v, ok := b.(*raw.Frame); ok {
body = v.Data
// if we have encoded data just send it
} else if len(r.Body) > 0 {
2019-01-09 19:20:57 +03:00
body = r.Body
2019-01-15 00:30:43 +03:00
// write the body to codec
2019-01-09 19:20:57 +03:00
} else if err := c.codec.Write(m, b); err != nil {
c.buf.wbuf.Reset()
2019-01-08 18:38:25 +03:00
// write an error if it failed
m.Error = errors.Wrapf(err, "Unable to encode body").Error()
2019-01-24 13:11:02 +03:00
m.Header["Micro-Error"] = m.Error
2019-01-09 19:20:57 +03:00
// no body to write
if err := c.codec.Write(m, nil); err != nil {
return err
}
2019-01-09 19:20:57 +03:00
} else {
// set the body
body = c.buf.wbuf.Bytes()
}
2015-12-16 05:15:09 +03:00
2019-01-11 16:44:47 +03:00
// Set content type if theres content
if len(body) > 0 {
m.Header["Content-Type"] = c.req.Header["Content-Type"]
}
2019-01-08 18:38:25 +03:00
// send on the socket
return c.socket.Send(&transport.Message{
2016-01-28 21:11:13 +03:00
Header: m.Header,
2019-01-09 19:20:57 +03:00
Body: body,
})
}
2018-11-23 23:05:31 +03:00
func (c *rpcCodec) Close() error {
// close the codec
c.codec.Close()
// close the socket
err := c.socket.Close()
// put back the buffers
bufferPool.Put(c.buf.rbuf)
bufferPool.Put(c.buf.wbuf)
// return the error
return err
}
2019-01-08 18:38:25 +03:00
func (c *rpcCodec) String() string {
2019-08-26 14:33:59 +03:00
return c.protocol
2019-01-08 18:38:25 +03:00
}