Refactor cookie handling configuration and environment variable handling

Author: ShocOne

README.md

@@ -108,8 +108,12 @@ Example configuration file (clientconfig.json):
       "LogExportPath": "/your/log/path/folder",
       "HideSensitiveData": true // redacts sensitive data from logs
     },
-    "Cookie": {
-      "EnableCookieJar": true // enable cookie jar support
+    "Cookies": {
+      "EnableCookieJar": true, // enable cookie jar support
+      "CustomCookies": { // set custom cookies as an alternative to cookie jar
+        "sessionId": "abc123",
+        "authToken": "xyz789"
+      }
     },
     "Retry": {
       "MaxRetryAttempts": 5, // set number of retry attempts

cookiejar/cookiejar.go

@@ -31,6 +31,17 @@ func SetupCookieJar(client *http.Client, enableCookieJar bool, log logger.Logger
 	return nil
 }
 
+// SetSpecificCookies sets specific cookies provided in the configuration on the HTTP request.
+func SetSpecificCookies(req *http.Request, cookies map[string]string) {
+	for name, value := range cookies {
+		cookie := &http.Cookie{
+			Name:  name,
+			Value: value,
+		}
+		req.AddCookie(cookie)
+	}
+}
+
 // GetCookies is a middleware that extracts cookies from incoming requests and serializes them.
 func GetCookies(next http.Handler, log logger.Logger) http.Handler {
 	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {

httpclient/client.go

@@ -60,7 +60,7 @@ type EnvironmentConfig struct {
 // ClientOptions holds optional configuration options for the HTTP Client.
 type ClientOptions struct {
 	Logging     LoggingConfig     // Configuration related to logging
-	Cookie      CookieConfig      // Cookie handling settings
+	Cookies     CookieConfig      // Cookie handling settings
 	Retry       RetryConfig       // Retry behavior configuration
 	Concurrency ConcurrencyConfig // Concurrency configuration
 	Timeout     TimeoutConfig     // Custom timeout settings
@@ -79,7 +79,7 @@ type LoggingConfig struct {
 // CookieConfig holds configuration related to cookie handling.
 type CookieConfig struct {
 	EnableCookieJar bool              // Enable or disable cookie jar
-	SpecificCookies map[string]string `json:"SpecificCookies,omitempty"` // Key-value pairs for specific cookies
+	CustomCookies   map[string]string `json:"CustomCookies,omitempty"` // Key-value pairs for setting specific cookies
 }
 
 // RetryConfig holds configuration related to retry behavior.
@@ -156,7 +156,7 @@ func BuildClient(config ClientConfig) (*Client, error) {
 	}
 
 	// Conditionally setup cookie jar
-	if err := cookiejar.SetupCookieJar(httpClient, config.ClientOptions.Cookie.EnableCookieJar, log); err != nil {
+	if err := cookiejar.SetupCookieJar(httpClient, config.ClientOptions.Cookies.EnableCookieJar, log); err != nil {
 		log.Error("Error setting up cookie jar", zap.Error(err))
 		return nil, err
 	}
@@ -200,7 +200,7 @@ func BuildClient(config ClientConfig) (*Client, error) {
 		zap.String("Log Encoding Format", config.ClientOptions.Logging.LogOutputFormat),
 		zap.String("Log Separator", config.ClientOptions.Logging.LogConsoleSeparator),
 		zap.Bool("Hide Sensitive Data In Logs", config.ClientOptions.Logging.HideSensitiveData),
-		zap.Bool("Cookie Jar Enabled", config.ClientOptions.Cookie.EnableCookieJar),
+		zap.Bool("Cookie Jar Enabled", config.ClientOptions.Cookies.EnableCookieJar),
 		zap.Int("Max Retry Attempts", config.ClientOptions.Retry.MaxRetryAttempts),
 		zap.Bool("Enable Dynamic Rate Limiting", config.ClientOptions.Retry.EnableDynamicRateLimiting),
 		zap.Int("Max Concurrent Requests", config.ClientOptions.Concurrency.MaxConcurrentRequests),

httpclient/client_configuration.go

@@ -137,8 +137,15 @@ func LoadConfigFromEnv(config *ClientConfig) (*ClientConfig, error) {
 	log.Printf("HideSensitiveData env value found and set to: %t", config.ClientOptions.Logging.HideSensitiveData)
 
 	// Cookies
-	config.ClientOptions.Cookie.EnableCookieJar = parseBool(getEnvOrDefault("ENABLE_COOKIE_JAR", strconv.FormatBool(config.ClientOptions.Cookie.EnableCookieJar)))
-	log.Printf("EnableCookieJar env value found and set to: %t", config.ClientOptions.Cookie.EnableCookieJar)
+	config.ClientOptions.Cookies.EnableCookieJar = parseBool(getEnvOrDefault("ENABLE_COOKIE_JAR", strconv.FormatBool(config.ClientOptions.Cookies.EnableCookieJar)))
+	log.Printf("EnableCookieJar env value found and set to: %t", config.ClientOptions.Cookies.EnableCookieJar)
+
+	// Load specific cookies from environment variable
+	cookieStr := getEnvOrDefault("CUSTOM_COOKIES", "")
+	if cookieStr != "" {
+		config.ClientOptions.Cookies.CustomCookies = parseCookiesFromString(cookieStr)
+		log.Printf("CustomCookies env value found and set")
+	}
 
 	// Retry
 	config.ClientOptions.Retry.MaxRetryAttempts = parseInt(getEnvOrDefault("MAX_RETRY_ATTEMPTS", strconv.Itoa(config.ClientOptions.Retry.MaxRetryAttempts)), DefaultMaxRetryAttempts)
@@ -343,3 +350,18 @@ func setLoggerDefaultValues(config *ClientConfig) {
 	// Log completion of setting default values
 	log.Println("Default values set for logger configuration")
 }
+
+// parseCookiesFromString parses a semi-colon separated string of key=value pairs into a map.
+func parseCookiesFromString(cookieStr string) map[string]string {
+	cookies := make(map[string]string)
+	pairs := strings.Split(cookieStr, ";")
+	for _, pair := range pairs {
+		kv := strings.SplitN(pair, "=", 2)
+		if len(kv) == 2 {
+			key := strings.TrimSpace(kv[0])
+			value := strings.TrimSpace(kv[1])
+			cookies[key] = value
+		}
+	}
+	return cookies
+}

httpclient/client_configuration_test.go

@@ -56,7 +56,7 @@ func TestLoadConfigFromFile(t *testing.T) {
 	assert.True(t, config.ClientOptions.Retry.EnableDynamicRateLimiting)
 	assert.Equal(t, 5, config.ClientOptions.Retry.MaxRetryAttempts)
 	assert.Equal(t, 3, config.ClientOptions.Concurrency.MaxConcurrentRequests)
-	assert.True(t, config.ClientOptions.Cookie.EnableCookieJar)
+	assert.True(t, config.ClientOptions.Cookies.EnableCookieJar)
 	assert.True(t, config.ClientOptions.Redirect.FollowRedirects)
 	assert.Equal(t, 5, config.ClientOptions.Redirect.MaxRedirects)
 }