feat(config): Add missing config properties for events. (#65)

Author: Michael Ng

README.md

@@ -28,9 +28,14 @@ client, err := optimizelyFactory.Client()
 
 ### Feature Rollouts
 ```
+import (
+  "github.com/optimizely/go-sdk/optimizely/client"
+  "github.com/optimizely/go-sdk/optimizely/entities"
+)
+
 user := entities.UserContext{
   ID: "optimizely end user",
-  Attributes: entities.UserAttributes{
+  Attributes: map[string]interface{}{
     "state":      "California",
     "likes_donuts": true,
   },

optimizely/config/datafileprojectconfig/config.go

@@ -33,6 +33,7 @@ type DatafileProjectConfig struct {
 	anonymizeIP          bool
 	attributeKeyToIDMap  map[string]string
 	audienceMap          map[string]entities.Audience
+	attributeMap         map[string]entities.Attribute
 	botFiltering         bool
 	eventMap             map[string]entities.Event
 	experimentKeyToIDMap map[string]string
@@ -82,11 +83,14 @@ func NewDatafileProjectConfig(jsonDatafile []byte) (*DatafileProjectConfig, erro
 		return nil, err
 	}
 
+	attributeMap, attributeKeyToIDMap := mappers.MapAttributes(datafile.Attributes)
 	experiments, experimentKeyMap := mappers.MapExperiments(datafile.Experiments)
 	rolloutMap := mappers.MapRollouts(datafile.Rollouts)
 	mergedAudiences := append(datafile.TypedAudiences, datafile.Audiences...)
 	config := &DatafileProjectConfig{
 		audienceMap:          mappers.MapAudiences(mergedAudiences),
+		attributeMap:         attributeMap,
+		attributeKeyToIDMap:  attributeKeyToIDMap,
 		experimentMap:        experiments,
 		experimentKeyToIDMap: experimentKeyMap,
 		rolloutMap:           rolloutMap,
@@ -117,6 +121,16 @@ func (c DatafileProjectConfig) GetFeatureByKey(featureKey string) (entities.Feat
 	return entities.Feature{}, errors.New(errMessage)
 }
 
+// GetAttributeByKey returns the attribute with the given key
+func (c DatafileProjectConfig) GetAttributeByKey(key string) (entities.Attribute, error) {
+	if attributeID, ok := c.attributeKeyToIDMap[key]; ok {
+		return c.attributeMap[attributeID], nil
+	}
+
+	errMessage := fmt.Sprintf(`Attribute with key "%s" not found`, key)
+	return entities.Attribute{}, errors.New(errMessage)
+}
+
 // GetFeatureList returns an array of all the features
 func (c DatafileProjectConfig) GetFeatureList() (featureList []entities.Feature) {
 	for _, feature := range c.featureMap {

optimizely/config/datafileprojectconfig/mappers/attribute.go

@@ -0,0 +1,40 @@
+/****************************************************************************
+ * Copyright 2019, Optimizely, Inc. and contributors                        *
+ *                                                                          *
+ * Licensed under the Apache License, Version 2.0 (the "License");          *
+ * you may not use this file except in compliance with the License.         *
+ * You may obtain a copy of the License at                                  *
+ *                                                                          *
+ *    http://www.apache.org/licenses/LICENSE-2.0                            *
+ *                                                                          *
+ * Unless required by applicable law or agreed to in writing, software      *
+ * distributed under the License is distributed on an "AS IS" BASIS,        *
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
+ * See the License for the specific language governing permissions and      *
+ * limitations under the License.                                           *
+ ***************************************************************************/
+
+package mappers
+
+import (
+	datafileEntities "github.com/optimizely/go-sdk/optimizely/config/datafileprojectconfig/entities"
+	"github.com/optimizely/go-sdk/optimizely/entities"
+)
+
+// MapAttributes maps the raw datafile attribute entities to SDK Attribute entities
+func MapAttributes(attributes []datafileEntities.Attribute) (attributeMap map[string]entities.Attribute, attributeKeyToIDMap map[string]string) {
+
+	attributeMap = make(map[string]entities.Attribute)
+	attributeKeyToIDMap = make(map[string]string)
+	for _, attribute := range attributes {
+		_, ok := attributeMap[attribute.ID]
+		if !ok {
+			attributeMap[attribute.ID] = entities.Attribute{
+				ID:  attribute.ID,
+				Key: attribute.Key,
+			}
+			attributeKeyToIDMap[attribute.Key] = attribute.ID
+		}
+	}
+	return attributeMap, attributeKeyToIDMap
+}

optimizely/entities/attribute.go

@@ -0,0 +1,23 @@
+/****************************************************************************
+ * Copyright 2019, Optimizely, Inc. and contributors                        *
+ *                                                                          *
+ * Licensed under the Apache License, Version 2.0 (the "License");          *
+ * you may not use this file except in compliance with the License.         *
+ * You may obtain a copy of the License at                                  *
+ *                                                                          *
+ *    http://www.apache.org/licenses/LICENSE-2.0                            *
+ *                                                                          *
+ * Unless required by applicable law or agreed to in writing, software      *
+ * distributed under the License is distributed on an "AS IS" BASIS,        *
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
+ * See the License for the specific language governing permissions and      *
+ * limitations under the License.                                           *
+ ***************************************************************************/
+
+package entities
+
+// Attribute contains the user attribute definition
+type Attribute struct {
+	ID  string
+	Key string
+}

optimizely/event/events.go

@@ -2,19 +2,18 @@ package event
 
 // 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"`
+	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"`
 }
 
 // UserEvent represents a user event
 type UserEvent struct {
-	Timestamp    int64 `json:"timestamp"`
+	Timestamp    int64  `json:"timestamp"`
 	UUID         string `json:"uuid"`
 	EventContext Context
 	VisitorID    string
@@ -50,11 +49,11 @@ type LogEvent struct {
 	event    Batch
 }
 
-// Context about the event to send in batch
+// Batch - 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"`
+	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"`

optimizely/event/factory.go

@@ -2,17 +2,23 @@ package event
 
 import (
 	"errors"
+	"fmt"
 	"strings"
 	"time"
 
+	"github.com/optimizely/go-sdk/optimizely"
+
 	guuid "github.com/google/uuid"
 	"github.com/optimizely/go-sdk/optimizely/entities"
+	"github.com/optimizely/go-sdk/optimizely/logging"
 	"github.com/optimizely/go-sdk/optimizely/utils"
 )
 
+var efLogger = logging.GetLogger("EventFactory")
+
 const impressionKey string = "campaign_activated"
-const clientKey string = "go-sdk"
-const clientVersion string = "1.0.0"
+const clientKey string = optimizely.ClientName
+const clientVersion string = optimizely.Version
 const attributeType = "custom"
 const specialPrefix = "$opt_"
 const botFilteringKey = "$opt_bot_filtering"
@@ -29,27 +35,26 @@ func makeTimestamp() int64 {
 }
 
 // CreateEventContext creates and returns EventContext
-func CreateEventContext(projectID string, revision string, accountID string, anonymizeIP bool, botFiltering bool, attributeKeyToIDMap map[string]string) Context {
+func CreateEventContext(projectConfig optimizely.ProjectConfig) Context {
 	context := Context{}
-	context.ProjectID = projectID
-	context.Revision = revision
-	context.AccountID = accountID
+	context.ProjectID = projectConfig.GetProjectID()
+	context.Revision = projectConfig.GetRevision()
+	context.AccountID = projectConfig.GetAccountID()
 	context.ClientName = clientKey
 	context.ClientVersion = clientVersion
-	context.AnonymizeIP = anonymizeIP
-	context.BotFiltering = botFiltering
-	context.attributeKeyToIDMap = attributeKeyToIDMap
+	context.AnonymizeIP = projectConfig.GetAnonymizeIP()
+	context.BotFiltering = projectConfig.GetBotFiltering()
 
 	return context
 }
 
-func createImpressionEvent(context Context, experiment entities.Experiment,
+func createImpressionEvent(projectConfig optimizely.ProjectConfig, experiment entities.Experiment,
 	variation entities.Variation, attributes map[string]interface{}) ImpressionEvent {
 
 	impression := ImpressionEvent{}
 	impression.Key = impressionKey
 	impression.EntityID = experiment.LayerID
-	impression.Attributes = getEventAttributes(context.attributeKeyToIDMap, attributes, context.BotFiltering)
+	impression.Attributes = getEventAttributes(projectConfig, attributes)
 	impression.VariationID = variation.ID
 	impression.ExperimentID = experiment.ID
 	impression.CampaignID = experiment.LayerID
@@ -58,18 +63,18 @@ func createImpressionEvent(context Context, experiment entities.Experiment,
 }
 
 // CreateImpressionUserEvent creates and returns ImpressionEvent for user
-func CreateImpressionUserEvent(context Context, experiment entities.Experiment,
+func CreateImpressionUserEvent(projectConfig optimizely.ProjectConfig, experiment entities.Experiment,
 	variation entities.Variation,
 	userContext entities.UserContext) UserEvent {
 
-	impression := createImpressionEvent(context, experiment, variation, userContext.Attributes)
+	impression := createImpressionEvent(projectConfig, experiment, variation, userContext.Attributes)
 
 	userEvent := UserEvent{}
 	userEvent.Timestamp = makeTimestamp()
 	userEvent.VisitorID = userContext.ID
 	userEvent.UUID = guuid.New().String()
 	userEvent.Impression = &impression
-	userEvent.EventContext = context
+	userEvent.EventContext = CreateEventContext(projectConfig)
 
 	return userEvent
 }
@@ -94,27 +99,27 @@ func createImpressionVisitor(userEvent UserEvent) 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 {
+func createConversionEvent(projectConfig optimizely.ProjectConfig, event entities.Event, attributes map[string]interface{}, eventTags map[string]interface{}) ConversionEvent {
 	conversion := ConversionEvent{}
 
 	conversion.Key = event.Key
 	conversion.EntityID = event.ID
 	conversion.Tags = eventTags
-	conversion.Attributes = getEventAttributes(attributeKeyToIDMap, attributes, botFiltering)
+	conversion.Attributes = getEventAttributes(projectConfig, attributes)
 
 	return conversion
 }
 
 // CreateConversionUserEvent creates and returns ConversionEvent for user
-func CreateConversionUserEvent(context Context, event entities.Event, userContext entities.UserContext, attributeKeyToIDMap map[string]string, eventTags map[string]interface{}) UserEvent {
+func CreateConversionUserEvent(projectConfig optimizely.ProjectConfig, event entities.Event, userContext entities.UserContext, eventTags map[string]interface{}) UserEvent {
 
 	userEvent := UserEvent{}
 	userEvent.Timestamp = makeTimestamp()
 	userEvent.VisitorID = userContext.ID
 	userEvent.UUID = guuid.New().String()
 
-	userEvent.EventContext = context
-	conversion := createConversionEvent(attributeKeyToIDMap, event, userContext.Attributes, eventTags, context.BotFiltering)
+	userEvent.EventContext = CreateEventContext(projectConfig)
+	conversion := createConversionEvent(projectConfig, event, userContext.Attributes, eventTags)
 	revenue, err := getRevenueValue(eventTags)
 	if err == nil {
 		conversion.Revenue = &revenue
@@ -185,49 +190,49 @@ func createVisitor(userEvent UserEvent, attributes []VisitorAttribute,
 // 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
 	eventBatch.Visitors = []Visitor{visitor}
-	eventBatch.ClientName = clientKey
-	eventBatch.ClientVersion = clientVersion
+	eventBatch.ClientName = userEvent.EventContext.ClientName
+	eventBatch.ClientVersion = userEvent.EventContext.ClientVersion
 	eventBatch.AnonymizeIP = userEvent.EventContext.AnonymizeIP
 	eventBatch.EnrichDecisions = true
 
 	return eventBatch
 }
 
 // get visitor attributes from user attributes
-func getEventAttributes(attributeKeyToIDMap map[string]string, attributes map[string]interface{}, botFiltering bool) []VisitorAttribute {
+func getEventAttributes(projectConfig optimizely.ProjectConfig, attributes map[string]interface{}) []VisitorAttribute {
 	var eventAttributes = []VisitorAttribute{}
 
 	for key, value := range attributes {
 		if value == nil {
 			continue
 		}
-		attribute := VisitorAttribute{}
-		id := attributeKeyToIDMap[key]
-		if id != "" {
-			attribute.EntityID = id
+		visitorAttribute := VisitorAttribute{}
+		attribute, _ := projectConfig.GetAttributeByKey(key)
+		if attribute.ID != "" {
+			visitorAttribute.EntityID = attribute.ID
 		} else if strings.HasPrefix(key, specialPrefix) {
-			attribute.EntityID = key
+			visitorAttribute.EntityID = key
 		} else {
+			efLogger.Debug(fmt.Sprintf("Unrecognized attribute %s provided. Pruning before sending event to Optimizely.", key))
 			continue
 		}
-		attribute.Value = value
-		attribute.AttributeType = attributeType
+		visitorAttribute.Value = value
+		visitorAttribute.AttributeType = attributeType
 
-		eventAttributes = append(eventAttributes, attribute)
+		eventAttributes = append(eventAttributes, visitorAttribute)
 	}
 
-	attribute := VisitorAttribute{}
-	attribute.Value = botFiltering
-	attribute.AttributeType = attributeType
-	attribute.Key = botFilteringKey
-	attribute.EntityID = botFilteringKey
-	eventAttributes = append(eventAttributes, attribute)
+	visitorAttribute := VisitorAttribute{}
+	visitorAttribute.Value = projectConfig.GetBotFiltering()
+	visitorAttribute.AttributeType = attributeType
+	visitorAttribute.Key = botFilteringKey
+	visitorAttribute.EntityID = botFilteringKey
+	eventAttributes = append(eventAttributes, visitorAttribute)
 
 	return eventAttributes
 }