Merge pull request #81 from optimizely/pawel/linters-fix

added linter definition file

Author: pawels-optimizely

.golangci.yml

@@ -0,0 +1,72 @@
+linters-settings:
+ govet:
+   check-shadowing: true
+ golint:
+   min-confidence: 0
+ gocyclo:
+   min-complexity: 16
+ maligned:
+   suggest-new: true
+ dupl:
+   threshold: 100
+ goconst:
+   min-len: 2
+   min-occurrences: 2
+ misspell:
+   locale: US
+ lll:
+   line-length: 140
+ gocritic:
+   enabled-tags:
+     - performance
+     - style
+     - experimental
+   disabled-checks:
+     - wrapperFunc
+     - hugeParam
+     - rangeValCopy
+
+linters:
+ disable-all: true
+ enable:
+   - megacheck
+   - golint
+   - govet
+   - unconvert
+   - megacheck
+   - structcheck
+   - gas
+   - gocyclo
+   - dupl
+   - misspell
+   - unparam
+   - varcheck
+   - deadcode
+   - typecheck
+   - ineffassign
+   - varcheck
+   - stylecheck
+   #- gochecknoinits
+   - scopelint
+   - gocritic
+   - golint
+   - nakedret
+   - gosimple
+   - prealloc 
+   - maligned
+ fast: false
+
+run:
+ skip-dirs:
+   - vendor
+ concurrency: 4
+
+issues:
+ exclude-rules:
+   - text: "weak cryptographic primitive"
+     linters:
+       - gosec
+ exclude-use-default: false
+
+service:
+ golangci-lint-version: 1.17.x

optimizely/client/client.go

@@ -14,6 +14,7 @@
  * limitations under the License.                                           *
  ***************************************************************************/
 
