feat: Add simple client factory method and remove metrics logic (#52)

Author: pawels-optimizely

examples/main.go

@@ -49,15 +49,20 @@ func main() {
 		time.Sleep(1000 * time.Millisecond)
 		fmt.Println("\nending")
 	}
+	fmt.Println()
 
-	/************* ClientWithContext ********************/
+	/************* ClientWithOptions - custom context  ********************/
 
 	optimizelyFactory = &client.OptimizelyFactory{
 		SDKKey: "4SLpaJA1r1pgE6T2CoMs9q",
 	}
 	ctx := context.Background()
 	ctx, cancelManager := context.WithCancel(ctx) // user can set up any context
-	app, err = optimizelyFactory.ClientWithContext(ctx)
+	clientOptions := client.Options{
+		Context: ctx,
+	}
+
+	app, err = optimizelyFactory.ClientWithOptions(clientOptions)
 	cancelManager() //  user can cancel anytime
 
 	if err != nil {
@@ -68,4 +73,23 @@ func main() {
 	enabled, _ = app.IsFeatureEnabled("mutext_feat", user)
 	fmt.Printf("Is feature enabled? %v\n", enabled)
 
+	time.Sleep(1000 * time.Millisecond)
+	fmt.Println()
+
+	/************* Client ********************/
+
+	optimizelyFactory = &client.OptimizelyFactory{
+		SDKKey: "4SLpaJA1r1pgE6T2CoMs9q",
+	}
+
+	app, err = optimizelyFactory.Client()
+	app.Close() //  user can cancel anytime
+
+	if err != nil {
+		fmt.Printf("Error instantiating client: %s", err)
+		return
+	}
+
+	enabled, _ = app.IsFeatureEnabled("mutext_feat", user)
+	fmt.Printf("Is feature enabled? %v\n", enabled)
 }

optimizely/client/client.go

@@ -17,6 +17,7 @@
 package client
 
 import (
+	"context"
 	"errors"
 	"fmt"
 	"reflect"
@@ -35,6 +36,8 @@ type OptimizelyClient struct {
 	configManager   optimizely.ProjectConfigManager
 	decisionService decision.DecisionService
 	isValid         bool
+
+	cancelFunc context.CancelFunc
 }
 
 // IsFeatureEnabled returns true if the feature is enabled for the given user
@@ -89,3 +92,8 @@ func (o *OptimizelyClient) IsFeatureEnabled(featureKey string, userContext entit
 	// @TODO(mng): send impression event
 	return result, nil
 }
+
+// Close closes the Optimizely instance and stops any ongoing tasks from its children components
+func (o *OptimizelyClient) Close() {
+	o.cancelFunc()
+}

optimizely/client/factory.go

@@ -18,25 +18,34 @@ package client
 
 import (
 	"context"
+	"errors"
 	"fmt"
 
 	"github.com/optimizely/go-sdk/optimizely"
 	"github.com/optimizely/go-sdk/optimizely/config"
 	"github.com/optimizely/go-sdk/optimizely/decision"
 )
 
+const datafileURLTemplate = "https://cdn.optimizely.com/datafiles/%s.json"
+
+// Options are used to create an instance of the OptimizelyClient with custom configuration
+type Options struct {
+	Context              context.Context
+	ProjectConfigManager optimizely.ProjectConfigManager
+}
+
 // OptimizelyFactory is used to construct an instance of the OptimizelyClient
 type OptimizelyFactory struct {
 	SDKKey   string
 	Datafile []byte
 }
 
-// StaticClient returns a client initialized with the defaults
+// StaticClient returns a client initialized with a static project config
 func (f OptimizelyFactory) StaticClient() (*OptimizelyClient, error) {
 	var configManager optimizely.ProjectConfigManager
 
 	if f.SDKKey != "" {
-		url := fmt.Sprintf("https://cdn.optimizely.com/datafiles/%s.json", f.SDKKey)
+		url := fmt.Sprintf(datafileURLTemplate, f.SDKKey)
 		staticConfigManager, err := config.NewStaticProjectConfigManagerFromURL(url)
 
 		if err != nil {
@@ -55,33 +64,53 @@ func (f OptimizelyFactory) StaticClient() (*OptimizelyClient, error) {
 		configManager = staticConfigManager
 	}
 
-	decisionService := decision.NewCompositeService()
-	client := OptimizelyClient{
-		decisionService: decisionService,
-		configManager:   configManager,
-		isValid:         true,
+	clientOptions := Options{
+		ProjectConfigManager: configManager,
 	}
-	return &client, nil
+	client, err := f.ClientWithOptions(clientOptions)
+	return client, err
 }
 
-// ClientWithContext returns a client initialized with the defaults
-func (f OptimizelyFactory) ClientWithContext(ctx context.Context) (*OptimizelyClient, error) {
-	var configManager optimizely.ProjectConfigManager
-
-	if f.SDKKey != "" {
-		url := fmt.Sprintf("https://cdn.optimizely.com/datafiles/%s.json", f.SDKKey)
-		request := config.NewRequester(url)
+// ClientWithOptions returns a client initialized with the given configuration options
+func (f OptimizelyFactory) ClientWithOptions(clientOptions Options) (*OptimizelyClient, error) {
+	client := &OptimizelyClient{
+		isValid: false,
+	}
 
-		configManager = config.NewPollingProjectConfigManager(ctx, request, f.Datafile, 0)
+	var ctx context.Context
+	if clientOptions.Context != nil {
+		ctx = clientOptions.Context
+	} else {
+		// if no context is provided, we create our own cancellable context and hand it over to the client so the client can shut down its child processes
+		ctx = context.Background()
+		var cancel context.CancelFunc
+		ctx, cancel = context.WithCancel(ctx)
+		client.cancelFunc = cancel
+	}
 
-		decisionService := decision.NewCompositeService()
-		client := OptimizelyClient{
-			decisionService: decisionService,
-			configManager:   configManager,
-			isValid:         true,
-		}
-		return &client, nil
+	if clientOptions.ProjectConfigManager != nil {
+		client.configManager = clientOptions.ProjectConfigManager
+	} else if f.SDKKey != "" {
+		url := fmt.Sprintf(datafileURLTemplate, f.SDKKey)
+		request := config.NewRequester(url)
+		client.configManager = config.NewPollingProjectConfigManager(ctx, request, f.Datafile, 0)
+	} else if f.Datafile != nil {
+		staticConfigManager, _ := config.NewStaticProjectConfigManagerFromPayload(f.Datafile)
+		client.configManager = staticConfigManager
+	} else {
+		return client, errors.New("unable to instantiate client: no project config manager, SDK key, or a Datafile provided")
 	}
 
-	return nil, fmt.Errorf("Cannot create ClientWithContext")
+	// @TODO: allow decision service to be passed in via options
+	client.decisionService = decision.NewCompositeService()
+	client.isValid = true
+	return client, nil
+}
+
+// Client returns a client initialized with the defaults
+func (f OptimizelyFactory) Client() (*OptimizelyClient, error) {
+	// Creates a default, canceleable context
+	clientOptions := Options{}
+	client, err := f.ClientWithOptions(clientOptions)
+	return client, err
 }

optimizely/client/factory_test.go

@@ -0,0 +1,37 @@
+/****************************************************************************
+ * 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 client
+
+import (
+	"errors"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestClientWithOptionsErrorCase(t *testing.T) {
+	// Error when no config manager, sdk key, or datafile is provided
+	factory := OptimizelyFactory{}
+	clientOptions := Options{}
+
+	client, err := factory.ClientWithOptions(clientOptions)
+	expectedErr := errors.New("unable to instantiate client: no project config manager, SDK key, or a Datafile provided")
+	assert.False(t, client.isValid)
+	if assert.Error(t, err) {
+		assert.Equal(t, err, expectedErr)
+	}
+}

optimizely/config/polling_manager.go

@@ -25,7 +25,6 @@ import (
 	"github.com/optimizely/go-sdk/optimizely"
 	"github.com/optimizely/go-sdk/optimizely/config/datafileprojectconfig"
 	"github.com/optimizely/go-sdk/optimizely/logging"
-	"github.com/optimizely/go-sdk/optimizely/utils"
 )
 
 const defaultPollingWait = time.Duration(5 * time.Minute) // default 5 minutes for polling wait
@@ -35,7 +34,6 @@ var cmLogger = logging.GetLogger("PollingConfigManager")
 // PollingProjectConfigManager maintains a dynamic copy of the project config
 type PollingProjectConfigManager struct {
 	requester     *Requester
-	metrics       *utils.Metrics
 	pollingWait   time.Duration
 	projectConfig optimizely.ProjectConfig
 	configLock    sync.RWMutex
@@ -55,14 +53,12 @@ func (cm *PollingProjectConfigManager) activate(initialPayload []byte, init bool
 			payload, code, e = cm.requester.Get()
 
 			if e != nil {
-				cm.metrics.Inc("bad_http_request")
 				cmLogger.Error(fmt.Sprintf("request returned with http code=%d", code), e)
 			}
 		}
 
 		projectConfig, err := datafileprojectconfig.NewDatafileProjectConfig(payload)
 		if err != nil {
-			cm.metrics.Inc("failed_project_config")
 			cmLogger.Error("failed to create project config", err)
 		}
 
@@ -80,7 +76,6 @@ func (cm *PollingProjectConfigManager) activate(initialPayload []byte, init bool
 		select {
 		case <-t.C:
 			update()
-			cm.metrics.Inc("polls")
 		case <-cm.ctx.Done():
 			cmLogger.Debug("Polling Config Manager Stopped")
 			return
@@ -95,7 +90,7 @@ func NewPollingProjectConfigManager(ctx context.Context, requester *Requester, i
 		pollingWait = defaultPollingWait
 	}
 
-	pollingProjectConfigManager := PollingProjectConfigManager{requester: requester, pollingWait: pollingWait, metrics: utils.NewMetrics(), ctx: ctx}
+	pollingProjectConfigManager := PollingProjectConfigManager{requester: requester, pollingWait: pollingWait, ctx: ctx}
 
 	pollingProjectConfigManager.activate(initialPayload, true) // initial poll
 
@@ -110,8 +105,3 @@ func (cm *PollingProjectConfigManager) GetConfig() optimizely.ProjectConfig {
 	defer cm.configLock.RUnlock()
 	return cm.projectConfig
 }
-
-//GetMetrics returns a string of all metrics
-func (cm *PollingProjectConfigManager) GetMetrics() string {
-	return cm.metrics.String()
-}

optimizely/config/polling_manager_test.go

@@ -18,9 +18,7 @@ package config
 
 import (
 	"context"
-	"log"
 	"testing"
-	"time"
 
 	"github.com/optimizely/go-sdk/optimizely/config/datafileprojectconfig"
 	"github.com/stretchr/testify/assert"
@@ -34,7 +32,6 @@ func TestNewPollingProjectConfigManager(t *testing.T) {
 	// Bad SDK Key test
 	configManager := NewPollingProjectConfigManager(context.Background(), request, []byte{}, 0)
 	assert.Equal(t, projectConfig, configManager.GetConfig())
-	assert.Equal(t, "[bad_http_request:1, failed_project_config:1]", configManager.GetMetrics())
 
 	// Good SDK Key test
 	URL = "https://cdn.optimizely.com/datafiles/4SLpaJA1r1pgE6T2CoMs9q.json"
@@ -44,22 +41,4 @@ func TestNewPollingProjectConfigManager(t *testing.T) {
 
 	assert.Equal(t, "", newConfig.GetAccountID())
 	assert.Equal(t, 4, len(newConfig.GetAudienceMap()))
-	assert.Equal(t, "", configManager.GetMetrics())
-
-}
-
-func TestPollingMetrics(t *testing.T) {
-	URL := "https://cdn.optimizely.com/datafiles/4SLpaJA1r1pgE6T2CoMs9q.json"
-	request := NewRequester(URL)
-
-	// Good SDK Key test -- number of polling
-	ctx := context.Background()
-	ctx, cancel := context.WithCancel(ctx)
-	configManager := NewPollingProjectConfigManager(ctx, request, []byte{}, 5*time.Second)
-	time.Sleep(16 * time.Second)
-	cancel()
-	log.Print("sleeping")
-	time.Sleep(5 * time.Second) // should have picked up another poll, but it is cancelled
-	assert.Equal(t, "[polls:3]", configManager.GetMetrics())
-
 }