Merge pull request #9 from srikanthkm/master

Go SDK update

Author: jojustin

.pre-commit-config.yaml

@@ -11,7 +11,7 @@ repos:
   # You are encouraged to use static refs such as tags, instead of branch name
   #
   # Running "pre-commit autoupdate" would automatically updates rev to latest tag
-  rev: 0.13.1+ibm.35.dss
+  rev: 0.13.1+ibm.36.dss
   hooks:
     -   id: detect-secrets # pragma: whitelist secret
         # Add options for detect-secrets-hook binary. You can run `detect-secrets-hook --help` to list out all possible options.

.secrets.baseline

@@ -3,7 +3,7 @@
     "files": "^.secrets.baseline$|go.sum|examples/SampleApp/go.sum|vendor",
     "lines": null
   },
-  "generated_at": "2021-05-26T13:33:49Z",
+  "generated_at": "2021-05-27T19:00:52Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"
@@ -25,6 +25,7 @@
       "name": "CloudantDetector"
     },
     {
+      "ghe_instance": "github.ibm.com",
       "name": "GheDetector"
     },
     {
@@ -69,15 +70,15 @@
         "hashed_secret": "d4c3d66fd0c38547a3c7a4c6bdc29c36911bc030",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 62,
+        "line_number": 63,
         "type": "Secret Keyword",
         "verified_result": null
       },
       {
         "hashed_secret": "a94906aadfc6ddd1659ef976cf1b5ecae197b9a3",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 129,
+        "line_number": 131,
         "type": "Secret Keyword",
         "verified_result": null
       }
@@ -93,7 +94,7 @@
       }
     ]
   },
