d4b149046f
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.
119 lines
2.5 KiB
Go
119 lines
2.5 KiB
Go
package server
|
|
|
|
import (
|
|
"bytes"
|
|
|
|
"github.com/micro/go-micro/codec"
|
|
"github.com/micro/go-micro/codec/jsonrpc"
|
|
"github.com/micro/go-micro/codec/protorpc"
|
|
"github.com/micro/go-micro/transport"
|
|
"github.com/pkg/errors"
|
|
)
|
|
|
|
type rpcPlusCodec struct {
|
|
socket transport.Socket
|
|
codec codec.Codec
|
|
|
|
req *transport.Message
|
|
buf *readWriteCloser
|
|
}
|
|
|
|
type readWriteCloser struct {
|
|
wbuf *bytes.Buffer
|
|
rbuf *bytes.Buffer
|
|
}
|
|
|
|
var (
|
|
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,
|
|
}
|
|
)
|
|
|
|
func (rwc *readWriteCloser) Read(p []byte) (n int, err error) {
|
|
return rwc.rbuf.Read(p)
|
|
}
|
|
|
|
func (rwc *readWriteCloser) Write(p []byte) (n int, err error) {
|
|
return rwc.wbuf.Write(p)
|
|
}
|
|
|
|
func (rwc *readWriteCloser) Close() error {
|
|
rwc.rbuf.Reset()
|
|
rwc.wbuf.Reset()
|
|
return nil
|
|
}
|
|
|
|
func newRpcPlusCodec(req *transport.Message, socket transport.Socket, c codec.NewCodec) serverCodec {
|
|
rwc := &readWriteCloser{
|
|
rbuf: bytes.NewBuffer(req.Body),
|
|
wbuf: bytes.NewBuffer(nil),
|
|
}
|
|
r := &rpcPlusCodec{
|
|
buf: rwc,
|
|
codec: c(rwc),
|
|
req: req,
|
|
socket: socket,
|
|
}
|
|
return r
|
|
}
|
|
|
|
func (c *rpcPlusCodec) ReadRequestHeader(r *request, first bool) error {
|
|
m := codec.Message{Header: c.req.Header}
|
|
|
|
if !first {
|
|
var tm transport.Message
|
|
if err := c.socket.Recv(&tm); err != nil {
|
|
return err
|
|
}
|
|
c.buf.rbuf.Reset()
|
|
if _, err := c.buf.rbuf.Write(tm.Body); err != nil {
|
|
return err
|
|
}
|
|
|
|
m.Header = tm.Header
|
|
}
|
|
|
|
err := c.codec.ReadHeader(&m, codec.Request)
|
|
r.ServiceMethod = m.Method
|
|
r.Seq = m.Id
|
|
return err
|
|
}
|
|
|
|
func (c *rpcPlusCodec) ReadRequestBody(b interface{}) error {
|
|
return c.codec.ReadBody(b)
|
|
}
|
|
|
|
func (c *rpcPlusCodec) WriteResponse(r *response, body interface{}, last bool) error {
|
|
c.buf.wbuf.Reset()
|
|
m := &codec.Message{
|
|
Method: r.ServiceMethod,
|
|
Id: r.Seq,
|
|
Error: r.Error,
|
|
Type: codec.Response,
|
|
Header: map[string]string{},
|
|
}
|
|
if err := c.codec.Write(m, body); err != nil {
|
|
c.buf.wbuf.Reset()
|
|
m.Error = errors.Wrapf(err, "Unable to encode body").Error()
|
|
if err := c.codec.Write(m, nil); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
m.Header["Content-Type"] = c.req.Header["Content-Type"]
|
|
return c.socket.Send(&transport.Message{
|
|
Header: m.Header,
|
|
Body: c.buf.wbuf.Bytes(),
|
|
})
|
|
}
|
|
|
|
func (c *rpcPlusCodec) Close() error {
|
|
c.buf.Close()
|
|
c.codec.Close()
|
|
return c.socket.Close()
|
|
}
|