Merge pull request #18 from IBM/saikumar1607-202111241032

ibm-cloud-appconfiguration · web-flow · commit 95ffd2df6827 · 2021-11-24T16:22:15.000+05:30
Changes to IsEnabled() method
diff --git a/.cra/.cveignore b/.cra/.cveignore
@@ -0,0 +1,7 @@
+[
+{
+"cve": "SNYK-GOLANG-GITHUBCOMGOBUFFALOPACKRV2-1920670",
+"expiration": "2021-11-25T08:40:51+05:30",
+"comment": "Details on why this is ignored is documented in https://github.ibm.com/devx-app-services/planning/issues/7876"
+}
+]
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+.idea/
+coverage.out
diff --git a/.secrets.baseline b/.secrets.baseline
@@ -3,7 +3,7 @@
     "files": "^.secrets.baseline$|go.sum|examples/SampleApp/go.sum|vendor",
     "lines": null
   },
-  "generated_at": "2021-11-10T07:34:54Z",
+  "generated_at": "2021-11-24T10:34:05Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# IBM Cloud App Configuration Go server SDK
+# IBM Cloud App Configuration Go server SDK 0.2.2
 
 IBM Cloud App Configuration SDK is used to perform feature flag and property evaluation based on the configuration on
 IBM Cloud App Configuration service.
diff --git a/examples/README.md b/examples/README.md
@@ -95,7 +95,7 @@ Click Save rule & Add the targeting.
 
 ```bash
 $ cd ./examples
-$ go get -u github.com/IBM/appconfiguration-go-sdk
+$ go mod tidy
 $ go run main.go
 ```
 
diff --git a/examples/go.mod b/examples/go.mod
@@ -3,6 +3,6 @@ module examples
 go 1.16
 
 require (
-	github.com/IBM/appconfiguration-go-sdk v0.2.1
+	github.com/IBM/appconfiguration-go-sdk v0.2.2
 	github.com/gorilla/mux v1.7.2
-)
+)
diff --git a/examples/go.sum b/examples/go.sum
diff --git a/go.mod b/go.mod
@@ -2,18 +2,19 @@ module github.com/IBM/appconfiguration-go-sdk
 
 go 1.16
 
+replace github.com/gobuffalo/packr/v2 => github.com/gobuffalo/packr/v2 v2.3.2
+
 require (
-	github.com/IBM/go-sdk-core/v5 v5.5.1
+	github.com/IBM/go-sdk-core/v5 v5.7.0
 	github.com/google/uuid v1.2.0 // indirect
 	github.com/gorilla/websocket v1.4.2
 	github.com/mitchellh/mapstructure v1.4.1 // indirect
 	github.com/robfig/cron v1.2.0
 	github.com/sirupsen/logrus v1.7.0
-	github.com/stretchr/testify v1.6.1
+	github.com/stretchr/testify v1.7.0
 	golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4 // indirect
 	golang.org/x/sys v0.0.0-20210616094352-59db8d763f22 // indirect
 	golang.org/x/text v0.3.6 // indirect
-	golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
 	gopkg.in/yaml.v3 v3.0.0-20200605160147-a5ece683394c
 )
