Add JSON RPC batch support

http://www.jsonrpc.org/specification#batch
This commit is contained in:
Taylor Gerring 2015-03-17 17:38:05 -04:00
parent fe819f3b9f
commit 8fd243ee23
2 changed files with 53 additions and 52 deletions

View File

@ -1,6 +1,8 @@
package rpc package rpc
import ( import (
"encoding/json"
"io/ioutil"
"net/http" "net/http"
"github.com/ethereum/go-ethereum/logger" "github.com/ethereum/go-ethereum/logger"
@ -16,54 +18,71 @@ const (
// JSONRPC returns a handler that implements the Ethereum JSON-RPC API. // JSONRPC returns a handler that implements the Ethereum JSON-RPC API.
func JSONRPC(pipe *xeth.XEth, dataDir string) http.Handler { func JSONRPC(pipe *xeth.XEth, dataDir string) http.Handler {
var json JsonWrapper var jsw JsonWrapper
api := NewEthereumApi(pipe, dataDir) api := NewEthereumApi(pipe, dataDir)
return http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) { return http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
// TODO this needs to be configurable
w.Header().Set("Access-Control-Allow-Origin", "*") w.Header().Set("Access-Control-Allow-Origin", "*")
rpchttplogger.DebugDetailln("Handling request") // Limit request size to resist DoS
if req.ContentLength > maxSizeReqLength { if req.ContentLength > maxSizeReqLength {
jsonerr := &RpcErrorObject{-32700, "Request too large"} jsonerr := &RpcErrorObject{-32700, "Request too large"}
json.Send(w, &RpcErrorResponse{JsonRpc: jsonrpcver, ID: nil, Error: jsonerr}) jsw.Send(w, &RpcErrorResponse{JsonRpc: jsonrpcver, ID: nil, Error: jsonerr})
return return
} }
reqParsed, reqerr := json.ParseRequestBody(req) defer req.Body.Close()
switch reqerr.(type) { body, err := ioutil.ReadAll(req.Body)
case nil: if err != nil {
break jsonerr := &RpcErrorObject{-32700, "Could not read request body"}
case *DecodeParamError, *InsufficientParamsError, *ValidationError: jsw.Send(w, &RpcErrorResponse{JsonRpc: jsonrpcver, ID: nil, Error: jsonerr})
jsonerr := &RpcErrorObject{-32602, reqerr.Error()} }
json.Send(w, &RpcErrorResponse{JsonRpc: jsonrpcver, ID: nil, Error: jsonerr})
return // Try to parse the request as a single
default: var reqSingle RpcRequest
jsonerr := &RpcErrorObject{-32700, "Could not parse request"} if err := json.Unmarshal(body, &reqSingle); err == nil {
json.Send(w, &RpcErrorResponse{JsonRpc: jsonrpcver, ID: nil, Error: jsonerr}) response := RpcResponse(api, &reqSingle)
jsw.Send(w, &response)
return return
} }
var response interface{} // Try to parse the request to batch
reserr := api.GetRequestReply(&reqParsed, &response) var reqBatch []RpcRequest
switch reserr.(type) { if err := json.Unmarshal(body, &reqBatch); err == nil {
case nil: // Build response batch
break resBatch := make([]*interface{}, len(reqBatch))
case *NotImplementedError: for i, request := range reqBatch {
jsonerr := &RpcErrorObject{-32601, reserr.Error()} response := RpcResponse(api, &request)
json.Send(w, &RpcErrorResponse{JsonRpc: jsonrpcver, ID: reqParsed.ID, Error: jsonerr}) resBatch[i] = response
return }
case *DecodeParamError, *InsufficientParamsError, *ValidationError: jsw.Send(w, resBatch)
jsonerr := &RpcErrorObject{-32602, reserr.Error()}
json.Send(w, &RpcErrorResponse{JsonRpc: jsonrpcver, ID: reqParsed.ID, Error: jsonerr})
return
default:
jsonerr := &RpcErrorObject{-32603, reserr.Error()}
json.Send(w, &RpcErrorResponse{JsonRpc: jsonrpcver, ID: reqParsed.ID, Error: jsonerr})
return return
} }
rpchttplogger.DebugDetailf("Generated response: %T %s", response, response) // Not a batch or single request, error
json.Send(w, &RpcSuccessResponse{JsonRpc: jsonrpcver, ID: reqParsed.ID, Result: response}) jsonerr := &RpcErrorObject{-32600, "Could not decode request"}
jsw.Send(w, &RpcErrorResponse{JsonRpc: jsonrpcver, ID: nil, Error: jsonerr})
}) })
} }
func RpcResponse(api *EthereumApi, request *RpcRequest) *interface{} {
var reply, response interface{}
reserr := api.GetRequestReply(request, &reply)
switch reserr.(type) {
case nil:
response = &RpcSuccessResponse{JsonRpc: jsonrpcver, ID: request.ID, Result: reply}
case *NotImplementedError:
jsonerr := &RpcErrorObject{-32601, reserr.Error()}
response = &RpcErrorResponse{JsonRpc: jsonrpcver, ID: request.ID, Error: jsonerr}
case *DecodeParamError, *InsufficientParamsError, *ValidationError:
jsonerr := &RpcErrorObject{-32602, reserr.Error()}
response = &RpcErrorResponse{JsonRpc: jsonrpcver, ID: request.ID, Error: jsonerr}
default:
jsonerr := &RpcErrorObject{-32603, reserr.Error()}
response = &RpcErrorResponse{JsonRpc: jsonrpcver, ID: request.ID, Error: jsonerr}
}
rpchttplogger.DebugDetailf("Generated response: %T %s", response, response)
return &response
}

View File

@ -21,7 +21,7 @@ import (
"fmt" "fmt"
"io" "io"
"math/big" "math/big"
"net/http" // "net/http"
"reflect" "reflect"
"time" "time"
@ -106,24 +106,6 @@ func (self JsonWrapper) Send(writer io.Writer, v interface{}) (n int, err error)
return writer.Write(payload) return writer.Write(payload)
} }
func (self JsonWrapper) ParseRequestBody(req *http.Request) (RpcRequest, error) {
var reqParsed RpcRequest
// Convert JSON to native types
d := json.NewDecoder(req.Body)
defer req.Body.Close()
err := d.Decode(&reqParsed)
if err != nil {
rpclogger.Errorln("Error decoding JSON: ", err)
return reqParsed, err
}
rpclogger.DebugDetailf("Parsed request: %s", reqParsed)
return reqParsed, nil
}
func toHex(b []byte) string { func toHex(b []byte) string {
hex := common.Bytes2Hex(b) hex := common.Bytes2Hex(b)
// Prefer output of "0x0" instead of "0x" // Prefer output of "0x0" instead of "0x"