Merge pull request #44 from IBM/prajwal-jarali-202509160923

Unification of Data format for API response and Bootstrap file

Author: saikumar1607

.secrets.baseline

@@ -3,7 +3,7 @@
     "files": "^.secrets.baseline$|go.sum|vendor|.cra/.cveignore",
     "lines": null
   },
-  "generated_at": "2025-04-30T06:02:48Z",
+  "generated_at": "2025-09-16T09:24:28Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"

README.md

@@ -1,4 +1,4 @@
-# IBM Cloud App Configuration Go server SDK 0.5.7
+# IBM Cloud App Configuration Go server SDK 0.5.8
 
 IBM Cloud App Configuration SDK is used to perform feature flag and property evaluation based on the configuration on
 IBM Cloud App Configuration service.

examples/go.mod

@@ -5,7 +5,7 @@ go 1.23.0
 toolchain go1.23.7
 
 require (
-	github.com/IBM/appconfiguration-go-sdk v0.5.7
+	github.com/IBM/appconfiguration-go-sdk v0.5.8
 	github.com/gorilla/mux v1.8.0
 	github.com/joho/godotenv v1.5.1
 )

lib/ConfigurationHandler.go

@@ -104,8 +104,10 @@ func (ch *ConfigurationHandler) loadData() {
 		log.Info(messages.ReadPersistentCache, path)
 		ch.persistentData = utils.ReadFiles(path)
 		if !bytes.Equal(ch.persistentData, []byte(`{}`)) {
-			configurations := models.ExtractConfigurationsFromPersistentCache(ch.persistentData)
-			if configurations != nil {
+			configurations, err := models.ExtractConfigurations(ch.persistentData, ch.environmentID, ch.collectionID)
+			if err != nil {
+				log.Error("Error occurred while reading persistent cache configurations - ", err.Error())
+			} else {
 				ch.saveInCache(configurations)
 				persistentCacheRead = true
 			}
@@ -116,17 +118,22 @@ func (ch *ConfigurationHandler) loadData() {
 		if len(ch.persistentCacheDirectory) > 0 {
 			if !persistentCacheRead {
 				bootstrapFileData := utils.ReadFiles(path)
-				bootstrapConfigurations := models.ExtractConfigurationsFromBootstrapJson(bootstrapFileData, ch.collectionID, ch.environmentID)
-				if bootstrapConfigurations != nil {
+				bootstrapConfigurations, err := models.ExtractConfigurations(bootstrapFileData, ch.environmentID, ch.collectionID)
+				if err != nil {
+					log.Error("Error occurred while reading bootstrap configurations - ", err.Error())
+				} else {
 					ch.saveInCache(bootstrapConfigurations)
-					go utils.StoreFiles(string(models.FormatConfig(bootstrapConfigurations, ch.environmentID)), ch.persistentCacheDirectory)
+					go utils.StoreFiles(string(models.FormatConfig(bootstrapConfigurations, ch.environmentID, ch.collectionID)), ch.persistentCacheDirectory)
+
 				}
 			}
 		} else {
 			log.Info(messages.ReadBootstrapConfigurations, path)
 			bootstrapFileData := utils.ReadFiles(path)
-			bootstrapConfigurations := models.ExtractConfigurationsFromBootstrapJson(bootstrapFileData, ch.collectionID, ch.environmentID)
-			if bootstrapConfigurations != nil {
+			bootstrapConfigurations, err := models.ExtractConfigurations(bootstrapFileData, ch.environmentID, ch.collectionID)
+			if err != nil {
+				log.Error("Error occurred while reading bootstrap configurations - ", err.Error())
+			} else {
 				ch.saveInCache(bootstrapConfigurations)
 			}
 		}
@@ -147,7 +154,7 @@ func (ch *ConfigurationHandler) FetchConfigurationData() {
 func (ch *ConfigurationHandler) saveInCache(data []byte) {
 	ch.mu.Lock()
 	defer ch.mu.Unlock()
-	configurations := models.Configurations{}
+	configurations := models.CacheConfig{}
 	err := json.Unmarshal(data, &configurations)
 	if err != nil {
 		log.Error(messages.UnmarshalJSONErr, err)
@@ -156,12 +163,12 @@ func (ch *ConfigurationHandler) saveInCache(data []byte) {
 	log.Debug(configurations)
 	featureMap := make(map[string]models.Feature)
 	for _, feature := range configurations.Features {
-		featureMap[feature.GetFeatureID()] = feature
+		featureMap[feature.GetFeatureID()] = feature.Feature
 	}
 
 	propertyMap := make(map[string]models.Property)
 	for _, property := range configurations.Properties {
-		propertyMap[property.GetPropertyID()] = property
+		propertyMap[property.GetPropertyID()] = property.Property
 	}
 
 	segmentMap := make(map[string]models.Segment)
@@ -230,8 +237,9 @@ func (ch *ConfigurationHandler) fetchFromAPI() {
 		if response != nil && response.StatusCode == 200 {
 			log.Info(messages.FetchAPISuccessful)
 			jsonData, _ := json.Marshal(response.Result)
-			configurations := models.ExtractConfigurationsFromAPIResponse(jsonData)
-			if configurations == nil {
+			configurations, err := models.ExtractConfigurations(jsonData, ch.environmentID, ch.collectionID)
+			if err != nil {
+				log.Error("Error occurred while reading fetched configurations - ", err.Error())
 				return
 			}
 			// asynchronously write the response to persistent volume, if enabled

lib/configurationhandler_test.go

@@ -86,7 +86,7 @@ func TestFetchApi(t *testing.T) {
 		http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 			w.Header().Set("Content-type", "application/json")
 			w.WriteHeader(200)
-			fmt.Fprintf(w, "%s", `{ "environments": [ { "name": "Dev", "environment_id": "dev", "description": "Environment created on instance creation", "tags": "", "color_code": "#FDD13A", "features": [ { "name": "Cycle Rentals", "feature_id": "cycle-rentals", "type": "BOOLEAN", "enabled_value": true, "disabled_value": false, "segment_rules": [], "enabled": true, "rollout_percentage": 95 } ], "properties": [ { "name": "Show Ad", "property_id": "show-ad", "tags": "", "type": "BOOLEAN", "value": false, "segment_rules": [] } ] } ], "segments": [ { "name": "beta-users", "segment_id": "knliu818", "rules": [ { "values": [ "ibm.com" ], "operator": "contains", "attribute_name": "email" } ] }, { "name": "ibm employees", "segment_id": "ka761hap", "rules": [ { "values": [ "ibm.com", "in.ibm.com" ], "operator": "endsWith", "attribute_name": "email" } ] } ] }`)
+			fmt.Fprintf(w, "%s", `{ "environments": [ { "name": "Dev", "environment_id": "dev", "description": "Environment created on instance creation", "tags": "", "color_code": "#FDD13A", "features": [ { "name": "Cycle Rentals", "feature_id": "cycle-rentals", "type": "BOOLEAN", "enabled_value": true, "disabled_value": false, "segment_rules": [], "enabled": true, "rollout_percentage": 95 } ], "properties": [ { "name": "Show Ad", "property_id": "show-ad", "tags": "", "type": "BOOLEAN", "value": false, "segment_rules": [ { "order": 1, "rollout_percentage": 100, "rules": [ { "segments": [ "knliu818", "ka761hap" ] } ], "value": true } ] } ] } ], "collections": [ { "name": "C1", "collection_id": "c1" } ], "segments": [ { "name": "beta-users", "segment_id": "knliu818", "rules": [ { "values": [ "ibm.com" ], "operator": "contains", "attribute_name": "email" } ] }, { "name": "ibm employees", "segment_id": "ka761hap", "rules": [ { "values": [ "ibm.com", "in.ibm.com" ], "operator": "endsWith", "attribute_name": "email" } ] } ] }`)
 		}))
 
 	ch := GetConfigurationHandlerInstance()

lib/internal/constants/constants.go

@@ -26,7 +26,7 @@ const DefaultEntityID = "$$null$$"
 const DefaultUsageLimit = 10
 
 // UserAgent specifies the user agent name
-const UserAgent = "appconfiguration-go-sdk/0.5.7"
+const UserAgent = "appconfiguration-go-sdk/0.5.8"
 
 // ConfigurationFile : Name of file to which configurations will be written
 const ConfigurationFile = "appconfiguration.json"

lib/internal/models/Config.go

@@ -16,47 +16,35 @@
 
 package models
 
-// Configurations : all the configurations pulled out from bootstrapJson/persistentCache/GitConfig/APIResponse
+// CacheConfig : all the configurations pulled out from bootstrapJson/persistentCache/GitConfig/APIResponse
 // will be stored in this struct format.
-type Configurations struct {
-	Features   []Feature  `json:"features"`
-	Properties []Property `json:"properties"`
-	Segments   []Segment  `json:"segments"`
+type CacheConfig struct {
+	Features   []FeatureC  `json:"features"`
+	Properties []PropertyC `json:"properties"`
+	Segments   []Segment   `json:"segments"`
 }
 
-// BootstrapConfig : the format of bootstrap configurations.
-type BootstrapConfig struct {
-	Environments []EnvironmentC `json:"environments"`
-	Collections  []Collection   `json:"collections"`
-	Segments     []Segment      `json:"segments"`
+// Config : the format of all configurations.
+type Config struct {
+	Environments []Environment `json:"environments"`
+	Collections  []Collection  `json:"collections"`
+	Segments     []Segment     `json:"segments"`
 }
-type EnvironmentC struct {
+type Environment struct {
 	Name          string      `json:"name"`
 	EnvironmentID string      `json:"environment_id"`
 	Features      []FeatureC  `json:"features"`
 	Properties    []PropertyC `json:"properties"`
 }
 type Collection struct {
-	Name         string `json:"name"`
+	Name         string `json:"name,omitempty"`
 	CollectionID string `json:"collection_id"`
 }
 type FeatureC struct {
 	Feature
-	Collections []Collection `json:"collections"`
+	Collections []Collection `json:"collections,omitempty"`
 }
 type PropertyC struct {
 	Property
-	Collections []Collection `json:"collections"`
-}
-
-// APIConfig : the format of configurations returned from the API: `GET /config?action=sdkConfig`
-type APIConfig struct {
-	Environments []Environment `json:"environments"`
-	Segments     []Segment     `json:"segments"`
-}
-type Environment struct {
-	Name          string     `json:"name"`
-	EnvironmentID string     `json:"environment_id"`
-	Features      []Feature  `json:"features"`
-	Properties    []Property `json:"properties"`
+	Collections []Collection `json:"collections,omitempty"`
 }