chore: Update httpclient client configuration options

Author: ShocOne

httpclient/config_validation.go

@@ -105,7 +105,7 @@ func validateClientConfig(config ClientConfig, populateDefaults bool) error {
 
 	// TODO adjust these strings to have links to documentation & centralise them
 	if config.Integration == nil {
-		return errors.New("no http client api integration supplied, please see documentation for go-api-http-client-integration and provide an implementation")
+		return errors.New("no http client api integration supplied, please see repo documentation for this client and go-api-http-client-integration and provide an implementation")
 	}
 
 	if config.MaxRetryAttempts < 0 {
@@ -137,47 +137,16 @@ func validateClientConfig(config ClientConfig, populateDefaults bool) error {
 	return nil
 }
 
-// SetDefaultValuesClientConfig sets default values for the client configuration.
+// SetDefaultValuesClientConfig sets default values for the client configuration. Ensuring that all fields have a valid or minimum value.
 func SetDefaultValuesClientConfig(config *ClientConfig) {
-
-	if !config.HideSensitiveData {
-		config.HideSensitiveData = DefaultHideSensitiveData
-	}
-
-	if config.MaxRetryAttempts == 0 {
-		config.MaxRetryAttempts = DefaultMaxRetryAttempts
-	}
-
-	if config.MaxConcurrentRequests == 0 {
-		config.MaxRetryAttempts = DefaultMaxConcurrentRequests
-	}
-
-	if !config.EnableDynamicRateLimiting {
-		config.EnableDynamicRateLimiting = DefaultEnableDynamicRateLimiting
-	}
-
-	if config.CustomTimeout == 0 {
-		config.CustomTimeout = DefaultCustomTimeout
-	}
-
-	if config.TokenRefreshBufferPeriod == 0 {
-		config.TokenRefreshBufferPeriod = DefaultTokenRefreshBufferPeriod
-	}
-
-	if config.TotalRetryDuration == 0 {
-		config.TotalRetryDuration = DefaultTotalRetryDuration
-	}
-
-	if !config.FollowRedirects {
-		config.FollowRedirects = DefaultFollowRedirects
-	}
-
-	if config.MaxRedirects == 0 {
-		config.MaxRedirects = DefaultMaxRedirects
-	}
-
-	if !config.EnableConcurrencyManagement {
-		config.EnableConcurrencyManagement = DefaultEnableConcurrencyManagement
-	}
-
+	setDefaultBool(&config.HideSensitiveData, DefaultHideSensitiveData)
+	setDefaultInt(&config.MaxRetryAttempts, DefaultMaxRetryAttempts, 1)
+	setDefaultInt(&config.MaxConcurrentRequests, DefaultMaxConcurrentRequests, 1)
+	setDefaultBool(&config.EnableDynamicRateLimiting, DefaultEnableDynamicRateLimiting)
+	setDefaultDuration(&config.CustomTimeout, DefaultCustomTimeout)
+	setDefaultDuration(&config.TokenRefreshBufferPeriod, DefaultTokenRefreshBufferPeriod)
+	setDefaultDuration(&config.TotalRetryDuration, DefaultTotalRetryDuration)
+	setDefaultBool(&config.FollowRedirects, DefaultFollowRedirects)
+	setDefaultInt(&config.MaxRedirects, DefaultMaxRedirects, 0)
+	setDefaultBool(&config.EnableConcurrencyManagement, DefaultEnableConcurrencyManagement)
 }

httpclient/utility.go

@@ -16,6 +16,7 @@ import (
 
 const ConfigFileExtension = ".json"
 
+// validateFilePath checks if a file path is valid.
 func validateFilePath(path string) (string, error) {
 	cleanPath := filepath.Clean(path)
 
@@ -36,6 +37,7 @@ func validateFilePath(path string) (string, error) {
 
 }
 
+// validateClientID checks if a client ID is a valid UUID.
 func validateValidClientID(clientID string) error {
 	uuidRegex := `^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`
 	if regexp.MustCompile(uuidRegex).MatchString(clientID) {
@@ -64,6 +66,7 @@ func validateClientSecret(clientSecret string) error {
 	return nil
 }
 
+// validateUsername checks if a username meets the minimum requirements.
 func validateUsername(username string) error {
 	usernameRegex := `^[a-zA-Z0-9!@#$%^&*()_\-\+=\[\]{\}\\|;:'",<.>/?]+$`
 	if !regexp.MustCompile(usernameRegex).MatchString(username) {
@@ -72,13 +75,16 @@ func validateUsername(username string) error {
 	return nil
 }
 
+// validatePassword checks if a password meets the minimum requirements.
 func validatePassword(password string) error {
 	if len(password) < 8 {
 		return errors.New("password not long enough")
 	}
 	return nil
 }
 
+// environment variable mapping helpers
+
 // getEnvAsString reads an environment variable as a string, with a fallback default value.
 func getEnvAsString(name string, defaultVal string) string {
 	if value, exists := os.LookupEnv(name); exists {
@@ -119,3 +125,30 @@ func getEnvAsDuration(name string, defaultVal time.Duration) time.Duration {
 	}
 	return defaultVal
 }
+
+// http field validation functions
+
+// setDefaultBool sets a boolean field to a default value if it is not already set during http client config field validation.
+func setDefaultBool(field *bool, defaultValue bool) {
+	if !*field {
+		*field = defaultValue
+	}
+}
+
+// setDefaultInt sets an integer field to a default value if it is not already set during http client config field validation.
+func setDefaultInt(field *int, defaultValue, minValue int) {
+	if *field == 0 {
+		*field = defaultValue
+	} else if *field < minValue {
+		*field = minValue
+	}
+}
+
+// setDefaultDuration sets a duration field to a default value if it is not already set during http client config field validation.
+func setDefaultDuration(field *time.Duration, defaultValue time.Duration) {
+	if *field == 0 {
+		*field = defaultValue
+	} else if *field < 0 {
+		*field = defaultValue
+	}
+}