add Get*Assignment methods with types (FF-757) (#22)

* add Get*Assignment methods with types (FF-757)

* consistent golang version 1.19; version 2.0.0

* simpler unit test

Author: leoromanovsky

.github/workflows/golang-lint.yml

@@ -17,7 +17,7 @@ jobs:
     steps:
       - uses: actions/setup-go@v3
         with:
-          go-version: '1.18'
+          go-version: '1.19'
       - uses: actions/checkout@v3
       - name: golangci-lint
         uses: golangci/golangci-lint-action@v3

.github/workflows/test-sdk.yml

@@ -10,7 +10,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-go@v3
         with:
-          go-version: 1.18
+          go-version: 1.19
       - name: Build
         run: go build -v ./...
       - name: 'Set up GCP SDK for downloading test data'

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Get Eppo
+Copyright (c) 2023 Eppo Data
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -17,7 +17,7 @@ testDataDir := eppoclient/test-data/
 test-data:
 	rm -rf $(testDataDir)
 	mkdir -p $(testDataDir)
-	gsutil cp gs://sdk-test-data/rac-experiments-v2.json $(testDataDir)
+	gsutil cp gs://sdk-test-data/rac-experiments-v3.json $(testDataDir)
 	gsutil cp -r gs://sdk-test-data/assignment-v2 $(testDataDir)
 
 test: test-data

README.md

@@ -1,14 +1,14 @@
 # Eppo SDK for Golang
 
-Eppoclient is a client sdk for `eppo.cloud` randomization API.
+EppoClient is a client sdk for the `eppo.cloud` randomization API.
 It is used to retrieve the experiments data and put it to in-memory cache, and then get assignments information.
 
 ## Getting Started
 
 Refer to our [SDK documentation](https://docs.geteppo.com/feature-flags/sdks/server-sdks/go) for how to install and use the SDK.
 
 ## Supported Go Versions
-This version of the SDK is compatible with Go v1.18 and above.
+This version of the SDK is compatible with Go v1.19 and above.
 
 ## Example
 
@@ -28,7 +28,7 @@ This version of the SDK is compatible with Go v1.18 and above.
 	}
 
 	func someBLFunc() {
-		assignment, _ := eppoClient.GetAssignment("subject-1", "experiment_5", sbjAttrs)
+		assignment, _ := eppoClient.GetStringAssignment("subject-1", "experiment_5", sbjAttrs)
 
 		if assignment == "control" {
 			// do something

eppoclient/assignmentlogger.go

@@ -8,7 +8,7 @@ type IAssignmentLogger interface {
 
 type AssignmentEvent struct {
 	Experiment        string
-	Variation         string
+	Variation         Value
 	Subject           string
 	Timestamp         string
 	SubjectAttributes dictionary

eppoclient/client.go

@@ -28,7 +28,27 @@ func newEppoClient(configRequestor iConfigRequestor, assignmentLogger IAssignmen
 	return ec
 }
 
-func (ec *EppoClient) GetAssignment(subjectKey string, flagKey string, subjectAttributes dictionary) (string, error) {
+func (ec *EppoClient) GetBoolAssignment(subjectKey string, flagKey string, subjectAttributes dictionary) (bool, error) {
+	variation, err := ec.getAssignment(subjectKey, flagKey, subjectAttributes, BoolType)
+	return variation.boolValue, err
+}
+
+func (ec *EppoClient) GetNumericAssignment(subjectKey string, flagKey string, subjectAttributes dictionary) (float64, error) {
+	variation, err := ec.getAssignment(subjectKey, flagKey, subjectAttributes, NumericType)
+	return variation.numericValue, err
+}
+
+func (ec *EppoClient) GetStringAssignment(subjectKey string, flagKey string, subjectAttributes dictionary) (string, error) {
+	variation, err := ec.getAssignment(subjectKey, flagKey, subjectAttributes, StringType)
+	return variation.stringValue, err
+}
+
+func (ec *EppoClient) GetJSONAssignment(subjectKey string, flagKey string, subjectAttributes dictionary) (string, error) {
+	variation, err := ec.getAssignment(subjectKey, flagKey, subjectAttributes, StringType)
+	return variation.stringValue, err
+}
+
+func (ec *EppoClient) getAssignment(subjectKey string, flagKey string, subjectAttributes dictionary, valueType ValueType) (Value, error) {
 	if subjectKey == "" {
 		panic("no subject key provided")
 	}
@@ -39,30 +59,29 @@ func (ec *EppoClient) GetAssignment(subjectKey string, flagKey string, subjectAt
 
 	config, err := ec.configRequestor.GetConfiguration(flagKey)
 	if err != nil {
-		return "", err
+		return Null(), err
 	}
 
-	override := getSubjectVariationOverride(config, subjectKey)
-
-	if override != "" {
+	override := getSubjectVariationOverride(config, subjectKey, valueType)
+	if override != Null() {
 		return override, nil
 	}
 
 	// Check if disabled
 	if !config.Enabled {
-		return "", errors.New("the experiment or flag is not enabled")
+		return Null(), errors.New("the experiment or flag is not enabled")
 	}
 
 	// Find matching rule
 	rule, err := findMatchingRule(subjectAttributes, config.Rules)
 	if err != nil {
-		return "", err
+		return Null(), err
 	}
 
 	// Check if in sample population
 	allocation := config.Allocations[rule.AllocationKey]
 	if !isInExperimentSample(subjectKey, flagKey, config.SubjectShards, allocation.PercentExposure) {
-		return "", errors.New("subject not part of the sample population")
+		return Null(), errors.New("subject not part of the sample population")
 	}
 
 	// Get assigned variation
@@ -77,7 +96,7 @@ func (ec *EppoClient) GetAssignment(subjectKey string, flagKey string, subjectAt
 		}
 	}
 
-	assignedVariation := variationShard.Value.StringValue()
+	assignedVariation := variationShard.Value
 
 	assignmentEvent := AssignmentEvent{
 		Experiment:        flagKey,
@@ -108,15 +127,15 @@ func (ec *EppoClient) GetAssignment(subjectKey string, flagKey string, subjectAt
 	return assignedVariation, nil
 }
 
-func getSubjectVariationOverride(experimentConfig experimentConfiguration, subject string) string {
+func getSubjectVariationOverride(experimentConfig experimentConfiguration, subject string, valueType ValueType) Value {
 	hash := md5.Sum([]byte(subject))
 	hashOutput := hex.EncodeToString(hash[:])
 
 	if val, ok := experimentConfig.Overrides[hashOutput]; ok {
-		return val.(string)
+		return val
 	}
 
-	return ""
+	return Null()
 }
 
 func isInExperimentSample(subjectKey string, flagKey string, subjectShards int, percentExposure float32) bool {

eppoclient/client_test.go

@@ -17,7 +17,7 @@ func Test_AssignBlankExperiment(t *testing.T) {
 	client := newEppoClient(mockConfigRequestor, mockLogger)
 
 	assert.Panics(t, func() {
-		_, err := client.GetAssignment("subject-1", "", dictionary{})
+		_, err := client.GetStringAssignment("subject-1", "", dictionary{})
 		if err != nil {
 			log.Println(err)
 		}
@@ -30,7 +30,7 @@ func Test_AssignBlankSubject(t *testing.T) {
 	client := newEppoClient(mockConfigRequestor, mockLogger)
 
 	assert.Panics(t, func() {
-		_, err := client.GetAssignment("", "experiment-1", dictionary{})
+		_, err := client.GetStringAssignment("", "experiment-1", dictionary{})
 		if err != nil {
 			log.Println(err)
 		}
@@ -40,7 +40,7 @@ func Test_AssignBlankSubject(t *testing.T) {
 func Test_SubjectNotInSample(t *testing.T) {
 	var mockLogger = new(mockLogger)
 	var mockConfigRequestor = new(mockConfigRequestor)
-	overrides := make(dictionary)
+	overrides := make(map[string]Value)
 	var mockVariations = []Variation{
 		{Name: "control", Value: String("control"), ShardRange: shardRange{Start: 0, End: 10000}},
 	}
@@ -62,7 +62,7 @@ func Test_SubjectNotInSample(t *testing.T) {
 
 	client := newEppoClient(mockConfigRequestor, mockLogger)
 
-	assignment, err := client.GetAssignment("user-1", "experiment-key-1", dictionary{})
+	assignment, err := client.GetStringAssignment("user-1", "experiment-key-1", dictionary{})
 
 	assert.Equal(t, "", assignment)
 	assert.NotNil(t, err)
@@ -73,7 +73,7 @@ func Test_LogAssignment(t *testing.T) {
 	mockLogger.Mock.On("LogAssignment", mock.Anything).Return()
 
 	var mockConfigRequestor = new(mockConfigRequestor)
-	overrides := make(dictionary)
+	overrides := make(map[string]Value)
 
 	var mockVariations = []Variation{
 		{Name: "control", Value: String("control"), ShardRange: shardRange{Start: 0, End: 10000}},
@@ -95,20 +95,20 @@ func Test_LogAssignment(t *testing.T) {
 
 	client := newEppoClient(mockConfigRequestor, mockLogger)
 
-	assignment, err := client.GetAssignment("user-1", "experiment-key-1", dictionary{})
+	assignment, err := client.GetStringAssignment("user-1", "experiment-key-1", dictionary{})
 	expected := "control"
 
 	assert.Nil(t, err)
 	assert.Equal(t, expected, assignment)
 	mockLogger.AssertNumberOfCalls(t, "LogAssignment", 1)
 }
 
-func Test_GetAssignmentHandlesLoggingPanic(t *testing.T) {
+func Test_GetStringAssignmentHandlesLoggingPanic(t *testing.T) {
 	var mockLogger = new(mockLogger)
 	mockLogger.Mock.On("LogAssignment", mock.Anything).Panic("logging panic")
 
 	var mockConfigRequestor = new(mockConfigRequestor)
-	overrides := make(dictionary)
+	overrides := make(map[string]Value)
 
 	var mockVariations = []Variation{
 		{Name: "control", Value: String("control"), ShardRange: shardRange{Start: 0, End: 10000}},
@@ -130,7 +130,7 @@ func Test_GetAssignmentHandlesLoggingPanic(t *testing.T) {
 
 	client := newEppoClient(mockConfigRequestor, mockLogger)
 
-	assignment, err := client.GetAssignment("user-1", "experiment-key-1", dictionary{})
+	assignment, err := client.GetStringAssignment("user-1", "experiment-key-1", dictionary{})
 	expected := "control"
 
 	assert.Nil(t, err)
@@ -144,7 +144,7 @@ func Test_AssignSubjectWithAttributesAndRules(t *testing.T) {
 	var matchesEmailCondition = condition{Operator: "MATCHES", Value: ".*@eppo.com", Attribute: "email"}
 	var textRule = rule{AllocationKey: defaultAllocationKey, Conditions: []condition{matchesEmailCondition}}
 	var mockConfigRequestor = new(mockConfigRequestor)
-	var overrides = make(dictionary)
+	overrides := make(map[string]Value)
 	var mockVariations = []Variation{
 		{Name: "control", Value: String("control"), ShardRange: shardRange{Start: 0, End: 10000}},
 	}
@@ -181,42 +181,77 @@ func Test_AssignSubjectWithAttributesAndRules(t *testing.T) {
 	client := newEppoClient(mockConfigRequestor, mockLogger)
 
 	for _, tt := range tests {
-		assignment, _ := client.GetAssignment(tt.a, tt.b, tt.c)
+		assignment, _ := client.GetStringAssignment(tt.a, tt.b, tt.c)
 
 		assert.Equal(t, tt.want, assignment)
 	}
 }
 
 func Test_WithSubjectInOverrides(t *testing.T) {
-	var mockLogger = new(mockLogger)
-	mockLogger.Mock.On("LogAssignment", mock.Anything).Return()
-
-	var mockConfigRequestor = new(mockConfigRequestor)
-	var mockVariations = []Variation{
-		{Name: "control", ShardRange: shardRange{Start: 0, End: 100}},
-	}
-	var overrides = make(dictionary)
-	overrides["d6d7705392bc7af633328bea8c4c6904"] = "override-variation"
-	var allocations = make(map[string]Allocation)
-	allocations[defaultAllocationKey] = Allocation{
-		PercentExposure: 1,
-		Variations:      mockVariations,
-	}
-	var mockResult = experimentConfiguration{
-		Name:          "recommendation_algo",
-		Enabled:       true,
-		SubjectShards: 1000,
-		Overrides:     overrides,
-		Rules:         []rule{textRule},
+	var tests = []struct {
+		name                        string
+		inputVariationOverrideValue Value
+		inputValueType              ValueType
+		want                        Value
+	}{
+		{"string override", String("variation-value"), StringType, String("variation-value")},
+		{"numeric override", Numeric(5), NumericType, Numeric(5)},
+		{"boolean override", Bool(true), BoolType, Bool(true)},
 	}
 
-	mockConfigRequestor.Mock.On("GetConfiguration", "experiment-key-1").Return(mockResult, nil)
-
-	client := newEppoClient(mockConfigRequestor, mockLogger)
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+
+			var mockLogger = new(mockLogger)
+			mockLogger.Mock.On("LogAssignment", mock.Anything).Return()
+
+			var mockConfigRequestor = new(mockConfigRequestor)
+			var mockVariations = []Variation{
+				{Name: "control", ShardRange: shardRange{Start: 0, End: 100}},
+			}
+			overrides := make(map[string]Value)
+			overrides["d6d7705392bc7af633328bea8c4c6904"] = tt.inputVariationOverrideValue
+			var allocations = make(map[string]Allocation)
+			allocations[defaultAllocationKey] = Allocation{
+				PercentExposure: 1,
+				Variations:      mockVariations,
+			}
+			var mockResult = experimentConfiguration{
+				Name:          "recommendation_algo",
+				Enabled:       true,
+				SubjectShards: 1000,
+				Overrides:     overrides,
+				Rules:         []rule{textRule},
+			}
+
+			mockConfigRequestor.Mock.On("GetConfiguration", "experiment-key-1").Return(mockResult, nil)
+
+			client := newEppoClient(mockConfigRequestor, mockLogger)
+
+			switch tt.inputValueType {
+			case StringType:
+				assignment, _ := client.GetStringAssignment("user-1", "experiment-key-1", dictionary{})
+
+				if assignment != tt.want.stringValue {
+					t.Errorf("got %s, want %s", assignment, tt.want.stringValue)
+				}
+			case NumericType:
+				assignment, _ := client.GetNumericAssignment("user-1", "experiment-key-1", dictionary{})
+
+				if assignment != tt.want.numericValue {
+					t.Errorf("got %T, want %T", assignment, tt.want.numericValue)
+				}
+			case BoolType:
+				assignment, _ := client.GetBoolAssignment("user-1", "experiment-key-1", dictionary{})
+
+				if assignment != tt.want.boolValue {
+					t.Errorf("got %t, want %t", assignment, tt.want.boolValue)
+				}
+
+			}
+		})
+	}
 
-	expected := "override-variation"
-	assignment, _ := client.GetAssignment("user-1", "experiment-key-1", dictionary{})
-	assert.Equal(t, expected, assignment)
 }
 
 func Test_WithSubjectInOverridesExpDisabled(t *testing.T) {
@@ -227,8 +262,8 @@ func Test_WithSubjectInOverridesExpDisabled(t *testing.T) {
 	var mockVariations = []Variation{
 		{Name: "control", ShardRange: shardRange{Start: 0, End: 100}},
 	}
-	var overrides = make(dictionary)
-	overrides["d6d7705392bc7af633328bea8c4c6904"] = "override-variation"
+	overrides := make(map[string]Value)
+	overrides["d6d7705392bc7af633328bea8c4c6904"] = String("override-variation")
 	var allocations = make(map[string]Allocation)
 	allocations[defaultAllocationKey] = Allocation{
 		PercentExposure: 1,
@@ -248,7 +283,7 @@ func Test_WithSubjectInOverridesExpDisabled(t *testing.T) {
 	client := newEppoClient(mockConfigRequestor, mockLogger)
 
 	expected := "override-variation"
-	assignment, err := client.GetAssignment("user-1", "experiment-key-1", dictionary{})
+	assignment, err := client.GetStringAssignment("user-1", "experiment-key-1", dictionary{})
 
 	assert.Nil(t, err)
 	assert.Equal(t, expected, assignment)
@@ -264,7 +299,7 @@ func Test_WithNullExpConfig(t *testing.T) {
 	client := newEppoClient(mockConfigRequestor, mockLogger)
 
 	expected := ""
-	assignment, err := client.GetAssignment("user-1", "experiment-key-1", dictionary{})
+	assignment, err := client.GetStringAssignment("user-1", "experiment-key-1", dictionary{})
 
 	assert.NotNil(t, err)
 	assert.Equal(t, expected, assignment)