Refactor RPC/*, tendermint/config for debora+barak

rpc/server/handlers.go

@@ -0,0 +1,395 @@
+package rpcserver
+
+import (
+	"bytes"
+	"encoding/json"
+	"errors"
+	"fmt"
+	"github.com/gorilla/websocket"
+	"github.com/tendermint/tendermint/binary"
+	"github.com/tendermint/tendermint/events"
+	. "github.com/tendermint/tendermint/rpc/types"
+	"io/ioutil"
+	"net/http"
+	"reflect"
+	"sync/atomic"
+	"time"
+)
+
+func RegisterRPCFuncs(mux *http.ServeMux, funcMap map[string]*RPCFunc) {
+	// HTTP endpoints
+	for funcName, rpcFunc := range funcMap {
+		mux.HandleFunc("/"+funcName, makeHTTPHandler(rpcFunc))
+	}
+
+	// JSONRPC endpoints
+	mux.HandleFunc("/", makeJSONRPCHandler(funcMap))
+}
+
+func RegisterEventsHandler(mux *http.ServeMux, evsw *events.EventSwitch) {
+	// websocket endpoint
+	wm := NewWebsocketManager(evsw)
+	mux.HandleFunc("/events", wm.websocketHandler) // 	websocket.Handler(w.eventsHandler))
+}
+
+//-------------------------------------
+// function introspection
+
+// holds all type information for each function
+type RPCFunc struct {
+	f        reflect.Value  // underlying rpc function
+	args     []reflect.Type // type of each function arg
+	returns  []reflect.Type // type of each return arg
+	argNames []string       // name of each argument
+}
+
+// wraps a function for quicker introspection
+func NewRPCFunc(f interface{}, args []string) *RPCFunc {
+	return &RPCFunc{
+		f:        reflect.ValueOf(f),
+		args:     funcArgTypes(f),
+		returns:  funcReturnTypes(f),
+		argNames: args,
+	}
+}
+
+// return a function's argument types
+func funcArgTypes(f interface{}) []reflect.Type {
+	t := reflect.TypeOf(f)
+	n := t.NumIn()
+	types := make([]reflect.Type, n)
+	for i := 0; i < n; i++ {
+		types[i] = t.In(i)
+	}
+	return types
+}
+
+// return a function's return types
+func funcReturnTypes(f interface{}) []reflect.Type {
+	t := reflect.TypeOf(f)
+	n := t.NumOut()
+	types := make([]reflect.Type, n)
+	for i := 0; i < n; i++ {
+		types[i] = t.Out(i)
+	}
+	return types
+}
+
+// function introspection
+//-----------------------------------------------------------------------------
+// rpc.json
+
+// jsonrpc calls grab the given method's function info and runs reflect.Call
+func makeJSONRPCHandler(funcMap map[string]*RPCFunc) http.HandlerFunc {
+	return func(w http.ResponseWriter, r *http.Request) {
+		if len(r.URL.Path) > 1 {
+			WriteRPCResponse(w, NewRPCResponse(nil, fmt.Sprintf("Invalid JSONRPC endpoint %s", r.URL.Path)))
+			return
+		}
+		b, _ := ioutil.ReadAll(r.Body)
+		var request RPCRequest
+		err := json.Unmarshal(b, &request)
+		if err != nil {
+			WriteRPCResponse(w, NewRPCResponse(nil, err.Error()))
+			return
+		}
+		rpcFunc := funcMap[request.Method]
+		if rpcFunc == nil {
+			WriteRPCResponse(w, NewRPCResponse(nil, "RPC method unknown: "+request.Method))
+			return
+		}
+		args, err := jsonParamsToArgs(rpcFunc, request.Params)
+		if err != nil {
+			WriteRPCResponse(w, NewRPCResponse(nil, err.Error()))
+			return
+		}
+		returns := rpcFunc.f.Call(args)
+		log.Debug("HTTPJSONRPC", "method", request.Method, "args", args, "returns", returns)
+		response, err := unreflectResponse(returns)
+		if err != nil {
+			WriteRPCResponse(w, NewRPCResponse(nil, err.Error()))
+			return
+		}
+		WriteRPCResponse(w, NewRPCResponse(response, ""))
+	}
+}
+
+// covert a list of interfaces to properly typed values
+func jsonParamsToArgs(rpcFunc *RPCFunc, params []interface{}) ([]reflect.Value, error) {
+	if len(rpcFunc.argNames) != len(params) {
+		return nil, errors.New(fmt.Sprintf("Expected %v parameters (%v), got %v (%v)",
+			len(rpcFunc.argNames), rpcFunc.argNames, len(params), params))
+	}
+	values := make([]reflect.Value, len(params))
+	for i, p := range params {
+		ty := rpcFunc.args[i]
+		v, err := _jsonObjectToArg(ty, p)
+		if err != nil {
+			return nil, err
+		}
+		values[i] = v
+	}
+	return values, nil
+}
+
+func _jsonObjectToArg(ty reflect.Type, object interface{}) (reflect.Value, error) {
+	var err error
+	v := reflect.New(ty)
+	binary.ReadJSONObject(v.Interface(), object, &err)
+	if err != nil {
+		return v, err
+	}
+	v = v.Elem()
+	return v, nil
+}
+
+// rpc.json
+//-----------------------------------------------------------------------------
+// rpc.http
+
+// convert from a function name to the http handler
+func makeHTTPHandler(rpcFunc *RPCFunc) func(http.ResponseWriter, *http.Request) {
+	return func(w http.ResponseWriter, r *http.Request) {
+		args, err := httpParamsToArgs(rpcFunc, r)
+		if err != nil {
+			WriteRPCResponse(w, NewRPCResponse(nil, err.Error()))
+			return
+		}
+		returns := rpcFunc.f.Call(args)
+		log.Debug("HTTPRestRPC", "method", r.URL.Path, "args", args, "returns", returns)
+		response, err := unreflectResponse(returns)
+		if err != nil {
+			WriteRPCResponse(w, NewRPCResponse(nil, err.Error()))
+			return
+		}
+		WriteRPCResponse(w, NewRPCResponse(response, ""))
+	}
+}
+
+// Covert an http query to a list of properly typed values.
+// To be properly decoded the arg must be a concrete type from tendermint (if its an interface).
+func httpParamsToArgs(rpcFunc *RPCFunc, r *http.Request) ([]reflect.Value, error) {
+	argTypes := rpcFunc.args
+	argNames := rpcFunc.argNames
+
+	var err error
+	values := make([]reflect.Value, len(argNames))
+	for i, name := range argNames {
+		ty := argTypes[i]
+		arg := GetParam(r, name)
+		values[i], err = _jsonStringToArg(ty, arg)
+		if err != nil {
+			return nil, err
+		}
+	}
+	return values, nil
+}
+
+func _jsonStringToArg(ty reflect.Type, arg string) (reflect.Value, error) {
+	var err error
+	v := reflect.New(ty)
+	binary.ReadJSON(v.Interface(), []byte(arg), &err)
+	if err != nil {
+		return v, err
+	}
+	v = v.Elem()
+	return v, nil
+}
+
+// rpc.http
+//-----------------------------------------------------------------------------
+// rpc.websocket
+
+const (
+	WSConnectionReaperSeconds = 5
+	MaxFailedSends            = 10
+	WriteChanBufferSize       = 10
+)
+
+// a single websocket connection
+// contains listener id, underlying ws connection,
+// and the event switch for subscribing to events
+type WSConnection struct {
+	id          string
+	wsConn      *websocket.Conn
+	writeChan   chan WSResponse
+	quitChan    chan struct{}
+	failedSends uint
+	started     uint32
+	stopped     uint32
+
+	evsw *events.EventSwitch
+}
+
+// new websocket connection wrapper
+func NewWSConnection(wsConn *websocket.Conn) *WSConnection {
+	return &WSConnection{
+		id:        wsConn.RemoteAddr().String(),
+		wsConn:    wsConn,
+		writeChan: make(chan WSResponse, WriteChanBufferSize), // buffered. we keep track when its full
+		quitChan:  make(chan struct{}),
+	}
+}
+
+// start the connection and hand her the event switch
+func (con *WSConnection) Start(evsw *events.EventSwitch) {
+	if atomic.CompareAndSwapUint32(&con.started, 0, 1) {
+		con.evsw = evsw
+
+		// read subscriptions/unsubscriptions to events
+		go con.read()
+		// write responses
+		con.write()
+	}
+}
+
+// close the connection
+func (con *WSConnection) Stop() {
+	if atomic.CompareAndSwapUint32(&con.stopped, 0, 1) {
+		con.evsw.RemoveListener(con.id)
+		close(con.quitChan)
+		// the write loop closes the websocket connection
+		// when it exits its loop, and the read loop
+		// closes the writeChan
+	}
+}
+
+// attempt to write response to writeChan and record failures
+func (con *WSConnection) safeWrite(resp WSResponse) {
+	select {
+	case con.writeChan <- resp:
+		// yay
+		con.failedSends = 0
+	default:
+		// channel is full
+		// if this happens too many times in a row,
+		// close connection
+		con.failedSends += 1
+	}
+}
+
+// read from the socket and subscribe to or unsubscribe from events
+func (con *WSConnection) read() {
+	defer close(con.writeChan)
+	reaper := time.Tick(time.Second * WSConnectionReaperSeconds)
+	for {
+		select {
+		// TODO: this actually doesn't work
+		// since ReadMessage blocks. Really it needs its own
+		// go routine
+		case <-reaper:
+			if con.failedSends > MaxFailedSends {
+				// sending has failed too many times.
+				// kill the connection
+				con.Stop()
+				return
+			}
+		default:
+			var in []byte
+			_, in, err := con.wsConn.ReadMessage()
+			if err != nil {
+				// an error reading the connection,
+				// kill the connection
+				con.Stop()
+				return
+			}
+			var req WSRequest
+			err = json.Unmarshal(in, &req)
+			if err != nil {
+				errStr := fmt.Sprintf("Error unmarshaling data: %s", err.Error())
+				con.safeWrite(WSResponse{Error: errStr})
+				continue
+			}
+			switch req.Type {
+			case "subscribe":
+				log.Info("New event subscription", "con id", con.id, "event", req.Event)
+				con.evsw.AddListenerForEvent(con.id, req.Event, func(msg interface{}) {
+					resp := WSResponse{
+						Event: req.Event,
+						Data:  msg,
+					}
+					con.safeWrite(resp)
+				})
+			case "unsubscribe":
+				if req.Event != "" {
+					con.evsw.RemoveListenerForEvent(req.Event, con.id)
+				} else {
+					con.evsw.RemoveListener(con.id)
+				}
+			default:
+				con.safeWrite(WSResponse{Error: "Unknown request type: " + req.Type})
+			}
+		}
+	}
+}
+
+// receives on a write channel and writes out on the socket
+func (con *WSConnection) write() {
+	defer con.wsConn.Close()
+	n, err := new(int64), new(error)
+	for {
+		select {
+		case msg := <-con.writeChan:
+			buf := new(bytes.Buffer)
+			binary.WriteJSON(msg, buf, n, err)
+			if *err != nil {
+				log.Error("Failed to marshal WSResponse to JSON", "error", err)
+			} else {
+				if err := con.wsConn.WriteMessage(websocket.TextMessage, buf.Bytes()); err != nil {
+					log.Error("Failed to write response on websocket", "error", err)
+					con.Stop()
+					return
+				}
+			}
+		case <-con.quitChan:
+			return
+		}
+	}
+}
+
+// main manager for all websocket connections
+// holds the event switch
+type WebsocketManager struct {
+	websocket.Upgrader
+	evsw *events.EventSwitch
+}
+
+func NewWebsocketManager(evsw *events.EventSwitch) *WebsocketManager {
+	return &WebsocketManager{
+		evsw: evsw,
+		Upgrader: websocket.Upgrader{
+			ReadBufferSize:  1024,
+			WriteBufferSize: 1024,
+			CheckOrigin: func(r *http.Request) bool {
+				// TODO
+				return true
+			},
+		},
+	}
+}
+
+func (wm *WebsocketManager) websocketHandler(w http.ResponseWriter, r *http.Request) {
+	wsConn, err := wm.Upgrade(w, r, nil)
+	if err != nil {
+		// TODO - return http error
+		log.Error("Failed to upgrade to websocket connection", "error", err)
+		return
+	}
+
+	// register connection
+	con := NewWSConnection(wsConn)
+	log.Info("New websocket connection", "origin", con.id)
+	con.Start(wm.evsw)
+}
+
+// rpc.websocket
+//-----------------------------------------------------------------------------
+
+// returns is Response struct and error. If error is not nil, return it
+func unreflectResponse(returns []reflect.Value) (interface{}, error) {
+	errV := returns[1]
+	if errV.Interface() != nil {
+		return nil, fmt.Errorf("%v", errV.Interface())
+	}
+	return returns[0].Interface(), nil
+}

rpc/server/http_params.go

@@ -0,0 +1,95 @@
+package rpcserver
+
+import (
+	"encoding/hex"
+	"fmt"
+	"net/http"
+	"regexp"
+	"strconv"
+
+	. "github.com/tendermint/tendermint/rpc/types"
+)
+
+var (
+	// Parts of regular expressions
+	atom    = "[A-Z0-9!#$%&'*+\\-/=?^_`{|}~]+"
+	dotAtom = atom + `(?:\.` + atom + `)*`
+	domain  = `[A-Z0-9.-]+\.[A-Z]{2,4}`
+
+	RE_HEX     = regexp.MustCompile(`^(?i)[a-f0-9]+$`)
+	RE_EMAIL   = regexp.MustCompile(`^(?i)(` + dotAtom + `)@(` + dotAtom + `)$`)
+	RE_ADDRESS = regexp.MustCompile(`^(?i)[a-z0-9]{25,34}$`)
+	RE_HOST    = regexp.MustCompile(`^(?i)(` + domain + `)$`)
+
+	//RE_ID12       = regexp.MustCompile(`^[a-zA-Z0-9]{12}$`)
+)
+
+func panicRPC(err error) {
+	panic(NewRPCResponse(nil, err.Error()))
+}
+
+func GetParam(r *http.Request, param string) string {
+	s := r.URL.Query().Get(param)
+	if s == "" {
+		s = r.FormValue(param)
+	}
+	return s
+}
+
+func GetParamByteSlice(r *http.Request, param string) ([]byte, error) {
+	s := GetParam(r, param)
+	return hex.DecodeString(s)
+}
+
+func GetParamInt64(r *http.Request, param string) (int64, error) {
+	s := GetParam(r, param)
+	i, err := strconv.ParseInt(s, 10, 64)
+	if err != nil {
+		return 0, fmt.Errorf(param, err.Error())
+	}
+	return i, nil
+}
+
+func GetParamInt32(r *http.Request, param string) (int32, error) {
+	s := GetParam(r, param)
+	i, err := strconv.ParseInt(s, 10, 32)
+	if err != nil {
+		return 0, fmt.Errorf(param, err.Error())
+	}
+	return int32(i), nil
+}
+
+func GetParamUint64(r *http.Request, param string) (uint64, error) {
+	s := GetParam(r, param)
+	i, err := strconv.ParseUint(s, 10, 64)
+	if err != nil {
+		return 0, fmt.Errorf(param, err.Error())
+	}
+	return i, nil
+}
+
+func GetParamUint(r *http.Request, param string) (uint, error) {
+	s := GetParam(r, param)
+	i, err := strconv.ParseUint(s, 10, 64)
+	if err != nil {
+		return 0, fmt.Errorf(param, err.Error())
+	}
+	return uint(i), nil
+}
+
+func GetParamRegexp(r *http.Request, param string, re *regexp.Regexp) (string, error) {
+	s := GetParam(r, param)
+	if !re.MatchString(s) {
+		return "", fmt.Errorf(param, "Did not match regular expression %v", re.String())
+	}
+	return s, nil
+}
+
+func GetParamFloat64(r *http.Request, param string) (float64, error) {
+	s := GetParam(r, param)
+	f, err := strconv.ParseFloat(s, 64)
+	if err != nil {
+		return 0, fmt.Errorf(param, err.Error())
+	}
+	return f, nil
+}

rpc/server/http_server.go

@@ -0,0 +1,120 @@
+// Commons for HTTP handling
+package rpcserver
+
+import (
+	"bufio"
+	"bytes"
+	"fmt"
+	"net"
+	"net/http"
+	"runtime/debug"
+	"time"
+
+	"github.com/tendermint/tendermint/alert"
+	"github.com/tendermint/tendermint/binary"
+	. "github.com/tendermint/tendermint/common"
+	. "github.com/tendermint/tendermint/rpc/types"
+)
+
+func StartHTTPServer(listenAddr string, handler http.Handler) {
+	log.Info(Fmt("Starting RPC HTTP server on %v", listenAddr))
+	go func() {
+		listener, err := net.Listen("tcp", listenAddr)
+		if err != nil {
+			Exit(Fmt("Failed to listen to %v", listenAddr))
+		}
+		res := http.Serve(
+			listener,
+			RecoverAndLogHandler(handler),
+		)
+		log.Crit("RPC HTTP server stopped", "result", res)
+	}()
+}
+
+func WriteRPCResponse(w http.ResponseWriter, res RPCResponse) {
+	buf, n, err := new(bytes.Buffer), new(int64), new(error)
+	binary.WriteJSON(res, buf, n, err)
+	if *err != nil {
+		log.Warn("Failed to write RPC response", "error", err)
+	}
+
+	w.Header().Set("Content-Type", "application/json")
+	w.WriteHeader(200)
+	w.Write(buf.Bytes())
+}
+
+//-----------------------------------------------------------------------------
+
+// Wraps an HTTP handler, adding error logging.
+// If the inner function panics, the outer function recovers, logs, sends an
+// HTTP 500 error response.
+func RecoverAndLogHandler(handler http.Handler) http.Handler {
+	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		// Wrap the ResponseWriter to remember the status
+		rww := &ResponseWriterWrapper{-1, w}
+		begin := time.Now()
+
+		// Common headers
+		origin := r.Header.Get("Origin")
+		rww.Header().Set("Access-Control-Allow-Origin", origin)
+		rww.Header().Set("Access-Control-Allow-Credentials", "true")
+		rww.Header().Set("Access-Control-Expose-Headers", "X-Server-Time")
+		rww.Header().Set("X-Server-Time", fmt.Sprintf("%v", begin.Unix()))
+
+		defer func() {
+			// Send a 500 error if a panic happens during a handler.
+			// Without this, Chrome & Firefox were retrying aborted ajax requests,
+			// at least to my localhost.
+			if e := recover(); e != nil {
+
+				// If RPCResponse
+				if res, ok := e.(RPCResponse); ok {
+					WriteRPCResponse(rww, res)
+				} else {
+					// For the rest,
+					log.Error("Panic in RPC HTTP handler", "error", e, "stack", string(debug.Stack()))
+					rww.WriteHeader(http.StatusInternalServerError)
+					WriteRPCResponse(rww, NewRPCResponse(nil, Fmt("Internal Server Error: %v", e)))
+				}
+			}
+
+			// Finally, log.
+			durationMS := time.Since(begin).Nanoseconds() / 1000000
+			if rww.Status == -1 {
+				rww.Status = 200
+			}
+			log.Debug("Served RPC HTTP response",
+				"method", r.Method, "url", r.URL,
+				"status", rww.Status, "duration", durationMS,
+				"remoteAddr", r.RemoteAddr,
+			)
+		}()
+
+		handler.ServeHTTP(rww, r)
+	})
+}
+
+// Remember the status for logging
+type ResponseWriterWrapper struct {
+	Status int
+	http.ResponseWriter
+}
+
+func (w *ResponseWriterWrapper) WriteHeader(status int) {
+	w.Status = status
+	w.ResponseWriter.WriteHeader(status)
+}
+
+// implements http.Hijacker
+func (w *ResponseWriterWrapper) Hijack() (net.Conn, *bufio.ReadWriter, error) {
+	return w.ResponseWriter.(http.Hijacker).Hijack()
+}
+
+// Stick it as a deferred statement in gouroutines to prevent the program from crashing.
+func Recover(daemonName string) {
+	if e := recover(); e != nil {
+		stack := string(debug.Stack())
+		errorString := fmt.Sprintf("[%s] %s\n%s", daemonName, e, stack)
+		alert.Alert(errorString)
+	}
+}

rpc/server/log.go

@@ -0,0 +1,7 @@
+package rpcserver
+
+import (
+	"github.com/tendermint/log15"
+)
+
+var log = log15.New("module", "rpcserver")