Merge pull request #24 from optimizely/eventProcessor

Simple Event processor, queue (can replace), event dispatcher, ImpressionEvent factory, sending events in unit tests

Author: thomaszurkan-optimizely

examples/main.go

@@ -4,6 +4,8 @@ import (
 	"fmt"
 
 	"github.com/optimizely/go-sdk/optimizely/client"
+	"github.com/optimizely/go-sdk/optimizely/event"
+	"time"
 )
 
 func main() {
@@ -12,4 +14,17 @@ func main() {
 	}
 	client := optimizelyFactory.Client()
 	fmt.Printf("Is feature enabled? %v", client.IsFeatureEnabled("go_sdk", "mike", nil))
+
+	processor := event.NewEventProcessor(100, 100)
+
+	impression := event.UserEvent{}
+
+	processor.ProcessImpression(impression)
+
+	_, ok := processor.(*event.QueueingEventProcessor)
+
+	if ok {
+		time.Sleep(1000 * time.Millisecond)
+		fmt.Println("\nending")
+	}
 }

optimizely/config/datafileProjectConfig/config.go

@@ -33,6 +33,38 @@ type DatafileProjectConfig struct {
 	experimentMap        map[string]entities.Experiment
 	experimentKeyToIDMap map[string]string
 	featureMap           map[string]entities.Feature
+	attributeKeyToIDMap  map[string]string
+	eventMap             map[string]entities.Event
+	projectID			 string
+	revision			 string
+	accountID			 string
+	anonymizeIP			 bool
+	botFiltering		 bool
+
+}
+
+func (config DatafileProjectConfig) GetProjectID() string {
+	return config.projectID
+}
+
+func (config DatafileProjectConfig) GetRevision() string {
+	return config.revision
+}
+
+func (config DatafileProjectConfig) GetAccountID() string {
+	return config.accountID
+}
+
+func (config DatafileProjectConfig) GetAnonymizeIP() bool {
+	return config.anonymizeIP
+}
+
+func (config DatafileProjectConfig) GetAttributeID(key string) string {
+	return config.attributeKeyToIDMap[key]
+}
+
+func (config DatafileProjectConfig) GetBotFiltering() bool {
+	return config.botFiltering
 }
 
 // NewDatafileProjectConfig initializes a new datafile from a json byte array using the default JSON datafile parser
@@ -53,6 +85,16 @@ func NewDatafileProjectConfig(jsonDatafile []byte) *DatafileProjectConfig {
 	return config
 }
 
