[FSSDK-11461] Go - Add SDK Multi-Region Support for Data Hosting (#414)

esrakartalOpt · web-flow · commit afaf5d657c12 · 2025-08-11T09:35:22.000-05:00
* [FSSDK-11461] Go - Add SDK Multi-Region Support for Data Hosting

* Fix lint issue

* Fix failed test cases

* Implement comments

* Fix lint issue
diff --git a/pkg/client/client_test.go b/pkg/client/client_test.go
@@ -177,6 +177,10 @@ func (TestConfig) GetClientVersion() string {
 	return "1.0.0"
 }
 
+func (TestConfig) GetRegion() string {
+	return "US"
+}
+
 type MockODPManager struct {
 	odp.Manager
 	mock.Mock
@@ -347,6 +351,7 @@ func TestSendODPEvent(t *testing.T) {
 
 func TestTrack(t *testing.T) {
 	mockProcessor := new(MockProcessor)
+	mockProcessor.Events = make([]event.UserEvent, 0) // Initialize Events slice
 	mockDecisionService := new(MockDecisionService)
 	mockProcessor.On("ProcessEvent", mock.AnythingOfType("UserEvent")).Return(true)
 
diff --git a/pkg/client/fixtures_test.go b/pkg/client/fixtures_test.go
@@ -82,6 +82,10 @@ func (c *MockProjectConfig) SendFlagDecisions() bool {
 	return false
 }
 
+func (c *MockProjectConfig) GetRegion() string {
+	return "US"
+}
+
 type MockProjectConfigManager struct {
 	projectConfig config.ProjectConfig
 	mock.Mock
diff --git a/pkg/cmab/service_test.go b/pkg/cmab/service_test.go
@@ -224,6 +224,11 @@ func (m *MockProjectConfig) GetDatafile() string {
 	return args.String(0)
 }
 
+func (m *MockProjectConfig) GetRegion() string {
+	args := m.Called()
+	return args.String(0)
+}
+
 type CmabServiceTestSuite struct {
 	suite.Suite
 	mockClient     *MockCmabClient
diff --git a/pkg/config/datafileprojectconfig/config.go b/pkg/config/datafileprojectconfig/config.go
@@ -57,6 +57,7 @@ type DatafileProjectConfig struct {
 	sendFlagDecisions    bool
 	sdkKey               string
 	environmentKey       string
+	region               string
 
 	flagVariationsMap map[string][]entities.Variation
 }
@@ -275,6 +276,11 @@ func (c DatafileProjectConfig) GetFlagVariationsMap() map[string][]entities.Vari
 	return c.flagVariationsMap
 }
 
+// GetRegion returns the region for the datafile
+func (c DatafileProjectConfig) GetRegion() string {
+	return c.region
+}
+
 // NewDatafileProjectConfig initializes a new datafile from a json byte array using the default JSON datafile parser
 func NewDatafileProjectConfig(jsonDatafile []byte, logger logging.OptimizelyLogProducer) (*DatafileProjectConfig, error) {
 	datafile, err := Parse(jsonDatafile)
@@ -326,6 +332,11 @@ func NewDatafileProjectConfig(jsonDatafile []byte, logger logging.OptimizelyLogP
 		attributeKeyMap[attribute.Key] = attribute
 	}
 
+	region := datafile.Region
+	if region == "" {
+		region = "US"
+	}
+
 	config := &DatafileProjectConfig{
 		hostForODP:           hostForODP,
 		publicKeyForODP:      publicKeyForODP,
@@ -353,6 +364,7 @@ func NewDatafileProjectConfig(jsonDatafile []byte, logger logging.OptimizelyLogP
 		flagVariationsMap:    flagVariationsMap,
 		attributeKeyMap:      attributeKeyMap,
 		attributeIDToKeyMap:  attributeIDToKeyMap,
+		region:               region,
 	}
 
 	logger.Info("Datafile is valid.")
diff --git a/pkg/config/datafileprojectconfig/entities/entities.go b/pkg/config/datafileprojectconfig/entities/entities.go
@@ -141,4 +141,5 @@ type Datafile struct {
 	SendFlagDecisions bool          `json:"sendFlagDecisions"`
 	SDKKey            string        `json:"sdkKey,omitempty"`
 	EnvironmentKey    string        `json:"environmentKey,omitempty"`
+	Region            string        `json:"region,omitempty"`
 }
diff --git a/pkg/config/interface.go b/pkg/config/interface.go
@@ -55,6 +55,7 @@ type ProjectConfig interface {
 	GetEnvironmentKey() string
 	GetAttributes() []entities.Attribute
 	GetFlagVariationsMap() map[string][]entities.Variation
+	GetRegion() string
 }
 
 // ProjectConfigManager maintains an instance of the ProjectConfig
diff --git a/pkg/decision/evaluator/audience_evaluator_test.go b/pkg/decision/evaluator/audience_evaluator_test.go
@@ -195,6 +195,11 @@ func (m *MockProjectConfig) GetDatafile() string {
 	return args.String(0)
 }
 
+func (m *MockProjectConfig) GetRegion() string {
+	args := m.Called()
+	return args.String(0)
+}
+
 // MockLogger is a mock implementation of OptimizelyLogProducer
 // (This declaration has been removed to resolve the redeclaration error)
 
diff --git a/pkg/event/dispatcher_test.go b/pkg/event/dispatcher_test.go
@@ -122,7 +122,7 @@ func TestQueueEventDispatcher_DispatchEvent(t *testing.T) {
 	batch := createBatchEvent(conversionUserEvent, createVisitorFromUserEvent(conversionUserEvent))
 	assert.Equal(t, conversionUserEvent.Timestamp, batch.Visitors[0].Snapshots[0].Events[0].Timestamp)
 
-	logEvent := createLogEvent(batch, DefaultEventEndPoint)
+	logEvent := createLogEvent(batch, EventEndPoints["US"])
 
 	success, _ := q.DispatchEvent(logEvent)
 
@@ -181,7 +181,7 @@ func TestQueueEventDispatcher_FailDispath(t *testing.T) {
 	batch := createBatchEvent(conversionUserEvent, createVisitorFromUserEvent(conversionUserEvent))
 	assert.Equal(t, conversionUserEvent.Timestamp, batch.Visitors[0].Snapshots[0].Events[0].Timestamp)
 
-	logEvent := createLogEvent(batch, DefaultEventEndPoint)
+	logEvent := createLogEvent(batch, EventEndPoints["US"])
 
 	q.DispatchEvent(logEvent)
 
@@ -221,7 +221,7 @@ func TestQueueEventDispatcher_WaitForDispatchingEventsOnClose(t *testing.T) {
 		batch := createBatchEvent(conversionUserEvent, createVisitorFromUserEvent(conversionUserEvent))
 		assert.Equal(t, conversionUserEvent.Timestamp, batch.Visitors[0].Snapshots[0].Events[0].Timestamp)
 
-		logEvent := createLogEvent(batch, DefaultEventEndPoint)
+		logEvent := createLogEvent(batch, EventEndPoints["US"])
 
 		success, _ := q.DispatchEvent(logEvent)
 
diff --git a/pkg/event/events.go b/pkg/event/events.go
@@ -26,6 +26,7 @@ type Context struct {
 	ClientName    string `json:"client_name"`
 	AnonymizeIP   bool   `json:"anonymize_ip"`
 	BotFiltering  bool   `json:"bot_filtering"`
+	Region        string `json:"region"`
 }
 
 // UserEvent represents a user event
@@ -87,6 +88,7 @@ type Batch struct {
 	ClientName      string    `json:"client_name"`
 	AnonymizeIP     bool      `json:"anonymize_ip"`
 	EnrichDecisions bool      `json:"enrich_decisions"`
+	Region          string    `json:"region"`
 }
 
 // Visitor represents a visitor of an eventbatch
diff --git a/pkg/event/factory.go b/pkg/event/factory.go
@@ -19,6 +19,7 @@ package event
 
 import (
 	"errors"
+	"log"
 	"strings"
 	"time"
 
@@ -37,7 +38,26 @@ const botFilteringKey = "$opt_bot_filtering"
 const revenueKey = "revenue"
 const valueKey = "value"
 
+// SupportedRegions maps of supported regions for event endpoints
+var SupportedRegions = map[string]bool{"US": true, "EU": true}
+
+func getEventEndPoint(region, eventEndPoint string) string {
+	if eventEndPoint != "" {
+		return eventEndPoint
+	}
+
+	region = strings.ToUpper(region)
+
+	if !SupportedRegions[region] {
+		log.Print("Unsupported region provided for event endpoint. Defaulting to US.")
+		region = "US"
+	}
+
+	return EventEndPoints[region]
+}
+
 func createLogEvent(event Batch, eventEndPoint string) LogEvent {
+	eventEndPoint = getEventEndPoint(event.Region, eventEndPoint)
 	return LogEvent{EndPoint: eventEndPoint, Event: event}
 }
 
@@ -55,6 +75,7 @@ func CreateEventContext(projectConfig config.ProjectConfig) Context {
 	context.ClientVersion = Version
 	context.AnonymizeIP = projectConfig.GetAnonymizeIP()
 	context.BotFiltering = projectConfig.GetBotFiltering()
+	context.Region = projectConfig.GetRegion()
 
 	return context
 }
@@ -253,6 +274,7 @@ func createBatchEvent(userEvent UserEvent, visitor Visitor) Batch {
 	eventBatch.ClientVersion = userEvent.EventContext.ClientVersion
 	eventBatch.AnonymizeIP = userEvent.EventContext.AnonymizeIP
 	eventBatch.EnrichDecisions = true
+	eventBatch.Region = userEvent.EventContext.Region
 
 	return eventBatch
 }
diff --git a/pkg/event/factory_test.go b/pkg/event/factory_test.go
@@ -86,6 +86,10 @@ func (t TestConfig) SendFlagDecisions() bool {
 	return t.sendFlagDecisions
 }
 
+func (TestConfig) GetRegion() string {
+	return "US"
+}
+
 func RandomString(len int) string {
 	bytes := make([]byte, len)
 	rand.Seed(time.Now().UnixNano())
diff --git a/pkg/event/processor.go b/pkg/event/processor.go
@@ -71,8 +71,11 @@ const CloseEventDispatchWaitTime = 500 * time.Millisecond
 // CloseEventDispatchTimeout holds the timeout value for the waiting for the dispatching events on client close
 const CloseEventDispatchTimeout = 30 * time.Second
 
-// DefaultEventEndPoint is used as the default endpoint for sending events.
-const DefaultEventEndPoint = "https://logx.optimizely.com/v1/events"
+// EventEndPoints holds the event endpoints for different regions
+var EventEndPoints = map[string]string{
+	"US": "https://logx.optimizely.com/v1/events",
+	"EU": "https://eu.logx.optimizely.com/v1/events",
+}
 
 const maxFlushWorkers = 1
 
@@ -159,7 +162,7 @@ func NewBatchEventProcessor(options ...BPOptionConfig) *BatchEventProcessor {
 	}
 
 	if p.EventEndPoint == "" {
-		p.EventEndPoint = DefaultEventEndPoint
+		p.EventEndPoint = EventEndPoints["US"]
 	}
 
 	if p.BatchSize > p.MaxQueueSize {
diff --git a/pkg/event/processor_test.go b/pkg/event/processor_test.go

Original file line number	Diff line number	Diff line change
`@@ -141,4 +141,5 @@ type Datafile struct {`
`141`	`141`	SendFlagDecisions bool `json:"sendFlagDecisions"`
`142`	`142`	SDKKey string `json:"sdkKey,omitempty"`
`143`	`143`	EnvironmentKey string `json:"environmentKey,omitempty"`
	`144`	+ Region string `json:"region,omitempty"`
`144`	`145`	`}`
Original file line number	Diff line number	Diff line change
`@@ -55,6 +55,7 @@ type ProjectConfig interface {`
`55`	`55`	`GetEnvironmentKey() string`
`56`	`56`	`GetAttributes() []entities.Attribute`
`57`	`57`	`GetFlagVariationsMap() map[string][]entities.Variation`
	`58`	`+ GetRegion() string`
`58`	`59`	`}`
`59`	`60`
`60`	`61`	`// ProjectConfigManager maintains an instance of the ProjectConfig`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@ type Context struct {`
`26`	`26`	ClientName string `json:"client_name"`
`27`	`27`	AnonymizeIP bool `json:"anonymize_ip"`
`28`	`28`	BotFiltering bool `json:"bot_filtering"`
	`29`	+ Region string `json:"region"`
`29`	`30`	`}`
`30`	`31`
`31`	`32`	`// UserEvent represents a user event`
`@@ -87,6 +88,7 @@ type Batch struct {`
`87`	`88`	ClientName string `json:"client_name"`
`88`	`89`	AnonymizeIP bool `json:"anonymize_ip"`
`89`	`90`	EnrichDecisions bool `json:"enrich_decisions"`
	`91`	+ Region string `json:"region"`
`90`	`92`	`}`
`91`	`93`
`92`	`94`	`// Visitor represents a visitor of an eventbatch`