origin/rpc/rpchandler.go

package rpc

import (
	"errors"
	"fmt"
	"github.com/duanhf2012/origin/v2/event"
	"github.com/duanhf2012/origin/v2/log"
	"reflect"

	"strings"
	"time"
	"unicode"
	"unicode/utf8"
)

const maxClusterNode int = 32

type FuncRpcClient func(nodeId string, serviceMethod string, filterRetire bool, client []*Client) (error, []*Client)
type FuncRpcServer func() IServer

const NodeIdNull = ""

var nilError = reflect.Zero(reflect.TypeOf((*error)(nil)).Elem())

type RpcError string

var NilError RpcError

func (e RpcError) Error() string {
	return string(e)
}

func ConvertError(e error) RpcError {
	if e == nil {
		return NilError
	}

	rpcErr := RpcError(e.Error())
	return rpcErr
}

type RpcMethodInfo struct {
	method           reflect.Method
	inParamValue     reflect.Value
	inParam          interface{}
	outParamValue    reflect.Value
	hasResponder     bool
	rpcProcessorType RpcProcessorType
}

type RawRpcCallBack func(rawData []byte)

type IRpcHandlerChannel interface {
	PushRpcResponse(call *Call) error
	PushRpcRequest(rpcRequest *RpcRequest) error
}

type RpcHandler struct {
	IRpcHandlerChannel

	rpcHandler      IRpcHandler
	mapFunctions    map[string]RpcMethodInfo
	mapRawFunctions map[uint32]RawRpcCallBack
	funcRpcClient   FuncRpcClient
	funcRpcServer   FuncRpcServer

	//pClientList []*Client
}

// NotifyEventToAllService type TriggerRpcConnEvent func(bConnect bool, clientSeq uint32, nodeId string)
type NotifyEventToAllService func(event event.IEvent)

type INodeConnListener interface {
	OnNodeConnected(nodeId string)
	OnNodeDisconnect(nodeId string)
}

type INatsConnListener interface {
	OnNatsConnected()
	OnNatsDisconnect()
}

type IDiscoveryServiceListener interface {
	OnDiscoveryService(nodeId string, serviceName []string)
	OnUnDiscoveryService(nodeId string, serviceName []string)
}

type CancelRpc func()

func emptyCancelRpc() {}

type IRpcHandler interface {
	IRpcHandlerChannel
	GetName() string
	InitRpcHandler(rpcHandler IRpcHandler, getClientFun FuncRpcClient, getServerFun FuncRpcServer, rpcHandlerChannel IRpcHandlerChannel)
	GetRpcHandler() IRpcHandler
	HandlerRpcRequest(request *RpcRequest)
	HandlerRpcResponseCB(call *Call)
	CallMethod(client *Client, ServiceMethod string, param interface{}, callBack reflect.Value, reply interface{}) error

	Call(serviceMethod string, args interface{}, reply interface{}) error
	CallNode(nodeId string, serviceMethod string, args interface{}, reply interface{}) error
	AsyncCall(serviceMethod string, args interface{}, callback interface{}) error
	AsyncCallNode(nodeId string, serviceMethod string, args interface{}, callback interface{}) error

	CallWithTimeout(timeout time.Duration, serviceMethod string, args interface{}, reply interface{}) error
	CallNodeWithTimeout(timeout time.Duration, nodeId string, serviceMethod string, args interface{}, reply interface{}) error
	AsyncCallWithTimeout(timeout time.Duration, serviceMethod string, args interface{}, callback interface{}) (CancelRpc, error)
	AsyncCallNodeWithTimeout(timeout time.Duration, nodeId string, serviceMethod string, args interface{}, callback interface{}) (CancelRpc, error)

	Go(serviceMethod string, args interface{}) error
	GoNode(nodeId string, serviceMethod string, args interface{}) error
	RawGoNode(rpcProcessorType RpcProcessorType, nodeId string, rpcMethodId uint32, serviceName string, rawArgs []byte) error
	CastGo(serviceMethod string, args interface{}) error
	UnmarshalInParam(rpcProcessor IRpcProcessor, serviceMethod string, rawRpcMethodId uint32, inParam []byte) (interface{}, error)
	GetRpcServer() FuncRpcServer
}

