Browse Source
rpc/client/http: drop endpoint arg from New and add WSOptions (#6176)
also - replace `MaxReconnectAttempts`, `ReadWait`, `WriteWait` and `PingPeriod` options with `WSOptions` in `WSClient` (rpc/jsonrpc/client/ws_client.go). - set default write wait to 10s for `WSClient`(rpc/jsonrpc/client/ws_client.go) - unexpose `WSEvents`(rpc/client/http.go) Closes #6162pull/6180/head
Anton Kaliaev
3 years ago
committed by
GitHub
GitHub
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
15 changed files with 344 additions and 314 deletions
Split View
Diff Options
-
+3 -0CHANGELOG_PENDING.md
-
+1 -1cmd/tendermint/commands/debug/dump.go
-
+2 -2cmd/tendermint/commands/debug/kill.go
-
+1 -1cmd/tendermint/commands/light.go
-
+1 -1light/provider/http/http.go
-
+1 -1light/provider/http/http_test.go
-
+2 -2rpc/client/examples_test.go
-
+31 -232rpc/client/http/http.go
-
+249 -0rpc/client/http/ws.go
-
+4 -4rpc/client/rpc_test.go
-
+7 -7rpc/jsonrpc/client/http_json_client.go
-
+36 -57rpc/jsonrpc/client/ws_client.go
-
+4 -4rpc/openapi/openapi.yaml
-
+1 -1statesync/stateprovider.go
-
+1 -1test/e2e/pkg/testnet.go
+ 3
- 0
CHANGELOG_PENDING.md
View File
+ 1
- 1
cmd/tendermint/commands/debug/dump.go
View File
+ 2
- 2
cmd/tendermint/commands/debug/kill.go
View File
+ 1
- 1
cmd/tendermint/commands/light.go
View File
+ 1
- 1
light/provider/http/http.go
View File
+ 1
- 1
light/provider/http/http_test.go
View File
+ 2
- 2
rpc/client/examples_test.go
View File
+ 31
- 232
rpc/client/http/http.go
View File
+ 249
- 0
rpc/client/http/ws.go
View File
| @ -0,0 +1,249 @@ | |||
| package http | |||
| import ( | |||
| "context" | |||
| "errors" | |||
| "fmt" | |||
| "strings" | |||
| "time" | |||
| tmjson "github.com/tendermint/tendermint/libs/json" | |||
| tmpubsub "github.com/tendermint/tendermint/libs/pubsub" | |||
| "github.com/tendermint/tendermint/libs/service" | |||
| tmsync "github.com/tendermint/tendermint/libs/sync" | |||
| rpcclient "github.com/tendermint/tendermint/rpc/client" | |||
| ctypes "github.com/tendermint/tendermint/rpc/core/types" | |||
| jsonrpcclient "github.com/tendermint/tendermint/rpc/jsonrpc/client" | |||
| ) | |||
| var errNotRunning = errors.New("client is not running. Use .Start() method to start") | |||
| // WSOptions for the WS part of the HTTP client. | |||
| type WSOptions struct { | |||
| Path string // path (e.g. "/ws") | |||
| jsonrpcclient.WSOptions // WSClient options | |||
| } | |||
| // DefaultWSOptions returns default WS options. | |||
| // See jsonrpcclient.DefaultWSOptions. | |||
| func DefaultWSOptions() WSOptions { | |||
| return WSOptions{ | |||
| Path: "/websocket", | |||
| WSOptions: jsonrpcclient.DefaultWSOptions(), | |||
| } | |||
| } | |||
| // Validate performs a basic validation of WSOptions. | |||
| func (wso WSOptions) Validate() error { | |||
| if len(wso.Path) <= 1 { | |||
| return errors.New("empty Path") | |||
| } | |||
| if wso.Path[0] != '/' { | |||
| return errors.New("leading slash is missing in Path") | |||
| } | |||
| return nil | |||
| } | |||
| // wsEvents is a wrapper around WSClient, which implements EventsClient. | |||
| type wsEvents struct { | |||
| service.BaseService | |||
| ws *jsonrpcclient.WSClient | |||
| mtx tmsync.RWMutex | |||
| subscriptions map[string]chan ctypes.ResultEvent // query -> chan | |||
| } | |||
| var _ rpcclient.EventsClient = (*wsEvents)(nil) | |||
| func newWsEvents(remote string, wso WSOptions) (*wsEvents, error) { | |||
| // validate options | |||
| if err := wso.Validate(); err != nil { | |||
| return nil, fmt.Errorf("invalid WSOptions: %w", err) | |||
| } | |||
| w := &wsEvents{ | |||
| subscriptions: make(map[string]chan ctypes.ResultEvent), | |||
| } | |||
| w.BaseService = *service.NewBaseService(nil, "wsEvents", w) | |||
| var err error | |||
| w.ws, err = jsonrpcclient.NewWSWithOptions(remote, wso.Path, wso.WSOptions) | |||
| if err != nil { | |||
| return nil, fmt.Errorf("can't create WS client: %w", err) | |||
| } | |||
| w.ws.OnReconnect(func() { | |||
| // resubscribe immediately | |||
| w.redoSubscriptionsAfter(0 * time.Second) | |||
| }) | |||
| w.ws.SetLogger(w.Logger) | |||
| return w, nil | |||
| } | |||
| // OnStart implements service.Service by starting WSClient and event loop. | |||
| func (w *wsEvents) OnStart() error { | |||
| if err := w.ws.Start(); err != nil { | |||
| return err | |||
| } | |||
| go w.eventListener() | |||
| return nil | |||
| } | |||
| // OnStop implements service.Service by stopping WSClient. | |||
| func (w *wsEvents) OnStop() { | |||
| if err := w.ws.Stop(); err != nil { | |||
| w.Logger.Error("Can't stop ws client", "err", err) | |||
| } | |||
| } | |||
| // Subscribe implements EventsClient by using WSClient to subscribe given | |||
| // subscriber to query. By default, it returns a channel with cap=1. Error is | |||
| // returned if it fails to subscribe. | |||
| // | |||
| // When reading from the channel, keep in mind there's a single events loop, so | |||
| // if you don't read events for this subscription fast enough, other | |||
| // subscriptions will slow down in effect. | |||
| // | |||
| // The channel is never closed to prevent clients from seeing an erroneous | |||
| // event. | |||
| // | |||
| // It returns an error if wsEvents is not running. | |||
| func (w *wsEvents) Subscribe(ctx context.Context, subscriber, query string, | |||
| outCapacity ...int) (out <-chan ctypes.ResultEvent, err error) { | |||
| if !w.IsRunning() { | |||
| return nil, errNotRunning | |||
| } | |||
| if err := w.ws.Subscribe(ctx, query); err != nil { | |||
| return nil, err | |||
| } | |||
| outCap := 1 | |||
| if len(outCapacity) > 0 { | |||
| outCap = outCapacity[0] | |||
| } | |||
| outc := make(chan ctypes.ResultEvent, outCap) | |||
| w.mtx.Lock() | |||
| // subscriber param is ignored because Tendermint will override it with | |||
| // remote IP anyway. | |||
| w.subscriptions[query] = outc | |||
| w.mtx.Unlock() | |||
| return outc, nil | |||
| } | |||
| // Unsubscribe implements EventsClient by using WSClient to unsubscribe given | |||
| // subscriber from query. | |||
| // | |||
| // It returns an error if wsEvents is not running. | |||
| func (w *wsEvents) Unsubscribe(ctx context.Context, subscriber, query string) error { | |||
| if !w.IsRunning() { | |||
| return errNotRunning | |||
| } | |||
| if err := w.ws.Unsubscribe(ctx, query); err != nil { | |||
| return err | |||
| } | |||
| w.mtx.Lock() | |||
| _, ok := w.subscriptions[query] | |||
| if ok { | |||
| delete(w.subscriptions, query) | |||
| } | |||
| w.mtx.Unlock() | |||
| return nil | |||
| } | |||
| // UnsubscribeAll implements EventsClient by using WSClient to unsubscribe | |||
| // given subscriber from all the queries. | |||
| // | |||
| // It returns an error if wsEvents is not running. | |||
| func (w *wsEvents) UnsubscribeAll(ctx context.Context, subscriber string) error { | |||
| if !w.IsRunning() { | |||
| return errNotRunning | |||
| } | |||
| if err := w.ws.UnsubscribeAll(ctx); err != nil { | |||
| return err | |||
| } | |||
| w.mtx.Lock() | |||
| w.subscriptions = make(map[string]chan ctypes.ResultEvent) | |||
| w.mtx.Unlock() | |||
| return nil | |||
| } | |||
| // After being reconnected, it is necessary to redo subscription to server | |||
| // otherwise no data will be automatically received. | |||
| func (w *wsEvents) redoSubscriptionsAfter(d time.Duration) { | |||
| time.Sleep(d) | |||
| ctx := context.Background() | |||
| w.mtx.Lock() | |||
| defer w.mtx.Unlock() | |||
| for q := range w.subscriptions { | |||
| err := w.ws.Subscribe(ctx, q) | |||
| if err != nil { | |||
| w.Logger.Error("failed to resubscribe", "query", q, "err", err) | |||
| delete(w.subscriptions, q) | |||
| } | |||
| } | |||
| } | |||
| func isErrAlreadySubscribed(err error) bool { | |||
| return strings.Contains(err.Error(), tmpubsub.ErrAlreadySubscribed.Error()) | |||
| } | |||
| func (w *wsEvents) eventListener() { | |||
| for { | |||
| select { | |||
| case resp, ok := <-w.ws.ResponsesCh: | |||
| if !ok { | |||
| return | |||
| } | |||
| if resp.Error != nil { | |||
| w.Logger.Error("WS error", "err", resp.Error.Error()) | |||
| // Error can be ErrAlreadySubscribed or max client (subscriptions per | |||
| // client) reached or Tendermint exited. | |||
| // We can ignore ErrAlreadySubscribed, but need to retry in other | |||
| // cases. | |||
| if !isErrAlreadySubscribed(resp.Error) { | |||
| // Resubscribe after 1 second to give Tendermint time to restart (if | |||
| // crashed). | |||
| w.redoSubscriptionsAfter(1 * time.Second) | |||
| } | |||
| continue | |||
| } | |||
| result := new(ctypes.ResultEvent) | |||
| err := tmjson.Unmarshal(resp.Result, result) | |||
| if err != nil { | |||
| w.Logger.Error("failed to unmarshal response", "err", err) | |||
| continue | |||
| } | |||
| w.mtx.RLock() | |||
| out, ok := w.subscriptions[result.Query] | |||
| w.mtx.RUnlock() | |||
| if ok { | |||
| select { | |||
| case out <- *result: | |||
| case <-w.Quit(): | |||
| return | |||
| } | |||
| } | |||
| case <-w.Quit(): | |||
| return | |||
| } | |||
| } | |||
| } | |||