Browse Source
new pubsub package
comment out failing consensus tests for now rewrite rpc httpclient to use new pubsub package import pubsub as tmpubsub, query as tmquery make event IDs constants EventKey -> EventTypeKey rename EventsPubsub to PubSub mempool does not use pubsub rename eventsSub to pubsub new subscribe API fix channel size issues and consensus tests bugs refactor rpc client add missing discardFromChan method add mutex rename pubsub to eventBus remove IsRunning from WSRPCConnection interface (not needed) add a comment in broadcastNewRoundStepsAndVotes rename registerEventCallbacks to broadcastNewRoundStepsAndVotes See https://dave.cheney.net/2014/03/19/channel-axioms stop eventBuses after reactor tests remove unnecessary Unsubscribe return subscribe helper function move discardFromChan to where it is used subscribe now returns an err this gives us ability to refuse to subscribe if pubsub is at its max capacity. use context for control overflow cache queries handle err when subscribing in replay_test rename testClientID to testSubscriber extract var set channel buffer capacity to 1 in replay_file fix byzantine_test unsubscribe from single event, not all events refactor httpclient to return events to appropriate channels return failing testReplayCrashBeforeWriteVote test fix TestValidatorSetChanges refactor code a bit fix testReplayCrashBeforeWriteVote add comment fix TestValidatorSetChanges fixes from Bucky's review update comment [ci skip] test TxEventBuffer update changelog fix TestValidatorSetChanges (2nd attempt) only do wg.Done when no errors benchmark event bus create pubsub server inside NewEventBus only expose config params (later if needed) set buffer capacity to 0 so we are not testing cache new tx event format: key = "Tx" plus a tag {"tx.hash": XYZ} This should allow to subscribe to all transactions! or a specific one using a query: "tm.events.type = Tx and tx.hash = '013ABF99434...'" use TimeoutCommit instead of afterPublishEventNewBlockTimeout TimeoutCommit is the time a node waits after committing a block, before it goes into the next height. So it will finish everything from the last block, but then wait a bit. The idea is this gives it time to hear more votes from other validators, to strengthen the commit it includes in the next block. But it also gives it time to hear about new transactions. waitForBlockWithUpdatedVals rewrite WAL crash tests Task: test that we can recover from any WAL crash. Solution: the old tests were relying on event hub being run in the same thread (we were injecting the private validator's last signature). when considering a rewrite, we considered two possible solutions: write a "fuzzy" testing system where WAL is crashing upon receiving a new message, or inject failures and trigger them in tests using something like https://github.com/coreos/gofail. remove sleep no cs.Lock around wal.Save test different cases (empty block, non-empty block, ...) comments add comments test 4 cases: empty block, non-empty block, non-empty block with smaller part size, many blocks fixes as per Bucky's last review reset subscriptions on UnsubscribeAll use a simple counter to track message for which we panicked also, set a smaller part size for all test casespull/788/head
Anton Kaliaev
8 years ago
No known key found for this signature in database
GPG Key ID: 7B6881D965918214
43 changed files with 1358 additions and 860 deletions
Unified View
Diff Options
-
+1 -0CHANGELOG.md
-
+5 -5blockchain/reactor.go
-
+23 -20consensus/byzantine_test.go
-
+0 -35consensus/common.go
-
+29 -15consensus/common_test.go
-
+6 -8consensus/mempool_test.go
-
+51 -24consensus/reactor.go
-
+65 -36consensus/reactor_test.go
-
+2 -4consensus/replay.go
-
+25 -10consensus/replay_file.go
-
+192 -192consensus/replay_test.go
-
+51 -50consensus/state.go
-
+69 -52consensus/state_test.go
-
+34 -8consensus/wal.go
-
+2 -0glide.lock
-
+1 -0glide.yaml
-
+0 -6mempool/reactor.go
-
+21 -26node/node.go
-
+10 -10rpc/client/event_test.go
-
+16 -24rpc/client/helpers.go
-
+80 -107rpc/client/httpclient.go
-
+13 -4rpc/client/interface.go
-
+63 -22rpc/client/localclient.go
-
+3 -2rpc/client/mock/client.go
-
+1 -1rpc/client/rpc_test.go
-
+49 -12rpc/core/events.go
-
+18 -8rpc/core/mempool.go
-
+5 -5rpc/core/pipe.go
-
+3 -2rpc/core/routes.go
-
+2 -2rpc/core/types/responses.go
-
+6 -6rpc/lib/client/ws_client.go
-
+1 -1rpc/lib/doc.go
-
+2 -2rpc/lib/rpc_test.go
-
+26 -19rpc/lib/server/handlers.go
-
+4 -2rpc/lib/types/types.go
-
+7 -8state/execution.go
-
+1 -1state/execution_test.go
-
+46 -0types/event_buffer.go
-
+21 -0types/event_buffer_test.go
-
+133 -0types/event_bus.go
-
+122 -0types/event_bus_test.go
-
+72 -131types/events.go
-
+77 -0types/nop_event_bus.go
+ 1
- 0
CHANGELOG.md
View File
+ 5
- 5
blockchain/reactor.go
View File
+ 23
- 20
consensus/byzantine_test.go
View File
+ 0
- 35
consensus/common.go
View File
| @ -1,35 +0,0 @@ | |||||
| package consensus | |||||
| import ( | |||||
| "github.com/tendermint/tendermint/types" | |||||
| ) | |||||
| // XXX: WARNING: these functions can halt the consensus as firing events is synchronous. | |||||
| // Make sure to read off the channels, and in the case of subscribeToEventRespond, to write back on it | |||||
| // NOTE: if chanCap=0, this blocks on the event being consumed | |||||
| func subscribeToEvent(evsw types.EventSwitch, receiver, eventID string, chanCap int) chan interface{} { | |||||
| // listen for event | |||||
| ch := make(chan interface{}, chanCap) | |||||
| types.AddListenerForEvent(evsw, receiver, eventID, func(data types.TMEventData) { | |||||
| ch <- data | |||||
| }) | |||||
| return ch | |||||
| } | |||||
| // NOTE: this blocks on receiving a response after the event is consumed | |||||
| func subscribeToEventRespond(evsw types.EventSwitch, receiver, eventID string) chan interface{} { | |||||
| // listen for event | |||||
| ch := make(chan interface{}) | |||||
| types.AddListenerForEvent(evsw, receiver, eventID, func(data types.TMEventData) { | |||||
| ch <- data | |||||
| <-ch | |||||
| }) | |||||
| return ch | |||||
| } | |||||
| func discardFromChan(ch chan interface{}, n int) { | |||||
| for i := 0; i < n; i++ { | |||||
| <-ch | |||||
| } | |||||
| } | |||||
+ 29
- 15
consensus/common_test.go
View File
+ 6
- 8
consensus/mempool_test.go
View File
+ 51
- 24
consensus/reactor.go
View File
+ 65
- 36
consensus/reactor_test.go
View File
+ 2
- 4
consensus/replay.go
View File
+ 25
- 10
consensus/replay_file.go
View File
+ 192
- 192
consensus/replay_test.go
View File
+ 51
- 50
consensus/state.go
View File
+ 69
- 52
consensus/state_test.go
View File
+ 34
- 8
consensus/wal.go
View File
+ 2
- 0
glide.lock
View File
+ 1
- 0
glide.yaml
View File
+ 0
- 6
mempool/reactor.go
View File
+ 21
- 26
node/node.go
View File
+ 10
- 10
rpc/client/event_test.go
View File
+ 16
- 24
rpc/client/helpers.go
View File
+ 80
- 107
rpc/client/httpclient.go
View File
+ 13
- 4
rpc/client/interface.go
View File
+ 63
- 22
rpc/client/localclient.go
View File
+ 3
- 2
rpc/client/mock/client.go
View File
+ 1
- 1
rpc/client/rpc_test.go
View File
+ 49
- 12
rpc/core/events.go
View File
+ 18
- 8
rpc/core/mempool.go
View File
+ 5
- 5
rpc/core/pipe.go
View File
+ 3
- 2
rpc/core/routes.go
View File
+ 2
- 2
rpc/core/types/responses.go
View File
+ 6
- 6
rpc/lib/client/ws_client.go
View File
+ 1
- 1
rpc/lib/doc.go
View File
+ 2
- 2
rpc/lib/rpc_test.go
View File
+ 26
- 19
rpc/lib/server/handlers.go
View File
+ 4
- 2
rpc/lib/types/types.go
View File
+ 7
- 8
state/execution.go
View File
+ 1
- 1
state/execution_test.go
View File
+ 46
- 0
types/event_buffer.go
View File
| @ -0,0 +1,46 @@ | |||||
| package types | |||||
| // Interface assertions | |||||
| var _ TxEventPublisher = (*TxEventBuffer)(nil) | |||||
| // TxEventBuffer is a buffer of events, which uses a slice to temporary store | |||||
| // events. | |||||
| type TxEventBuffer struct { | |||||
| next TxEventPublisher | |||||
| capacity int | |||||
| events []EventDataTx | |||||
| } | |||||
| // NewTxEventBuffer accepts an EventBus and returns a new buffer with the given | |||||
| // capacity. | |||||
| func NewTxEventBuffer(next TxEventPublisher, capacity int) *TxEventBuffer { | |||||
| return &TxEventBuffer{ | |||||
| next: next, | |||||
| capacity: capacity, | |||||
| events: make([]EventDataTx, 0, capacity), | |||||
| } | |||||
| } | |||||
| // Len returns the number of events cached. | |||||
| func (b TxEventBuffer) Len() int { | |||||
| return len(b.events) | |||||
| } | |||||
| // PublishEventTx buffers an event to be fired upon finality. | |||||
| func (b *TxEventBuffer) PublishEventTx(e EventDataTx) error { | |||||
| b.events = append(b.events, e) | |||||
| return nil | |||||
| } | |||||
| // Flush publishes events by running next.PublishWithTags on all cached events. | |||||
| // Blocks. Clears cached events. | |||||
| func (b *TxEventBuffer) Flush() error { | |||||
| for _, e := range b.events { | |||||
| err := b.next.PublishEventTx(e) | |||||
| if err != nil { | |||||
| return err | |||||
| } | |||||
| } | |||||
| b.events = make([]EventDataTx, 0, b.capacity) | |||||
| return nil | |||||
| } | |||||
+ 21
- 0
types/event_buffer_test.go
View File
| @ -0,0 +1,21 @@ | |||||
| package types | |||||
| import ( | |||||
| "testing" | |||||
| "github.com/stretchr/testify/assert" | |||||
| ) | |||||
| type eventBusMock struct{} | |||||
| func (eventBusMock) PublishEventTx(e EventDataTx) error { | |||||
| return nil | |||||
| } | |||||
| func TestEventBuffer(t *testing.T) { | |||||
| b := NewTxEventBuffer(eventBusMock{}, 1) | |||||
| b.PublishEventTx(EventDataTx{}) | |||||
| assert.Equal(t, 1, b.Len()) | |||||
| b.Flush() | |||||
| assert.Equal(t, 0, b.Len()) | |||||
| } | |||||
+ 133
- 0
types/event_bus.go
View File
| @ -0,0 +1,133 @@ | |||||
| package types | |||||
| import ( | |||||
| "context" | |||||
| "fmt" | |||||
| cmn "github.com/tendermint/tmlibs/common" | |||||
| "github.com/tendermint/tmlibs/log" | |||||
| tmpubsub "github.com/tendermint/tmlibs/pubsub" | |||||
| ) | |||||
| const defaultCapacity = 1000 | |||||
| // EventBus is a common bus for all events going through the system. All calls | |||||
| // are proxied to underlying pubsub server. All events must be published using | |||||
| // EventBus to ensure correct data types. | |||||
| type EventBus struct { | |||||
| cmn.BaseService | |||||
| pubsub *tmpubsub.Server | |||||
| } | |||||
| // NewEventBus returns a new event bus. | |||||
| func NewEventBus() *EventBus { | |||||
| return NewEventBusWithBufferCapacity(defaultCapacity) | |||||
| } | |||||
| // NewEventBusWithBufferCapacity returns a new event bus with the given buffer capacity. | |||||
| func NewEventBusWithBufferCapacity(cap int) *EventBus { | |||||
| // capacity could be exposed later if needed | |||||
| pubsub := tmpubsub.NewServer(tmpubsub.BufferCapacity(cap)) | |||||
| b := &EventBus{pubsub: pubsub} | |||||
| b.BaseService = *cmn.NewBaseService(nil, "EventBus", b) | |||||
| return b | |||||
| } | |||||
| func (b *EventBus) SetLogger(l log.Logger) { | |||||
| b.BaseService.SetLogger(l) | |||||
| b.pubsub.SetLogger(l.With("module", "pubsub")) | |||||
| } | |||||
| func (b *EventBus) OnStart() error { | |||||
| return b.pubsub.OnStart() | |||||
| } | |||||
| func (b *EventBus) OnStop() { | |||||
| b.pubsub.OnStop() | |||||
| } | |||||
| func (b *EventBus) Subscribe(ctx context.Context, subscriber string, query tmpubsub.Query, out chan<- interface{}) error { | |||||
| return b.pubsub.Subscribe(ctx, subscriber, query, out) | |||||
| } | |||||
| func (b *EventBus) Unsubscribe(ctx context.Context, subscriber string, query tmpubsub.Query) error { | |||||
| return b.pubsub.Unsubscribe(ctx, subscriber, query) | |||||
| } | |||||
| func (b *EventBus) UnsubscribeAll(ctx context.Context, subscriber string) error { | |||||
| return b.pubsub.UnsubscribeAll(ctx, subscriber) | |||||
| } | |||||
| func (b *EventBus) publish(eventType string, eventData TMEventData) error { | |||||
| if b.pubsub != nil { | |||||
| // no explicit deadline for publishing events | |||||
| ctx := context.Background() | |||||
| b.pubsub.PublishWithTags(ctx, eventData, map[string]interface{}{EventTypeKey: eventType}) | |||||
| } | |||||
| return nil | |||||
| } | |||||
| //--- block, tx, and vote events | |||||
| func (b *EventBus) PublishEventNewBlock(block EventDataNewBlock) error { | |||||
| return b.publish(EventNewBlock, TMEventData{block}) | |||||
| } | |||||
| func (b *EventBus) PublishEventNewBlockHeader(header EventDataNewBlockHeader) error { | |||||
| return b.publish(EventNewBlockHeader, TMEventData{header}) | |||||
| } | |||||
| func (b *EventBus) PublishEventVote(vote EventDataVote) error { | |||||
| return b.publish(EventVote, TMEventData{vote}) | |||||
| } | |||||
| func (b *EventBus) PublishEventTx(tx EventDataTx) error { | |||||
| if b.pubsub != nil { | |||||
| // no explicit deadline for publishing events | |||||
| ctx := context.Background() | |||||
| b.pubsub.PublishWithTags(ctx, TMEventData{tx}, map[string]interface{}{EventTypeKey: EventTx, TxHashKey: fmt.Sprintf("%X", tx.Tx.Hash())}) | |||||
| } | |||||
| return nil | |||||
| } | |||||
| //--- EventDataRoundState events | |||||
| func (b *EventBus) PublishEventNewRoundStep(rs EventDataRoundState) error { | |||||
| return b.publish(EventNewRoundStep, TMEventData{rs}) | |||||
| } | |||||
| func (b *EventBus) PublishEventTimeoutPropose(rs EventDataRoundState) error { | |||||
| return b.publish(EventTimeoutPropose, TMEventData{rs}) | |||||
| } | |||||
| func (b *EventBus) PublishEventTimeoutWait(rs EventDataRoundState) error { | |||||
| return b.publish(EventTimeoutWait, TMEventData{rs}) | |||||
| } | |||||
| func (b *EventBus) PublishEventNewRound(rs EventDataRoundState) error { | |||||
| return b.publish(EventNewRound, TMEventData{rs}) | |||||
| } | |||||
| func (b *EventBus) PublishEventCompleteProposal(rs EventDataRoundState) error { | |||||
| return b.publish(EventCompleteProposal, TMEventData{rs}) | |||||
| } | |||||
| func (b *EventBus) PublishEventPolka(rs EventDataRoundState) error { | |||||
| return b.publish(EventPolka, TMEventData{rs}) | |||||
| } | |||||
| func (b *EventBus) PublishEventUnlock(rs EventDataRoundState) error { | |||||
| return b.publish(EventUnlock, TMEventData{rs}) | |||||
| } | |||||
| func (b *EventBus) PublishEventRelock(rs EventDataRoundState) error { | |||||
| return b.publish(EventRelock, TMEventData{rs}) | |||||
| } | |||||
| func (b *EventBus) PublishEventLock(rs EventDataRoundState) error { | |||||
| return b.publish(EventLock, TMEventData{rs}) | |||||
| } | |||||
| func (b *EventBus) PublishEventProposalHeartbeat(ph EventDataProposalHeartbeat) error { | |||||
| return b.publish(EventProposalHeartbeat, TMEventData{ph}) | |||||
| } | |||||
+ 122
- 0
types/event_bus_test.go
View File
| @ -0,0 +1,122 @@ | |||||
| package types | |||||
| import ( | |||||
| "context" | |||||
| "fmt" | |||||
| "math/rand" | |||||
| "testing" | |||||
| "time" | |||||
| tmpubsub "github.com/tendermint/tmlibs/pubsub" | |||||
| ) | |||||
| func BenchmarkEventBus(b *testing.B) { | |||||
| benchmarks := []struct { | |||||
| name string | |||||
| numClients int | |||||
| randQueries bool | |||||
| randEvents bool | |||||
| }{ | |||||
| {"10Clients1Query1Event", 10, false, false}, | |||||
| {"100Clients", 100, false, false}, | |||||
| {"1000Clients", 1000, false, false}, | |||||
| {"10ClientsRandQueries1Event", 10, true, false}, | |||||
| {"100Clients", 100, true, false}, | |||||
| {"1000Clients", 1000, true, false}, | |||||
| {"10ClientsRandQueriesRandEvents", 10, true, true}, | |||||
| {"100Clients", 100, true, true}, | |||||
| {"1000Clients", 1000, true, true}, | |||||
| {"10Clients1QueryRandEvents", 10, false, true}, | |||||
| {"100Clients", 100, false, true}, | |||||
| {"1000Clients", 1000, false, true}, | |||||
| } | |||||
| for _, bm := range benchmarks { | |||||
| b.Run(bm.name, func(b *testing.B) { | |||||
| benchmarkEventBus(bm.numClients, bm.randQueries, bm.randEvents, b) | |||||
| }) | |||||
| } | |||||
| } | |||||
| func benchmarkEventBus(numClients int, randQueries bool, randEvents bool, b *testing.B) { | |||||
| // for random* functions | |||||
| rand.Seed(time.Now().Unix()) | |||||
| eventBus := NewEventBusWithBufferCapacity(0) // set buffer capacity to 0 so we are not testing cache | |||||
| eventBus.Start() | |||||
| defer eventBus.Stop() | |||||
| ctx := context.Background() | |||||
| q := EventQueryNewBlock | |||||
| for i := 0; i < numClients; i++ { | |||||
| ch := make(chan interface{}) | |||||
| go func() { | |||||
| for range ch { | |||||
| } | |||||
| }() | |||||
| if randQueries { | |||||
| q = randQuery() | |||||
| } | |||||
| eventBus.Subscribe(ctx, fmt.Sprintf("client-%d", i), q, ch) | |||||
| } | |||||
| eventType := EventNewBlock | |||||
| b.ReportAllocs() | |||||
| b.ResetTimer() | |||||
| for i := 0; i < b.N; i++ { | |||||
| if randEvents { | |||||
| eventType = randEvent() | |||||
| } | |||||
| eventBus.publish(eventType, TMEventData{"Gamora"}) | |||||
| } | |||||
| } | |||||
| var events = []string{EventBond, | |||||
| EventUnbond, | |||||
| EventRebond, | |||||
| EventDupeout, | |||||
| EventFork, | |||||
| EventNewBlock, | |||||
| EventNewBlockHeader, | |||||
| EventNewRound, | |||||
| EventNewRoundStep, | |||||
| EventTimeoutPropose, | |||||
| EventCompleteProposal, | |||||
| EventPolka, | |||||
| EventUnlock, | |||||
| EventLock, | |||||
| EventRelock, | |||||
| EventTimeoutWait, | |||||
| EventVote} | |||||
| func randEvent() string { | |||||
| return events[rand.Intn(len(events))] | |||||
| } | |||||
| var queries = []tmpubsub.Query{EventQueryBond, | |||||
| EventQueryUnbond, | |||||
| EventQueryRebond, | |||||
| EventQueryDupeout, | |||||
| EventQueryFork, | |||||
| EventQueryNewBlock, | |||||
| EventQueryNewBlockHeader, | |||||
| EventQueryNewRound, | |||||
| EventQueryNewRoundStep, | |||||
| EventQueryTimeoutPropose, | |||||
| EventQueryCompleteProposal, | |||||
| EventQueryPolka, | |||||
| EventQueryUnlock, | |||||
| EventQueryLock, | |||||
| EventQueryRelock, | |||||
| EventQueryTimeoutWait, | |||||
| EventQueryVote} | |||||
| func randQuery() tmpubsub.Query { | |||||
| return queries[rand.Intn(len(queries))] | |||||
| } | |||||
+ 72
- 131
types/events.go
View File
+ 77
- 0
types/nop_event_bus.go
View File
| @ -0,0 +1,77 @@ | |||||
| package types | |||||
| import ( | |||||
| "context" | |||||
| tmpubsub "github.com/tendermint/tmlibs/pubsub" | |||||
| ) | |||||
| type NopEventBus struct{} | |||||
| func (NopEventBus) Subscribe(ctx context.Context, subscriber string, query tmpubsub.Query, out chan<- interface{}) error { | |||||
| return nil | |||||
| } | |||||
| func (NopEventBus) Unsubscribe(ctx context.Context, subscriber string, query tmpubsub.Query) error { | |||||
| return nil | |||||
| } | |||||
| func (NopEventBus) UnsubscribeAll(ctx context.Context, subscriber string) error { | |||||
| return nil | |||||
| } | |||||
| //--- block, tx, and vote events | |||||
| func (NopEventBus) PublishEventNewBlock(block EventDataNewBlock) error { | |||||
| return nil | |||||
| } | |||||
| func (NopEventBus) PublishEventNewBlockHeader(header EventDataNewBlockHeader) error { | |||||
| return nil | |||||
| } | |||||
| func (NopEventBus) PublishEventVote(vote EventDataVote) error { | |||||
| return nil | |||||
| } | |||||
| func (NopEventBus) PublishEventTx(tx EventDataTx) error { | |||||
| return nil | |||||
| } | |||||
| //--- EventDataRoundState events | |||||
| func (NopEventBus) PublishEventNewRoundStep(rs EventDataRoundState) error { | |||||
| return nil | |||||
| } | |||||
| func (NopEventBus) PublishEventTimeoutPropose(rs EventDataRoundState) error { | |||||
| return nil | |||||
| } | |||||
| func (NopEventBus) PublishEventTimeoutWait(rs EventDataRoundState) error { | |||||
| return nil | |||||
| } | |||||
| func (NopEventBus) PublishEventNewRound(rs EventDataRoundState) error { | |||||
| return nil | |||||
| } | |||||
| func (NopEventBus) PublishEventCompleteProposal(rs EventDataRoundState) error { | |||||
| return nil | |||||
| } | |||||
| func (NopEventBus) PublishEventPolka(rs EventDataRoundState) error { | |||||
| return nil | |||||
| } | |||||
| func (NopEventBus) PublishEventUnlock(rs EventDataRoundState) error { | |||||
| return nil | |||||
| } | |||||
| func (NopEventBus) PublishEventRelock(rs EventDataRoundState) error { | |||||
| return nil | |||||
| } | |||||
| func (NopEventBus) PublishEventLock(rs EventDataRoundState) error { | |||||
| return nil | |||||
| } | |||||