func reqHandlerNull(Returns interface{}, Err RpcError) {
}

var requestHandlerNull reflect.Value

func init() {
	requestHandlerNull = reflect.ValueOf(reqHandlerNull)
}

func (handler *RpcHandler) GetRpcHandler() IRpcHandler {
	return handler.rpcHandler
}

func (handler *RpcHandler) InitRpcHandler(rpcHandler IRpcHandler, getClientFun FuncRpcClient, getServerFun FuncRpcServer, rpcHandlerChannel IRpcHandlerChannel) {
	handler.IRpcHandlerChannel = rpcHandlerChannel
	handler.mapRawFunctions = make(map[uint32]RawRpcCallBack)
	handler.rpcHandler = rpcHandler
	handler.mapFunctions = map[string]RpcMethodInfo{}
	handler.funcRpcClient = getClientFun
	handler.funcRpcServer = getServerFun
	handler.RegisterRpc(rpcHandler)
}

// Is this an exported - upper case - name?
func isExported(name string) bool {
	r, _ := utf8.DecodeRuneInString(name)
	return unicode.IsUpper(r)
}

// Is this type exported or a builtin?
func (handler *RpcHandler) isExportedOrBuiltinType(t reflect.Type) bool {
	for t.Kind() == reflect.Ptr {
		t = t.Elem()
	}
	// PkgPath will be non-empty even for an exported type,
	// so we need to check the type name as well.
	return isExported(t.Name()) || t.PkgPath() == ""
}

func (handler *RpcHandler) suitableMethods(method reflect.Method) error {
	//只有RPC_开头的才能被调用
	if strings.Index(method.Name, "RPC_") != 0 && strings.Index(method.Name, "RPC") != 0 {
		return nil
	}

	//取出输入参数类型
	var rpcMethodInfo RpcMethodInfo
	typ := method.Type

	if typ.NumIn() < 2 || typ.NumIn() > 4 {
		return fmt.Errorf("%s Unsupported parameter format", method.Name)
	}

	//1.判断第一个参数
	var parIdx = 1
	if typ.In(parIdx).String() == "rpc.RequestHandler" {
		parIdx += 1
		rpcMethodInfo.hasResponder = true
	}

	if rpcMethodInfo.hasResponder && typ.NumOut() > 0  {
		return fmt.Errorf("%s should not have return parameters", method.Name)
	}

	if !rpcMethodInfo.hasResponder && typ.NumOut() != 1  {
		return fmt.Errorf("%s The number of returned arguments must be 1", method.Name)
	}

	if !rpcMethodInfo.hasResponder && typ.Out(0).String() != "error" {
		return fmt.Errorf("%s The return parameter must be of type error", method.Name)
	}

	for i := parIdx; i < typ.NumIn(); i++ {
		if handler.isExportedOrBuiltinType(typ.In(i)) == false {
			return fmt.Errorf("%s Unsupported parameter types", method.Name)
		}
	}

	rpcMethodInfo.inParamValue = reflect.New(typ.In(parIdx).Elem())
	rpcMethodInfo.inParam = reflect.New(typ.In(parIdx).Elem()).Interface()
	pt, _ := GetProcessorType(rpcMethodInfo.inParamValue.Interface())
	rpcMethodInfo.rpcProcessorType = pt

	parIdx++
	if parIdx < typ.NumIn() {
		rpcMethodInfo.outParamValue = reflect.New(typ.In(parIdx).Elem())
	}

	rpcMethodInfo.method = method
	handler.mapFunctions[handler.rpcHandler.GetName()+"."+method.Name] = rpcMethodInfo
	return nil
}

func (handler *RpcHandler) RegisterRpc(rpcHandler IRpcHandler) error {
	typ := reflect.TypeOf(rpcHandler)
	for m := 0; m < typ.NumMethod(); m++ {
		method := typ.Method(m)
		err := handler.suitableMethods(method)
		if err != nil {
			panic(err)
		}
	}

	return nil
}

func (handler *RpcHandler) HandlerRpcResponseCB(call *Call) {
	defer func() {
		if r := recover(); r != nil {
			log.StackError(fmt.Sprint(r))
		}
	}()

	if call.Err == nil {
		call.callback.Call([]reflect.Value{reflect.ValueOf(call.Reply), nilError})
	} else {
		call.callback.Call([]reflect.Value{reflect.ValueOf(call.Reply), reflect.ValueOf(call.Err)})
	}
	ReleaseCall(call)
}

