Skip to content

FSSDK-8970: Adds support for odp options in config. #366

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yasirfolio3 merged 4 commits into from
Mar 7, 2023
Merged

FSSDK-8970: Adds support for odp options in config. #366

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bb7dd2c
Adds support for odp options in config.yaml
yasirfolio3 Mar 6, 2023
94b0732
Suggested changes made.
yasirfolio3 Mar 7, 2023
e044e10
Added a message.
yasirfolio3 Mar 7, 2023
3fb5d3f
Suggested changes made.
yasirfolio3 Mar 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 23 additions & 2 deletions cmd/optimizely/main_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,12 @@ func assertClient(t *testing.T, actual config.ClientConfig) {
assert.Equal(t, "https://localhost/v1/%s.json", actual.DatafileURLTemplate)
assert.Equal(t, "https://logx.localhost.com/v1", actual.EventURL)
assert.Equal(t, "custom-regex", actual.SdkKeyRegex)
assert.True(t, actual.ODP.Disable)
assert.Equal(t, 5*time.Second, actual.ODP.EventsFlushInterval)
assert.Equal(t, 5*time.Second, actual.ODP.EventsRequestTimeout)
assert.Equal(t, 100, actual.ODP.SegmentsCacheSize)
assert.Equal(t, 1*time.Minute, actual.ODP.SegmentsCacheTimeout)
assert.Equal(t, 5*time.Second, actual.ODP.SegmentsRequestTimeout)

assert.Equal(t, "in-memory", actual.UserProfileService["default"])
userProfileServices := map[string]interface{}{
Expand Down Expand Up @@ -262,8 +268,16 @@ func TestViperProps(t *testing.T) {
"default": "in-memory",
"services": odpCacheServices,
}
v.Set("client.odp.cache", odpCache)

odpConfig := map[string]interface{}{
"disable": true,
"eventsRequestTimeout": 5 * time.Second,
"eventsFlushInterval": 5 * time.Second,
"segmentsCacheSize": 100,
"segmentsCacheTimeout": 1 * time.Minute,
"segmentsRequestTimeout": 5 * time.Second,
"cache": odpCache,
}
v.Set("client.odp", odpConfig)
v.Set("log.pretty", true)
v.Set("log.includeSdkKey", false)
v.Set("log.level", "debug")
Expand Down Expand Up @@ -349,8 +363,15 @@ func TestViperEnv(t *testing.T) {
_ = os.Setenv("OPTIMIZELY_CLIENT_DATAFILEURLTEMPLATE", "https://localhost/v1/%s.json")
_ = os.Setenv("OPTIMIZELY_CLIENT_EVENTURL", "https://logx.localhost.com/v1")
_ = os.Setenv("OPTIMIZELY_CLIENT_SDKKEYREGEX", "custom-regex")

_ = os.Setenv("OPTIMIZELY_CLIENT_USERPROFILESERVICE", `{"default":"in-memory","services":{"in-memory":{"storagestrategy":"fifo"},"redis":{"host":"localhost:6379","password":""},"rest":{"host":"http://localhost","lookuppath":"/ups/lookup","savepath":"/ups/save","headers":{"content-type":"application/json"},"async":true},"custom":{"path":"http://test2.com"}}}`)
_ = os.Setenv("OPTIMIZELY_CLIENT_ODP_CACHE", `{"default":"in-memory","services":{"in-memory":{"size":100,"timeout":5},"redis":{"host":"localhost:6379","password":""},"custom":{"path":"http://test2.com"}}}`)
_ = os.Setenv("OPTIMIZELY_CLIENT_ODP_DISABLE", `true`)
_ = os.Setenv("OPTIMIZELY_CLIENT_ODP_EVENTSREQUESTTIMEOUT", `5s`)
_ = os.Setenv("OPTIMIZELY_CLIENT_ODP_EVENTSFLUSHINTERVAL", `5s`)
_ = os.Setenv("OPTIMIZELY_CLIENT_ODP_SEGMENTSCACHESIZE", `100`)
_ = os.Setenv("OPTIMIZELY_CLIENT_ODP_SEGMENTSCACHETIMEOUT", `1m`)
_ = os.Setenv("OPTIMIZELY_CLIENT_ODP_SEGMENTSREQUESTTIMEOUT", `5s`)

_ = os.Setenv("OPTIMIZELY_LOG_PRETTY", "true")
_ = os.Setenv("OPTIMIZELY_LOG_INCLUDESDKKEY", "false")
Expand Down
6 changes: 6 additions & 0 deletions cmd/optimizely/testdata/default.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,12 @@ client:
custom:
path: "http://test2.com"
odp:
disable: true
eventsRequestTimeout: 5s
eventsFlushInterval: 5s
segmentsCacheSize: 100
segmentsCacheTimeout: 1m
segmentsRequestTimeout: 5s
cache:
default: "in-memory"
services:
Expand Down
13 changes: 13 additions & 0 deletions config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,19 @@ client:
# Content-Type: "application/json"
# Auth-Token: "12345"
odp:
## Disable odp
disable: false
## Timeout in seconds after which event requests will timeout.
eventsRequestTimeout: 10s
## Flush interval in seconds for odp events
eventsFlushInterval: 1s
## Max number of items that can be stored in odp segments cache.
segmentsCacheSize: 10000
## Timeout in seconds after which an item stored in odp segments cache will be deleted.
segmentsCacheTimeout: 600s
## Timeout in seconds after which segment requests will timeout.
segmentsRequestTimeout: 10s
## This will override all other settings
cache:
Copy link
Contributor

@jaeopt jaeopt Mar 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! What about "segmentsCache" instead of "cache" to be consistent with "segmentsCacheSize" and "segmentsCacheTimeout"?

Copy link
Contributor Author

@yasirfolio3 yasirfolio3 Mar 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure, will update this in the parent PR for odp-cache, this is branched off of it.

default: ""
services:
Expand Down
14 changes: 13 additions & 1 deletion config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,12 @@ func NewDefaultConfig() *AgentConfig {
"services": map[string]interface{}{},
},
ODP: OdpConfig{
Disable: false,
EventsRequestTimeout: 10 * time.Second,
EventsFlushInterval: 1 * time.Second,
SegmentsCacheSize: 10000,
SegmentsCacheTimeout: 600 * time.Second,
SegmentsRequestTimeout: 10 * time.Second,
Cache: ODPCacheConfigs{
"default": "",
"services": map[string]interface{}{},
Expand Down Expand Up @@ -177,7 +183,13 @@ type ClientConfig struct {

// OdpConfig holds the odp configuration
type OdpConfig struct {
Cache ODPCacheConfigs `json:"cache"`
EventsRequestTimeout time.Duration `json:"eventsRequestTimeout"`
EventsFlushInterval time.Duration `json:"eventsFlushInterval"`
Disable bool `json:"disable"`
SegmentsCacheSize int `json:"segmentsCacheSize"`
SegmentsCacheTimeout time.Duration `json:"segmentsCacheTimeout"`
SegmentsRequestTimeout time.Duration `json:"segmentsRequestTimeout"`
Cache ODPCacheConfigs `json:"cache"`
}

// LogConfig holds the log configuration
Expand Down
6 changes: 6 additions & 0 deletions config/config_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,12 @@ func TestDefaultConfig(t *testing.T) {
assert.Equal(t, "https://logx.optimizely.com/v1/events", conf.Client.EventURL)
assert.Equal(t, "^\\w+(:\\w+)?$", conf.Client.SdkKeyRegex)
assert.Equal(t, "", conf.Client.UserProfileService["default"])
assert.Equal(t, false, conf.Client.ODP.Disable)
assert.Equal(t, 1*time.Second, conf.Client.ODP.EventsFlushInterval)
assert.Equal(t, 10*time.Second, conf.Client.ODP.EventsRequestTimeout)
assert.Equal(t, 10000, conf.Client.ODP.SegmentsCacheSize)
assert.Equal(t, 600*time.Second, conf.Client.ODP.SegmentsCacheTimeout)
assert.Equal(t, 10*time.Second, conf.Client.ODP.SegmentsRequestTimeout)
assert.Equal(t, map[string]interface{}{}, conf.Client.UserProfileService["services"])
assert.Equal(t, "", conf.Client.ODP.Cache["default"])
assert.Equal(t, map[string]interface{}{}, conf.Client.ODP.Cache["services"])
Expand Down
39 changes: 33 additions & 6 deletions pkg/optimizely/cache.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,9 @@ import (
"github.com/optimizely/go-sdk/pkg/decision"
"github.com/optimizely/go-sdk/pkg/event"
"github.com/optimizely/go-sdk/pkg/odp"
odpEventPkg "github.com/optimizely/go-sdk/pkg/odp/event"
odpSegmentPkg "github.com/optimizely/go-sdk/pkg/odp/segment"
"github.com/optimizely/go-sdk/pkg/utils"

odpCachePkg "github.com/optimizely/go-sdk/pkg/odp/cache"
cmap "github.com/orcaman/concurrent-map"
Expand Down Expand Up @@ -242,6 +244,7 @@ func defaultLoader(
client.WithConfigManager(configManager),
client.WithExperimentOverrides(forcedVariations),
client.WithEventProcessor(ep),
client.WithOdpDisabled(conf.ODP.Disable),
}

var clientUserProfileService decision.UserProfileService
Expand All @@ -262,15 +265,39 @@ func defaultLoader(
// convert odpCache to Cache interface
if convertedODPCache, ok := rawODPCache.(odpCachePkg.Cache); ok && convertedODPCache != nil {
clientODPCache = convertedODPCache
odpSegmentOptions := []odpSegmentPkg.SMOptionFunc{odpSegmentPkg.WithSegmentsCache(clientODPCache)}
segmentManager := odpSegmentPkg.NewSegmentManager(sdkKey, odpSegmentOptions...)
odpOptions := []odp.OMOptionFunc{odp.WithSegmentManager(segmentManager)}
odpManager := odp.NewOdpManager(sdkKey,
false, odpOptions...)
clientOptions = append(clientOptions, client.WithOdpManager(odpManager))
}
}

// Create segment manager with odpConfig and custom cache
segmentManager := odpSegmentPkg.NewSegmentManager(
sdkKey,
odpSegmentPkg.WithAPIManager(
odpSegmentPkg.NewSegmentAPIManager(sdkKey, utils.NewHTTPRequester(nil, utils.Timeout(conf.ODP.SegmentsRequestTimeout))),
),
odpSegmentPkg.WithSegmentsCacheSize(conf.ODP.SegmentsCacheSize),
odpSegmentPkg.WithSegmentsCacheTimeout(conf.ODP.SegmentsCacheTimeout),
odpSegmentPkg.WithSegmentsCache(clientODPCache),
)

// Create event manager with odpConfig
eventManager := odpEventPkg.NewBatchEventManager(
odpEventPkg.WithAPIManager(
odpEventPkg.NewEventAPIManager(
sdkKey, utils.NewHTTPRequester(nil, utils.Timeout(conf.ODP.EventsRequestTimeout)),
),
),
odpEventPkg.WithFlushInterval(conf.ODP.EventsFlushInterval),
)

// Create odp manager with custom segment and event manager
odpManager := odp.NewOdpManager(
sdkKey,
conf.ODP.Disable,
odp.WithSegmentManager(segmentManager),
odp.WithEventManager(eventManager),
)
clientOptions = append(clientOptions, client.WithOdpManager(odpManager))

optimizelyClient, err := optimizelyFactory.Client(
clientOptions...,
)
Expand Down
6 changes: 6 additions & 0 deletions pkg/optimizely/cache_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,12 +407,18 @@ func (s *DefaultLoaderTestSuite) TestDefaultLoader() {
}},
},
ODP: config.OdpConfig{
EventsRequestTimeout: 10 * time.Second,
EventsFlushInterval: 1 * time.Second,
Cache: map[string]interface{}{"default": "in-memory", "services": map[string]interface{}{
"in-memory": map[string]interface{}{
"size": 100,
"timeout": 5,
}},
},
Disable: true,
SegmentsCacheTimeout: 5 * time.Minute,
SegmentsCacheSize: 100,
SegmentsRequestTimeout: 10 * time.Second,
},
}

Expand Down