diff --git a/go.sum b/go.sum
diff --git a/lib/appconfiguration_test.go b/lib/appconfiguration_test.go
@@ -82,15 +82,14 @@ func TestSetContext(t *testing.T) {
 	reset(ac)
 
 	// when collection id and environment id is provided successfully and the number of context options is more than 1
-	F := false
 	ac.Init("a", "b", "c")
 	ac.isInitialized = true
 	ac.SetContext("c1", "dev", ContextOptions{
 		BootstrapFile:           "saflights/flights.json",
-		LiveConfigUpdateEnabled: &F,
+		LiveConfigUpdateEnabled: false,
 	}, ContextOptions{
 		BootstrapFile:           "saflights/flights.json",
-		LiveConfigUpdateEnabled: &F,
+		LiveConfigUpdateEnabled: false,
 	})
 	if hook.LastEntry().Message != "AppConfiguration - Incorrect usage of context options. At most of one ContextOptions struct should be passed." {
 		t.Errorf("Test failed: Incorrect error message")
@@ -103,7 +102,7 @@ func TestSetContext(t *testing.T) {
 	assert.Equal(t, false, ac.isInitializedConfig)
 	ac.SetContext("c1", "dev", ContextOptions{
 		BootstrapFile:           "saflights/flights.json",
-		LiveConfigUpdateEnabled: &F,
+		LiveConfigUpdateEnabled: false,
 	})
 	assert.Equal(t, true, ac.isInitializedConfig)
 	reset(ac)
@@ -114,9 +113,9 @@ func TestSetContext(t *testing.T) {
 	assert.Equal(t, false, ac.isInitializedConfig)
 	ac.SetContext("c1", "dev", ContextOptions{
 		BootstrapFile:           "",
-		LiveConfigUpdateEnabled: &F,
+		LiveConfigUpdateEnabled: false,
 	})
-	if hook.LastEntry().Message != "AppConfiguration - Provide configuration_file value when live_config_update_enabled is false." {
+	if hook.LastEntry().Message != "AppConfiguration - Provide bootstrap_file value when live_config_update_enabled is false." {
 		t.Errorf("Test failed: Incorrect error message")
 	}
 	reset(ac)
diff --git a/lib/configurationhandler_test.go b/lib/configurationhandler_test.go
@@ -50,11 +50,10 @@ func TestInitConfigurationHandlerInstance(t *testing.T) {
 }
 func TestConfigHandlerSetContext(t *testing.T) {
 	// test set context when initialised properly
-	F := false
 	ch := GetConfigurationHandlerInstance()
 	ch.SetContext("c1", "dev", ContextOptions{
 		BootstrapFile:           "flights.json",
-		LiveConfigUpdateEnabled: &F,
+		LiveConfigUpdateEnabled: false,
 	})
 	assert.Equal(t, "c1", ch.collectionID)
 	assert.Equal(t, "dev", ch.environmentID)
diff --git a/lib/internal/constants/constants.go b/lib/internal/constants/constants.go
@@ -19,11 +19,14 @@ package constants
 // DefaultSegmentID : Default Segment ID
 const DefaultSegmentID = "$$null$$"
 
+// DefaultEntityID : Default Entity ID
+const DefaultEntityID = "$$null$$"
+
 // DefaultUsageLimit : Default Usage Limit
 const DefaultUsageLimit = 25
 
 // UserAgent specifies the user agent name
-const UserAgent = "appconfiguration-go-sdk/0.2.1"
+const UserAgent = "appconfiguration-go-sdk/0.2.2"
 
 // ConfigurationFile : Name of file to which configurations will be written
 const ConfigurationFile = "appconfiguration.json"
diff --git a/lib/internal/models/Feature.go b/lib/internal/models/Feature.go
@@ -81,6 +81,9 @@ func (f *Feature) GetFeatureDataFormat() string {
 
 // IsEnabled : Is Enabled
 func (f *Feature) IsEnabled() bool {
+	defer func() {
+		utils.GetMeteringInstance().RecordEvaluation(f.GetFeatureID(), "", constants.DefaultEntityID, constants.DefaultSegmentID)
+	}()
 	return f.Enabled
 }
 
@@ -114,7 +117,7 @@ func (f *Feature) featureEvaluation(entityID string, entityAttributes map[string
 		utils.GetMeteringInstance().RecordEvaluation(f.GetFeatureID(), "", entityID, evaluatedSegmentID)
 	}()
 
-	if f.IsEnabled() {
+	if f.Enabled {
 		log.Debug(messages.EvaluatingFeature)
 		defer utils.GracefullyHandleError()
 
diff --git a/lib/internal/models/models_test.go b/lib/internal/models/models_test.go
@@ -152,6 +152,13 @@ func TestFeature(t *testing.T) {
 	if feature.GetCurrentValue("entityID123", entityMap) != float64(1) {
 		t.Error("Expected TestFeatureGetCurrentValueNumeric test case to pass")
 	}
+	feature.DataType = "INVALID_DATATYPE"
+	feature.Format = ""
+	feature.EnabledValue = float64(1)
+	feature.DisabledValue = float64(0)
+	if feature.GetCurrentValue("entityID123", entityMap) != nil {
+		t.Error("Expected TestFeatureGetCurrentValueWithInvalidFeatureDatatype test case to pass")
+	}
 	feature.DataType = "BOOLEAN"
 	feature.EnabledValue = true
 	feature.DisabledValue = false
@@ -233,7 +240,12 @@ func TestProperty(t *testing.T) {
 	if property.GetCurrentValue("entityID123", entityMap) != float64(1) {
 		t.Error("Expected TestPropertyGetCurrentValueNumeric test case to pass")
 	}
-
+	property.DataType = "INVALID_DATATYPE"
+	property.Format = ""
+	property.Value = float64(1)
+	if property.GetCurrentValue("entityID123", entityMap) != nil {
+		t.Error("Expected TestPropertyGetCurrentValueWithInvalidPropertyDatatype test case to pass")
+	}
 	property.DataType = "BOOLEAN"
 	property.Value = true
 
diff --git a/lib/internal/utils/Metering.go b/lib/internal/utils/Metering.go
@@ -32,7 +32,7 @@ import (
 type Usages struct {
 	FeatureID      string      `json:"feature_id,omitempty"`
 	PropertyID     string      `json:"property_id,omitempty"`
-	EntityID       string      `json:"entity_id"`
+	EntityID       interface{} `json:"entity_id"`
 	SegmentID      interface{} `json:"segment_id"`
 	EvaluationTime string      `json:"evaluation_time"`
 	Count          int64       `json:"count"`
@@ -201,12 +201,16 @@ func (mt *Metering) buildRequestBody(sendMeteringData map[string]map[string]map[
 							} else {
 								usages.PropertyID = featureID
 							}
+							if entityID == constants.DefaultEntityID {
+								usages.EntityID = nil
+							} else {
+								usages.EntityID = entityID
+							}
 							if segmentID == constants.DefaultSegmentID {
 								usages.SegmentID = nil
 							} else {
 								usages.SegmentID = segmentID
 							}
-							usages.EntityID = entityID
 							usages.EvaluationTime = val.evaluationTime
 							usages.Count = val.count
 							usagesArray = append(usagesArray, usages)

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`"files": "^.secrets.baseline$\|go.sum\|examples/SampleApp/go.sum\|vendor",`
`4`	`4`	`"lines": null`
`5`	`5`	`},`
`6`		`- "generated_at": "2021-11-10T07:34:54Z",`
	`6`	`+ "generated_at": "2021-11-24T10:34:05Z",`
`7`	`7`	`"plugins_used": [`
`8`	`8`	`{`
`9`	`9`	`"name": "AWSKeyDetector"`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# IBM Cloud App Configuration Go server SDK`
	`1`	`+# IBM Cloud App Configuration Go server SDK 0.2.2`
`2`	`2`
`3`	`3`	`IBM Cloud App Configuration SDK is used to perform feature flag and property evaluation based on the configuration on`
`4`	`4`	`IBM Cloud App Configuration service.`