(chore): add batch event sending (#56)

* add batch event sending

* add a few unit tests for batching events. default batch size is 10

* only create visitor for batch. cleanup from review comments

* added logging and took out prints

* cleanup nits

Author: thomaszurkan-optimizely

optimizely/event/dispatcher.go

@@ -4,6 +4,7 @@ import (
 	"bytes"
 	"encoding/json"
 	"fmt"
+	"github.com/optimizely/go-sdk/optimizely/logging"
 	"net/http"
 )
 
@@ -16,27 +17,25 @@ type Dispatcher interface {
 type HTTPEventDispatcher struct {
 }
 
+var dispatcherLogger = logging.GetLogger("EventDispatcher")
+
 // DispatchEvent dispatches event with callback
 func (*HTTPEventDispatcher) DispatchEvent(event LogEvent, callback func(success bool)) {
-	// add to current batch or create new batch
-	// does a batch have to contain a decision or can it just be impressions?
 
 	jsonValue, _ := json.Marshal(event.event)
-	resp, err := http.Post(event.endPoint, "application/json", bytes.NewBuffer(jsonValue))
-	fmt.Println(resp)
-	fmt.Println(string(jsonValue))
+	resp, err := http.Post( event.endPoint, "application/json", bytes.NewBuffer(jsonValue))
 	// also check response codes
 	// resp.StatusCode == 400 is an error
 	success := true
 
 	if err != nil {
-		fmt.Println(err)
+		dispatcherLogger.Error("http.Post failed:", err)
 		success = false
 	} else {
 		if resp.StatusCode == 204 {
 			success = true
 		} else {
-			fmt.Printf("invalid response %d", resp.StatusCode)
+			fmt.Printf("http.Post invalid response %d", resp.StatusCode)
 			success = false
 		}
 	}

optimizely/event/events.go

@@ -1,28 +1,28 @@
 package event
 
-// EventContext holds project-related contextual information about a UserEvent
-type EventContext struct {
-	Revision            string            `json:"revision"`
-	AccountID           string            `json:"account_id"`
-	ClientVersion       string            `json:"client_version"`
-	ProjectID           string            `json:"project_id"`
-	ClientName          string            `json:"client_name"`
-	AnonymizeIP         bool              `json:"anonymize_ip"`
-	BotFiltering        bool              `json:"bot_filtering"`
+// Context holds project-related contextual information about a UserEvent
+type Context struct {
+	Revision        string  `json:"revision"`
+	AccountID       string  `json:"account_id"`
+	ClientVersion   string  `json:"client_version"`
+	ProjectID       string  `json:"project_id"`
+	ClientName      string  `json:"client_name"`
+	AnonymizeIP     bool    `json:"anonymize_ip"`
+	BotFiltering    bool    `json:"bot_filtering"`
 	attributeKeyToIDMap map[string]string `json:"attributeKeyToIdMap"`
 }
 
-// UserEvent respresents a user event
+// UserEvent represents a user event
 type UserEvent struct {
-	Timestamp    int64  `json:"timestamp"`
+	Timestamp    int64 `json:"timestamp"`
 	UUID         string `json:"uuid"`
-	EventContext EventContext
+	EventContext Context
 	VisitorID    string
 	Impression   *ImpressionEvent
 	Conversion   *ConversionEvent
 }
 
-// ImpressionEvent respresents an impression event
+// ImpressionEvent represents an impression event
 type ImpressionEvent struct {
 	EntityID     string `json:"entity_id"`
 	Key          string `json:"key"`
@@ -32,7 +32,7 @@ type ImpressionEvent struct {
 	ExperimentID string `json:"experiment_id"`
 }
 
-// ConversionEvent respresents a conversion event
+// ConversionEvent represents a conversion event
 type ConversionEvent struct {
 	EntityID   string `json:"entity_id"`
 	Key        string `json:"key"`
@@ -44,53 +44,53 @@ type ConversionEvent struct {
 	Value   *float64 `json:"value,omitempty"`
 }
 
-// LogEvent respresents a log event
+// LogEvent represents a log event
 type LogEvent struct {
 	endPoint string
-	event    EventBatch
+	event    Batch
 }
 
-// EventBatch respresents Context about the event
-type EventBatch struct {
-	Revision        string    `json:"revision"`
-	AccountID       string    `json:"account_id"`
-	ClientVersion   string    `json:"client_version"`
+// Context about the event to send in batch
+type Batch struct {
+	Revision        string  `json:"revision"`
+	AccountID       string  `json:"account_id"`
+	ClientVersion   string  `json:"client_version"`
 	Visitors        []Visitor `json:"visitors"`
 	ProjectID       string    `json:"project_id"`
 	ClientName      string    `json:"client_name"`
 	AnonymizeIP     bool      `json:"anonymize_ip"`
 	EnrichDecisions bool      `json:"enrich_decisions"`
 }
 
-// Visitor respresents a visitor of an eventbatch
+// Visitor represents a visitor of an eventbatch
 type Visitor struct {
 	Attributes []VisitorAttribute `json:"attributes"`
 	Snapshots  []Snapshot         `json:"snapshots"`
 	VisitorID  string             `json:"visitor_id"`
 }
 
-// VisitorAttribute respresents an attribute of a visitor
+// VisitorAttribute represents an attribute of a visitor
 type VisitorAttribute struct {
 	Value         interface{} `json:"value"`
 	Key           string      `json:"key"`
 	AttributeType string      `json:"type"`
 	EntityID      string      `json:"entity_id"`
 }
 
-// Snapshot respresents a snapshot of a visitor
+// Snapshot represents a snapshot of a visitor
 type Snapshot struct {
 	Decisions []Decision      `json:"decisions"`
 	Events    []SnapshotEvent `json:"events"`
 }
 
-// Decision respresents a decision of a snapshot
+// Decision represents a decision of a snapshot
 type Decision struct {
 	VariationID  string `json:"variation_id"`
 	CampaignID   string `json:"campaign_id"`
 	ExperimentID string `json:"experiment_id"`
 }
 
-// SnapshotEvent respresents an event of a snapshot
+// SnapshotEvent represents an event of a snapshot
 type SnapshotEvent struct {
 	EntityID  string                 `json:"entity_id"`
 	Key       string                 `json:"key"`

optimizely/event/factory.go

@@ -20,7 +20,7 @@ const eventEndPoint = "https://logx.optimizely.com/v1/events"
 const revenueKey = "revenue"
 const valueKey = "value"
 
-func createLogEvent(event EventBatch) LogEvent {
+func createLogEvent(event Batch) LogEvent {
 	return LogEvent{endPoint: eventEndPoint, event: event}
 }
 
@@ -29,8 +29,8 @@ func makeTimestamp() int64 {
 }
 
 // CreateEventContext creates and returns EventContext
-func CreateEventContext(projectID string, revision string, accountID string, anonymizeIP bool, botFiltering bool, attributeKeyToIDMap map[string]string) EventContext {
-	context := EventContext{}
+func CreateEventContext(projectID string, revision string, accountID string, anonymizeIP bool, botFiltering bool, attributeKeyToIDMap map[string]string) Context {
+	context := Context{}
 	context.ProjectID = projectID
 	context.Revision = revision
 	context.AccountID = accountID
@@ -43,7 +43,7 @@ func CreateEventContext(projectID string, revision string, accountID string, ano
 	return context
 }
 
-func createImpressionEvent(context EventContext, experiment entities.Experiment,
+func createImpressionEvent(context Context, experiment entities.Experiment,
 	variation entities.Variation, attributes map[string]interface{}) ImpressionEvent {
 
 	impression := ImpressionEvent{}
@@ -58,7 +58,7 @@ func createImpressionEvent(context EventContext, experiment entities.Experiment,
 }
 
 // CreateImpressionUserEvent creates and returns ImpressionEvent for user
-func CreateImpressionUserEvent(context EventContext, experiment entities.Experiment,
+func CreateImpressionUserEvent(context Context, experiment entities.Experiment,
 	variation entities.Variation,
 	userContext entities.UserContext) UserEvent {
 
@@ -74,8 +74,8 @@ func CreateImpressionUserEvent(context EventContext, experiment entities.Experim
 	return userEvent
 }
 
-func createImpressionBatchEvent(userEvent UserEvent) EventBatch {
-
+// create an impression visitor
+func createImpressionVisitor(userEvent UserEvent) Visitor {
 	decision := Decision{}
 	decision.CampaignID = userEvent.Impression.CampaignID
 	decision.ExperimentID = userEvent.Impression.ExperimentID
@@ -88,10 +88,12 @@ func createImpressionBatchEvent(userEvent UserEvent) EventBatch {
 	dispatchEvent.UUID = guuid.New().String()
 	dispatchEvent.Tags = make(map[string]interface{})
 
-	return createBatchEvent(userEvent, userEvent.Impression.Attributes, []Decision{decision}, []SnapshotEvent{dispatchEvent})
+	visitor := createVisitor(userEvent, userEvent.Impression.Attributes, []Decision{decision}, []SnapshotEvent{dispatchEvent})
 
+	return visitor
 }
 
+// create a conversion event
 func createConversionEvent(attributeKeyToIDMap map[string]string, event entities.Event, attributes map[string]interface{}, eventTags map[string]interface{}, botFiltering bool) ConversionEvent {
 	conversion := ConversionEvent{}
 
@@ -104,7 +106,7 @@ func createConversionEvent(attributeKeyToIDMap map[string]string, event entities
 }
 
 // CreateConversionUserEvent creates and returns ConversionEvent for user
-func CreateConversionUserEvent(context EventContext, event entities.Event, userContext entities.UserContext, attributeKeyToIDMap map[string]string, eventTags map[string]interface{}) UserEvent {
+func CreateConversionUserEvent(context Context, event entities.Event, userContext entities.UserContext, attributeKeyToIDMap map[string]string, eventTags map[string]interface{}) UserEvent {
 
 	userEvent := UserEvent{}
 	userEvent.Timestamp = makeTimestamp()
@@ -127,7 +129,21 @@ func CreateConversionUserEvent(context EventContext, event entities.Event, userC
 	return userEvent
 
 }
-func createConversionBatchEvent(userEvent UserEvent) EventBatch {
+
+// create visitor from user event
+func createVisitorFromUserEvent(event UserEvent) Visitor {
+	if event.Impression != nil {
+		return createImpressionVisitor(event)
+	}
+	if event.Conversion != nil {
+		return createConversionVisitor(event)
+	}
+
+	return Visitor{}
+}
+
+// create a conversion visitor
+func createConversionVisitor(userEvent UserEvent) Visitor {
 
 	dispatchEvent := SnapshotEvent{}
 	dispatchEvent.Timestamp = makeTimestamp()
@@ -142,13 +158,15 @@ func createConversionBatchEvent(userEvent UserEvent) EventBatch {
 		dispatchEvent.Value = userEvent.Conversion.Value
 	}
 
-	return createBatchEvent(userEvent, userEvent.Conversion.Attributes, []Decision{}, []SnapshotEvent{dispatchEvent})
+	visitor := createVisitor(userEvent, userEvent.Conversion.Attributes, []Decision{}, []SnapshotEvent{dispatchEvent})
+
+	return visitor
 }
 
-func createBatchEvent(userEvent UserEvent, attributes []VisitorAttribute,
+// create a visitor
+func createVisitor(userEvent UserEvent, attributes []VisitorAttribute,
 	decisions []Decision,
-	dispatchEvents []SnapshotEvent) EventBatch {
-
+	dispatchEvents []SnapshotEvent) Visitor {
 	snapShot := Snapshot{}
 	snapShot.Decisions = decisions
 	snapShot.Events = dispatchEvents
@@ -161,7 +179,14 @@ func createBatchEvent(userEvent UserEvent, attributes []VisitorAttribute,
 	visitor.Snapshots = []Snapshot{snapShot}
 	visitor.VisitorID = userEvent.VisitorID
 
-	eventBatch := EventBatch{}
+	return visitor
+}
+
+// create a batch event with visitor
+func createBatchEvent(userEvent UserEvent, visitor Visitor) Batch {
+
+
+	eventBatch := Batch{}
 	eventBatch.ProjectID = userEvent.EventContext.ProjectID
 	eventBatch.Revision = userEvent.EventContext.Revision
 	eventBatch.AccountID = userEvent.EventContext.AccountID
@@ -174,6 +199,7 @@ func createBatchEvent(userEvent UserEvent, attributes []VisitorAttribute,
 	return eventBatch
 }
 
+// get visitor attributes from user attributes
 func getEventAttributes(attributeKeyToIDMap map[string]string, attributes map[string]interface{}, botFiltering bool) []VisitorAttribute {
 	var eventAttributes = []VisitorAttribute{}
 
@@ -206,6 +232,7 @@ func getEventAttributes(attributeKeyToIDMap map[string]string, attributes map[st
 	return eventAttributes
 }
 
+// get revenue attribute
 func getRevenueValue(eventTags map[string]interface{}) (int64, error) {
 	if value, ok := eventTags[revenueKey]; ok {
 		return utils.GetIntValue(value)
@@ -214,6 +241,7 @@ func getRevenueValue(eventTags map[string]interface{}) (int64, error) {
 	return 0, errors.New("No event tag found for revenue")
 }
 
+// get a value attribute
 func getTagValue(eventTags map[string]interface{}) (float64, error) {
 	if value, ok := eventTags[valueKey]; ok {
 		return utils.GetFloatValue(value)

optimizely/event/factory_test.go

@@ -129,7 +129,7 @@ func TestCreateConversionEventRevenue(t *testing.T) {
 	assert.Equal(t, int64(55), *conversionUserEvent.Conversion.Revenue)
 	assert.Equal(t, 25.1, *conversionUserEvent.Conversion.Value)
 
-	batch := createConversionBatchEvent(conversionUserEvent)
+	batch := createBatchEvent(conversionUserEvent, createVisitorFromUserEvent(conversionUserEvent))
 	assert.Equal(t, int64(55), *batch.Visitors[0].Snapshots[0].Events[0].Revenue)
 	assert.Equal(t, 25.1, *batch.Visitors[0].Snapshots[0].Events[0].Value)