internal/jsonrpc2_v2: error out in-flight client calls when the reader breaks
Otherwise, the Await method on the corresponding AsyncCall will never unblock, leading to a deadlock (detected by the test changes in CL 388597). For golang/go#46047 For golang/go#46520 For golang/go#49387 Change-Id: I7954f80786059772ddd7f8c98d8752d56d074919 Reviewed-on: https://go-review.googlesource.com/c/tools/+/388775 Run-TryBot: Bryan Mills <bcmills@google.com> Reviewed-by: Ian Cottrell <iancottrell@google.com> gopls-CI: kokoro <noreply+kokoro@google.com> Auto-Submit: Bryan Mills <bcmills@google.com> TryBot-Result: Gopher Robot <gobot@golang.org>
This commit is contained in:
parent
dd9a221959
commit
9e251950a6
2 changed files with 42 additions and 11 deletions
|
|
@ -175,9 +175,25 @@ func (c *Connection) Call(ctx context.Context, method string, params interface{}
|
||||||
// are racing the response.
|
// are racing the response.
|
||||||
// rchan is buffered in case the response arrives without a listener.
|
// rchan is buffered in case the response arrives without a listener.
|
||||||
result.response = make(chan *Response, 1)
|
result.response = make(chan *Response, 1)
|
||||||
pending := <-c.outgoingBox
|
outgoing, ok := <-c.outgoingBox
|
||||||
pending[result.id] = result.response
|
if !ok {
|
||||||
c.outgoingBox <- pending
|
// If the call failed due to (say) an I/O error or broken pipe, attribute it
|
||||||
|
// as such. (If the error is nil, then the connection must have been shut
|
||||||
|
// down cleanly.)
|
||||||
|
err := c.async.wait()
|
||||||
|
if err == nil {
|
||||||
|
err = ErrClientClosing
|
||||||
|
}
|
||||||
|
|
||||||
|
resp, respErr := NewResponse(result.id, nil, err)
|
||||||
|
if respErr != nil {
|
||||||
|
panic(fmt.Errorf("unexpected error from NewResponse: %w", respErr))
|
||||||
|
}
|
||||||
|
result.response <- resp
|
||||||
|
return result
|
||||||
|
}
|
||||||
|
outgoing[result.id] = result.response
|
||||||
|
c.outgoingBox <- outgoing
|
||||||
// now we are ready to send
|
// now we are ready to send
|
||||||
if err := c.write(ctx, call); err != nil {
|
if err := c.write(ctx, call); err != nil {
|
||||||
// sending failed, we will never get a response, so deliver a fake one
|
// sending failed, we will never get a response, so deliver a fake one
|
||||||
|
|
@ -290,8 +306,19 @@ func (c *Connection) Close() error {
|
||||||
|
|
||||||
// readIncoming collects inbound messages from the reader and delivers them, either responding
|
// readIncoming collects inbound messages from the reader and delivers them, either responding
|
||||||
// to outgoing calls or feeding requests to the queue.
|
// to outgoing calls or feeding requests to the queue.
|
||||||
func (c *Connection) readIncoming(ctx context.Context, reader Reader, toQueue chan<- *incoming) {
|
func (c *Connection) readIncoming(ctx context.Context, reader Reader, toQueue chan<- *incoming) (err error) {
|
||||||
defer close(toQueue)
|
defer func() {
|
||||||
|
// Retire any outgoing requests that were still in flight.
|
||||||
|
// With the Reader no longer being processed, they necessarily cannot receive a response.
|
||||||
|
outgoing := <-c.outgoingBox
|
||||||
|
close(c.outgoingBox) // Prevent new outgoing requests, which would deadlock.
|
||||||
|
for id, responseBox := range outgoing {
|
||||||
|
responseBox <- &Response{ID: id, Error: err}
|
||||||
|
}
|
||||||
|
|
||||||
|
close(toQueue)
|
||||||
|
}()
|
||||||
|
|
||||||
for {
|
for {
|
||||||
// get the next message
|
// get the next message
|
||||||
// no lock is needed, this is the only reader
|
// no lock is needed, this is the only reader
|
||||||
|
|
@ -301,7 +328,7 @@ func (c *Connection) readIncoming(ctx context.Context, reader Reader, toQueue ch
|
||||||
if !isClosingError(err) {
|
if !isClosingError(err) {
|
||||||
c.async.setError(err)
|
c.async.setError(err)
|
||||||
}
|
}
|
||||||
return
|
return err
|
||||||
}
|
}
|
||||||
switch msg := msg.(type) {
|
switch msg := msg.(type) {
|
||||||
case *Request:
|
case *Request:
|
||||||
|
|
@ -340,12 +367,12 @@ func (c *Connection) readIncoming(ctx context.Context, reader Reader, toQueue ch
|
||||||
}
|
}
|
||||||
|
|
||||||
func (c *Connection) incomingResponse(msg *Response) {
|
func (c *Connection) incomingResponse(msg *Response) {
|
||||||
pending := <-c.outgoingBox
|
var response chan<- *Response
|
||||||
response, ok := pending[msg.ID]
|
if outgoing, ok := <-c.outgoingBox; ok {
|
||||||
if ok {
|
response = outgoing[msg.ID]
|
||||||
delete(pending, msg.ID)
|
delete(outgoing, msg.ID)
|
||||||
|
c.outgoingBox <- outgoing
|
||||||
}
|
}
|
||||||
c.outgoingBox <- pending
|
|
||||||
if response != nil {
|
if response != nil {
|
||||||
response <- msg
|
response <- msg
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -33,6 +33,10 @@ var (
|
||||||
ErrServerOverloaded = NewError(-32000, "JSON RPC overloaded")
|
ErrServerOverloaded = NewError(-32000, "JSON RPC overloaded")
|
||||||
// ErrUnknown should be used for all non coded errors.
|
// ErrUnknown should be used for all non coded errors.
|
||||||
ErrUnknown = NewError(-32001, "JSON RPC unknown error")
|
ErrUnknown = NewError(-32001, "JSON RPC unknown error")
|
||||||
|
// ErrServerClosing is returned for calls that arrive while the server is closing.
|
||||||
|
ErrServerClosing = NewError(-32002, "JSON RPC server is closing")
|
||||||
|
// ErrClientClosing is a dummy error returned for calls initiated while the client is closing.
|
||||||
|
ErrClientClosing = NewError(-32003, "JSON RPC client is closing")
|
||||||
)
|
)
|
||||||
|
|
||||||
const wireVersion = "2.0"
|
const wireVersion = "2.0"
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue