Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix frozen subscriptions #267

Merged
merged 3 commits into from Sep 11, 2019
Merged
Changes from 1 commit
Commits
File filter...
Filter file types
Jump to…
Jump to file or symbol
Failed to load files and symbols.

Always

Just for now

Next

go-kosu: fix frozen subscriptions

  • Loading branch information
gchaincl committed Sep 11, 2019
commit f95043aa5496131448946b8bfa1ec15ba16fed6a
@@ -101,18 +101,10 @@ func (c *Client) Subscribe(ctx context.Context, q string) (<-chan rpctypes.Resul
return nil, nil, err
}

closer := func() {
_ = c.Client.Unsubscribe(ctx, "kosu", q)
}

closer := func() { _ = c.Client.Unsubscribe(ctx, "kosu", q) }
return ch, closer, nil
}

// Unsubscribe unsubscribes given subscriber from query.
func (c *Client) Unsubscribe(ctx context.Context, query string) error {
return c.Client.Unsubscribe(ctx, "kosu", query)
}

// QueryRoundInfo performs a ABCIQuery to "/roundinfo"
func (c *Client) QueryRoundInfo() (*types.RoundInfo, error) {
var pb types.RoundInfo
@@ -51,11 +51,11 @@ func NewCommand() *cobra.Command {
return nil
},
RunE: func(cmd *cobra.Command, args []string) error {
client, err := abci.NewHTTPClient(url, key)
fn := func() (*abci.Client, error) { return abci.NewHTTPClient(url, key) }
srv, err := NewServer(fn)
if err != nil {
return err
}
srv := NewServer(client)

wg := sync.WaitGroup{}
if http {
@@ -11,13 +11,23 @@ const (
Version = "1.0"
)

// ClientFactory is a function that returns a new abci.Client
// It is invoked by the Server each time we subscribe to an event.
type ClientFactory func() (*abci.Client, error)

// NewServer returns a new Server which holds the registered rpc service
func NewServer(abci *abci.Client) *rpc.Server {
srv := rpc.NewServer()
if err := srv.RegisterName("kosu", &Service{abci: abci}); err != nil {
panic(err)
func NewServer(fn ClientFactory) (*rpc.Server, error) {
server := rpc.NewServer()
service, err := NewService(fn)
if err != nil {
return nil, err
}

if err := server.RegisterName("kosu", service); err != nil {
return nil, err
}
return srv

return server, nil
}

// DialInProc wraps rpc.DialInProc constructor
@@ -52,7 +52,10 @@ func TestRPC(t *testing.T) {
require.NoError(t, err)
defer appClient.Stop() // nolint:errcheck

rpcClient := rpc.DialInProc(NewServer(appClient))
srv, err := NewServer(app.NewClient)
require.NoError(t, err)

rpcClient := rpc.DialInProc(srv)
defer rpcClient.Close()

test.run(t, app, appClient, rpcClient)
@@ -22,14 +22,21 @@ import (

// Service is a RPC service
type Service struct {
abci *abci.Client
abci *abci.Client
newClient ClientFactory
}

// NewService returns a new service given a abci client
func NewService(abci *abci.Client) *Service {
return &Service{
abci: abci,
func NewService(fn ClientFactory) (*Service, error) {
c, err := fn()
if err != nil {
return nil, err
}

return &Service{
abci: c,
newClient: fn,
}, nil
}

func eventDecoder(event tmtypes.TMEventData) (interface{}, error) {
@@ -48,24 +55,29 @@ func eventDecoder(event tmtypes.TMEventData) (interface{}, error) {
}

func (s *Service) subscribeTM(ctx context.Context, query string) (*rpc.Subscription, error) {
client, err := s.newClient()
if err != nil {
return nil, err
}

notifier, supported := rpc.NotifierFromContext(ctx)
if !supported {
return nil, rpc.ErrNotificationsUnsupported
}

events, closer, err := s.abci.Subscribe(ctx, query)
events, closer, err := client.Subscribe(ctx, query)
if err != nil {
return nil, err
}

rpcSub := notifier.CreateSubscription()
go func() {
defer s.abci.Unsubscribe(ctx, query) // nolint
defer closer()
defer client.Stop() // nolint

for {
select {
case <-rpcSub.Err():
closer()
return
case <-notifier.Closed():
return
@@ -330,21 +342,26 @@ for {
```
*/
func (s *Service) NewOrders(ctx context.Context) (*rpc.Subscription, error) {
client, err := s.newClient()
if err != nil {
return nil, err
}

notifier, supported := rpc.NotifierFromContext(ctx)
if !supported {
return nil, rpc.ErrNotificationsUnsupported
}

query := "tm.event='NewBlock'"
events, closer, err := s.abci.Subscribe(ctx, query)
events, closer, err := client.Subscribe(ctx, query)
if err != nil {
return nil, err
}

rpcSub := notifier.CreateSubscription()
blocks := make(chan *tmtypes.Block, 1024)
go func() {
defer s.abci.Unsubscribe(ctx, query) // nolint
defer closer()
defer close(blocks)

for {
@@ -353,7 +370,6 @@ func (s *Service) NewOrders(ctx context.Context) (*rpc.Subscription, error) {
log.Printf("ctx.Err() = %+v\n", ctx.Err())
return
case <-rpcSub.Err():
closer()
return
case <-notifier.Closed():
return
@@ -5,6 +5,7 @@ import (
"encoding/json"
"testing"

"github.com/ParadigmFoundation/kosu-monorepo/packages/go-kosu/abci"
"github.com/ParadigmFoundation/kosu-monorepo/packages/go-kosu/abci/types"
"github.com/ParadigmFoundation/kosu-monorepo/packages/go-kosu/rpc"

@@ -78,9 +79,11 @@ func (suite *IntegrationTestSuite) TestOrders() {

suite.Run("RPCEvents", func() {
tx := NewOrderTx(suite.T())
rpcClient := rpc.DialInProc(
rpc.NewServer(suite.Client()),
)

srv, err := rpc.NewServer(func() (*abci.Client, error) { return suite.Client(), nil })
suite.Require().NoError(err)

rpcClient := rpc.DialInProc(srv)

ctx, cancel := context.WithCancel(context.Background())
defer cancel()
@@ -3,6 +3,7 @@ package tests
import (
"io/ioutil"
"os"
"strings"
"testing"
"time"

@@ -20,6 +21,10 @@ func StartServer(t *testing.T, db db.DB) (*abci.App, func()) {
for {
app, closer, err := startServer(t, db)
if err != nil {
if strings.Contains(err.Error(), "address already in use") {
t.Fatal(err)
}

closer()
time.Sleep(100 * time.Millisecond)
continue
ProTip! Use n and p to navigate between commits in a pull request.
You can’t perform that action at this time.