func (handler *RpcHandler) HandlerRpcRequest(request *RpcRequest) {
	if request.requestHandle == nil {
		defer ReleaseRpcRequest(request)
	}

	defer func() {
		if r := recover(); r != nil {
			log.StackError(fmt.Sprint(r))
			rpcErr := RpcError("call error : core dumps")
			if request.requestHandle != nil {
				request.requestHandle(nil, rpcErr)
			}
		}
	}()

	//如果是原始RPC请求
	rawRpcId := request.RpcRequestData.GetRpcMethodId()
	if rawRpcId > 0 {
		v, ok := handler.mapRawFunctions[rawRpcId]
		if ok == false {
			log.Error("RpcHandler cannot find request rpc id", log.Uint32("rawRpcId", rawRpcId))
			return
		}
		rawData, ok := request.inParam.([]byte)
		if ok == false {
			log.Error("RpcHandler cannot  convert", log.String("RpcHandlerName", handler.rpcHandler.GetName()), log.Uint32("rawRpcId", rawRpcId))
			return
		}

		v(rawData)
		return
	}

	//普通的rpc请求
	v, ok := handler.mapFunctions[request.RpcRequestData.GetServiceMethod()]
	if ok == false {
		err := "RpcHandler " + handler.rpcHandler.GetName() + " cannot find " + request.RpcRequestData.GetServiceMethod()
		log.Error("HandlerRpcRequest cannot find serviceMethod", log.String("RpcHandlerName", handler.rpcHandler.GetName()), log.String("serviceMethod", request.RpcRequestData.GetServiceMethod()))
		if request.requestHandle != nil {
			request.requestHandle(nil, RpcError(err))
		}
		return
	}

	var paramList []reflect.Value
	var err error
	//生成Call参数
	paramList = append(paramList, reflect.ValueOf(handler.GetRpcHandler())) //接受者
	if v.hasResponder == true {
		if request.requestHandle != nil {
			responder := reflect.ValueOf(request.requestHandle)
			paramList = append(paramList, responder)
		} else {
			paramList = append(paramList, requestHandlerNull)
		}
	}

	paramList = append(paramList, reflect.ValueOf(request.inParam))
	var oParam reflect.Value
	if v.outParamValue.IsValid() {
		if request.localReply != nil {
			oParam = reflect.ValueOf(request.localReply) //输出参数
		} else {
			oParam = reflect.New(v.outParamValue.Type().Elem())
		}
		paramList = append(paramList, oParam) //输出参数
	} else if request.requestHandle != nil && v.hasResponder == false { //调用方有返回值，但被调用函数没有返回参数
		rErr := "Call Rpc " + request.RpcRequestData.GetServiceMethod() + " without return parameter!"
		log.Error("call serviceMethod without return parameter", log.String("serviceMethod", request.RpcRequestData.GetServiceMethod()))
		request.requestHandle(nil, RpcError(rErr))
		return
	}

	requestHandle := request.requestHandle
	returnValues := v.method.Func.Call(paramList)
	if len(returnValues) > 0 {
		errInter := returnValues[0].Interface()
		if errInter != nil {
			err = errInter.(error)
		}
	}

	if v.hasResponder == false && requestHandle != nil {
		requestHandle(oParam.Interface(), ConvertError(err))
	}
}

