Merge pull request #64 from silasdavis/event-cache

Fix zeroed buffer getting flushed to the empty event

events/event_cache.go

@@ -1,9 +1,5 @@
 package events
 
-const (
-	eventsBufferSize = 1000
-)
-
 // An EventCache buffers events for a Fireable
 // All events are cached. Filtering happens on Flush
 type EventCache struct {
@@ -15,7 +11,6 @@ type EventCache struct {
 func NewEventCache(evsw Fireable) *EventCache {
 	return &EventCache{
 		evsw: evsw,
-		events: make([]eventInfo, eventsBufferSize),
 	}
 }
 
@@ -27,7 +22,7 @@ type eventInfo struct {
 
 // Cache an event to be fired upon finality.
 func (evc *EventCache) FireEvent(event string, data EventData) {
-	// append to list
+	// append to list (go will grow our backing array exponentially)
 	evc.events = append(evc.events, eventInfo{event, data})
 }
 
@@ -37,5 +32,6 @@ func (evc *EventCache) Flush() {
 	for _, ei := range evc.events {
 		evc.evsw.FireEvent(ei.event, ei.data)
 	}
-	evc.events = make([]eventInfo, eventsBufferSize)
+	// Clear the buffer, since we only add to it with append it's safe to just set it to nil and maybe safe an allocation
+	evc.events = nil
 }

events/event_cache_test.go

@@ -0,0 +1,35 @@
+package events
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestEventCache_Flush(t *testing.T) {
+	evsw := NewEventSwitch()
+	evsw.Start()
+	evsw.AddListenerForEvent("nothingness", "", func(data EventData) {
+		// Check we are not initialising an empty buffer full of zeroed eventInfos in the EventCache
+		require.FailNow(t, "We should never receive a message on this switch since none are fired")
+	})
+	evc := NewEventCache(evsw)
+	evc.Flush()
+	// Check after reset
+	evc.Flush()
+	fail := true
+	pass := false
+	evsw.AddListenerForEvent("somethingness", "something", func(data EventData) {
+		if fail {
+			require.FailNow(t, "Shouldn't see a message until flushed")
+		}
+		pass = true
+	})
+	evc.FireEvent("something", struct{ int }{1})
+	evc.FireEvent("something", struct{ int }{2})
+	evc.FireEvent("something", struct{ int }{3})
+	fail = false
+	evc.Flush()
+	assert.True(t, pass)
+}