refac: Clean up various factory methods to simplify initialization. (#206)

Author: Michael Ng

README.md

@@ -8,7 +8,7 @@
 ### Install from github:
 
 ```$sh
-go install github.com/optimizely/go-sdk
+go get github.com/optimizely/go-sdk
 ```
 
 ### Install from source:
@@ -29,14 +29,14 @@ module mymodule
 go 1.12
 
 require (
-	github.com/optimizely/go-sdk v1.0.0-beta6
+	github.com/optimizely/go-sdk v1.0.0-beta7
 )
 ```
 
 If you are already using `go.mod` in your application you can run the following:
 
 ```
-go mod edit -require github.com/optimizely/[email protected]beta6
+go mod edit -require github.com/optimizely/[email protected]beta7
 ```
 
 NOTE:
@@ -113,3 +113,11 @@ License (MIT): https://github.com/json-iterator/go/blob/master/LICENSE
 subset
 Copyright (c) 2015, Facebook, Inc. All rights reserved.
 License (BSD): https://github.com/facebookarchive/subset/blob/master/license
+
+profile
+Copyright (c) 2013 Dave Cheney. All rights reserved.
+License (BSD): https://github.com/pkg/profile/blob/master/LICENSE
+
+sync
+Copyright (c) 2009 The Go Authors. All rights reserved.
+https://github.com/golang/sync/blob/master/LICENSE

examples/main.go

@@ -70,8 +70,7 @@ func main() {
 	/************* Setting Polling Interval ********************/
 
 	optimizelyClient, _ = optimizelyFactory.Client(
-		client.WithPollingConfigManager(sdkKey, time.Second, nil),
-		client.WithCompositeDecisionService(sdkKey),
+		client.WithPollingConfigManager(time.Second, nil),
 		client.WithBatchEventProcessor(event.DefaultBatchSize, event.DefaultEventQueueSize, event.DefaultEventFlushInterval),
 	)
 	optimizelyClient.Close()

pkg/client/factory.go

@@ -35,6 +35,7 @@ type OptimizelyFactory struct {
 
 	configManager      pkg.ProjectConfigManager
 	decisionService    decision.Service
+	eventDispatcher    event.Dispatcher
 	eventProcessor     event.Processor
 	executionCtx       utils.ExecutionCtx
 	userProfileService decision.UserProfileService
@@ -70,25 +71,25 @@ func (f OptimizelyFactory) Client(clientOptions ...OptionFunc) (*OptimizelyClien
 		appClient.ConfigManager = config.NewPollingProjectConfigManager(
 			f.SDKKey,
 			config.WithInitialDatafile(f.Datafile),
-			config.WithPollingInterval(config.DefaultPollingInterval),
 		)
 	}
 
 	if f.eventProcessor != nil {
 		appClient.EventProcessor = f.eventProcessor
 	} else {
-		appClient.EventProcessor = event.NewBatchEventProcessor(
-			event.WithBatchSize(event.DefaultBatchSize),
-			event.WithQueueSize(event.DefaultEventQueueSize),
-			event.WithFlushInterval(event.DefaultEventFlushInterval),
+		var eventProcessorOptions = []event.BPOptionConfig{
 			event.WithSDKKey(f.SDKKey),
-		)
+		}
+		if f.eventDispatcher != nil {
+			eventProcessorOptions = append(eventProcessorOptions, event.WithEventDispatcher(f.eventDispatcher))
+		}
+		appClient.EventProcessor = event.NewBatchEventProcessor(eventProcessorOptions...)
 	}
 
 	if f.decisionService != nil {
 		appClient.DecisionService = f.decisionService
 	} else {
-		experimentServiceOptions := []decision.CESOptionFunc{}
+		var experimentServiceOptions []decision.CESOptionFunc
 		if f.userProfileService != nil {
 			experimentServiceOptions = append(experimentServiceOptions, decision.WithUserProfileService(f.userProfileService))
 		}
@@ -113,35 +114,20 @@ func (f OptimizelyFactory) Client(clientOptions ...OptionFunc) (*OptimizelyClien
 }
 
 // WithPollingConfigManager sets polling config manager on a client.
-func WithPollingConfigManager(sdkKey string, pollingInterval time.Duration, initDataFile []byte) OptionFunc {
+func WithPollingConfigManager(pollingInterval time.Duration, initDataFile []byte) OptionFunc {
 	return func(f *OptimizelyFactory) {
-		f.configManager = config.NewPollingProjectConfigManager(sdkKey, config.WithInitialDatafile(initDataFile),
+		f.configManager = config.NewPollingProjectConfigManager(f.SDKKey, config.WithInitialDatafile(initDataFile),
 			config.WithPollingInterval(pollingInterval))
 	}
 }
 
-// WithPollingConfigManagerRequester sets polling config manager on a client.
-func WithPollingConfigManagerRequester(requester utils.Requester, pollingInterval time.Duration, initDataFile []byte) OptionFunc {
-	return func(f *OptimizelyFactory) {
-		f.configManager = config.NewPollingProjectConfigManager("", config.WithInitialDatafile(initDataFile),
-			config.WithPollingInterval(pollingInterval), config.WithRequester(requester))
-	}
-}
-
 // WithConfigManager sets polling config manager on a client.
 func WithConfigManager(configManager pkg.ProjectConfigManager) OptionFunc {
 	return func(f *OptimizelyFactory) {
 		f.configManager = configManager
 	}
 }
 
-// WithCompositeDecisionService sets decision service on a client.
-func WithCompositeDecisionService(sdkKey string) OptionFunc {
-	return func(f *OptimizelyFactory) {
-		f.decisionService = decision.NewCompositeService(sdkKey)
-	}
-}
-
 // WithDecisionService sets decision service on a client.
 func WithDecisionService(decisionService decision.Service) OptionFunc {
 	return func(f *OptimizelyFactory) {
@@ -178,6 +164,13 @@ func WithEventProcessor(eventProcessor event.Processor) OptionFunc {
 	}
 }
 
+// WithEventDispatcher sets event dispatcher on the factory.
+func WithEventDispatcher(eventDispatcher event.Dispatcher) OptionFunc {
+	return func(f *OptimizelyFactory) {
+		f.eventDispatcher = eventDispatcher
+	}
+}
+
 // WithExecutionContext allows user to pass in their own execution context to override the default one in the client.
 func WithExecutionContext(executionContext utils.ExecutionCtx) OptionFunc {
 	return func(f *OptimizelyFactory) {
@@ -210,7 +203,6 @@ func (f OptimizelyFactory) StaticClient() (*OptimizelyClient, error) {
 
 	optlyClient, e := f.Client(
 		WithConfigManager(configManager),
-		WithCompositeDecisionService(f.SDKKey),
 		WithBatchEventProcessor(event.DefaultBatchSize, event.DefaultEventQueueSize, event.DefaultEventFlushInterval),
 	)
 	return optlyClient, e

pkg/client/factory_test.go

@@ -74,20 +74,7 @@ func TestClientWithSDKKey(t *testing.T) {
 func TestClientWithPollingConfigManager(t *testing.T) {
 	factory := OptimizelyFactory{}
 
-	optimizelyClient, err := factory.Client(WithPollingConfigManager("1212", time.Hour, nil))
-	assert.NoError(t, err)
-	assert.NotNil(t, optimizelyClient.ConfigManager)
-	assert.NotNil(t, optimizelyClient.DecisionService)
-	assert.NotNil(t, optimizelyClient.EventProcessor)
-}
-
-func TestClientWithPollingConfigManagerRequester(t *testing.T) {
-
-	factory := OptimizelyFactory{}
-	mockRequester := new(MockRequester)
-	mockRequester.On("Get", []utils.Header(nil)).Return([]byte(`{"revision":"42"}`), http.Header{}, http.StatusOK, nil)
-
-	optimizelyClient, err := factory.Client(WithPollingConfigManagerRequester(mockRequester, time.Minute, nil))
+	optimizelyClient, err := factory.Client(WithPollingConfigManager(time.Hour, nil))
 	assert.NoError(t, err)
 	assert.NotNil(t, optimizelyClient.ConfigManager)
 	assert.NotNil(t, optimizelyClient.DecisionService)
@@ -162,3 +149,14 @@ func TestClientWithCustomDecisionServiceOptions(t *testing.T) {
 	assert.NoError(t, err)
 	assert.NotNil(t, optimizelyClient.DecisionService)
 }
+
+func TestClientWithEventDispatcher(t *testing.T) {
+	factory := OptimizelyFactory{SDKKey: "1212"}
+
+	mockEventDispatcher := new(MockDispatcher)
+	optimizelyClient, err := factory.Client(WithEventDispatcher(mockEventDispatcher))
+	assert.NoError(t, err)
+
+	dispatcher := optimizelyClient.EventProcessor.(*event.BatchEventProcessor).EventDispatcher
+	assert.Equal(t, dispatcher, mockEventDispatcher)
+}

pkg/decision/persisting_experiment_service.go

@@ -97,5 +97,6 @@ func (p PersistingExperimentService) saveDecision(userProfile UserProfile, exper
 		}
 		userProfile.ExperimentBucketMap[decisionKey] = decision.Variation.ID
 		p.userProfileService.Save(userProfile)
+		pesLogger.Debug(fmt.Sprintf(`Decision saved for user "%s".`, userProfile.ID))
 	}
 }