func (handler *RpcHandler) CallMethod(client *Client, ServiceMethod string, param interface{}, callBack reflect.Value, reply interface{}) error {
	var err error
	v, ok := handler.mapFunctions[ServiceMethod]
	if ok == false {
		err = errors.New("RpcHandler " + handler.rpcHandler.GetName() + " cannot find" + ServiceMethod)
		log.Error("CallMethod cannot find serviceMethod", log.String("rpcHandlerName", handler.rpcHandler.GetName()), log.String("serviceMethod", ServiceMethod))
		return err
	}

	var paramList []reflect.Value
	var returnValues []reflect.Value
	var pCall *Call
	var callSeq uint64
	if v.hasResponder == true {
		paramList = append(paramList, reflect.ValueOf(handler.GetRpcHandler())) //接受者
		pCall = MakeCall()
		pCall.callback = &callBack
		pCall.Seq = client.generateSeq()
		callSeq = pCall.Seq
		pCall.TimeOut = DefaultRpcTimeout
		pCall.ServiceMethod = ServiceMethod
		client.AddPending(pCall)

		//有返回值时
		if reply != nil {
			//如果是Call同步调用
			hd := func(Returns interface{}, Err RpcError) {
				rpcCall := client.RemovePending(callSeq)
				if rpcCall == nil {
					log.Error("cannot find call seq", log.Uint64("seq", callSeq))
					return
				}

				//解析数据
				if len(Err) != 0 {
					rpcCall.Err = Err
				} else if Returns != nil {
					_, processor := GetProcessorType(Returns)
					var bytes []byte
					bytes, rpcCall.Err = processor.Marshal(Returns)
					if rpcCall.Err == nil {
						rpcCall.Err = processor.Unmarshal(bytes, reply)
					}
				}

				//如果找不到，说明已经超时
				rpcCall.Reply = reply
				rpcCall.done <- rpcCall
			}
			paramList = append(paramList, reflect.ValueOf(hd))
		} else { //无返回值时,是一个requestHandlerNull空回调
			paramList = append(paramList, callBack)
		}
		paramList = append(paramList, reflect.ValueOf(param))

		//rpc函数被调用
		returnValues = v.method.Func.Call(paramList)

		//判断返回值是否错误，有错误时则回调
		errInter := returnValues[0].Interface()
		if errInter != nil && callBack != requestHandlerNull {
			err = errInter.(error)
			callBack.Call([]reflect.Value{reflect.ValueOf(reply), reflect.ValueOf(err)})
		}
	} else {
		paramList = append(paramList, reflect.ValueOf(handler.GetRpcHandler())) //接受者
		paramList = append(paramList, reflect.ValueOf(param))

		//被调用RPC函数有返回值时
		if v.outParamValue.IsValid() {
			//不带返回值参数的RPC函数
			if reply == nil {
				paramList = append(paramList, reflect.New(v.outParamValue.Type().Elem()))
			} else {
				//带返回值参数的RPC函数
				paramList = append(paramList, reflect.ValueOf(reply)) //输出参数
			}
		}

		returnValues = v.method.Func.Call(paramList)
		errInter := returnValues[0].Interface()

		//如果无回调
		if callBack != requestHandlerNull {
			valErr := nilError
			if errInter != nil {
				err = errInter.(error)
				valErr = reflect.ValueOf(err)
			}

			callBack.Call([]reflect.Value{reflect.ValueOf(reply), valErr})
		}
	}

	rpcCall := client.FindPending(callSeq)
	if rpcCall != nil {
		err = rpcCall.Done().Err
		if rpcCall.callback != nil {
			valErr := nilError
			if rpcCall.Err != nil {
				valErr = reflect.ValueOf(rpcCall.Err)
			}
			rpcCall.callback.Call([]reflect.Value{reflect.ValueOf(rpcCall.Reply), valErr})
		}
		client.RemovePending(rpcCall.Seq)
		ReleaseCall(rpcCall)
	}

	return err
}

func (handler *RpcHandler) goRpc(processor IRpcProcessor, bCast bool, nodeId string, serviceMethod string, args interface{}) error {
	pClientList := make([]*Client, 0, maxClusterNode)
	err, pClientList := handler.funcRpcClient(nodeId, serviceMethod, false, pClientList)
	if len(pClientList) == 0 {
		if err != nil {
			log.Error("call serviceMethod is failed", log.String("serviceMethod", serviceMethod), log.ErrorField("error", err))
		} else {
			log.Error("cannot find serviceMethod", log.String("serviceMethod", serviceMethod))
		}
		return err
	}

	if len(pClientList) > 1 && bCast == false {
		log.Error("cannot call serviceMethod more then 1 node", log.String("serviceMethod", serviceMethod))
		return errors.New("cannot call more then 1 node")
	}

	//2.rpcClient调用
	for i := 0; i < len(pClientList); i++ {
		pCall := pClientList[i].Go(pClientList[i].GetTargetNodeId(), DefaultRpcTimeout, handler.rpcHandler, true, serviceMethod, args, nil)
		if pCall.Err != nil {
			err = pCall.Err
		}
		pClientList[i].RemovePending(pCall.Seq)
		ReleaseCall(pCall)
	}

	return err
}

