Feat: added SDKkey and environmentKey in datafile (#312)

yasirfolio3 · msohailhussain · web-flow · commit 43dd94afb566 · 2021-06-16T10:20:02.000-07:00
* Added support for sdkKey and Environment to config.

* updating `environment` to `environmentKey` as per fsc changes.

* suggested changes made.

Co-authored-by: msohailhussain &lt;mirza.sohailhussain@gmail.com&gt;
diff --git a/pkg/config/datafileprojectconfig/config.go b/pkg/config/datafileprojectconfig/config.go
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright 2019-2020, Optimizely, Inc. and contributors                   *
+ * Copyright 2019-2021, 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.         *
@@ -48,6 +48,8 @@ type DatafileProjectConfig struct {
 	anonymizeIP          bool
 	botFiltering         bool
 	sendFlagDecisions    bool
+	sdkKey               string
+	environmentKey       string
 }
 
 // GetDatafile returns a string representation of the environment's datafile
@@ -80,11 +82,21 @@ func (c DatafileProjectConfig) GetAttributeID(key string) string {
 	return c.attributeKeyToIDMap[key]
 }
 
-// GetBotFiltering returns GetBotFiltering
+// GetBotFiltering returns botFiltering
 func (c DatafileProjectConfig) GetBotFiltering() bool {
 	return c.botFiltering
 }
 
+// GetSdkKey returns sdkKey for specific environment.
+func (c DatafileProjectConfig) GetSdkKey() string {
+	return c.sdkKey
+}
+
+// GetEnvironmentKey returns current environment of the datafile.
+func (c DatafileProjectConfig) GetEnvironmentKey() string {
+	return c.environmentKey
+}
+
 // GetEventByKey returns the event with the given key
 func (c DatafileProjectConfig) GetEventByKey(eventKey string) (entities.Event, error) {
 	if event, ok := c.eventMap[eventKey]; ok {
@@ -215,6 +227,8 @@ func NewDatafileProjectConfig(jsonDatafile []byte, logger logging.OptimizelyLogP
 		audienceMap:          mappers.MapAudiences(mergedAudiences),
 		attributeMap:         attributeMap,
 		botFiltering:         datafile.BotFiltering,
+		sdkKey:               datafile.SDKKey,
+		environmentKey:       datafile.EnvironmentKey,
 		experimentKeyToIDMap: experimentKeyMap,
 		experimentMap:        experimentMap,
 		groupMap:             groupMap,
diff --git a/pkg/config/datafileprojectconfig/config_test.go b/pkg/config/datafileprojectconfig/config_test.go
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright 2019, Optimizely, Inc. and contributors                        *
+ * Copyright 2019,2021, 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.         *
@@ -39,15 +39,17 @@ func TestNewDatafileProjectConfigNil(t *testing.T) {
 }
 
 func TestNewDatafileProjectConfigNotNil(t *testing.T) {
-	dpc := DatafileProjectConfig{accountID: "123", revision: "1", projectID: "12345"}
-	jsonDatafileStr := `{"accountID": "123", "revision": "1", "projectId": "12345", "version": "4"}`
+	dpc := DatafileProjectConfig{accountID: "123", revision: "1", projectID: "12345", sdkKey: "a", environmentKey: "production"}
+	jsonDatafileStr := `{"accountID": "123", "revision": "1", "projectId": "12345", "version": "4", "sdkKey": "a", "environmentKey": "production"}`
 	jsonDatafile := []byte(jsonDatafileStr)
 	projectConfig, err := NewDatafileProjectConfig(jsonDatafile, logging.GetLogger("", "DatafileProjectConfig"))
 	assert.Nil(t, err)
 	assert.NotNil(t, projectConfig)
 	assert.Equal(t, dpc.accountID, projectConfig.accountID)
 	assert.Equal(t, dpc.revision, projectConfig.revision)
 	assert.Equal(t, dpc.projectID, projectConfig.projectID)
+	assert.Equal(t, dpc.environmentKey, projectConfig.environmentKey)
+	assert.Equal(t, dpc.sdkKey, projectConfig.sdkKey)
 }
 
 func TestGetProjectID(t *testing.T) {
@@ -98,6 +100,21 @@ func TestGetAttributeID(t *testing.T) {
 	assert.Equal(t, id, config.GetAttributeID(key))
 }
 
+func TestGetSdkKey(t *testing.T) {
+	config := &DatafileProjectConfig{
+		sdkKey: "1",
+	}
+
+	assert.Equal(t, "1", config.GetSdkKey())
+}
+
+func TestGetEnvironmentKey(t *testing.T) {
+	config := &DatafileProjectConfig{
+		environmentKey: "production",
+	}
+	assert.Equal(t, "production", config.GetEnvironmentKey())
+}
+
 func TestGetBotFiltering(t *testing.T) {
 	botFiltering := true
 	config := &DatafileProjectConfig{
diff --git a/pkg/config/datafileprojectconfig/entities/entities.go b/pkg/config/datafileprojectconfig/entities/entities.go
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright 2019, Optimizely, Inc. and contributors                        *
+ * Copyright 2019,2021, 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.         *
@@ -122,4 +122,6 @@ type Datafile struct {
 	AnonymizeIP       bool          `json:"anonymizeIP"`
 	BotFiltering      bool          `json:"botFiltering"`
 	SendFlagDecisions bool          `json:"sendFlagDecisions"`
+	SDKKey            string        `json:"sdkKey,omitempty"`
+	EnvironmentKey    string        `json:"environmentKey,omitempty"`
 }
diff --git a/pkg/config/datafileprojectconfig/entities/entities_test.go b/pkg/config/datafileprojectconfig/entities/entities_test.go
@@ -0,0 +1,48 @@
+/****************************************************************************
+ * Copyright 2021, 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 entities
+
+import (
+	"encoding/json"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestUnMarshalSdkKeyAndEnvironmentKeyFromDatafile(t *testing.T) {
+	datafile := Datafile{}
+	var jsonMap map[string]interface{}
+	bytesData, _ := json.Marshal(datafile)
+	json.Unmarshal(bytesData, &jsonMap)
+
+	_, keyExists := jsonMap["sdkKey"]
+	assert.False(t, keyExists)
+
+	_, keyExists = jsonMap["environmentKey"]
+	assert.False(t, keyExists)
+
+	datafile.SDKKey = "a"
+	datafile.EnvironmentKey = "production"
+	bytesData, _ = json.Marshal(datafile)
+	json.Unmarshal(bytesData, &jsonMap)
+
+	_, keyExists = jsonMap["sdkKey"]
+	assert.True(t, keyExists)
+
+	_, keyExists = jsonMap["environmentKey"]
+	assert.True(t, keyExists)
+}
diff --git a/pkg/config/interface.go b/pkg/config/interface.go
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright 2019-2020, Optimizely, Inc. and contributors                   *
+ * Copyright 2019-2021, 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.         *
@@ -42,6 +42,8 @@ type ProjectConfig interface {
 	GetProjectID() string
 	GetRevision() string
 	SendFlagDecisions() bool
+	GetSdkKey() string
+	GetEnvironmentKey() string
 }
 
 // ProjectConfigManager maintains an instance of the ProjectConfig
diff --git a/pkg/config/optimizely_config.go b/pkg/config/optimizely_config.go
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright 2019-2020, Optimizely, Inc. and contributors                   *
+ * Copyright 2019-2021, 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.         *
@@ -26,6 +26,8 @@ type OptimizelyConfig struct {
 	Revision       string                          `json:"revision"`
 	ExperimentsMap map[string]OptimizelyExperiment `json:"experimentsMap"`
 	FeaturesMap    map[string]OptimizelyFeature    `json:"featuresMap"`
+	SdkKey         string                          `json:"sdkKey,omitempty"`
+	EnvironmentKey string                          `json:"environmentKey,omitempty"`
 	datafile       string
 }
 
@@ -167,6 +169,8 @@ func NewOptimizelyConfig(projConfig ProjectConfig) *OptimizelyConfig {
 	optimizelyConfig.ExperimentsMap = getExperimentMap(featuresList, experimentsList, variableByIDMap)
 	optimizelyConfig.FeaturesMap = getFeatureMap(featuresList, optimizelyConfig.ExperimentsMap)
 	optimizelyConfig.Revision = revision
+	optimizelyConfig.SdkKey = projConfig.GetSdkKey()
+	optimizelyConfig.EnvironmentKey = projConfig.GetEnvironmentKey()
 	optimizelyConfig.datafile = projConfig.GetDatafile()
 
 	return optimizelyConfig
diff --git a/pkg/config/optimizely_config_test.go b/pkg/config/optimizely_config_test.go
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright 2019-2020, Optimizely, Inc. and contributors                   *
+ * Copyright 2019-2021, 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.         *
@@ -64,10 +64,48 @@ func (s *OptimizelyConfigTestSuite) TestOptlyConfig() {
 	s.Equal(s.expectedOptimizelyConfig.ExperimentsMap, optimizelyConfig.ExperimentsMap)
 	s.Equal(s.expectedOptimizelyConfig.Revision, optimizelyConfig.Revision)
 	s.Equal(s.expectedOptimizelyConfig.datafile, optimizelyConfig.datafile)
+	s.Equal(s.expectedOptimizelyConfig.SdkKey, optimizelyConfig.SdkKey)
+	s.Equal(s.expectedOptimizelyConfig.EnvironmentKey, optimizelyConfig.EnvironmentKey)
 
 	s.Equal(s.expectedOptimizelyConfig, *optimizelyConfig)
 }
 
+func (s *OptimizelyConfigTestSuite) TestOptlyConfigUnMarshalEmptySDKKeyAndEnvironmentKey() {
+	datafile := []byte(`{"version":"4"}`)
+	projectMgr := NewStaticProjectConfigManagerWithOptions("", WithInitialDatafile(datafile))
+	optimizelyConfig := NewOptimizelyConfig(projectMgr.projectConfig)
+	s.Equal("", optimizelyConfig.SdkKey)
+	s.Equal("", optimizelyConfig.EnvironmentKey)
+
+	var jsonMap map[string]interface{}
+	bytesData, _ := json.Marshal(optimizelyConfig)
+	json.Unmarshal(bytesData, &jsonMap)
+
+	_, keyExists := jsonMap["sdkKey"]
+	s.False(keyExists)
+
+	_, keyExists = jsonMap["environmentKey"]
+	s.False(keyExists)
+}
+
+func (s *OptimizelyConfigTestSuite) TestOptlyConfigUnMarshalNonEmptySDKKeyAndEnvironmentKey() {
+	datafile := []byte(`{"version":"4", "sdkKey":"a", "environmentKey": "production"}`)
+	projectMgr := NewStaticProjectConfigManagerWithOptions("", WithInitialDatafile(datafile))
+	optimizelyConfig := NewOptimizelyConfig(projectMgr.projectConfig)
+	s.Equal("a", optimizelyConfig.SdkKey)
+	s.Equal("production", optimizelyConfig.EnvironmentKey)
+
+	var jsonMap map[string]interface{}
+	bytesData, _ := json.Marshal(optimizelyConfig)
+	json.Unmarshal(bytesData, &jsonMap)
+
+	_, keyExists := jsonMap["sdkKey"]
+	s.True(keyExists)
+
+	_, keyExists = jsonMap["environmentKey"]
+	s.True(keyExists)
+}
+
 func (s *OptimizelyConfigTestSuite) TestOptlyConfigNullProjectConfig() {
 	optimizelyConfig := NewOptimizelyConfig(nil)
 
diff --git a/test-data/decide-test-datafile.json b/test-data/decide-test-datafile.json
@@ -342,5 +342,7 @@
       "key": "event_multiple_running_exp_attached"
     }
   ],
-  "revision": "241"
-}
+  "revision": "241",
+  "sdkKey": "ValidProjectConfigV4",
+  "environmentKey": "production"
+}
