forked from mirror/go-ethereum
bas-vk
9 years ago
committed by
GitHub
commit
771655e3fe
@ -1,55 +0,0 @@ |
||||
// Copyright 2015 The go-ethereum Authors
|
||||
// This file is part of go-ethereum.
|
||||
//
|
||||
// go-ethereum is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// go-ethereum is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
package utils |
||||
|
||||
import ( |
||||
"fmt" |
||||
"strings" |
||||
|
||||
"github.com/ethereum/go-ethereum/node" |
||||
"github.com/ethereum/go-ethereum/rpc" |
||||
"gopkg.in/urfave/cli.v1" |
||||
) |
||||
|
||||
// NewRemoteRPCClient returns a RPC client which connects to a running geth instance.
|
||||
// Depending on the given context this can either be a IPC or a HTTP client.
|
||||
func NewRemoteRPCClient(ctx *cli.Context) (rpc.Client, error) { |
||||
if ctx.Args().Present() { |
||||
endpoint := ctx.Args().First() |
||||
return NewRemoteRPCClientFromString(endpoint) |
||||
} |
||||
// use IPC by default
|
||||
return rpc.NewIPCClient(node.DefaultIPCEndpoint()) |
||||
} |
||||
|
||||
// NewRemoteRPCClientFromString returns a RPC client which connects to the given
|
||||
// endpoint. It must start with either `ipc:` or `rpc:` (HTTP).
|
||||
func NewRemoteRPCClientFromString(endpoint string) (rpc.Client, error) { |
||||
if strings.HasPrefix(endpoint, "ipc:") { |
||||
return rpc.NewIPCClient(endpoint[4:]) |
||||
} |
||||
if strings.HasPrefix(endpoint, "rpc:") { |
||||
return rpc.NewHTTPClient(endpoint[4:]) |
||||
} |
||||
if strings.HasPrefix(endpoint, "http://") { |
||||
return rpc.NewHTTPClient(endpoint) |
||||
} |
||||
if strings.HasPrefix(endpoint, "ws:") { |
||||
return rpc.NewWSClient(endpoint) |
||||
} |
||||
return nil, fmt.Errorf("invalid endpoint") |
||||
} |
||||
@ -0,0 +1,740 @@ |
||||
// Copyright 2016 The go-ethereum Authors
|
||||
// This file is part of the go-ethereum library.
|
||||
//
|
||||
// The go-ethereum library is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU Lesser General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// The go-ethereum library is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU Lesser General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU Lesser General Public License
|
||||
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
package rpc |
||||
|
||||
import ( |
||||
"bytes" |
||||
"encoding/json" |
||||
"errors" |
||||
"fmt" |
||||
"net" |
||||
"net/url" |
||||
"reflect" |
||||
"strconv" |
||||
"sync" |
||||
"sync/atomic" |
||||
"time" |
||||
|
||||
"github.com/ethereum/go-ethereum/logger" |
||||
"github.com/ethereum/go-ethereum/logger/glog" |
||||
"golang.org/x/net/context" |
||||
) |
||||
|
||||
var ( |
||||
ErrClientQuit = errors.New("client is closed") |
||||
ErrNoResult = errors.New("no result in JSON-RPC response") |
||||
) |
||||
|
||||
const ( |
||||
clientSubscriptionBuffer = 100 // if exceeded, the client stops reading
|
||||
tcpKeepAliveInterval = 30 * time.Second |
||||
defaultDialTimeout = 10 * time.Second // used when dialing if the context has no deadline
|
||||
defaultWriteTimeout = 10 * time.Second // used for calls if the context has no deadline
|
||||
subscribeTimeout = 5 * time.Second // overall timeout eth_subscribe, rpc_modules calls
|
||||
) |
||||
|
||||
// BatchElem is an element in a batch request.
|
||||
type BatchElem struct { |
||||
Method string |
||||
Args []interface{} |
||||
// The result is unmarshaled into this field. Result must be set to a
|
||||
// non-nil pointer value of the desired type, otherwise the response will be
|
||||
// discarded.
|
||||
Result interface{} |
||||
// Error is set if the server returns an error for this request, or if
|
||||
// unmarshaling into Result fails. It is not set for I/O errors.
|
||||
Error error |
||||
} |
||||
|
||||
// A value of this type can a JSON-RPC request, notification, successful response or
|
||||
// error response. Which one it is depends on the fields.
|
||||
type jsonrpcMessage struct { |
||||
Version string `json:"jsonrpc"` |
||||
ID json.RawMessage `json:"id,omitempty"` |
||||
Method string `json:"method,omitempty"` |
||||
Params json.RawMessage `json:"params,omitempty"` |
||||
Error *jsonError `json:"error,omitempty"` |
||||
Result json.RawMessage `json:"result,omitempty"` |
||||
} |
||||
|
||||
func (msg *jsonrpcMessage) isNotification() bool { |
||||
return msg.ID == nil && msg.Method != "" |
||||
} |
||||
|
||||
func (msg *jsonrpcMessage) isResponse() bool { |
||||
return msg.hasValidID() && msg.Method == "" && len(msg.Params) == 0 |
||||
} |
||||
|
||||
func (msg *jsonrpcMessage) hasValidID() bool { |
||||
return len(msg.ID) > 0 && msg.ID[0] != '{' && msg.ID[0] != '[' |
||||
} |
||||
|
||||
func (msg *jsonrpcMessage) String() string { |
||||
b, _ := json.Marshal(msg) |
||||
return string(b) |
||||
} |
||||
|
||||
// Client represents a connection to an RPC server.
|
||||
type Client struct { |
||||
idCounter uint32 |
||||
connectFunc func(ctx context.Context) (net.Conn, error) |
||||
isHTTP bool |
||||
|
||||
// writeConn is only safe to access outside dispatch, with the
|
||||
// write lock held. The write lock is taken by sending on
|
||||
// requestOp and released by sending on sendDone.
|
||||
writeConn net.Conn |
||||
|
||||
// for dispatch
|
||||
close chan struct{} |
||||
didQuit chan struct{} // closed when client quits
|
||||
reconnected chan net.Conn // where write/reconnect sends the new connection
|
||||
readErr chan error // errors from read
|
||||
readResp chan []*jsonrpcMessage // valid messages from read
|
||||
requestOp chan *requestOp // for registering response IDs
|
||||
sendDone chan error // signals write completion, releases write lock
|
||||
respWait map[string]*requestOp // active requests
|
||||
subs map[string]*ClientSubscription // active subscriptions
|
||||
} |
||||
|
||||
type requestOp struct { |
||||
ids []json.RawMessage |
||||
err error |
||||
resp chan *jsonrpcMessage // receives up to len(ids) responses
|
||||
sub *ClientSubscription // only set for EthSubscribe requests
|
||||
} |
||||
|
||||
func (op *requestOp) wait(ctx context.Context) (*jsonrpcMessage, error) { |
||||
select { |
||||
case <-ctx.Done(): |
||||
return nil, ctx.Err() |
||||
case resp := <-op.resp: |
||||
return resp, op.err |
||||
} |
||||
} |
||||
|
||||
// Dial creates a new client for the given URL.
|
||||
//
|
||||
// The currently supported URL schemes are "http", "https", "ws" and "wss". If rawurl is a
|
||||
// file name with no URL scheme, a local socket connection is established using UNIX
|
||||
// domain sockets on supported platforms and named pipes on Windows. If you want to
|
||||
// configure transport options, use DialHTTP, DialWebsocket or DialIPC instead.
|
||||
//
|
||||
// For websocket connections, the origin is set to the local host name.
|
||||
//
|
||||
// The client reconnects automatically if the connection is lost.
|
||||
func Dial(rawurl string) (*Client, error) { |
||||
return DialContext(context.Background(), rawurl) |
||||
} |
||||
|
||||
// DialContext creates a new RPC client, just like Dial.
|
||||
//
|
||||
// The context is used to cancel or time out the initial connection establishment. It does
|
||||
// not affect subsequent interactions with the client.
|
||||
func DialContext(ctx context.Context, rawurl string) (*Client, error) { |
||||
u, err := url.Parse(rawurl) |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
switch u.Scheme { |
||||
case "http", "https": |
||||
return DialHTTP(rawurl) |
||||
case "ws", "wss": |
||||
return DialWebsocket(ctx, rawurl, "") |
||||
case "": |
||||
return DialIPC(ctx, rawurl) |
||||
default: |
||||
return nil, fmt.Errorf("no known transport for URL scheme %q", u.Scheme) |
||||
} |
||||
} |
||||
|
||||
func newClient(initctx context.Context, connectFunc func(context.Context) (net.Conn, error)) (*Client, error) { |
||||
conn, err := connectFunc(initctx) |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
_, isHTTP := conn.(*httpConn) |
||||
|
||||
c := &Client{ |
||||
writeConn: conn, |
||||
isHTTP: isHTTP, |
||||
connectFunc: connectFunc, |
||||
close: make(chan struct{}), |
||||
didQuit: make(chan struct{}), |
||||
reconnected: make(chan net.Conn), |
||||
readErr: make(chan error), |
||||
readResp: make(chan []*jsonrpcMessage), |
||||
requestOp: make(chan *requestOp), |
||||
sendDone: make(chan error, 1), |
||||
respWait: make(map[string]*requestOp), |
||||
subs: make(map[string]*ClientSubscription), |
||||
} |
||||
if !isHTTP { |
||||
go c.dispatch(conn) |
||||
} |
||||
return c, nil |
||||
} |
||||
|
||||
func (c *Client) nextID() json.RawMessage { |
||||
id := atomic.AddUint32(&c.idCounter, 1) |
||||
return []byte(strconv.FormatUint(uint64(id), 10)) |
||||
} |
||||
|
||||
// SupportedModules calls the rpc_modules method, retrieving the list of
|
||||
// APIs that are available on the server.
|
||||
func (c *Client) SupportedModules() (map[string]string, error) { |
||||
var result map[string]string |
||||
ctx, cancel := context.WithTimeout(context.Background(), subscribeTimeout) |
||||
defer cancel() |
||||
err := c.CallContext(ctx, &result, "rpc_modules") |
||||
return result, err |
||||
} |
||||
|
||||
// Close closes the client, aborting any in-flight requests.
|
||||
func (c *Client) Close() { |
||||
if c.isHTTP { |
||||
return |
||||
} |
||||
select { |
||||
case c.close <- struct{}{}: |
||||
<-c.didQuit |
||||
case <-c.didQuit: |
||||
} |
||||
} |
||||
|
||||
// Call performs a JSON-RPC call with the given arguments and unmarshals into
|
||||
// result if no error occurred.
|
||||
//
|
||||
// The result must be a pointer so that package json can unmarshal into it. You
|
||||
// can also pass nil, in which case the result is ignored.
|
||||
func (c *Client) Call(result interface{}, method string, args ...interface{}) error { |
||||
ctx := context.Background() |
||||
return c.CallContext(ctx, result, method, args...) |
||||
} |
||||
|
||||
// CallContext performs a JSON-RPC call with the given arguments. If the context is
|
||||
// canceled before the call has successfully returned, CallContext returns immediately.
|
||||
//
|
||||
// The result must be a pointer so that package json can unmarshal into it. You
|
||||
// can also pass nil, in which case the result is ignored.
|
||||
func (c *Client) CallContext(ctx context.Context, result interface{}, method string, args ...interface{}) error { |
||||
msg, err := c.newMessage(method, args...) |
||||
if err != nil { |
||||
return err |
||||
} |
||||
op := &requestOp{ids: []json.RawMessage{msg.ID}, resp: make(chan *jsonrpcMessage, 1)} |
||||
|
||||
if c.isHTTP { |
||||
err = c.sendHTTP(ctx, op, msg) |
||||
} else { |
||||
err = c.send(ctx, op, msg) |
||||
} |
||||
if err != nil { |
||||
return err |
||||
} |
||||
|
||||
// dispatch has accepted the request and will close the channel it when it quits.
|
||||
switch resp, err := op.wait(ctx); { |
||||
case err != nil: |
||||
return err |
||||
case resp.Error != nil: |
||||
return resp.Error |
||||
case len(resp.Result) == 0: |
||||
return ErrNoResult |
||||
default: |
||||
return json.Unmarshal(resp.Result, &result) |
||||
} |
||||
} |
||||
|
||||
// BatchCall sends all given requests as a single batch and waits for the server
|
||||
// to return a response for all of them.
|
||||
//
|
||||
// In contrast to Call, BatchCall only returns I/O errors. Any error specific to
|
||||
// a request is reported through the Error field of the corresponding BatchElem.
|
||||
//
|
||||
// Note that batch calls may not be executed atomically on the server side.
|
||||
func (c *Client) BatchCall(b []BatchElem) error { |
||||
ctx := context.Background() |
||||
return c.BatchCallContext(ctx, b) |
||||
} |
||||
|
||||
// BatchCall sends all given requests as a single batch and waits for the server
|
||||
// to return a response for all of them. The wait duration is bounded by the
|
||||
// context's deadline.
|
||||
//
|
||||
// In contrast to CallContext, BatchCallContext only returns I/O errors. Any
|
||||
// error specific to a request is reported through the Error field of the
|
||||
// corresponding BatchElem.
|
||||
//
|
||||
// Note that batch calls may not be executed atomically on the server side.
|
||||
func (c *Client) BatchCallContext(ctx context.Context, b []BatchElem) error { |
||||
msgs := make([]*jsonrpcMessage, len(b)) |
||||
op := &requestOp{ |
||||
ids: make([]json.RawMessage, len(b)), |
||||
resp: make(chan *jsonrpcMessage, len(b)), |
||||
} |
||||
for i, elem := range b { |
||||
msg, err := c.newMessage(elem.Method, elem.Args...) |
||||
if err != nil { |
||||
return err |
||||
} |
||||
msgs[i] = msg |
||||
op.ids[i] = msg.ID |
||||
} |
||||
|
||||
var err error |
||||
if c.isHTTP { |
||||
err = c.sendBatchHTTP(ctx, op, msgs) |
||||
} else { |
||||
err = c.send(ctx, op, msgs) |
||||
} |
||||
|
||||
// Wait for all responses to come back.
|
||||
for n := 0; n < len(b) && err == nil; n++ { |
||||
var resp *jsonrpcMessage |
||||
resp, err = op.wait(ctx) |
||||
if err != nil { |
||||
break |
||||
} |
||||
// Find the element corresponding to this response.
|
||||
// The element is guaranteed to be present because dispatch
|
||||
// only sends valid IDs to our channel.
|
||||
var elem *BatchElem |
||||
for i := range msgs { |
||||
if bytes.Equal(msgs[i].ID, resp.ID) { |
||||
elem = &b[i] |
||||
break |
||||
} |
||||
} |
||||
if resp.Error != nil { |
||||
elem.Error = resp.Error |
||||
continue |
||||
} |
||||
if len(resp.Result) == 0 { |
||||
elem.Error = ErrNoResult |
||||
continue |
||||
} |
||||
elem.Error = json.Unmarshal(resp.Result, elem.Result) |
||||
} |
||||
return err |
||||
} |
||||
|
||||
// EthSubscribe calls the "eth_subscribe" method with the given arguments,
|
||||
// registering a subscription. Server notifications for the subscription are
|
||||
// sent to the given channel. The element type of the channel must match the
|
||||
// expected type of content returned by the subscription.
|
||||
//
|
||||
// Callers should not use the same channel for multiple calls to EthSubscribe.
|
||||
// The channel is closed when the notification is unsubscribed or an error
|
||||
// occurs. The error can be retrieved via the Err method of the subscription.
|
||||
//
|
||||
// Slow subscribers will block the clients ingress path eventually.
|
||||
func (c *Client) EthSubscribe(channel interface{}, args ...interface{}) (*ClientSubscription, error) { |
||||
// Check type of channel first.
|
||||
chanVal := reflect.ValueOf(channel) |
||||
if chanVal.Kind() != reflect.Chan || chanVal.Type().ChanDir()&reflect.SendDir == 0 { |
||||
panic("first argument to EthSubscribe must be a writable channel") |
||||
} |
||||
if chanVal.IsNil() { |
||||
panic("channel given to EthSubscribe must not be nil") |
||||
} |
||||
if c.isHTTP { |
||||
return nil, ErrNotificationsUnsupported |
||||
} |
||||
|
||||
msg, err := c.newMessage(subscribeMethod, args...) |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
op := &requestOp{ |
||||
ids: []json.RawMessage{msg.ID}, |
||||
resp: make(chan *jsonrpcMessage), |
||||
sub: newClientSubscription(c, chanVal), |
||||
} |
||||
ctx, cancel := context.WithTimeout(context.Background(), subscribeTimeout) |
||||
defer cancel() |
||||
|
||||
// Send the subscription request.
|
||||
// The arrival and validity of the response is signaled on sub.quit.
|
||||
if err := c.send(ctx, op, msg); err != nil { |
||||
return nil, err |
||||
} |
||||
if _, err := op.wait(ctx); err != nil { |
||||
return nil, err |
||||
} |
||||
return op.sub, nil |
||||
} |
||||
|
||||
func (c *Client) newMessage(method string, paramsIn ...interface{}) (*jsonrpcMessage, error) { |
||||
params, err := json.Marshal(paramsIn) |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
return &jsonrpcMessage{Version: "2.0", ID: c.nextID(), Method: method, Params: params}, nil |
||||
} |
||||
|
||||
// send registers op with the dispatch loop, then sends msg on the connection.
|
||||
// if sending fails, op is deregistered.
|
||||
func (c *Client) send(ctx context.Context, op *requestOp, msg interface{}) error { |
||||
select { |
||||
case c.requestOp <- op: |
||||
if glog.V(logger.Detail) { |
||||
glog.Info("sending ", msg) |
||||
} |
||||
err := c.write(ctx, msg) |
||||
c.sendDone <- err |
||||
return err |
||||
case <-c.didQuit: |
||||
return ErrClientQuit |
||||
} |
||||
} |
||||
|
||||
func (c *Client) write(ctx context.Context, msg interface{}) error { |
||||
deadline, ok := ctx.Deadline() |
||||
if !ok { |
||||
deadline = time.Now().Add(defaultWriteTimeout) |
||||
} |
||||
// The previous write failed. Try to establish a new connection.
|
||||
if c.writeConn == nil { |
||||
if err := c.reconnect(ctx); err != nil { |
||||
return err |
||||
} |
||||
} |
||||
c.writeConn.SetWriteDeadline(deadline) |
||||
err := json.NewEncoder(c.writeConn).Encode(msg) |
||||
if err != nil { |
||||
c.writeConn = nil |
||||
} |
||||
return err |
||||
} |
||||
|
||||
func (c *Client) reconnect(ctx context.Context) error { |
||||
newconn, err := c.connectFunc(ctx) |
||||
if err != nil { |
||||
glog.V(logger.Detail).Infof("reconnect failed: %v", err) |
||||
return err |
||||
} |
||||
select { |
||||
case c.reconnected <- newconn: |
||||
c.writeConn = newconn |
||||
return nil |
||||
case <-c.didQuit: |
||||
newconn.Close() |
||||
return ErrClientQuit |
||||
} |
||||
} |
||||
|
||||
// dispatch is the main loop of the client.
|
||||
// It sends read messages to waiting calls to Call and BatchCall
|
||||
// and subscription notifications to registered subscriptions.
|
||||
func (c *Client) dispatch(conn net.Conn) { |
||||
// Spawn the initial read loop.
|
||||
go c.read(conn) |
||||
|
||||
var ( |
||||
lastOp *requestOp // tracks last send operation
|
||||
requestOpLock = c.requestOp // nil while the send lock is held
|
||||
reading = true // if true, a read loop is running
|
||||
) |
||||
defer close(c.didQuit) |
||||
defer func() { |
||||
c.closeRequestOps(ErrClientQuit) |
||||
conn.Close() |
||||
if reading { |
||||
// Empty read channels until read is dead.
|
||||
for { |
||||
select { |
||||
case <-c.readResp: |
||||
case <-c.readErr: |
||||
return |
||||
} |
||||
} |
||||
} |
||||
}() |
||||
|
||||
for { |
||||
select { |
||||
case <-c.close: |
||||
return |
||||
|
||||
// Read path.
|
||||
case batch := <-c.readResp: |
||||
for _, msg := range batch { |
||||
switch { |
||||
case msg.isNotification(): |
||||
if glog.V(logger.Detail) { |
||||
glog.Info("<-readResp: notification ", msg) |
||||
} |
||||
c.handleNotification(msg) |
||||
case msg.isResponse(): |
||||
if glog.V(logger.Detail) { |
||||
glog.Info("<-readResp: response ", msg) |
||||
} |
||||
c.handleResponse(msg) |
||||
default: |
||||
if glog.V(logger.Debug) { |
||||
glog.Error("<-readResp: dropping weird message", msg) |
||||
} |
||||
// TODO: maybe close
|
||||
} |
||||
} |
||||
|
||||
case err := <-c.readErr: |
||||
glog.V(logger.Debug).Infof("<-readErr: %v", err) |
||||
c.closeRequestOps(err) |
||||
conn.Close() |
||||
reading = false |
||||
|
||||
case newconn := <-c.reconnected: |
||||
glog.V(logger.Debug).Infof("<-reconnected: (reading=%t) %v", reading, conn.RemoteAddr()) |
||||
if reading { |
||||
// Wait for the previous read loop to exit. This is a rare case.
|
||||
conn.Close() |
||||
<-c.readErr |
||||
} |
||||
go c.read(newconn) |
||||
reading = true |
||||
conn = newconn |
||||
|
||||
// Send path.
|
||||
case op := <-requestOpLock: |
||||
// Stop listening for further send ops until the current one is done.
|
||||
requestOpLock = nil |
||||
lastOp = op |
||||
for _, id := range op.ids { |
||||
c.respWait[string(id)] = op |
||||
} |
||||
|
||||
case err := <-c.sendDone: |
||||
if err != nil { |
||||
// Remove response handlers for the last send. We remove those here
|
||||
// because the error is already handled in Call or BatchCall. When the
|
||||
// read loop goes down, it will signal all other current operations.
|
||||
for _, id := range lastOp.ids { |
||||
delete(c.respWait, string(id)) |
||||
} |
||||
} |
||||
// Listen for send ops again.
|
||||
requestOpLock = c.requestOp |
||||
lastOp = nil |
||||
} |
||||
} |
||||
} |
||||
|
||||
// closeRequestOps unblocks pending send ops and active subscriptions.
|
||||
func (c *Client) closeRequestOps(err error) { |
||||
didClose := make(map[*requestOp]bool) |
||||
|
||||
for id, op := range c.respWait { |
||||
// Remove the op so that later calls will not close op.resp again.
|
||||
delete(c.respWait, id) |
||||
|
||||
if !didClose[op] { |
||||
op.err = err |
||||
close(op.resp) |
||||
didClose[op] = true |
||||
} |
||||
} |
||||
for id, sub := range c.subs { |
||||
delete(c.subs, id) |
||||
sub.quitWithError(err, false) |
||||
} |
||||
} |
||||
|
||||
func (c *Client) handleNotification(msg *jsonrpcMessage) { |
||||
if msg.Method != notificationMethod { |
||||
glog.V(logger.Debug).Info("dropping non-subscription message: ", msg) |
||||
return |
||||
} |
||||
var subResult struct { |
||||
ID string `json:"subscription"` |
||||
Result json.RawMessage `json:"result"` |
||||
} |
||||
if err := json.Unmarshal(msg.Params, &subResult); err != nil { |
||||
glog.V(logger.Debug).Info("dropping invalid subscription message: ", msg) |
||||
return |
||||
} |
||||
if c.subs[subResult.ID] != nil { |
||||
c.subs[subResult.ID].deliver(subResult.Result) |
||||
} |
||||
} |
||||
|
||||
func (c *Client) handleResponse(msg *jsonrpcMessage) { |
||||
op := c.respWait[string(msg.ID)] |
||||
if op == nil { |
||||
glog.V(logger.Debug).Infof("unsolicited response %v", msg) |
||||
return |
||||
} |
||||
delete(c.respWait, string(msg.ID)) |
||||
// For normal responses, just forward the reply to Call/BatchCall.
|
||||
if op.sub == nil { |
||||
op.resp <- msg |
||||
return |
||||
} |
||||
// For subscription responses, start the subscription if the server
|
||||
// indicates success. EthSubscribe gets unblocked in either case through
|
||||
// the op.resp channel.
|
||||
defer close(op.resp) |
||||
if msg.Error != nil { |
||||
op.err = msg.Error |
||||
return |
||||
} |
||||
if op.err = json.Unmarshal(msg.Result, &op.sub.subid); op.err == nil { |
||||
go op.sub.start() |
||||
c.subs[op.sub.subid] = op.sub |
||||
} |
||||
} |
||||
|
||||
// Reading happens on a dedicated goroutine.
|
||||
|
||||
func (c *Client) read(conn net.Conn) error { |
||||
var ( |
||||
buf json.RawMessage |
||||
dec = json.NewDecoder(conn) |
||||
) |
||||
readMessage := func() (rs []*jsonrpcMessage, err error) { |
||||
buf = buf[:0] |
||||
if err = dec.Decode(&buf); err != nil { |
||||
return nil, err |
||||
} |
||||
if isBatch(buf) { |
||||
err = json.Unmarshal(buf, &rs) |
||||
} else { |
||||
rs = make([]*jsonrpcMessage, 1) |
||||
err = json.Unmarshal(buf, &rs[0]) |
||||
} |
||||
return rs, err |
||||
} |
||||
|
||||
for { |
||||
resp, err := readMessage() |
||||
if err != nil { |
||||
c.readErr <- err |
||||
return err |
||||
} |
||||
c.readResp <- resp |
||||
} |
||||
} |
||||
|
||||
// Subscriptions.
|
||||
|
||||
// A ClientSubscription represents a subscription established through EthSubscribe.
|
||||
type ClientSubscription struct { |
||||
client *Client |
||||
etype reflect.Type |
||||
channel reflect.Value |
||||
subid string |
||||
in chan json.RawMessage |
||||
|
||||
quitOnce sync.Once // ensures quit is closed once
|
||||
quit chan struct{} // quit is closed when the subscription exits
|
||||
errOnce sync.Once // ensures err is closed once
|
||||
err chan error |
||||
} |
||||
|
||||
func newClientSubscription(c *Client, channel reflect.Value) *ClientSubscription { |
||||
sub := &ClientSubscription{ |
||||
client: c, |
||||
etype: channel.Type().Elem(), |
||||
channel: channel, |
||||
quit: make(chan struct{}), |
||||
err: make(chan error, 1), |
||||
// in is buffered so dispatch can continue even if the subscriber is slow.
|
||||
in: make(chan json.RawMessage, clientSubscriptionBuffer), |
||||
} |
||||
return sub |
||||
} |
||||
|
||||
// Err returns the subscription error channel. The intended use of Err is to schedule
|
||||
// resubscription when the client connection is closed unexpectedly.
|
||||
//
|
||||
// The error channel receives a value when the subscription has ended due
|
||||
// to an error. The received error is ErrClientQuit if Close has been called
|
||||
// on the underlying client and no other error has occurred.
|
||||
//
|
||||
// The error channel is closed when Unsubscribe is called on the subscription.
|
||||
func (sub *ClientSubscription) Err() <-chan error { |
||||
return sub.err |
||||
} |
||||
|
||||
// Unsubscribe unsubscribes the notification and closes the error channel.
|
||||
// It can safely be called more than once.
|
||||
func (sub *ClientSubscription) Unsubscribe() { |
||||
sub.quitWithError(nil, true) |
||||
sub.errOnce.Do(func() { close(sub.err) }) |
||||
} |
||||
|
||||
func (sub *ClientSubscription) quitWithError(err error, unsubscribeServer bool) { |
||||
sub.quitOnce.Do(func() { |
||||
if unsubscribeServer { |
||||
sub.requestUnsubscribe() |
||||
} |
||||
if err != nil { |
||||
sub.err <- err |
||||
} |
||||
close(sub.quit) |
||||
}) |
||||
} |
||||
|
||||
func (sub *ClientSubscription) deliver(result json.RawMessage) (ok bool) { |
||||
select { |
||||
case sub.in <- result: |
||||
return true |
||||
case <-sub.quit: |
||||
return false |
||||
} |
||||
} |
||||
|
||||
func (sub *ClientSubscription) start() { |
||||
sub.quitWithError(sub.forward()) |
||||
} |
||||
|
||||
func (sub *ClientSubscription) forward() (err error, unsubscribeServer bool) { |
||||
cases := []reflect.SelectCase{ |
||||
{Dir: reflect.SelectRecv, Chan: reflect.ValueOf(sub.quit)}, |
||||
{Dir: reflect.SelectSend, Chan: sub.channel}, |
||||
} |
||||
for { |
||||
select { |
||||
case result := <-sub.in: |
||||
val, err := sub.unmarshal(result) |
||||
if err != nil { |
||||
return err, true |
||||
} |
||||
cases[1].Send = val |
||||
switch chosen, _, _ := reflect.Select(cases); chosen { |
||||
case 0: // <-sub.quit
|
||||
return nil, false |
||||
case 1: // sub.channel<-
|
||||
continue |
||||
} |
||||
case <-sub.quit: |
||||
return nil, false |
||||
} |
||||
} |
||||
} |
||||
|
||||
func (sub *ClientSubscription) unmarshal(result json.RawMessage) (reflect.Value, error) { |
||||
val := reflect.New(sub.etype) |
||||
err := json.Unmarshal(result, val.Interface()) |
||||
return val.Elem(), err |
||||
} |
||||
|
||||
func (sub *ClientSubscription) requestUnsubscribe() error { |
||||
var result interface{} |
||||
return sub.client.Call(&result, unsubscribeMethod, sub.subid) |
||||
} |
||||
@ -0,0 +1,60 @@ |
||||
// Copyright 2016 The go-ethereum Authors
|
||||
// This file is part of the go-ethereum library.
|
||||
//
|
||||
// The go-ethereum library is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU Lesser General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// The go-ethereum library is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU Lesser General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU Lesser General Public License
|
||||
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
// +build !go1.5
|
||||
|
||||
package rpc |
||||
|
||||
import ( |
||||
"net" |
||||
"net/http" |
||||
"time" |
||||
|
||||
"golang.org/x/net/context" |
||||
) |
||||
|
||||
// In older versions of Go (below 1.5), dials cannot be canceled
|
||||
// via a channel or context. The context deadline can still applied.
|
||||
|
||||
// contextDialer returns a dialer that applies the deadline value from the given context.
|
||||
func contextDialer(ctx context.Context) *net.Dialer { |
||||
dialer := &net.Dialer{KeepAlive: tcpKeepAliveInterval} |
||||
if deadline, ok := ctx.Deadline(); ok { |
||||
dialer.Deadline = deadline |
||||
} else { |
||||
dialer.Deadline = time.Now().Add(defaultDialTimeout) |
||||
} |
||||
return dialer |
||||
} |
||||
|
||||
// dialContext connects to the given address, aborting the dial if ctx is canceled.
|
||||
func dialContext(ctx context.Context, network, addr string) (net.Conn, error) { |
||||
return contextDialer(ctx).Dial(network, addr) |
||||
} |
||||
|
||||
// requestWithContext copies req, adding the cancelation channel and deadline from ctx.
|
||||
func requestWithContext(c *http.Client, req *http.Request, ctx context.Context) (*http.Client, *http.Request) { |
||||
// Set Timeout on the client if the context has a deadline.
|
||||
// Note that there is no default timeout (unlike in contextDialer) because
|
||||
// the timeout applies to the entire request, including reads from body.
|
||||
if deadline, ok := ctx.Deadline(); ok { |
||||
c2 := *c |
||||
c2.Timeout = deadline.Sub(time.Now()) |
||||
c = &c2 |
||||
} |
||||
req2 := *req |
||||
return c, &req2 |
||||
} |
||||
@ -0,0 +1,61 @@ |
||||
// Copyright 2016 The go-ethereum Authors
|
||||
// This file is part of the go-ethereum library.
|
||||
//
|
||||
// The go-ethereum library is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU Lesser General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// The go-ethereum library is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU Lesser General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU Lesser General Public License
|
||||
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
// +build go1.5,!go1.6
|
||||
|
||||
package rpc |
||||
|
||||
import ( |
||||
"net" |
||||
"net/http" |
||||
"time" |
||||
|
||||
"golang.org/x/net/context" |
||||
) |
||||
|
||||
// In Go 1.5, dials cannot be canceled via a channel or context. The context deadline can
|
||||
// still be applied. Go 1.5 adds the ability to cancel HTTP requests via a channel.
|
||||
|
||||
// contextDialer returns a dialer that applies the deadline value from the given context.
|
||||
func contextDialer(ctx context.Context) *net.Dialer { |
||||
dialer := &net.Dialer{KeepAlive: tcpKeepAliveInterval} |
||||
if deadline, ok := ctx.Deadline(); ok { |
||||
dialer.Deadline = deadline |
||||
} else { |
||||
dialer.Deadline = time.Now().Add(defaultDialTimeout) |
||||
} |
||||
return dialer |
||||
} |
||||
|
||||
// dialContext connects to the given address, aborting the dial if ctx is canceled.
|
||||
func dialContext(ctx context.Context, network, addr string) (net.Conn, error) { |
||||
return contextDialer(ctx).Dial(network, addr) |
||||
} |
||||
|
||||
// requestWithContext copies req, adding the cancelation channel and deadline from ctx.
|
||||
func requestWithContext(c *http.Client, req *http.Request, ctx context.Context) (*http.Client, *http.Request) { |
||||
// Set Timeout on the client if the context has a deadline.
|
||||
// Note that there is no default timeout (unlike in contextDialer) because
|
||||
// the timeout applies to the entire request, including reads from body.
|
||||
if deadline, ok := ctx.Deadline(); ok { |
||||
c2 := *c |
||||
c2.Timeout = deadline.Sub(time.Now()) |
||||
c = &c2 |
||||
} |
||||
req2 := *req |
||||
req2.Cancel = ctx.Done() |
||||
return c, &req2 |
||||
} |
||||
@ -0,0 +1,55 @@ |
||||
// Copyright 2016 The go-ethereum Authors
|
||||
// This file is part of the go-ethereum library.
|
||||
//
|
||||
// The go-ethereum library is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU Lesser General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// The go-ethereum library is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU Lesser General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU Lesser General Public License
|
||||
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
// +build go1.6,!go1.7
|
||||
|
||||
package rpc |
||||
|
||||
import ( |
||||
"net" |
||||
"net/http" |
||||
"time" |
||||
|
||||
"golang.org/x/net/context" |
||||
) |
||||
|
||||
// In Go 1.6, net.Dialer gained the ability to cancel via a channel.
|
||||
|
||||
// contextDialer returns a dialer that applies the deadline value from the given context.
|
||||
func contextDialer(ctx context.Context) *net.Dialer { |
||||
dialer := &net.Dialer{Cancel: ctx.Done(), KeepAlive: tcpKeepAliveInterval} |
||||
if deadline, ok := ctx.Deadline(); ok { |
||||
dialer.Deadline = deadline |
||||
} else { |
||||
dialer.Deadline = time.Now().Add(defaultDialTimeout) |
||||
} |
||||
return dialer |
||||
} |
||||
|
||||
// dialContext connects to the given address, aborting the dial if ctx is canceled.
|
||||
func dialContext(ctx context.Context, network, addr string) (net.Conn, error) { |
||||
return contextDialer(ctx).Dial(network, addr) |
||||
} |
||||
|
||||
// requestWithContext copies req, adding the cancelation channel and deadline from ctx.
|
||||
func requestWithContext(c *http.Client, req *http.Request, ctx context.Context) (*http.Client, *http.Request) { |
||||
// We set Timeout on the client for Go <= 1.5. There
|
||||
// is no need to do that here because the dial will be canceled
|
||||
// by package http.
|
||||
req2 := *req |
||||
req2.Cancel = ctx.Done() |
||||
return c, &req2 |
||||
} |
||||
@ -0,0 +1,51 @@ |
||||
// Copyright 2016 The go-ethereum Authors
|
||||
// This file is part of the go-ethereum library.
|
||||
//
|
||||
// The go-ethereum library is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU Lesser General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// The go-ethereum library is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU Lesser General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU Lesser General Public License
|
||||
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
// +build go1.7
|
||||
|
||||
package rpc |
||||
|
||||
import ( |
||||
"context" |
||||
"net" |
||||
"net/http" |
||||
"time" |
||||
) |
||||
|
||||
// In Go 1.7, context moved into the standard library and support
|
||||
// for cancelation via context was added to net.Dialer and http.Request.
|
||||
|
||||
// contextDialer returns a dialer that applies the deadline value from the given context.
|
||||
func contextDialer(ctx context.Context) *net.Dialer { |
||||
dialer := &net.Dialer{Cancel: ctx.Done(), KeepAlive: tcpKeepAliveInterval} |
||||
if deadline, ok := ctx.Deadline(); ok { |
||||
dialer.Deadline = deadline |
||||
} else { |
||||
dialer.Deadline = time.Now().Add(defaultDialTimeout) |
||||
} |
||||
return dialer |
||||
} |
||||
|
||||
// dialContext connects to the given address, aborting the dial if ctx is canceled.
|
||||
func dialContext(ctx context.Context, network, addr string) (net.Conn, error) { |
||||
d := &net.Dialer{KeepAlive: tcpKeepAliveInterval} |
||||
return d.DialContext(ctx, network, addr) |
||||
} |
||||
|
||||
// requestWithContext copies req, adding the cancelation channel and deadline from ctx.
|
||||
func requestWithContext(c *http.Client, req *http.Request, ctx context.Context) (*http.Client, *http.Request) { |
||||
return c, req.WithContext(ctx) |
||||
} |
||||
@ -0,0 +1,83 @@ |
||||
// Copyright 2016 The go-ethereum Authors
|
||||
// This file is part of the go-ethereum library.
|
||||
//
|
||||
// The go-ethereum library is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU Lesser General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// The go-ethereum library is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU Lesser General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU Lesser General Public License
|
||||
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
package rpc_test |
||||
|
||||
import ( |
||||
"fmt" |
||||
"math/big" |
||||
"time" |
||||
|
||||
"github.com/ethereum/go-ethereum/rpc" |
||||
) |
||||
|
||||
// In this example, our client whishes to track the latest 'block number'
|
||||
// known to the server. The server supports two methods:
|
||||
//
|
||||
// eth_getBlockByNumber("latest", {})
|
||||
// returns the latest block object.
|
||||
//
|
||||
// eth_subscribe("newBlocks")
|
||||
// creates a subscription which fires block objects when new blocks arrive.
|
||||
|
||||
type Block struct { |
||||
Number *big.Int |
||||
} |
||||
|
||||
func ExampleClientSubscription() { |
||||
// Connect the client.
|
||||
client, _ := rpc.Dial("ws://127.0.0.1:8485") |
||||
subch := make(chan Block) |
||||
go subscribeBlocks(client, subch) |
||||
|
||||
// Print events from the subscription as they arrive.
|
||||
for block := range subch { |
||||
fmt.Println("latest block:", block.Number) |
||||
} |
||||
} |
||||
|
||||
// subscribeBlocks runs in its own goroutine and maintains
|
||||
// a subscription for new blocks.
|
||||
func subscribeBlocks(client *rpc.Client, subch chan Block) { |
||||
for i := 0; ; i++ { |
||||
if i > 0 { |
||||
time.Sleep(2 * time.Second) |
||||
} |
||||
|
||||
// Subscribe to new blocks.
|
||||
sub, err := client.EthSubscribe(subch, "newBlocks") |
||||
if err == rpc.ErrClientQuit { |
||||
return // Stop reconnecting if the client was closed.
|
||||
} else if err != nil { |
||||
fmt.Println("subscribe error:", err) |
||||
continue |
||||
} |
||||
|
||||
// The connection is established now.
|
||||
// Update the channel with the current block.
|
||||
var lastBlock Block |
||||
if err := client.Call(&lastBlock, "eth_getBlockByNumber", "latest"); err != nil { |
||||
fmt.Println("can't get latest block:", err) |
||||
continue |
||||
} |
||||
subch <- lastBlock |
||||
|
||||
// The subscription will deliver events to the channel. Wait for the
|
||||
// subscription to end for any reason, then loop around to re-establish
|
||||
// the connection.
|
||||
fmt.Println("connection lost: ", <-sub.Err()) |
||||
} |
||||
} |
||||
@ -0,0 +1,489 @@ |
||||
// Copyright 2016 The go-ethereum Authors
|
||||
// This file is part of the go-ethereum library.
|
||||
//
|
||||
// The go-ethereum library is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU Lesser General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// The go-ethereum library is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU Lesser General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU Lesser General Public License
|
||||
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
package rpc |
||||
|
||||
import ( |
||||
"fmt" |
||||
"math/rand" |
||||
"net" |
||||
"net/http" |
||||
"net/http/httptest" |
||||
"os" |
||||
"reflect" |
||||
"runtime" |
||||
"sync" |
||||
"testing" |
||||
"time" |
||||
|
||||
"github.com/davecgh/go-spew/spew" |
||||
"github.com/ethereum/go-ethereum/logger" |
||||
"github.com/ethereum/go-ethereum/logger/glog" |
||||
"golang.org/x/net/context" |
||||
) |
||||
|
||||
func TestClientRequest(t *testing.T) { |
||||
server := newTestServer("service", new(Service)) |
||||
defer server.Stop() |
||||
client := DialInProc(server) |
||||
defer client.Close() |
||||
|
||||
var resp Result |
||||
if err := client.Call(&resp, "service_echo", "hello", 10, &Args{"world"}); err != nil { |
||||
t.Fatal(err) |
||||
} |
||||
if !reflect.DeepEqual(resp, Result{"hello", 10, &Args{"world"}}) { |
||||
t.Errorf("incorrect result %#v", resp) |
||||
} |
||||
} |
||||
|
||||
func TestClientBatchRequest(t *testing.T) { |
||||
server := newTestServer("service", new(Service)) |
||||
defer server.Stop() |
||||
client := DialInProc(server) |
||||
defer client.Close() |
||||
|
||||
batch := []BatchElem{ |
||||
{ |
||||
Method: "service_echo", |
||||
Args: []interface{}{"hello", 10, &Args{"world"}}, |
||||
Result: new(Result), |
||||
}, |
||||
{ |
||||
Method: "service_echo", |
||||
Args: []interface{}{"hello2", 11, &Args{"world"}}, |
||||
Result: new(Result), |
||||
}, |
||||
{ |
||||
Method: "no_such_method", |
||||
Args: []interface{}{1, 2, 3}, |
||||
Result: new(int), |
||||
}, |
||||
} |
||||
if err := client.BatchCall(batch); err != nil { |
||||
t.Fatal(err) |
||||
} |
||||
wantResult := []BatchElem{ |
||||
{ |
||||
Method: "service_echo", |
||||
Args: []interface{}{"hello", 10, &Args{"world"}}, |
||||
Result: &Result{"hello", 10, &Args{"world"}}, |
||||
}, |
||||
{ |
||||
Method: "service_echo", |
||||
Args: []interface{}{"hello2", 11, &Args{"world"}}, |
||||
Result: &Result{"hello2", 11, &Args{"world"}}, |
||||
}, |
||||
{ |
||||
Method: "no_such_method", |
||||
Args: []interface{}{1, 2, 3}, |
||||
Result: new(int), |
||||
Error: &jsonError{Code: -32601, Message: "The method no_such_method_ does not exist/is not available"}, |
||||
}, |
||||
} |
||||
if !reflect.DeepEqual(batch, wantResult) { |
||||
t.Errorf("batch results mismatch:\ngot %swant %s", spew.Sdump(batch), spew.Sdump(wantResult)) |
||||
} |
||||
} |
||||
|
||||
// func TestClientCancelInproc(t *testing.T) { testClientCancel("inproc", t) }
|
||||
func TestClientCancelWebsocket(t *testing.T) { testClientCancel("ws", t) } |
||||
func TestClientCancelHTTP(t *testing.T) { testClientCancel("http", t) } |
||||
func TestClientCancelIPC(t *testing.T) { testClientCancel("ipc", t) } |
||||
|
||||
// This test checks that requests made through CallContext can be canceled by canceling
|
||||
// the context.
|
||||
func testClientCancel(transport string, t *testing.T) { |
||||
server := newTestServer("service", new(Service)) |
||||
defer server.Stop() |
||||
|
||||
// What we want to achieve is that the context gets canceled
|
||||
// at various stages of request processing. The interesting cases
|
||||
// are:
|
||||
// - cancel during dial
|
||||
// - cancel while performing a HTTP request
|
||||
// - cancel while waiting for a response
|
||||
//
|
||||
// To trigger those, the times are chosen such that connections
|
||||
// are killed within the deadline for every other call (maxKillTimeout
|
||||
// is 2x maxCancelTimeout).
|
||||
//
|
||||
// Once a connection is dead, there is a fair chance it won't connect
|
||||
// successfully because the accept is delayed by 1s.
|
||||
maxContextCancelTimeout := 300 * time.Millisecond |
||||
fl := &flakeyListener{ |
||||
maxAcceptDelay: 1 * time.Second, |
||||
maxKillTimeout: 600 * time.Millisecond, |
||||
} |
||||
|
||||
var client *Client |
||||
switch transport { |
||||
case "ws", "http": |
||||
c, hs := httpTestClient(server, transport, fl) |
||||
defer hs.Close() |
||||
client = c |
||||
case "ipc": |
||||
c, l := ipcTestClient(server, fl) |
||||
defer l.Close() |
||||
client = c |
||||
default: |
||||
panic("unknown transport: " + transport) |
||||
} |
||||
|
||||
// These tests take a lot of time, run them all at once.
|
||||
// You probably want to run with -parallel 1 or comment out
|
||||
// the call to t.Parallel if you enable the logging.
|
||||
t.Parallel() |
||||
// glog.SetV(6)
|
||||
// glog.SetToStderr(true)
|
||||
// defer glog.SetToStderr(false)
|
||||
// glog.Infoln("testing ", transport)
|
||||
|
||||
// The actual test starts here.
|
||||
var ( |
||||
wg sync.WaitGroup |
||||
nreqs = 10 |
||||
ncallers = 6 |
||||
) |
||||
caller := func(index int) { |
||||
defer wg.Done() |
||||
for i := 0; i < nreqs; i++ { |
||||
var ( |
||||
ctx context.Context |
||||
cancel func() |
||||
timeout = time.Duration(rand.Int63n(int64(maxContextCancelTimeout))) |
||||
) |
||||
if index < ncallers/2 { |
||||
// For half of the callers, create a context without deadline
|
||||
// and cancel it later.
|
||||
ctx, cancel = context.WithCancel(context.Background()) |
||||
time.AfterFunc(timeout, cancel) |
||||
} else { |
||||
// For the other half, create a context with a deadline instead. This is
|
||||
// different because the context deadline is used to set the socket write
|
||||
// deadline.
|
||||
ctx, cancel = context.WithTimeout(context.Background(), timeout) |
||||
} |
||||
// Now perform a call with the context.
|
||||
// The key thing here is that no call will ever complete successfully.
|
||||
err := client.CallContext(ctx, nil, "service_sleep", 2*maxContextCancelTimeout) |
||||
if err != nil { |
||||
glog.V(logger.Debug).Infoln("got expected error:", err) |
||||
} else { |
||||
t.Errorf("no error for call with %v wait time", timeout) |
||||
} |
||||
cancel() |
||||
} |
||||
} |
||||
wg.Add(ncallers) |
||||
for i := 0; i < ncallers; i++ { |
||||
go caller(i) |
||||
} |
||||
wg.Wait() |
||||
} |
||||
|
||||
func TestClientSubscribeInvalidArg(t *testing.T) { |
||||
server := newTestServer("service", new(Service)) |
||||
defer server.Stop() |
||||
client := DialInProc(server) |
||||
defer client.Close() |
||||
|
||||
check := func(shouldPanic bool, arg interface{}) { |
||||
defer func() { |
||||
err := recover() |
||||
if shouldPanic && err == nil { |
||||
t.Errorf("EthSubscribe should've panicked for %#v", arg) |
||||
} |
||||
if !shouldPanic && err != nil { |
||||
t.Errorf("EthSubscribe shouldn't have panicked for %#v", arg) |
||||
buf := make([]byte, 1024*1024) |
||||
buf = buf[:runtime.Stack(buf, false)] |
||||
t.Error(err) |
||||
t.Error(string(buf)) |
||||
} |
||||
}() |
||||
client.EthSubscribe(arg, "foo_bar") |
||||
} |
||||
check(true, nil) |
||||
check(true, 1) |
||||
check(true, (chan int)(nil)) |
||||
check(true, make(<-chan int)) |
||||
check(false, make(chan int)) |
||||
check(false, make(chan<- int)) |
||||
} |
||||
|
||||
func TestClientSubscribe(t *testing.T) { |
||||
server := newTestServer("eth", new(NotificationTestService)) |
||||
defer server.Stop() |
||||
client := DialInProc(server) |
||||
defer client.Close() |
||||
|
||||
nc := make(chan int) |
||||
count := 10 |
||||
sub, err := client.EthSubscribe(nc, "someSubscription", count, 0) |
||||
if err != nil { |
||||
t.Fatal("can't subscribe:", err) |
||||
} |
||||
for i := 0; i < count; i++ { |
||||
if val := <-nc; val != i { |
||||
t.Fatalf("value mismatch: got %d, want %d", val, i) |
||||
} |
||||
} |
||||
|
||||
sub.Unsubscribe() |
||||
select { |
||||
case v := <-nc: |
||||
t.Fatal("received value after unsubscribe:", v) |
||||
case err := <-sub.Err(): |
||||
if err != nil { |
||||
t.Fatalf("Err returned a non-nil error after explicit unsubscribe: %q", err) |
||||
} |
||||
case <-time.After(1 * time.Second): |
||||
t.Fatalf("subscription not closed within 1s after unsubscribe") |
||||
} |
||||
} |
||||
|
||||
// In this test, the connection drops while EthSubscribe is
|
||||
// waiting for a response.
|
||||
func TestClientSubscribeClose(t *testing.T) { |
||||
service := &NotificationTestService{ |
||||
gotHangSubscriptionReq: make(chan struct{}), |
||||
unblockHangSubscription: make(chan struct{}), |
||||
} |
||||
server := newTestServer("eth", service) |
||||
defer server.Stop() |
||||
client := DialInProc(server) |
||||
defer client.Close() |
||||
|
||||
var ( |
||||
nc = make(chan int) |
||||
errc = make(chan error) |
||||
sub *ClientSubscription |
||||
err error |
||||
) |
||||
go func() { |
||||
sub, err = client.EthSubscribe(nc, "hangSubscription", 999) |
||||
errc <- err |
||||
}() |
||||
|
||||
<-service.gotHangSubscriptionReq |
||||
client.Close() |
||||
service.unblockHangSubscription <- struct{}{} |
||||
|
||||
select { |
||||
case err := <-errc: |
||||
if err == nil { |
||||
t.Errorf("EthSubscribe returned nil error after Close") |
||||
} |
||||
if sub != nil { |
||||
t.Error("EthSubscribe returned non-nil subscription after Close") |
||||
} |
||||
case <-time.After(1 * time.Second): |
||||
t.Fatalf("EthSubscribe did not return within 1s after Close") |
||||
} |
||||
} |
||||
|
||||
func TestClientHTTP(t *testing.T) { |
||||
server := newTestServer("service", new(Service)) |
||||
defer server.Stop() |
||||
|
||||
client, hs := httpTestClient(server, "http", nil) |
||||
defer hs.Close() |
||||
defer client.Close() |
||||
|
||||
// Launch concurrent requests.
|
||||
var ( |
||||
results = make([]Result, 100) |
||||
errc = make(chan error) |
||||
wantResult = Result{"a", 1, new(Args)} |
||||
) |
||||
defer client.Close() |
||||
for i := range results { |
||||
i := i |
||||
go func() { |
||||
errc <- client.Call(&results[i], "service_echo", |
||||
wantResult.String, wantResult.Int, wantResult.Args) |
||||
}() |
||||
} |
||||
|
||||
// Wait for all of them to complete.
|
||||
timeout := time.NewTimer(5 * time.Second) |
||||
defer timeout.Stop() |
||||
for i := range results { |
||||
select { |
||||
case err := <-errc: |
||||
if err != nil { |
||||
t.Fatal(err) |
||||
} |
||||
case <-timeout.C: |
||||
t.Fatalf("timeout (got %d/%d) results)", i+1, len(results)) |
||||
} |
||||
} |
||||
|
||||
// Check results.
|
||||
for i := range results { |
||||
if !reflect.DeepEqual(results[i], wantResult) { |
||||
t.Errorf("result %d mismatch: got %#v, want %#v", i, results[i], wantResult) |
||||
} |
||||
} |
||||
} |
||||
|
||||
func TestClientReconnect(t *testing.T) { |
||||
startServer := func(addr string) (*Server, net.Listener) { |
||||
srv := newTestServer("service", new(Service)) |
||||
l, err := net.Listen("tcp", addr) |
||||
if err != nil { |
||||
t.Fatal(err) |
||||
} |
||||
go http.Serve(l, srv.WebsocketHandler("*")) |
||||
return srv, l |
||||
} |
||||
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second) |
||||
defer cancel() |
||||
|
||||
// Start a server and corresponding client.
|
||||
s1, l1 := startServer("127.0.0.1:0") |
||||
client, err := DialContext(ctx, "ws://"+l1.Addr().String()) |
||||
if err != nil { |
||||
t.Fatal("can't dial", err) |
||||
} |
||||
|
||||
// Perform a call. This should work because the server is up.
|
||||
var resp Result |
||||
if err := client.CallContext(ctx, &resp, "service_echo", "", 1, nil); err != nil { |
||||
t.Fatal(err) |
||||
} |
||||
|
||||
// Shut down the server and try calling again. It shouldn't work.
|
||||
l1.Close() |
||||
s1.Stop() |
||||
if err := client.CallContext(ctx, &resp, "service_echo", "", 2, nil); err == nil { |
||||
t.Error("successful call while the server is down") |
||||
t.Logf("resp: %#v", resp) |
||||
} |
||||
|
||||
// Allow for some cool down time so we can listen on the same address again.
|
||||
time.Sleep(2 * time.Second) |
||||
|
||||
// Start it up again and call again. The connection should be reestablished.
|
||||
// We spawn multiple calls here to check whether this hangs somehow.
|
||||
s2, l2 := startServer(l1.Addr().String()) |
||||
defer l2.Close() |
||||
defer s2.Stop() |
||||
|
||||
start := make(chan struct{}) |
||||
errors := make(chan error, 20) |
||||
for i := 0; i < cap(errors); i++ { |
||||
go func() { |
||||
<-start |
||||
var resp Result |
||||
errors <- client.CallContext(ctx, &resp, "service_echo", "", 3, nil) |
||||
}() |
||||
} |
||||
close(start) |
||||
errcount := 0 |
||||
for i := 0; i < cap(errors); i++ { |
||||
if err = <-errors; err != nil { |
||||
errcount++ |
||||
} |
||||
} |
||||
t.Log("err:", err) |
||||
if errcount > 1 { |
||||
t.Errorf("expected one error after disconnect, got %d", errcount) |
||||
} |
||||
} |
||||
|
||||
func newTestServer(serviceName string, service interface{}) *Server { |
||||
server := NewServer() |
||||
if err := server.RegisterName(serviceName, service); err != nil { |
||||
panic(err) |
||||
} |
||||
return server |
||||
} |
||||
|
||||
func httpTestClient(srv *Server, transport string, fl *flakeyListener) (*Client, *httptest.Server) { |
||||
// Create the HTTP server.
|
||||
var hs *httptest.Server |
||||
switch transport { |
||||
case "ws": |
||||
hs = httptest.NewUnstartedServer(srv.WebsocketHandler("*")) |
||||
case "http": |
||||
hs = httptest.NewUnstartedServer(srv) |
||||
default: |
||||
panic("unknown HTTP transport: " + transport) |
||||
} |
||||
// Wrap the listener if required.
|
||||
if fl != nil { |
||||
fl.Listener = hs.Listener |
||||
hs.Listener = fl |
||||
} |
||||
// Connect the client.
|
||||
hs.Start() |
||||
client, err := Dial(transport + "://" + hs.Listener.Addr().String()) |
||||
if err != nil { |
||||
panic(err) |
||||
} |
||||
return client, hs |
||||
} |
||||
|
||||
func ipcTestClient(srv *Server, fl *flakeyListener) (*Client, net.Listener) { |
||||
// Listen on a random endpoint.
|
||||
endpoint := fmt.Sprintf("go-ethereum-test-ipc-%d-%d", os.Getpid(), rand.Int63()) |
||||
if runtime.GOOS == "windows" { |
||||
endpoint = `\\.\pipe\` + endpoint |
||||
} else { |
||||
endpoint = os.TempDir() + "/" + endpoint |
||||
} |
||||
l, err := ipcListen(endpoint) |
||||
if err != nil { |
||||
panic(err) |
||||
} |
||||
// Connect the listener to the server.
|
||||
if fl != nil { |
||||
fl.Listener = l |
||||
l = fl |
||||
} |
||||
go srv.ServeListener(l) |
||||
// Connect the client.
|
||||
client, err := Dial(endpoint) |
||||
if err != nil { |
||||
panic(err) |
||||
} |
||||
return client, l |
||||
} |
||||
|
||||
// flakeyListener kills accepted connections after a random timeout.
|
||||
type flakeyListener struct { |
||||
net.Listener |
||||
maxKillTimeout time.Duration |
||||
maxAcceptDelay time.Duration |
||||
} |
||||
|
||||
func (l *flakeyListener) Accept() (net.Conn, error) { |
||||
delay := time.Duration(rand.Int63n(int64(l.maxAcceptDelay))) |
||||
time.Sleep(delay) |
||||
|
||||
c, err := l.Listener.Accept() |
||||
if err == nil { |
||||
timeout := time.Duration(rand.Int63n(int64(l.maxKillTimeout))) |
||||
time.AfterFunc(timeout, func() { |
||||
glog.V(logger.Debug).Infof("killing conn %v after %v", c.LocalAddr(), timeout) |
||||
c.Close() |
||||
}) |
||||
} |
||||
return c, err |
||||
} |
||||
Loading…
Reference in new issue