func (handler *RpcHandler) callRpc(timeout time.Duration, nodeId string, serviceMethod string, args interface{}, reply interface{}) error {
	pClientList := make([]*Client, 0, maxClusterNode)
	err, pClientList := handler.funcRpcClient(nodeId, serviceMethod, false, pClientList)
	if err != nil {
		log.Error("Call serviceMethod is failed", log.ErrorField("error", err))
		return err
	} else if len(pClientList) <= 0 {
		err = errors.New("Call serviceMethod is error:cannot find " + serviceMethod)
		log.Error("cannot find serviceMethod", log.String("serviceMethod", serviceMethod))
		return err
	} else if len(pClientList) > 1 {
		log.Error("Cannot call more then 1 node!", log.String("serviceMethod", serviceMethod))
		return errors.New("cannot call more then 1 node")
	}

	pClient := pClientList[0]
	pCall := pClient.Go(pClient.GetTargetNodeId(), timeout, handler.rpcHandler, false, serviceMethod, args, reply)

	err = pCall.Done().Err
	pClient.RemovePending(pCall.Seq)
	ReleaseCall(pCall)
	return err
}

func (handler *RpcHandler) asyncCallRpc(timeout time.Duration, nodeId string, serviceMethod string, args interface{}, callback interface{}) (CancelRpc, error) {
	fVal := reflect.ValueOf(callback)
	if fVal.Kind() != reflect.Func {
		err := errors.New("call " + serviceMethod + " input callback param is error!")
		log.Error("input callback param is error", log.String("serviceMethod", serviceMethod))
		return emptyCancelRpc, err
	}

	if fVal.Type().NumIn() != 2 {
		err := errors.New("call " + serviceMethod + " callback param function is error!")
		log.Error("callback param function is error", log.String("serviceMethod", serviceMethod))
		return emptyCancelRpc, err
	}

	if fVal.Type().In(0).Kind() != reflect.Ptr || fVal.Type().In(1).String() != "error" {
		err := errors.New("call " + serviceMethod + " callback param function is error!")
		log.Error("callback param function is error", log.String("serviceMethod", serviceMethod))
		return emptyCancelRpc, err
	}

	reply := reflect.New(fVal.Type().In(0).Elem()).Interface()
	pClientList := make([]*Client, 0, 1)
	err, pClientList := handler.funcRpcClient(nodeId, serviceMethod, false, pClientList[:])
	if len(pClientList) == 0 || err != nil {
		if err == nil {
			if nodeId != NodeIdNull {
				err = fmt.Errorf("cannot find %s from nodeId %s", serviceMethod, nodeId)
			} else {
				err = fmt.Errorf("no %s service found in the origin network", serviceMethod)
			}
		}
		fVal.Call([]reflect.Value{reflect.ValueOf(reply), reflect.ValueOf(err)})
		log.Error("cannot find serviceMethod from node", log.String("serviceMethod", serviceMethod), log.String("nodeId", nodeId))
		return emptyCancelRpc, nil
	}

	if len(pClientList) > 1 {
		err := errors.New("cannot call more then 1 node")
		fVal.Call([]reflect.Value{reflect.ValueOf(reply), reflect.ValueOf(err)})
		log.Error("cannot call more then 1 node", log.String("serviceMethod", serviceMethod))
		return emptyCancelRpc, nil
	}

	//2.rpcClient调用
	return pClientList[0].AsyncCall(pClientList[0].GetTargetNodeId(), timeout, handler.rpcHandler, serviceMethod, fVal, args, reply, )
}

func (handler *RpcHandler) GetName() string {
	return handler.rpcHandler.GetName()
}

func (handler *RpcHandler) CallWithTimeout(timeout time.Duration, serviceMethod string, args interface{}, reply interface{}) error {
	return handler.callRpc(timeout, NodeIdNull, serviceMethod, args, reply)
}

func (handler *RpcHandler) CallNodeWithTimeout(timeout time.Duration, nodeId string, serviceMethod string, args interface{}, reply interface{}) error {
	return handler.callRpc(timeout, nodeId, serviceMethod, args, reply)
}