-  "version": "0.13.1+ibm.35.dss",
+  "version": "0.13.1+ibm.36.dss",
   "word_list": {
     "file": null,
     "hash": null

README.md

@@ -25,6 +25,8 @@ properties for distributed applications centrally.
 
 ## Installation
 
+The current version of this SDK: 0.1.0
+
 There are a few different ways to download and install the IBM App Configuration Go SDK project for use by your Go
 application:
 
@@ -55,7 +57,10 @@ Initialize the sdk to connect with your App Configuration service instance.
 ```go
 appConfiguration := AppConfiguration.GetInstance()
 appConfiguration.Init("region", "guid", "apikey")
-appConfiguration.SetContext("collectionId", "environmentId")
+
+collectionId := "airlines-webapp"
+environmentId := "dev"
+appConfiguration.SetContext(collectionId, environmentId)
 ```
 
 - region : Region name where the App Configuration service instance is created. Use
@@ -78,37 +83,42 @@ You can also work offline with local configuration file and perform feature and
 After [`appConfiguration.Init("region", "guid", "apikey")`](#using-the-sdk), follow the below steps
 
 ```go
-appConfiguration.SetContext("collectionId", "environmentId", AppConfiguration.ContextOptions{
-  ConfigurationFile:       "path/to/configuration/file.json",
-  LiveConfigUpdateEnabled: false,
+appConfiguration.SetContext("airlines-webapp", "dev", AppConfiguration.ContextOptions{
+  ConfigurationFile:       "saflights/flights.json",
+  LiveConfigUpdateEnabled: false
 })
 ```
 
 - ConfigurationFile: Path to the JSON file, which contains configuration details.
 - LiveConfigUpdateEnabled: Set this value to `false` if the new configuration values shouldn't be fetched from the
   server. Make sure to provide a proper JSON file in the path. By default, this value is enabled.
 
+### Permissions required by SDK
+  Add write permission for `non-root` users to `appconfiguration.json` file which is used as cache in AppConfiguration SDK.
+  AppConfiguration cache location will be the application root folder.
+
 ## Get single feature
 
 ```go
-feature := appConfiguration.GetFeature("featureId")
+feature, err := appConfiguration.GetFeature("online-check-in")
+if err == nil {
+    fmt.Println("Feature Name", feature.GetFeatureName())
+    fmt.Println("Feature Id", feature.GetFeatureId())
+    fmt.Println("Feature Type", feature.GetFeatureDataType())
 
-if (feature.IsEnabled()) {
+    if (feature.IsEnabled()) {
         // feature flag is enabled
-} else {
+    } else {
         // feature flag is disabled
+    }
 }
-fmt.Println("Feature Name", feature.GetFeatureName())
-fmt.Println("Feature Id", feature.GetFeatureId())
-fmt.Println("Feature Type", feature.GetFeatureDataType())
-fmt.Println("Feature is enabled", feature.IsEnabled())
 ```
 
 ## Get all features
 
 ```go
 features := appConfiguration.GetFeatures()
-feature := features["featureId"]
+feature := features["online-check-in"]
 
 fmt.Println("Feature Name", feature.GetFeatureName())
 fmt.Println("Feature Id", feature.GetFeatureId())
@@ -118,34 +128,35 @@ fmt.Println("Feature is enabled", feature.IsEnabled())
 
 ## Evaluate a feature
 
-You can use the ` feature.GetCurrentValue(identityId, identityAttributes)` method to evaluate the value of the feature
-flag. You should pass an unique identityId as the parameter to perform the feature flag evaluation. If the feature flag
+You can use the ` feature.GetCurrentValue(entityId, entityAttributes)` method to evaluate the value of the feature
+flag. You should pass an unique entityId as the parameter to perform the feature flag evaluation. If the feature flag
 is configured with segments in the App Configuration service, you can set the attributes values as a map.
 
 ```go
-identityId := "identityId"
-identityAttributes := make(map[string]interface{})
-identityAttributes["email"] = "ibm.com"
-identityAttributes["city"] = "Bangalore"
+entityId := "john_doe"
+entityAttributes := make(map[string]interface{})
+entityAttributes["city"] = "Bangalore"
+entityAttributes["country"] = "India"
 
-featureVal := feature.GetCurrentValue(identityId, identityAttributes)
+featureVal := feature.GetCurrentValue(entityId, entityAttributes)
 ```
 
 ## Get single property
 
 ```go
-property := appConfiguration.GetProperty("propertyId")
-
-fmt.Println("Property Name", property.GetPropertyName())
-fmt.Println("Property Id", property.GetPropertyId())
-fmt.Println("Property Type", property.GetPropertyDataType())
+property, err := appConfiguration.GetProperty("check-in-charges")
+if err == nil {
+    fmt.Println("Property Name", property.GetPropertyName())
+    fmt.Println("Property Id", property.GetPropertyId())
+    fmt.Println("Property Type", property.GetPropertyDataType())
+}
 ```
 
 ## Get all properties
 
 ```go
 properties := appConfiguration.GetProperties()
-property := properties["propertyId"]
+property := properties["check-in-charges"]
 
 fmt.Println("Property Name", property.GetPropertyName())
 fmt.Println("Property Id", property.GetPropertyId())
@@ -154,22 +165,22 @@ fmt.Println("Property Type", property.GetPropertyDataType())
 
 ## Evaluate a property
 
-You can use the ` property.GetCurrentValue(identityId, identityAttributes)` method to evaluate the value of the
-property. You should pass an unique identityId as the parameter to perform the property evaluation. If the property is
+You can use the ` property.GetCurrentValue(entityId, entityAttributes)` method to evaluate the value of the
+property. You should pass an unique entityId as the parameter to perform the property evaluation. If the property is
 configured with segments in the App Configuration service, you can set the attributes values as a map.
 
 ```go
-identityId := "identityId"
-identityAttributes := make(map[string]interface{})
-identityAttributes["email"] = "ibm.com"
-identityAttributes["city"] = "Bengaluru"
+entityId := "john_doe"
+entityAttributes := make(map[string]interface{})
+entityAttributes["city"] = "Bangalore"
+entityAttributes["country"] = "India"
 
-propertyVal := property.GetCurrentValue(identityId, identityAttributes)
+propertyVal := property.GetCurrentValue(entityId, entityAttributes)
 ```
 
 ## Set listener for feature or property data changes
 
-To listen to the data changes add the following code in your application
+To listen to the configurations changes in your App Configuration service instance, implement the `RegisterConfigurationUpdateListener` event listener as mentioned below 
 
 ```go
 appConfiguration.RegisterConfigurationUpdateListener(func () {

examples/README.md

@@ -1,6 +1,6 @@
-# Sample Application
+# Example Application
 
-> **DISCLAIMER**: This is a guideline sample application and is used for demonstrative and illustrative purposes only. This is not a production ready code.
+> **DISCLAIMER**: This is a guideline example application and is used for demonstrative and illustrative purposes only. This is not a production ready code.
 
 ## Step 1: Create an instance of App Configuration service
 
@@ -89,7 +89,7 @@ Click Save rule & Add the targeting.
 ```
 - Use the `id` of default environment created on instance creation.
 
-- In the sample app, provide the collectionId, environmentId, featureId & propertyId in file [`main.go`](main.go#L23)
+- In the example app, provide the collectionId, environmentId, featureId & propertyId in file [`main.go`](main.go#L23)
 
 ## Step 4: Run the app
 

examples/go.mod

@@ -2,8 +2,7 @@ module examples
 
 go 1.16
 
-
 require (
-	github.com/IBM/appconfiguration-go-sdk v0.0.1
+	github.com/IBM/appconfiguration-go-sdk v0.1.0
 	github.com/gorilla/mux v1.7.2
 )

examples/main.go

@@ -19,28 +19,33 @@ func main() {
 	appConfiguration := AppConfiguration.GetInstance()
 	appConfiguration.Init(AppConfiguration.REGION_US_SOUTH, "<guid>", "<apikey>")
 	appConfiguration.SetContext("<collectionId>", "<environmentId>")
-	identityId := "user123"
-	identityAttributes := make(map[string]interface{})
-	identityAttributes["city"] = "Bangalore"
-	identityAttributes["radius"] = 60
-
-	appConfiguration.RegisterConfigurationUpdateListener(func() {
-
-		fmt.Println("\n\nFEATURE FLAG OPERATIONS\n")
-		feature := appConfiguration.GetFeature("<featureId>")
+	entityId := "user123"
+	entityAttributes := make(map[string]interface{})
+	entityAttributes["city"] = "Bangalore"
+	entityAttributes["radius"] = 60
+
+	fmt.Println("\n\nFEATURE FLAG OPERATIONS\n")
+	feature, err := appConfiguration.GetFeature("<featureId>")
+	if err == nil {
 		fmt.Println("Feature Name:", feature.GetFeatureName())
 		fmt.Println("Feature Id:", feature.GetFeatureId())
 		fmt.Println("Feature Data type:", feature.GetFeatureDataType())
 		fmt.Println("Is Feature enabled?", feature.IsEnabled())
-		fmt.Println("Feature evaluated value is:", feature.GetCurrentValue(identityId, identityAttributes))
+		fmt.Println("Feature evaluated value is:", feature.GetCurrentValue(entityId, entityAttributes))
+	}
 
-		fmt.Println("\n\nPROPERTY OPERATIONS\n")
-		property := appConfiguration.GetProperty("<propertyId>")
+	fmt.Println("\n\nPROPERTY OPERATIONS\n")
+	property, err := appConfiguration.GetProperty("<propertyId>")
+	if err == nil {
 		fmt.Println("Property Name:", property.GetPropertyName())
 		fmt.Println("Property Id:", property.GetPropertyId())
 		fmt.Println("Property Data type:", property.GetPropertyDataType())
-		fmt.Println("Property evaluated value is:", property.GetCurrentValue(identityId, identityAttributes))
-
+		fmt.Println("Property evaluated value is:", property.GetCurrentValue(entityId, entityAttributes))
+	}
+	//whenever the configurations get changed/updated on the app configuration service instance the function inside this listener is triggered.
+	//So, to keep track of live changes to configurations use this listener.
+	appConfiguration.RegisterConfigurationUpdateListener(func() {
+		fmt.Println("configurations updated")
 	})
 
 	myRouter := mux.NewRouter().StrictSlash(true)

lib/AppConfiguration.go

@@ -17,9 +17,11 @@
 package lib
 
 import (
-	"github.com/IBM/appconfiguration-go-sdk/lib/internal/constants"
+	"errors"
 	"os"
 
+	"github.com/IBM/appconfiguration-go-sdk/lib/internal/constants"
+
 	"github.com/IBM/appconfiguration-go-sdk/lib/internal/messages"
 	"github.com/IBM/appconfiguration-go-sdk/lib/internal/models"
 
@@ -60,10 +62,10 @@ func (ac *AppConfiguration) Init(region string, guid string, apikey string) {
 			log.Error(messages.REGION_ERROR)
 		}
 		if len(guid) == 0 {
-			log.Error(messages.APIKEY_ERROR)
+			log.Error(messages.GUID_ERROR)
 		}
 		if len(apikey) == 0 {
-			log.Error(messages.GUID_ERRROR)
+			log.Error(messages.APIKEY_ERROR)
 		}
 		return
 	}
@@ -100,11 +102,17 @@ func (ac *AppConfiguration) SetContext(collectionId string, environmentId string
 		return
 	}
 	ac.isInitializedConfig = true
-	if _, err := os.Stat(constants.FEATURE_FILE); os.IsNotExist(err) {
+	file, err := os.Stat(constants.FEATURE_FILE)
+	if os.IsNotExist(err) {
 		ac.configurationHandlerInstance.loadData()
 	} else {
-		ac.configurationHandlerInstance.loadConfigurations()
-		go ac.configurationHandlerInstance.loadData()
+		if file.Size() == 0 {
+			log.Error(constants.FEATURE_FILE + messages.ConfigurationFileEmpty)
+			ac.configurationHandlerInstance.loadData()
+		} else {
+			ac.configurationHandlerInstance.loadConfigurations()
+			go ac.configurationHandlerInstance.loadData()
+		}
 	}
 }
 
@@ -124,12 +132,12 @@ func (ac *AppConfiguration) RegisterConfigurationUpdateListener(fhl configuratio
 	}
 }
 
-func (ac *AppConfiguration) GetFeature(featureId string) models.Feature {
+func (ac *AppConfiguration) GetFeature(featureId string) (models.Feature, error) {
 	if ac.isInitializedConfig == true && ac.configurationHandlerInstance != nil {
 		return ac.configurationHandlerInstance.getFeature(featureId)
 	} else {
 		log.Error(messages.COLLECTION_INIT_ERROR)
-		return models.Feature{}
+		return models.Feature{}, errors.New(messages.ERROR_INVALID_FEATURE_ACTION)
 	}
 }
 func (ac *AppConfiguration) GetFeatures() map[string]models.Feature {
@@ -140,12 +148,12 @@ func (ac *AppConfiguration) GetFeatures() map[string]models.Feature {
 		return nil
 	}
 }
-func (ac *AppConfiguration) GetProperty(propertyId string) models.Property {
+func (ac *AppConfiguration) GetProperty(propertyId string) (models.Property, error) {
 	if ac.isInitializedConfig == true && ac.configurationHandlerInstance != nil {
 		return ac.configurationHandlerInstance.getProperty(propertyId)
 	} else {
 		log.Error(messages.COLLECTION_INIT_ERROR)
-		return models.Property{}
+		return models.Property{}, errors.New(messages.ERROR_INVALID_PROPERTY_ACTION)
 	}
 }
 func (ac *AppConfiguration) GetProperties() map[string]models.Property {