feat: added GetFeatureVariableJSON and GetAllFeatureVariables (#251)

* feat: added GetFeatureVariableJSON and GetAllFeatureVariables

Author: pawels-optimizely

.travis.yml

@@ -55,6 +55,8 @@ jobs:
         # Need to download packages explicitly
         - mkdir $GOPATH/src/github.com/twmb && cd $GOPATH/src/github.com/twmb && git clone https://github.com/twmb/murmur3.git && cd $TRAVIS_BUILD_DIR
         - pushd $GOPATH/src/github.com/twmb/murmur3 && git checkout v1.0.0 && popd
+        - mkdir $GOPATH/src/github.com/hashicorp && cd $GOPATH/src/github.com/hashicorp && git clone https://github.com/hashicorp/go-multierror.git && cd $TRAVIS_BUILD_DIR
+        - pushd $GOPATH/src/github.com/hashicorp/go-multierror && git checkout v1.0.0 && popd
         - go get -v -d ./...
         # This pkg not in go 1.10
         - go get github.com/stretchr/testify

go.mod

@@ -4,6 +4,7 @@ go 1.12
 
 require (
 	github.com/google/uuid v1.1.1
+	github.com/hashicorp/go-multierror v1.1.0
 	github.com/json-iterator/go v1.1.7
 	github.com/pkg/errors v0.8.1
 	github.com/pkg/profile v1.3.0

go.sum

@@ -11,6 +11,10 @@ github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMo
 github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
 github.com/google/uuid v1.1.1 h1:Gkbcsh/GbpXz7lPftLA3P6TYMwjCLYm83jiFQZF/3gY=
 github.com/google/uuid v1.1.1/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
+github.com/hashicorp/errwrap v1.0.0 h1:hLrqtEDnRye3+sgx6z4qVLNuviH3MR5aQ0ykNJa/UYA=
+github.com/hashicorp/errwrap v1.0.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4=
+github.com/hashicorp/go-multierror v1.1.0 h1:B9UzwGQJehnUY1yNrnwREHc3fGbC2xefo8g4TbElacI=
+github.com/hashicorp/go-multierror v1.1.0/go.mod h1:spPvp8C1qA32ftKqdAHm4hHTbPw+vmowP0z+KUhOZdA=
 github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ=
 github.com/inconshreveable/mousetrap v1.0.0 h1:Z8tu5sraLXCXIcARxBp/8cbvlwVa7Z1NHg9XEKhtSvM=
 github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=

pkg/client/client.go

@@ -30,7 +30,10 @@ import (
 	"github.com/optimizely/go-sdk/pkg/event"
 	"github.com/optimizely/go-sdk/pkg/logging"
 	"github.com/optimizely/go-sdk/pkg/notification"
+	"github.com/optimizely/go-sdk/pkg/optimizelyjson"
 	"github.com/optimizely/go-sdk/pkg/utils"
+
+	"github.com/hashicorp/go-multierror"
 )
 
 // OptimizelyClient is the entry point to the Optimizely SDK
@@ -215,6 +218,22 @@ func (o *OptimizelyClient) GetFeatureVariableString(featureKey, variableKey stri
 	return value, err
 }
 
+// GetFeatureVariableJSON returns the feature variable value of type json associated with the given feature and variable keys.
+func (o *OptimizelyClient) GetFeatureVariableJSON(featureKey, variableKey string, userContext entities.UserContext) (value *optimizelyjson.OptimizelyJSON, err error) {
+
+	val, valueType, err := o.GetFeatureVariable(featureKey, variableKey, userContext)
+	if err != nil {
+		return value, err
+	}
+
+	value, err = optimizelyjson.NewOptimizelyJSONfromString(val)
+	if err != nil || valueType != entities.JSON {
+		return nil, fmt.Errorf("variable value for key %s is invalid or wrong type", variableKey)
+	}
+
+	return value, err
+}
+
 // GetFeatureVariable returns feature variable as a string along with it's associated type.
 func (o *OptimizelyClient) GetFeatureVariable(featureKey, variableKey string, userContext entities.UserContext) (value string, valueType entities.VariableType, err error) {
 
@@ -234,8 +253,8 @@ func (o *OptimizelyClient) GetFeatureVariable(featureKey, variableKey string, us
 	return variable.DefaultValue, variable.Type, err
 }
 
-// GetAllFeatureVariables returns all the variables for a given feature along with the enabled state.
-func (o *OptimizelyClient) GetAllFeatureVariables(featureKey string, userContext entities.UserContext) (enabled bool, variableMap map[string]interface{}, err error) {
+// GetAllFeatureVariablesWithDecision returns all the variables for a given feature along with the enabled state.
+func (o *OptimizelyClient) GetAllFeatureVariablesWithDecision(featureKey string, userContext entities.UserContext) (enabled bool, variableMap map[string]interface{}, err error) {
 
 	variableMap = make(map[string]interface{})
 	decisionContext, featureDecision, err := o.getFeatureDecision(featureKey, "", userContext)
@@ -254,6 +273,8 @@ func (o *OptimizelyClient) GetAllFeatureVariables(featureKey string, userContext
 		return enabled, variableMap, nil
 	}
 
+	errs := new(multierror.Error)
+
 	for _, v := range feature.VariableMap {
 		val := v.DefaultValue
 
@@ -268,10 +289,17 @@ func (o *OptimizelyClient) GetAllFeatureVariables(featureKey string, userContext
 		switch varType := v.Type; varType {
 		case entities.Boolean:
 			out, err = strconv.ParseBool(val)
+			errs = multierror.Append(errs, err)
 		case entities.Double:
 			out, err = strconv.ParseFloat(val, 64)
+			errs = multierror.Append(errs, err)
 		case entities.Integer:
 			out, err = strconv.Atoi(val)
+			errs = multierror.Append(errs, err)
+		case entities.JSON:
+			var optlyJSON, err = optimizelyjson.NewOptimizelyJSONfromString(val)
+			out = optlyJSON.ToMap()
+			errs = multierror.Append(errs, err)
 		case entities.String:
 		default:
 			o.logger.Warning(fmt.Sprintf(`type "%s" is unknown, returning string`, varType))
@@ -280,7 +308,17 @@ func (o *OptimizelyClient) GetAllFeatureVariables(featureKey string, userContext
 		variableMap[v.Key] = out
 	}
 
-	return enabled, variableMap, err
+	return enabled, variableMap, errs.ErrorOrNil()
+}
+
+// GetAllFeatureVariables returns all the variables as OptimizelyJSON object for a given feature.
+func (o *OptimizelyClient) GetAllFeatureVariables(featureKey string, userContext entities.UserContext) (optlyJSON *optimizelyjson.OptimizelyJSON, err error) {
+	_, variableMap, err := o.GetAllFeatureVariablesWithDecision(featureKey, userContext)
+	if err != nil {
+		return optlyJSON, err
+	}
+	optlyJSON = optimizelyjson.NewOptimizelyJSONfromMap(variableMap)
+	return optlyJSON, nil
 }
 
 // GetVariation returns the key of the variation the user is bucketed into. Does not generate impression events.