+// Package client has client definitions
 package client
 
 import (
@@ -37,7 +38,7 @@ var logger = logging.GetLogger("Client")
 // OptimizelyClient is the entry point to the Optimizely SDK
 type OptimizelyClient struct {
 	configManager   optimizely.ProjectConfigManager
-	decisionService decision.DecisionService
+	decisionService decision.Service
 	eventProcessor  event.Processor
 	isValid         bool
 
@@ -55,15 +56,16 @@ func (o *OptimizelyClient) IsFeatureEnabled(featureKey string, userContext entit
 		}
 	}()
 
-	if isValid, err := o.isValidClient("IsFeatureEnabled"); !isValid {
+	var isValid bool
+	if isValid, err = o.isValidClient("IsFeatureEnabled"); !isValid {
 		return false, err
 	}
 
 	projectConfig := o.configManager.GetConfig()
-	feature, err := projectConfig.GetFeatureByKey(featureKey)
-	if err != nil {
-		logger.Error("Error retrieving feature", err)
-		return result, err
+	feature, e := projectConfig.GetFeatureByKey(featureKey)
+	if e != nil {
+		logger.Error("Error retrieving feature", e)
+		return result, e
 	}
 	featureDecisionContext := decision.FeatureDecisionContext{
 		Feature:       &feature,
@@ -72,14 +74,14 @@ func (o *OptimizelyClient) IsFeatureEnabled(featureKey string, userContext entit
 
 	userID := userContext.ID
 	logger.Debug(fmt.Sprintf(`Evaluating feature "%s" for user "%s".`, featureKey, userID))
-	featureDecision, err := o.decisionService.GetFeatureDecision(featureDecisionContext, userContext)
+	featureDecision, e1 := o.decisionService.GetFeatureDecision(featureDecisionContext, userContext)
 
-	if err != nil {
-		logger.Error("Received an error while computing feature decision", err)
-		return result, err
+	if e1 != nil {
+		logger.Error("received an error while computing feature decision", e1)
+		return result, e1
 	}
 
-	result = (featureDecision.Variation.FeatureEnabled == true)
+	result = featureDecision.Variation.FeatureEnabled
 	if result {
 		logger.Info(fmt.Sprintf(`Feature "%s" is enabled for user "%s".`, featureKey, userID))
 	} else {
@@ -99,7 +101,7 @@ func (o *OptimizelyClient) GetEnabledFeatures(userContext entities.UserContext)
 
 	defer func() {
 		if r := recover(); r != nil {
-			errorMessage := fmt.Sprintf(`Optimizely SDK is panicking with the error "%s"`, string(debug.Stack()))
+			errorMessage := fmt.Sprintf(`optimizely SDK is panicking with the error "%s"`, string(debug.Stack()))
 			err = errors.New(errorMessage)
 			logger.Error(errorMessage, err)
 		}
@@ -125,15 +127,15 @@ func (o *OptimizelyClient) GetEnabledFeatures(userContext entities.UserContext)
 // Track take and event key with event tags and if the event is part of the config, send to events backend.
 func (o *OptimizelyClient) Track(eventKey string, userContext entities.UserContext, eventTags map[string]interface{}) (err error) {
 	if !o.isValid {
-		errorMessage := "Optimizely instance is not valid. Failing GetEnabledFeatures."
+		errorMessage := "optimizely instance is not valid; failing GetEnabledFeatures"
 		err = errors.New(errorMessage)
 		logger.Error(errorMessage, err)
 		return err
 	}
 
 	defer func() {
 		if r := recover(); r != nil {
-			errorMessage := fmt.Sprintf(`Optimizely SDK is panicking with the error "%s"`, string(debug.Stack()))
+			errorMessage := fmt.Sprintf(`optimizely SDK is panicking with the error "%s"`, string(debug.Stack()))
 			err = errors.New(errorMessage)
 			logger.Error(errorMessage, err)
 		}
@@ -145,7 +147,7 @@ func (o *OptimizelyClient) Track(eventKey string, userContext entities.UserConte
 		userEvent := event.CreateConversionUserEvent(o.configManager.GetConfig(), configEvent, userContext, eventTags)
 		o.eventProcessor.ProcessEvent(userEvent)
 	} else {
-		errorMessage := fmt.Sprintf(`Optimizely SDK track: error getting event with key "%s"`, eventKey)
+		errorMessage := fmt.Sprintf(`optimizely SDK track: error getting event with key "%s"`, eventKey)
 		logger.Error(errorMessage, eventError)
 		return eventError
 	}
@@ -154,82 +156,83 @@ func (o *OptimizelyClient) Track(eventKey string, userContext entities.UserConte
 }
 
 // GetFeatureVariableBoolean returns boolean feature variable value
-func (o *OptimizelyClient) GetFeatureVariableBoolean(featureKey string, variableKey string, userContext entities.UserContext) (value bool, err error) {
+func (o *OptimizelyClient) GetFeatureVariableBoolean(featureKey, variableKey string, userContext entities.UserContext) (value bool, err error) {
 	val, valueType, err := o.getFeatureVariable(featureKey, variableKey, userContext)
 	if err != nil {
 		return false, err
 	}
 	convertedValue, err := strconv.ParseBool(val)
 	if err != nil || valueType != entities.Boolean {
-		return false, fmt.Errorf("Variable value for key %s is invalid or wrong type", variableKey)
+		return false, fmt.Errorf("variable value for key %s is invalid or wrong type", variableKey)
 	}
 	return convertedValue, err
 }
 
 // GetFeatureVariableDouble returns double feature variable value
-func (o *OptimizelyClient) GetFeatureVariableDouble(featureKey string, variableKey string, userContext entities.UserContext) (value float64, err error) {
+func (o *OptimizelyClient) GetFeatureVariableDouble(featureKey, variableKey string, userContext entities.UserContext) (value float64, err error) {
 	val, valueType, err := o.getFeatureVariable(featureKey, variableKey, userContext)
 	if err != nil {
 		return 0, err
 	}
 	convertedValue, err := strconv.ParseFloat(val, 64)
 	if err != nil || valueType != entities.Double {
-		return 0, fmt.Errorf("Variable value for key %s is invalid or wrong type", variableKey)
+		return 0, fmt.Errorf("variable value for key %s is invalid or wrong type", variableKey)
 	}
 	return convertedValue, err
 }
 
 // GetFeatureVariableInteger returns integer feature variable value
-func (o *OptimizelyClient) GetFeatureVariableInteger(featureKey string, variableKey string, userContext entities.UserContext) (value int, err error) {
+func (o *OptimizelyClient) GetFeatureVariableInteger(featureKey, variableKey string, userContext entities.UserContext) (value int, err error) {
 	val, valueType, err := o.getFeatureVariable(featureKey, variableKey, userContext)
 	if err != nil {
 		return 0, err
 	}
 	convertedValue, err := strconv.Atoi(val)
 	if err != nil || valueType != entities.Integer {
-		return 0, fmt.Errorf("Variable value for key %s is invalid or wrong type", variableKey)
+		return 0, fmt.Errorf("variable value for key %s is invalid or wrong type", variableKey)
 	}
 	return convertedValue, err
 }
 
 // GetFeatureVariableString returns string feature variable value
-func (o *OptimizelyClient) GetFeatureVariableString(featureKey string, variableKey string, userContext entities.UserContext) (value string, err error) {
+func (o *OptimizelyClient) GetFeatureVariableString(featureKey, variableKey string, userContext entities.UserContext) (value string, err error) {
 	value, valueType, err := o.getFeatureVariable(featureKey, variableKey, userContext)
 	if err != nil {
 		return "", err
 	}
 	if valueType != entities.String {
-		return "", fmt.Errorf("Variable value for key %s is wrong type", variableKey)
+		return "", fmt.Errorf("variable value for key %s is wrong type", variableKey)
 	}
 	return value, err
 }
 
-func (o *OptimizelyClient) getFeatureVariable(featureKey string, variableKey string, userContext entities.UserContext) (value string, valueType entities.VariableType, err error) {
+func (o *OptimizelyClient) getFeatureVariable(featureKey, variableKey string, userContext entities.UserContext) (value string, valueType entities.VariableType, err error) {
 
 	defer func() {
 		if r := recover(); r != nil {
-			errorMessage := fmt.Sprintf(`Optimizely SDK is panicking with the error "%s"`, string(debug.Stack()))
+			errorMessage := fmt.Sprintf(`optimizely SDK is panicking with the error "%s"`, string(debug.Stack()))
 			err = errors.New(errorMessage)
 			logger.Error(errorMessage, err)
 		}
 	}()
 
-	if isValid, err := o.isValidClient("getFeatureVariable"); !isValid {
+	var isValid bool
+	if isValid, err = o.isValidClient("getFeatureVariable"); !isValid {
 		return "", "", err
 	}
 
 	projectConfig := o.configManager.GetConfig()
 
-	feature, err := projectConfig.GetFeatureByKey(featureKey)
-	if err != nil {
-		logger.Error("Error retrieving feature", err)
-		return "", "", err
+	feature, e := projectConfig.GetFeatureByKey(featureKey)
+	if e != nil {
+		logger.Error("error retrieving feature", e)
+		return "", "", e
 	}
 
-	variable, err := projectConfig.GetVariableByKey(featureKey, variableKey)
-	if err != nil {
-		logger.Error("Error retrieving variable", err)
-		return "", "", err
+	variable, e1 := projectConfig.GetVariableByKey(featureKey, variableKey)
+	if e1 != nil {
+		logger.Error("error retrieving variable", e1)
+		return "", "", e1
 	}
 
 	var featureValue = variable.DefaultValue
@@ -239,8 +242,8 @@ func (o *OptimizelyClient) getFeatureVariable(featureKey string, variableKey str
 		ProjectConfig: projectConfig,
 	}
 
-	featureDecision, err := o.decisionService.GetFeatureDecision(featureDecisionContext, userContext)
-	if err == nil {
+	featureDecision, e2 := o.decisionService.GetFeatureDecision(featureDecisionContext, userContext)
+	if e2 == nil {
 		if v, ok := featureDecision.Variation.Variables[variable.ID]; ok && featureDecision.Variation.FeatureEnabled {
 			featureValue = v.Value
 		}
@@ -252,7 +255,7 @@ func (o *OptimizelyClient) getFeatureVariable(featureKey string, variableKey str
 
 func (o *OptimizelyClient) isValidClient(methodName string) (result bool, err error) {
 	if !o.isValid {
-		errorMessage := fmt.Sprintf("Optimizely instance is not valid. Failing %s.", methodName)
+		errorMessage := fmt.Sprintf("optimizely instance is not valid. Failing %s.", methodName)
 		err := errors.New(errorMessage)
 		logger.Error(errorMessage, nil)
 		return false, err

optimizely/client/client_test.go

@@ -63,7 +63,7 @@ func (p *MockProjectConfigManager) GetConfig() optimizely.ProjectConfig {
 }
 
 type MockDecisionService struct {
-	decision.DecisionService
+	decision.Service
 	mock.Mock
 }
 

optimizely/client/factory.go

@@ -14,6 +14,7 @@
  * limitations under the License.                                           *
  ***************************************************************************/
 
+// Package client has client facing factories
 package client
 
 import (
@@ -35,7 +36,7 @@ import (
 type Options struct {
 	Context              context.Context
 	ProjectConfigManager optimizely.ProjectConfigManager
-	DecisionService      decision.DecisionService
+	DecisionService      decision.Service
 }
 
 // OptimizelyFactory is used to construct an instance of the OptimizelyClient
@@ -97,17 +98,18 @@ func (f OptimizelyFactory) ClientWithOptions(clientOptions Options) (*Optimizely
 
 	notificationCenter := notification.NewNotificationCenter()
 
-	if clientOptions.ProjectConfigManager != nil {
+	switch {
+	case clientOptions.ProjectConfigManager != nil:
 		client.configManager = clientOptions.ProjectConfigManager
-	} else if f.SDKKey != "" {
+	case f.SDKKey != "":
 		options := config.PollingProjectConfigManagerOptions{
 			Datafile: f.Datafile,
 		}
 		client.configManager = config.NewPollingProjectConfigManagerWithOptions(ctx, f.SDKKey, options)
-	} else if f.Datafile != nil {
+	case f.Datafile != nil:
 		staticConfigManager, _ := config.NewStaticProjectConfigManagerFromPayload(f.Datafile)
 		client.configManager = staticConfigManager
-	} else {
+	default:
 		return client, errors.New("unable to instantiate client: no project config manager, SDK key, or a Datafile provided")
 	}
 

optimizely/config/datafileprojectconfig/config.go

@@ -14,6 +14,7 @@
  * limitations under the License.                                           *
  ***************************************************************************/
 
+// Package datafileprojectconfig //
 package datafileprojectconfig
 
 import (
@@ -30,19 +31,19 @@ var logger = logging.GetLogger("DatafileProjectConfig")
 // DatafileProjectConfig is a project config backed by a datafile
 type DatafileProjectConfig struct {
 	accountID            string
-	anonymizeIP          bool
-	attributeKeyToIDMap  map[string]string
+	projectID            string
+	revision             string
+	experimentKeyToIDMap map[string]string
 	audienceMap          map[string]entities.Audience
 	attributeMap         map[string]entities.Attribute
-	botFiltering         bool
 	eventMap             map[string]entities.Event
-	experimentKeyToIDMap map[string]string
+	attributeKeyToIDMap  map[string]string
 	experimentMap        map[string]entities.Experiment
 	featureMap           map[string]entities.Feature
 	groupMap             map[string]entities.Group
-	projectID            string
-	revision             string
 	rolloutMap           map[string]entities.Rollout
+	anonymizeIP          bool
+	botFiltering         bool
 }
 
 // GetProjectID returns projectID
@@ -122,10 +123,10 @@ func (c DatafileProjectConfig) GetFeatureByKey(featureKey string) (entities.Feat
 }
 
 // GetVariableByKey returns the featureVariable with the given key
-func (c DatafileProjectConfig) GetVariableByKey(featureKey string, variableKey string) (entities.Variable, error) {
+func (c DatafileProjectConfig) GetVariableByKey(featureKey, variableKey string) (entities.Variable, error) {
 
 	var variable entities.Variable
-	var err = fmt.Errorf("Variable with key %s not found", featureKey)
+	var err = fmt.Errorf("variable with key %s not found", featureKey)
 	if feature, ok := c.featureMap[featureKey]; ok {
 		for _, v := range feature.Variables {
 			if v.Key == variableKey {