mirror of
https://github.com/fluencelabs/tendermint
synced 2025-05-01 09:42:12 +00:00
fcaa545e1e
Spell out the package explicitly. This commit is totally textual, and does not change any logic. The swiss-army knife package may serve a kick-start in early stage development. But as the codebase growing, we might want to retire it gradually: For simple wrapping functions, just inline it on the call site. For larger pice of code, make it an independent package.
343 lines
9.6 KiB
Go
343 lines
9.6 KiB
Go
package abcicli
|
|
|
|
import (
|
|
"net"
|
|
"sync"
|
|
"time"
|
|
|
|
context "golang.org/x/net/context"
|
|
grpc "google.golang.org/grpc"
|
|
|
|
"github.com/tendermint/abci/types"
|
|
common "github.com/tendermint/go-common"
|
|
)
|
|
|
|
// A stripped copy of the remoteClient that makes
|
|
// synchronous calls using grpc
|
|
type grpcClient struct {
|
|
common.BaseService
|
|
mustConnect bool
|
|
|
|
client types.ABCIApplicationClient
|
|
|
|
mtx sync.Mutex
|
|
addr string
|
|
err error
|
|
resCb func(*types.Request, *types.Response) // listens to all callbacks
|
|
}
|
|
|
|
func NewGRPCClient(addr string, mustConnect bool) (*grpcClient, error) {
|
|
cli := &grpcClient{
|
|
addr: addr,
|
|
mustConnect: mustConnect,
|
|
}
|
|
cli.BaseService = *common.NewBaseService(nil, "grpcClient", cli)
|
|
_, err := cli.Start() // Just start it, it's confusing for callers to remember to start.
|
|
return cli, err
|
|
}
|
|
|
|
func dialerFunc(addr string, timeout time.Duration) (net.Conn, error) {
|
|
return common.Connect(addr)
|
|
}
|
|
|
|
func (cli *grpcClient) OnStart() error {
|
|
cli.BaseService.OnStart()
|
|
RETRY_LOOP:
|
|
|
|
for {
|
|
conn, err := grpc.Dial(cli.addr, grpc.WithInsecure(), grpc.WithDialer(dialerFunc))
|
|
if err != nil {
|
|
if cli.mustConnect {
|
|
return err
|
|
} else {
|
|
log.Warn(common.Fmt("abci.grpcClient failed to connect to %v. Retrying...\n", cli.addr))
|
|
time.Sleep(time.Second * 3)
|
|
continue RETRY_LOOP
|
|
}
|
|
}
|
|
|
|
client := types.NewABCIApplicationClient(conn)
|
|
|
|
ENSURE_CONNECTED:
|
|
for {
|
|
_, err := client.Echo(context.Background(), &types.RequestEcho{"hello"}, grpc.FailFast(true))
|
|
if err == nil {
|
|
break ENSURE_CONNECTED
|
|
}
|
|
time.Sleep(time.Second)
|
|
}
|
|
|
|
cli.client = client
|
|
return nil
|
|
}
|
|
}
|
|
|
|
func (cli *grpcClient) OnStop() {
|
|
cli.BaseService.OnStop()
|
|
cli.mtx.Lock()
|
|
defer cli.mtx.Unlock()
|
|
// TODO: how to close conn? its not a net.Conn and grpc doesn't expose a Close()
|
|
/*if cli.conn != nil {
|
|
cli.conn.Close()
|
|
}*/
|
|
}
|
|
|
|
func (cli *grpcClient) StopForError(err error) {
|
|
cli.mtx.Lock()
|
|
if !cli.IsRunning() {
|
|
return
|
|
}
|
|
|
|
if cli.err == nil {
|
|
cli.err = err
|
|
}
|
|
cli.mtx.Unlock()
|
|
|
|
log.Warn(common.Fmt("Stopping abci.grpcClient for error: %v", err.Error()))
|
|
cli.Stop()
|
|
}
|
|
|
|
func (cli *grpcClient) Error() error {
|
|
cli.mtx.Lock()
|
|
defer cli.mtx.Unlock()
|
|
return cli.err
|
|
}
|
|
|
|
// Set listener for all responses
|
|
// NOTE: callback may get internally generated flush responses.
|
|
func (cli *grpcClient) SetResponseCallback(resCb Callback) {
|
|
cli.mtx.Lock()
|
|
defer cli.mtx.Unlock()
|
|
cli.resCb = resCb
|
|
}
|
|
|
|
//----------------------------------------
|
|
// GRPC calls are synchronous, but some callbacks expect to be called asynchronously
|
|
// (eg. the mempool expects to be able to lock to remove bad txs from cache).
|
|
// To accomodate, we finish each call in its own go-routine,
|
|
// which is expensive, but easy - if you want something better, use the socket protocol!
|
|
// maybe one day, if people really want it, we use grpc streams,
|
|
// but hopefully not :D
|
|
|
|
func (cli *grpcClient) EchoAsync(msg string) *ReqRes {
|
|
req := types.ToRequestEcho(msg)
|
|
res, err := cli.client.Echo(context.Background(), req.GetEcho(), grpc.FailFast(true))
|
|
if err != nil {
|
|
cli.StopForError(err)
|
|
}
|
|
return cli.finishAsyncCall(req, &types.Response{&types.Response_Echo{res}})
|
|
}
|
|
|
|
func (cli *grpcClient) FlushAsync() *ReqRes {
|
|
req := types.ToRequestFlush()
|
|
res, err := cli.client.Flush(context.Background(), req.GetFlush(), grpc.FailFast(true))
|
|
if err != nil {
|
|
cli.StopForError(err)
|
|
}
|
|
return cli.finishAsyncCall(req, &types.Response{&types.Response_Flush{res}})
|
|
}
|
|
|
|
func (cli *grpcClient) InfoAsync() *ReqRes {
|
|
req := types.ToRequestInfo()
|
|
res, err := cli.client.Info(context.Background(), req.GetInfo(), grpc.FailFast(true))
|
|
if err != nil {
|
|
cli.StopForError(err)
|
|
}
|
|
return cli.finishAsyncCall(req, &types.Response{&types.Response_Info{res}})
|
|
}
|
|
|
|
func (cli *grpcClient) SetOptionAsync(key string, value string) *ReqRes {
|
|
req := types.ToRequestSetOption(key, value)
|
|
res, err := cli.client.SetOption(context.Background(), req.GetSetOption(), grpc.FailFast(true))
|
|
if err != nil {
|
|
cli.StopForError(err)
|
|
}
|
|
return cli.finishAsyncCall(req, &types.Response{&types.Response_SetOption{res}})
|
|
}
|
|
|
|
func (cli *grpcClient) DeliverTxAsync(tx []byte) *ReqRes {
|
|
req := types.ToRequestDeliverTx(tx)
|
|
res, err := cli.client.DeliverTx(context.Background(), req.GetDeliverTx(), grpc.FailFast(true))
|
|
if err != nil {
|
|
cli.StopForError(err)
|
|
}
|
|
return cli.finishAsyncCall(req, &types.Response{&types.Response_DeliverTx{res}})
|
|
}
|
|
|
|
func (cli *grpcClient) CheckTxAsync(tx []byte) *ReqRes {
|
|
req := types.ToRequestCheckTx(tx)
|
|
res, err := cli.client.CheckTx(context.Background(), req.GetCheckTx(), grpc.FailFast(true))
|
|
if err != nil {
|
|
cli.StopForError(err)
|
|
}
|
|
return cli.finishAsyncCall(req, &types.Response{&types.Response_CheckTx{res}})
|
|
}
|
|
|
|
func (cli *grpcClient) QueryAsync(query []byte) *ReqRes {
|
|
req := types.ToRequestQuery(query)
|
|
res, err := cli.client.Query(context.Background(), req.GetQuery(), grpc.FailFast(true))
|
|
if err != nil {
|
|
cli.StopForError(err)
|
|
}
|
|
return cli.finishAsyncCall(req, &types.Response{&types.Response_Query{res}})
|
|
}
|
|
|
|
func (cli *grpcClient) CommitAsync() *ReqRes {
|
|
req := types.ToRequestCommit()
|
|
res, err := cli.client.Commit(context.Background(), req.GetCommit(), grpc.FailFast(true))
|
|
if err != nil {
|
|
cli.StopForError(err)
|
|
}
|
|
return cli.finishAsyncCall(req, &types.Response{&types.Response_Commit{res}})
|
|
}
|
|
|
|
func (cli *grpcClient) InitChainAsync(validators []*types.Validator) *ReqRes {
|
|
req := types.ToRequestInitChain(validators)
|
|
res, err := cli.client.InitChain(context.Background(), req.GetInitChain(), grpc.FailFast(true))
|
|
if err != nil {
|
|
cli.StopForError(err)
|
|
}
|
|
return cli.finishAsyncCall(req, &types.Response{&types.Response_InitChain{res}})
|
|
}
|
|
|
|
func (cli *grpcClient) BeginBlockAsync(hash []byte, header *types.Header) *ReqRes {
|
|
req := types.ToRequestBeginBlock(hash, header)
|
|
res, err := cli.client.BeginBlock(context.Background(), req.GetBeginBlock(), grpc.FailFast(true))
|
|
if err != nil {
|
|
cli.StopForError(err)
|
|
}
|
|
return cli.finishAsyncCall(req, &types.Response{&types.Response_BeginBlock{res}})
|
|
}
|
|
|
|
func (cli *grpcClient) EndBlockAsync(height uint64) *ReqRes {
|
|
req := types.ToRequestEndBlock(height)
|
|
res, err := cli.client.EndBlock(context.Background(), req.GetEndBlock(), grpc.FailFast(true))
|
|
if err != nil {
|
|
cli.StopForError(err)
|
|
}
|
|
return cli.finishAsyncCall(req, &types.Response{&types.Response_EndBlock{res}})
|
|
}
|
|
|
|
func (cli *grpcClient) finishAsyncCall(req *types.Request, res *types.Response) *ReqRes {
|
|
reqres := NewReqRes(req)
|
|
reqres.Response = res // Set response
|
|
reqres.Done() // Release waiters
|
|
reqres.SetDone() // so reqRes.SetCallback will run the callback
|
|
|
|
// go routine for callbacks
|
|
go func() {
|
|
// Notify reqRes listener if set
|
|
if cb := reqres.GetCallback(); cb != nil {
|
|
cb(res)
|
|
}
|
|
|
|
// Notify client listener if set
|
|
if cli.resCb != nil {
|
|
cli.resCb(reqres.Request, res)
|
|
}
|
|
}()
|
|
return reqres
|
|
}
|
|
|
|
func (cli *grpcClient) checkErrGetResult() types.Result {
|
|
if err := cli.Error(); err != nil {
|
|
// StopForError should already have been called if error is set
|
|
return types.ErrInternalError.SetLog(err.Error())
|
|
}
|
|
return types.Result{}
|
|
}
|
|
|
|
//----------------------------------------
|
|
|
|
func (cli *grpcClient) EchoSync(msg string) (res types.Result) {
|
|
reqres := cli.EchoAsync(msg)
|
|
if res := cli.checkErrGetResult(); res.IsErr() {
|
|
return res
|
|
}
|
|
resp := reqres.Response.GetEcho()
|
|
return types.NewResultOK([]byte(resp.Message), LOG)
|
|
}
|
|
|
|
func (cli *grpcClient) FlushSync() error {
|
|
return nil
|
|
}
|
|
|
|
func (cli *grpcClient) InfoSync() (resInfo types.ResponseInfo, err error) {
|
|
reqres := cli.InfoAsync()
|
|
if err = cli.Error(); err != nil {
|
|
return resInfo, err
|
|
}
|
|
if resInfo_ := reqres.Response.GetInfo(); resInfo_ != nil {
|
|
return *resInfo_, nil
|
|
} else {
|
|
return resInfo, nil
|
|
}
|
|
}
|
|
|
|
func (cli *grpcClient) SetOptionSync(key string, value string) (res types.Result) {
|
|
reqres := cli.SetOptionAsync(key, value)
|
|
if res := cli.checkErrGetResult(); res.IsErr() {
|
|
return res
|
|
}
|
|
resp := reqres.Response.GetSetOption()
|
|
return types.Result{Code: OK, Data: nil, Log: resp.Log}
|
|
}
|
|
|
|
func (cli *grpcClient) DeliverTxSync(tx []byte) (res types.Result) {
|
|
reqres := cli.DeliverTxAsync(tx)
|
|
if res := cli.checkErrGetResult(); res.IsErr() {
|
|
return res
|
|
}
|
|
resp := reqres.Response.GetDeliverTx()
|
|
return types.Result{Code: resp.Code, Data: resp.Data, Log: resp.Log}
|
|
}
|
|
|
|
func (cli *grpcClient) CheckTxSync(tx []byte) (res types.Result) {
|
|
reqres := cli.CheckTxAsync(tx)
|
|
if res := cli.checkErrGetResult(); res.IsErr() {
|
|
return res
|
|
}
|
|
resp := reqres.Response.GetCheckTx()
|
|
return types.Result{Code: resp.Code, Data: resp.Data, Log: resp.Log}
|
|
}
|
|
|
|
func (cli *grpcClient) QuerySync(query []byte) (res types.Result) {
|
|
reqres := cli.QueryAsync(query)
|
|
if res := cli.checkErrGetResult(); res.IsErr() {
|
|
return res
|
|
}
|
|
resp := reqres.Response.GetQuery()
|
|
return types.Result{Code: resp.Code, Data: resp.Data, Log: resp.Log}
|
|
}
|
|
|
|
func (cli *grpcClient) CommitSync() (res types.Result) {
|
|
reqres := cli.CommitAsync()
|
|
if res := cli.checkErrGetResult(); res.IsErr() {
|
|
return res
|
|
}
|
|
resp := reqres.Response.GetCommit()
|
|
return types.Result{Code: resp.Code, Data: resp.Data, Log: resp.Log}
|
|
}
|
|
|
|
func (cli *grpcClient) InitChainSync(validators []*types.Validator) (err error) {
|
|
cli.InitChainAsync(validators)
|
|
return cli.Error()
|
|
}
|
|
|
|
func (cli *grpcClient) BeginBlockSync(hash []byte, header *types.Header) (err error) {
|
|
cli.BeginBlockAsync(hash, header)
|
|
return cli.Error()
|
|
}
|
|
|
|
func (cli *grpcClient) EndBlockSync(height uint64) (resEndBlock types.ResponseEndBlock, err error) {
|
|
reqres := cli.EndBlockAsync(height)
|
|
if err := cli.Error(); err != nil {
|
|
return resEndBlock, err
|
|
}
|
|
if resEndBlock_ := reqres.Response.GetEndBlock(); resEndBlock_ != nil {
|
|
return *resEndBlock_, nil
|
|
} else {
|
|
return resEndBlock, nil
|
|
}
|
|
}
|