Merge pull request #189 from hlian/master

server/rpc_codec: friendlier behavior if c.codec.Write fails
This commit is contained in:
Asim Aslam 2017-07-18 14:18:12 +01:00 committed by GitHub
commit 8264e90bce
3 changed files with 110 additions and 2 deletions

View File

@ -7,6 +7,7 @@ import (
"github.com/micro/go-micro/codec/jsonrpc" "github.com/micro/go-micro/codec/jsonrpc"
"github.com/micro/go-micro/codec/protorpc" "github.com/micro/go-micro/codec/protorpc"
"github.com/micro/go-micro/transport" "github.com/micro/go-micro/transport"
"github.com/pkg/errors"
) )
type rpcPlusCodec struct { type rpcPlusCodec struct {
@ -96,7 +97,11 @@ func (c *rpcPlusCodec) WriteResponse(r *response, body interface{}, last bool) e
Header: map[string]string{}, Header: map[string]string{},
} }
if err := c.codec.Write(m, body); err != nil { if err := c.codec.Write(m, body); err != nil {
return err 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"] m.Header["Content-Type"] = c.req.Header["Content-Type"]

100
server/rpc_codec_test.go Normal file
View File

@ -0,0 +1,100 @@
package server
import (
"bytes"
"errors"
"testing"
"github.com/micro/go-micro/codec"
"github.com/micro/go-micro/transport"
)
// testCodec is a dummy codec that only knows how to encode nil bodies
type testCodec struct {
buf *bytes.Buffer
}
type testSocket struct {
}
// TestCodecWriteError simulates what happens when a codec is unable
// to encode a message (e.g. a missing branch of an "oneof" message in
// protobufs)
//
// We expect an error to be sent to the socket. Previously the socket
// would remain open with no bytes sent, leading to client-side
// timeouts.
func TestCodecWriteError(t *testing.T) {
socket := testSocket{}
message := transport.Message{
Header: map[string]string{},
Body: []byte{},
}
rwc := readWriteCloser{
rbuf: new(bytes.Buffer),
wbuf: new(bytes.Buffer),
}
c := rpcPlusCodec{
buf: &rwc,
codec: &testCodec{
buf: rwc.wbuf,
},
req: &message,
socket: socket,
}
err := c.WriteResponse(&response{
ServiceMethod: "Service.Method",
Seq: 0,
Error: "",
next: nil,
}, "body", false)
if err != nil {
t.Fatalf(`Expected WriteResponse to fail; got "%+v" instead`, err)
}
const expectedError = "Unable to encode body: simulating a codec write failure"
actualError := rwc.wbuf.String()
if actualError != expectedError {
t.Fatalf(`Expected error "%+v" in the write buffer, got "%+v" instead`, expectedError, actualError)
}
}
func (c *testCodec) ReadHeader(message *codec.Message, typ codec.MessageType) error {
return nil
}
func (c *testCodec) ReadBody(dest interface{}) error {
return nil
}
func (c *testCodec) Write(message *codec.Message, dest interface{}) error {
if dest != nil {
return errors.New("simulating a codec write failure")
}
c.buf.Write([]byte(message.Error))
return nil
}
func (c *testCodec) Close() error {
return nil
}
func (c *testCodec) String() string {
return "string"
}
func (s testSocket) Recv(message *transport.Message) error {
return nil
}
func (s testSocket) Send(message *transport.Message) error {
return nil
}
func (s testSocket) Close() error {
return nil
}

View File

@ -249,7 +249,10 @@ func (s *service) call(ctx context.Context, server *server, sending *sync.Mutex,
errmsg = err.Error() errmsg = err.Error()
} }
server.sendResponse(sending, req, replyv.Interface(), codec, errmsg, true) err = server.sendResponse(sending, req, replyv.Interface(), codec, errmsg, true)
if err != nil {
log.Log("rpc call: unable to send response: ", err)
}
server.freeRequest(req) server.freeRequest(req)
return return
} }