2015-06-01 18:55:27 +01:00
|
|
|
package server
|
|
|
|
|
|
|
|
import (
|
|
|
|
"bytes"
|
2015-11-25 19:50:05 +00:00
|
|
|
|
2015-11-28 11:22:29 +00:00
|
|
|
"github.com/micro/go-micro/codec"
|
2019-01-07 13:48:38 +00:00
|
|
|
raw "github.com/micro/go-micro/codec/bytes"
|
2019-01-02 12:55:06 +00:00
|
|
|
"github.com/micro/go-micro/codec/grpc"
|
|
|
|
"github.com/micro/go-micro/codec/json"
|
2015-11-28 18:54:38 +00:00
|
|
|
"github.com/micro/go-micro/codec/jsonrpc"
|
2019-01-02 12:55:06 +00:00
|
|
|
"github.com/micro/go-micro/codec/proto"
|
2015-11-28 18:54:38 +00:00
|
|
|
"github.com/micro/go-micro/codec/protorpc"
|
2019-07-09 18:41:26 +01:00
|
|
|
"github.com/micro/go-micro/transport"
|
server/rpc_codec: if c.codec.Write fails, reset write buffer and encode an error message about the encoding failure
When developing go-micro services, it is frequently possible to set invalid results in the response pointer. When this happens (as I and @trushton personally experienced), `sendResponse()` returns an error correctly explaining what happened (e.g. protobuf refused to encode a bad struct) but the `call()` function one above it in the stack ignores the returned error object.
Thus, invalid structs go un-encoded and the _client side times out_. @trushton and I first caught this in our CI builds when we left a protobuf.Empty field uninitialized (nil) instead of setting it to `&ptypes.Empty{}`. This resulted in an `proto: oneof field has nil value` error, but it was dropped and became a terribly confusing client timeout instead.
This patch is two independent changes:
* In rpc_codec, when a serialization failure occurs serialize an error message, which will correctly become a 500 for HTTP services, about the encoding failure. This means rpc_codec only returns an `error` when a socket failure occurs, which I believe is the behavior that rpc_service is expecting anyway.
* In rpc_service, log any errors returned by sendResponse instead of dropping the error object. This will make debugging client timeouts less of a hassle.
2017-07-11 17:51:36 -04:00
|
|
|
"github.com/pkg/errors"
|
2015-06-01 18:55:27 +01:00
|
|
|
)
|
|
|
|
|
2018-11-23 20:05:31 +00:00
|
|
|
type rpcCodec struct {
|
2015-06-01 18:55:27 +01:00
|
|
|
socket transport.Socket
|
2015-11-28 11:22:29 +00:00
|
|
|
codec codec.Codec
|
2019-01-08 15:38:25 +00:00
|
|
|
first bool
|
2015-06-01 18:55:27 +01:00
|
|
|
|
|
|
|
req *transport.Message
|
2015-10-15 22:06:43 +01:00
|
|
|
buf *readWriteCloser
|
|
|
|
}
|
2015-06-01 18:55:27 +01:00
|
|
|
|
2015-10-15 22:06:43 +01:00
|
|
|
type readWriteCloser struct {
|
2015-06-01 18:55:27 +01:00
|
|
|
wbuf *bytes.Buffer
|
|
|
|
rbuf *bytes.Buffer
|
|
|
|
}
|
|
|
|
|
2015-11-28 11:22:29 +00:00
|
|
|
var (
|
2019-01-07 13:48:38 +00:00
|
|
|
DefaultContentType = "application/protobuf"
|
|
|
|
|
|
|
|
DefaultCodecs = map[string]codec.NewCodec{
|
2019-01-02 12:55:06 +00:00
|
|
|
"application/grpc": grpc.NewCodec,
|
|
|
|
"application/grpc+json": grpc.NewCodec,
|
|
|
|
"application/grpc+proto": grpc.NewCodec,
|
2018-12-31 22:01:16 +00:00
|
|
|
"application/json": json.NewCodec,
|
2015-11-28 18:54:38 +00:00
|
|
|
"application/json-rpc": jsonrpc.NewCodec,
|
2018-12-31 22:01:16 +00:00
|
|
|
"application/protobuf": proto.NewCodec,
|
2015-11-28 18:54:38 +00:00
|
|
|
"application/proto-rpc": protorpc.NewCodec,
|
2019-01-07 13:48:38 +00:00
|
|
|
"application/octet-stream": raw.NewCodec,
|
2015-11-28 11:22:29 +00:00
|
|
|
}
|
2019-01-18 10:12:57 +00: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,
|
|
|
|
}
|
2015-11-28 11:22:29 +00:00
|
|
|
)
|
|
|
|
|
2015-10-15 22:06:43 +01:00
|
|
|
func (rwc *readWriteCloser) Read(p []byte) (n int, err error) {
|
|
|
|
return rwc.rbuf.Read(p)
|
2015-06-01 18:55:27 +01:00
|
|
|
}
|
|
|
|
|
2015-10-15 22:06:43 +01:00
|
|
|
func (rwc *readWriteCloser) Write(p []byte) (n int, err error) {
|
|
|
|
return rwc.wbuf.Write(p)
|
|
|
|
}
|
2015-06-01 18:55:27 +01:00
|
|
|
|
2015-10-15 22:06:43 +01:00
|
|
|
func (rwc *readWriteCloser) Close() error {
|
|
|
|
rwc.rbuf.Reset()
|
|
|
|
rwc.wbuf.Reset()
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2019-01-24 10:11:02 +00: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) {
|
|
|
|
get := func(hdr, v string) string {
|
|
|
|
if len(v) > 0 {
|
|
|
|
return v
|
|
|
|
}
|
|
|
|
|
|
|
|
if hd := m.Header[hdr]; len(hd) > 0 {
|
|
|
|
return hd
|
|
|
|
}
|
|
|
|
|
|
|
|
// old
|
|
|
|
return m.Header["X-"+hdr]
|
|
|
|
}
|
|
|
|
|
|
|
|
m.Id = get("Micro-Id", m.Id)
|
|
|
|
m.Error = get("Micro-Error", m.Error)
|
|
|
|
m.Endpoint = get("Micro-Endpoint", m.Endpoint)
|
|
|
|
m.Method = get("Micro-Method", m.Method)
|
|
|
|
m.Target = get("Micro-Service", m.Target)
|
|
|
|
|
|
|
|
// 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 10:12:57 +00:00
|
|
|
// setupProtocol sets up the old protocol
|
|
|
|
func setupProtocol(msg *transport.Message) codec.NewCodec {
|
2019-01-24 10:11:02 +00: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)
|
2019-01-18 10:43:41 +00:00
|
|
|
|
|
|
|
// if the protocol exists (mucp) do nothing
|
|
|
|
if len(protocol) > 0 {
|
2019-01-18 10:12:57 +00:00
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2019-01-18 10:43:41 +00: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 10:12:57 +00:00
|
|
|
|
2019-01-18 10:43:41 +00:00
|
|
|
// old target method specified
|
|
|
|
if len(target) > 0 {
|
|
|
|
return defaultCodecs[msg.Header["Content-Type"]]
|
|
|
|
}
|
2019-01-18 10:12:57 +00:00
|
|
|
|
2019-01-18 10:43:41 +00:00
|
|
|
// no method then set to endpoint
|
|
|
|
if len(method) == 0 {
|
2019-01-24 10:11:02 +00:00
|
|
|
msg.Header["Micro-Method"] = endpoint
|
2019-01-18 10:12:57 +00:00
|
|
|
}
|
|
|
|
|
2019-01-18 10:43:41 +00:00
|
|
|
// no endpoint then set to method
|
|
|
|
if len(endpoint) == 0 {
|
2019-01-24 10:11:02 +00:00
|
|
|
msg.Header["Micro-Endpoint"] = method
|
2019-01-18 10:43:41 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
return nil
|
2019-01-18 10:12:57 +00:00
|
|
|
}
|
|
|
|
|
2019-01-08 15:38:25 +00:00
|
|
|
func newRpcCodec(req *transport.Message, socket transport.Socket, c codec.NewCodec) codec.Codec {
|
2015-11-25 19:50:05 +00:00
|
|
|
rwc := &readWriteCloser{
|
2019-08-16 14:42:45 +01:00
|
|
|
rbuf: bytes.NewBuffer(nil),
|
2015-11-25 19:50:05 +00:00
|
|
|
wbuf: bytes.NewBuffer(nil),
|
|
|
|
}
|
2018-11-23 20:05:31 +00:00
|
|
|
r := &rpcCodec{
|
2015-11-25 19:50:05 +00:00
|
|
|
buf: rwc,
|
2015-11-28 11:22:29 +00:00
|
|
|
codec: c(rwc),
|
2015-10-16 11:15:17 +01:00
|
|
|
req: req,
|
2015-11-25 19:50:05 +00:00
|
|
|
socket: socket,
|
2015-06-01 18:55:27 +01:00
|
|
|
}
|
2015-10-15 22:06:43 +01:00
|
|
|
return r
|
|
|
|
}
|
|
|
|
|
2019-01-08 15:38:25 +00:00
|
|
|
func (c *rpcCodec) ReadHeader(r *codec.Message, t codec.MessageType) error {
|
2019-01-24 10:11:02 +00:00
|
|
|
// the initial message
|
2019-01-09 16:20:57 +00:00
|
|
|
m := codec.Message{
|
|
|
|
Header: c.req.Header,
|
|
|
|
Body: c.req.Body,
|
|
|
|
}
|
2015-12-18 20:28:50 +00:00
|
|
|
|
2019-08-15 20:08:49 +01:00
|
|
|
var tm transport.Message
|
2019-01-08 15:38:25 +00:00
|
|
|
|
2019-08-15 20:08:49 +01: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-14 21:30:43 +00:00
|
|
|
|
2019-08-15 20:08:49 +01:00
|
|
|
// write the body to the buffer
|
|
|
|
if _, err := c.buf.rbuf.Write(tm.Body); err != nil {
|
|
|
|
return err
|
2015-12-16 02:15:09 +00:00
|
|
|
}
|
|
|
|
|
2019-08-15 20:08:49 +01:00
|
|
|
// set the message header
|
|
|
|
m.Header = tm.Header
|
|
|
|
// set the message body
|
|
|
|
m.Body = tm.Body
|
|
|
|
|
|
|
|
// set req
|
|
|
|
c.req = &tm
|
2019-01-08 15:38:25 +00:00
|
|
|
|
2018-12-31 22:01:16 +00:00
|
|
|
// set some internal things
|
2019-01-24 10:11:02 +00:00
|
|
|
getHeaders(&m)
|
2019-01-07 09:11:36 +00:00
|
|
|
|
|
|
|
// read header via codec
|
2019-01-24 10:11:02 +00:00
|
|
|
if err := c.codec.ReadHeader(&m, codec.Request); err != nil {
|
|
|
|
return err
|
2019-01-18 10:23:36 +00:00
|
|
|
}
|
|
|
|
|
2019-02-01 15:57:34 +00:00
|
|
|
// fallback for 0.14 and older
|
|
|
|
if len(m.Endpoint) == 0 {
|
|
|
|
m.Endpoint = m.Method
|
|
|
|
}
|
|
|
|
|
2019-01-24 10:11:02 +00:00
|
|
|
// set message
|
|
|
|
*r = m
|
|
|
|
|
|
|
|
return nil
|
2015-06-01 18:55:27 +01:00
|
|
|
}
|
|
|
|
|
2019-01-07 18:20:47 +00:00
|
|
|
func (c *rpcCodec) ReadBody(b interface{}) error {
|
2019-01-14 21:30:43 +00:00
|
|
|
// don't read empty body
|
|
|
|
if len(c.req.Body) == 0 {
|
|
|
|
return nil
|
|
|
|
}
|
2019-01-16 15:27:57 +00:00
|
|
|
// read raw data
|
|
|
|
if v, ok := b.(*raw.Frame); ok {
|
|
|
|
v.Data = c.req.Body
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
// decode the usual way
|
2015-11-28 11:22:29 +00:00
|
|
|
return c.codec.ReadBody(b)
|
2015-06-01 18:55:27 +01:00
|
|
|
}
|
|
|
|
|
2019-01-09 16:20:57 +00:00
|
|
|
func (c *rpcCodec) Write(r *codec.Message, b interface{}) error {
|
2015-10-15 22:06:43 +01:00
|
|
|
c.buf.wbuf.Reset()
|
2019-01-08 15:38:25 +00:00
|
|
|
|
|
|
|
// create a new message
|
2015-11-28 11:22:29 +00:00
|
|
|
m := &codec.Message{
|
2019-01-18 10:12:57 +00:00
|
|
|
Target: r.Target,
|
|
|
|
Method: r.Method,
|
2019-01-10 21:25:31 +00:00
|
|
|
Endpoint: r.Endpoint,
|
|
|
|
Id: r.Id,
|
|
|
|
Error: r.Error,
|
|
|
|
Type: r.Type,
|
2019-01-14 21:30:43 +00:00
|
|
|
Header: r.Header,
|
|
|
|
}
|
|
|
|
|
|
|
|
if m.Header == nil {
|
|
|
|
m.Header = map[string]string{}
|
2019-01-11 13:44:47 +00:00
|
|
|
}
|
|
|
|
|
2019-01-24 10:11:02 +00:00
|
|
|
setHeaders(m, r)
|
2019-01-08 15:38:25 +00:00
|
|
|
|
2019-01-09 16:20:57 +00:00
|
|
|
// the body being sent
|
|
|
|
var body []byte
|
|
|
|
|
2019-01-16 15:27:57 +00:00
|
|
|
// 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 16:20:57 +00:00
|
|
|
body = r.Body
|
2019-01-14 21:30:43 +00:00
|
|
|
// write the body to codec
|
2019-01-09 16:20:57 +00:00
|
|
|
} else if err := c.codec.Write(m, b); err != nil {
|
server/rpc_codec: if c.codec.Write fails, reset write buffer and encode an error message about the encoding failure
When developing go-micro services, it is frequently possible to set invalid results in the response pointer. When this happens (as I and @trushton personally experienced), `sendResponse()` returns an error correctly explaining what happened (e.g. protobuf refused to encode a bad struct) but the `call()` function one above it in the stack ignores the returned error object.
Thus, invalid structs go un-encoded and the _client side times out_. @trushton and I first caught this in our CI builds when we left a protobuf.Empty field uninitialized (nil) instead of setting it to `&ptypes.Empty{}`. This resulted in an `proto: oneof field has nil value` error, but it was dropped and became a terribly confusing client timeout instead.
This patch is two independent changes:
* In rpc_codec, when a serialization failure occurs serialize an error message, which will correctly become a 500 for HTTP services, about the encoding failure. This means rpc_codec only returns an `error` when a socket failure occurs, which I believe is the behavior that rpc_service is expecting anyway.
* In rpc_service, log any errors returned by sendResponse instead of dropping the error object. This will make debugging client timeouts less of a hassle.
2017-07-11 17:51:36 -04:00
|
|
|
c.buf.wbuf.Reset()
|
2019-01-08 15:38:25 +00:00
|
|
|
|
|
|
|
// write an error if it failed
|
server/rpc_codec: if c.codec.Write fails, reset write buffer and encode an error message about the encoding failure
When developing go-micro services, it is frequently possible to set invalid results in the response pointer. When this happens (as I and @trushton personally experienced), `sendResponse()` returns an error correctly explaining what happened (e.g. protobuf refused to encode a bad struct) but the `call()` function one above it in the stack ignores the returned error object.
Thus, invalid structs go un-encoded and the _client side times out_. @trushton and I first caught this in our CI builds when we left a protobuf.Empty field uninitialized (nil) instead of setting it to `&ptypes.Empty{}`. This resulted in an `proto: oneof field has nil value` error, but it was dropped and became a terribly confusing client timeout instead.
This patch is two independent changes:
* In rpc_codec, when a serialization failure occurs serialize an error message, which will correctly become a 500 for HTTP services, about the encoding failure. This means rpc_codec only returns an `error` when a socket failure occurs, which I believe is the behavior that rpc_service is expecting anyway.
* In rpc_service, log any errors returned by sendResponse instead of dropping the error object. This will make debugging client timeouts less of a hassle.
2017-07-11 17:51:36 -04:00
|
|
|
m.Error = errors.Wrapf(err, "Unable to encode body").Error()
|
2019-01-07 09:11:36 +00:00
|
|
|
m.Header["X-Micro-Error"] = m.Error
|
2019-01-24 10:11:02 +00:00
|
|
|
m.Header["Micro-Error"] = m.Error
|
2019-01-09 16:20:57 +00:00
|
|
|
// no body to write
|
server/rpc_codec: if c.codec.Write fails, reset write buffer and encode an error message about the encoding failure
When developing go-micro services, it is frequently possible to set invalid results in the response pointer. When this happens (as I and @trushton personally experienced), `sendResponse()` returns an error correctly explaining what happened (e.g. protobuf refused to encode a bad struct) but the `call()` function one above it in the stack ignores the returned error object.
Thus, invalid structs go un-encoded and the _client side times out_. @trushton and I first caught this in our CI builds when we left a protobuf.Empty field uninitialized (nil) instead of setting it to `&ptypes.Empty{}`. This resulted in an `proto: oneof field has nil value` error, but it was dropped and became a terribly confusing client timeout instead.
This patch is two independent changes:
* In rpc_codec, when a serialization failure occurs serialize an error message, which will correctly become a 500 for HTTP services, about the encoding failure. This means rpc_codec only returns an `error` when a socket failure occurs, which I believe is the behavior that rpc_service is expecting anyway.
* In rpc_service, log any errors returned by sendResponse instead of dropping the error object. This will make debugging client timeouts less of a hassle.
2017-07-11 17:51:36 -04:00
|
|
|
if err := c.codec.Write(m, nil); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2019-01-09 16:20:57 +00:00
|
|
|
} else {
|
|
|
|
// set the body
|
|
|
|
body = c.buf.wbuf.Bytes()
|
2015-06-01 18:55:27 +01:00
|
|
|
}
|
2015-12-16 02:15:09 +00:00
|
|
|
|
2019-01-11 13:44:47 +00:00
|
|
|
// Set content type if theres content
|
|
|
|
if len(body) > 0 {
|
|
|
|
m.Header["Content-Type"] = c.req.Header["Content-Type"]
|
|
|
|
}
|
|
|
|
|
2019-01-08 15:38:25 +00:00
|
|
|
// send on the socket
|
2015-06-01 18:55:27 +01:00
|
|
|
return c.socket.Send(&transport.Message{
|
2016-01-28 18:11:13 +00:00
|
|
|
Header: m.Header,
|
2019-01-09 16:20:57 +00:00
|
|
|
Body: body,
|
2015-06-01 18:55:27 +01:00
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2018-11-23 20:05:31 +00:00
|
|
|
func (c *rpcCodec) Close() error {
|
2015-10-15 22:06:43 +01:00
|
|
|
c.buf.Close()
|
2015-11-28 11:22:29 +00:00
|
|
|
c.codec.Close()
|
2015-06-01 18:55:27 +01:00
|
|
|
return c.socket.Close()
|
|
|
|
}
|
2019-01-08 15:38:25 +00:00
|
|
|
|
|
|
|
func (c *rpcCodec) String() string {
|
|
|
|
return "rpc"
|
|
|
|
}
|