func (handler *RpcHandler) AsyncCallWithTimeout(timeout time.Duration, serviceMethod string, args interface{}, callback interface{}) (CancelRpc, error) {
	return handler.asyncCallRpc(timeout, NodeIdNull, serviceMethod, args, callback)
}

func (handler *RpcHandler) AsyncCallNodeWithTimeout(timeout time.Duration, nodeId string, serviceMethod string, args interface{}, callback interface{}) (CancelRpc, error) {
	return handler.asyncCallRpc(timeout, nodeId, serviceMethod, args, callback)
}

func (handler *RpcHandler) AsyncCall(serviceMethod string, args interface{}, callback interface{}) error {
	_, err := handler.asyncCallRpc(DefaultRpcTimeout, NodeIdNull, serviceMethod, args, callback)
	return err
}

func (handler *RpcHandler) Call(serviceMethod string, args interface{}, reply interface{}) error {
	return handler.callRpc(DefaultRpcTimeout, NodeIdNull, serviceMethod, args, reply)
}

func (handler *RpcHandler) Go(serviceMethod string, args interface{}) error {
	return handler.goRpc(nil, false, NodeIdNull, serviceMethod, args)
}

func (handler *RpcHandler) AsyncCallNode(nodeId string, serviceMethod string, args interface{}, callback interface{}) error {
	_, err := handler.asyncCallRpc(DefaultRpcTimeout, nodeId, serviceMethod, args, callback)

	return err
}

func (handler *RpcHandler) CallNode(nodeId string, serviceMethod string, args interface{}, reply interface{}) error {
	return handler.callRpc(DefaultRpcTimeout, nodeId, serviceMethod, args, reply)
}

func (handler *RpcHandler) GoNode(nodeId string, serviceMethod string, args interface{}) error {
	return handler.goRpc(nil, false, nodeId, serviceMethod, args)
}

func (handler *RpcHandler) CastGo(serviceMethod string, args interface{}) error {
	return handler.goRpc(nil, true, NodeIdNull, serviceMethod, args)
}

func (handler *RpcHandler) RawGoNode(rpcProcessorType RpcProcessorType, nodeId string, rpcMethodId uint32, serviceName string, rawArgs []byte) error {
	processor := GetProcessor(uint8(rpcProcessorType))
	pClientList := make([]*Client, 0, 1)
	err, pClientList := handler.funcRpcClient(nodeId, serviceName, false, pClientList)
	if len(pClientList) == 0 || err != nil {
		log.Error("call serviceMethod is failed", log.ErrorField("error", err))
		return err
	}
	if len(pClientList) > 1 {
		err := errors.New("cannot call more then 1 node")
		log.Error("cannot call more then 1 node", log.String("serviceName", serviceName))
		return err
	}

	//2.rpcClient调用
	//如果调用本结点服务
	for i := 0; i < len(pClientList); i++ {
		//跨node调用
		pCall := pClientList[i].RawGo(pClientList[i].GetTargetNodeId(), DefaultRpcTimeout, handler.rpcHandler, processor, true, rpcMethodId, serviceName, rawArgs, nil)
		if pCall.Err != nil {
			err = pCall.Err
		}

		pClientList[i].RemovePending(pCall.Seq)
		ReleaseCall(pCall)
	}

	return err
}

func (handler *RpcHandler) RegRawRpc(rpcMethodId uint32, rawRpcCB RawRpcCallBack) {
	handler.mapRawFunctions[rpcMethodId] = rawRpcCB
}

func (handler *RpcHandler) UnmarshalInParam(rpcProcessor IRpcProcessor, serviceMethod string, rawRpcMethodId uint32, inParam []byte) (interface{}, error) {
	if rawRpcMethodId > 0 {
		return inParam, nil
	}

	v, ok := handler.mapFunctions[serviceMethod]
	if ok == false {
		return nil, errors.New("RpcHandler " + handler.rpcHandler.GetName() + " cannot find " + serviceMethod)
	}

	var err error
	param := reflect.New(v.inParamValue.Type().Elem()).Interface()
	err = rpcProcessor.Unmarshal(inParam, param)
	return param, err
}

func (handler *RpcHandler) GetRpcServer() FuncRpcServer {
	return handler.funcRpcServer
}