+// GetEventByKey returns the event with the given key
+func (config DatafileProjectConfig) GetEventByKey(eventKey string) (entities.Event, error) {
+	if event, ok := config.eventMap[eventKey]; ok {
+		return event, nil
+	}
+
+	errMessage := fmt.Sprintf("Event with key %s not found", eventKey)
+	return entities.Event{}, errors.New(errMessage)
+}
+
 // GetFeatureByKey returns the feature with the given key
 func (config DatafileProjectConfig) GetFeatureByKey(featureKey string) (entities.Feature, error) {
 	if feature, ok := config.featureMap[featureKey]; ok {

optimizely/config/datafileProjectConfig/entities/entities.go

@@ -28,6 +28,7 @@ type Experiment struct {
 	// @TODO(mng): include audienceConditions
 	ID                string              `json:"id"`
 	Key               string              `json:"key"`
+	LayerID           string              `json:"layerId"`
 	Status            string              `json:"status"`
 	Variations        []Variation         `json:"variations"`
 	TrafficAllocation []trafficAllocation `json:"trafficAllocation"`
@@ -58,6 +59,12 @@ type Variation struct {
 	FeatureEnabled bool   `json:"featureEnabled"`
 }
 
+type Event struct {
+	ID string `json:"id"`
+	Key string `json:"key"`
+	ExperimentIds []string `json:"experimentIds"`
+}
+
 // Datafile represents the datafile we get from Optimizely
 type Datafile struct {
 	AccountID    string        `json:"accountId"`
@@ -66,6 +73,7 @@ type Datafile struct {
 	BotFiltering bool          `json:"botFiltering"`
 	Experiments  []Experiment  `json:"experiments"`
 	FeatureFlags []FeatureFlag `json:"featureFlags"`
+	Events       []Event       `json:"events"`
 	ProjectID    string        `json:"projectId"`
 	Revision     string        `json:"revision"`
 	Variables    []string      `json:"variables"`

optimizely/config/interface.go

@@ -23,6 +23,13 @@ import (
 // ProjectConfig contains the parsed project entities
 type ProjectConfig interface {
 	GetFeatureByKey(string) (entities.Feature, error)
+	GetProjectID() string
+	GetRevision()  string
+	GetAccountID() string
+	GetAnonymizeIP() bool
+	GetAttributeID(key string) string // returns "" if there is no id
+	GetBotFiltering() bool
+	GetEventByKey(string) (entities.Event, error)
 }
 
 // ProjectConfigManager manages the config

optimizely/entities/event.go

@@ -0,0 +1,8 @@
+package entities
+
+type Event struct {
+	ID string `json:"id"`
+	Key string `json:"key"`
+	ExperimentIds []string `json:"experimentIds"`
+}
+

optimizely/entities/experiment.go

@@ -28,6 +28,7 @@ type Variation struct {
 type Experiment struct {
 	AudienceIds       []string
 	ID                string
+	LayerID           string
 	Key               string
 	Variations        map[string]Variation
 	TrafficAllocation []Range

optimizely/entities/user_context.go

@@ -35,6 +35,7 @@ type UserAttributes struct {
 }
 
 var floatType = reflect.TypeOf(float64(0))
+var intType = reflect.TypeOf(int64(0))
 
 // GetString returns the string value for the specified attribute name in the attributes map. Returns error if not found.
 func (u UserAttributes) GetString(attrName string) (string, error) {
@@ -73,6 +74,18 @@ func (u UserAttributes) GetFloat(attrName string) (float64, error) {
 	return 0, fmt.Errorf(`No float attribute named "%s"`, attrName)
 }
 
+func (u UserAttributes) GetInt(attrName string) (int64, error) {
+	if value, ok := u.Attributes[attrName]; ok {
+		v := reflect.ValueOf(value)
+		if v.Type().String() == "int64" || v.Type().ConvertibleTo(intType) {
+			intValue := v.Convert(intType).Int()
+			return intValue, nil
+		}
+	}
+
+	return 0, fmt.Errorf(`No int attribute named "%s"`, attrName)
+}
+
 // GetBucketingID returns the bucketing ID to use for the given user
 func (u UserContext) GetBucketingID() (string, error) {
 	// by default
@@ -90,3 +103,4 @@ func (u UserContext) GetBucketingID() (string, error) {
 
 	return bucketingID, nil
 }
+

optimizely/event/dispatcher.go

@@ -0,0 +1,43 @@
+package event
+
+import (
+	"bytes"
+	"encoding/json"
+	"fmt"
+	"net/http"
+)
+
+type Dispatcher interface {
+	DispatchEvent(event LogEvent, callback func(success bool))
+}
+
+type HttpEventDispatcher struct {
+}
+
+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))
+	// also check response codes
+	// resp.StatusCode == 400 is an error
+	success := true
+
+	if err != nil {
+		fmt.Println(err)
+		success = false
+	} else {
+		if resp.StatusCode == 204 {
+			success = true
+		} else {
+			fmt.Printf("invalid response %d", resp.StatusCode)
+			success = false
+		}
+	}
+	callback(success)
+
+}
+

optimizely/event/events.go

@@ -0,0 +1,91 @@
+package event
+
+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"`
+	AttributeKeyToIdMap map[string]string `json:"attributeKeyToIdMap"`
+}
+
+type UserEvent struct {
+	Timestamp int64 `json:"timestamp"`
+	Uuid      string `json:"uuid"`
+	EventContext EventContext
+	VisitorID string
+	Impression *ImpressionEvent
+	Conversion *ConversionEvent
+}
+
+type ImpressionEvent struct {
+	EntityID  string `json:"entity_id"`
+	Key       string `json:"key"`
+	Attributes 	 []VisitorAttribute
+	VariationID  string `json:"variation_id"`
+	CampaignID   string `json:"campaign_id"`
+	ExperimentID string `json:"experiment_id"`
+}
+
+type ConversionEvent struct {
+	EntityID  string `json:"entity_id"`
+	Key       string `json:"key"`
+	Attributes 	 []VisitorAttribute
+	Tags      map[string]interface{} `json:"tags,omitempty"`
+	// these need to be pointers because 0 is a valid Revenue or Value.
+	// 0 is equivalent to omitempty for json marshalling.
+	Revenue   *int64 `json:"revenue,omitempty"`
+	Value     *float64 `json:"value,omitempty"`
+}
+
+type LogEvent struct {
+	endPoint string
+	event    EventBatch
+}
+// Context about the event
+type EventBatch 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"`
+}
+
+type Visitor struct {
+	Attributes []VisitorAttribute `json:"attributes"`
+	Snapshots  []Snapshot         `json:"snapshots"`
+	VisitorID  string             `json:"visitor_id"`
+}
+
+type VisitorAttribute struct {
+	Value         interface{} `json:"value"`
+	Key           string	`json:"key"`
+	AttributeType string	`json:"type"`
+	EntityID      string	`json:"entity_id"`
+}
+
+type Snapshot struct {
+	Decisions []Decision   `json:"decisions"`
+ 	Events []SnapshotEvent `json:"events"`
+}
+
+type Decision struct {
+	VariationID  string `json:"variation_id"`
+	CampaignID   string `json:"campaign_id"`
+	ExperimentID string `json:"experiment_id"`
+}
+
+type SnapshotEvent struct {
+	EntityID  string `json:"entity_id"`
+	Key       string `json:"key"`
+	Timestamp int64 `json:"timestamp"`
+	Uuid      string `json:"uuid"`
+	Tags      map[string]interface{} `json:"tags,omitempty"`
+	Revenue   *int64 `json:"revenue,omitempty"`
+	Value     *float64 `json:"value,omitempty"`
+}