added helpers to manage string conversion when uses time duration

Author: ShocOne

helpers/helpers.go

@@ -1,4 +1,4 @@
-// helpers/helpers_test.go
+// helpers/helpers.go
 package helpers
 
 import (
@@ -54,5 +54,27 @@ func (d JSONDuration) Duration() time.Duration {
 	return time.Duration(d)
 }
 
+// MarshalJSON returns the JSON representation of the duration.
+func (d JSONDuration) String() string {
+	return time.Duration(d).String()
+}
+
 // JSONDuration wraps time.Duration for custom JSON unmarshalling.
 type JSONDuration time.Duration
+
+// GetEnvOrDefault returns the value of an environment variable or a default value.
+func GetEnvOrDefault(envKey string, defaultValue string) string {
+	if value, exists := os.LookupEnv(envKey); exists {
+		return value
+	}
+	return defaultValue
+}
+
+// ParseJSONDuration attempts to parse a string value as a duration and returns the result or a default value.
+func ParseJSONDuration(value string, defaultVal JSONDuration) JSONDuration {
+	result, err := time.ParseDuration(value)
+	if err != nil {
+		return defaultVal
+	}
+	return JSONDuration(result)
+}

httpclient/client.go

@@ -14,6 +14,7 @@ import (
 	"github.com/deploymenttheory/go-api-http-client/apiintegrations/apihandler"
 	"github.com/deploymenttheory/go-api-http-client/authenticationhandler"
 	"github.com/deploymenttheory/go-api-http-client/concurrency"
+	"github.com/deploymenttheory/go-api-http-client/helpers"
 
 	"github.com/deploymenttheory/go-api-http-client/logger"
 	"github.com/deploymenttheory/go-api-http-client/redirecthandler"
@@ -94,10 +95,16 @@ type ConcurrencyConfig struct {
 }
 
 // TimeoutConfig holds custom timeout settings.
+// type TimeoutConfig struct {
+// 	CustomTimeout            time.Duration // Custom timeout for the HTTP client
+// 	TokenRefreshBufferPeriod time.Duration // Buffer period before token expiry to attempt token refresh
+// 	TotalRetryDuration       time.Duration // Total duration to attempt retries
+// }
+
 type TimeoutConfig struct {
-	CustomTimeout            time.Duration // Custom timeout for the HTTP client
-	TokenRefreshBufferPeriod time.Duration // Buffer period before token expiry to attempt token refresh
-	TotalRetryDuration       time.Duration // Total duration to attempt retries
+	CustomTimeout            helpers.JSONDuration // Custom timeout for the HTTP client
+	TokenRefreshBufferPeriod helpers.JSONDuration // Buffer period before token expiry to attempt token refresh
+	TotalRetryDuration       helpers.JSONDuration // Total duration to attempt retries
 }
 
 // RedirectConfig holds configuration related to redirect handling.
@@ -152,7 +159,7 @@ func BuildClient(config ClientConfig) (*Client, error) {
 
 	// Initialize the internal HTTP client
 	httpClient := &http.Client{
-		Timeout: config.ClientOptions.Timeout.CustomTimeout,
+		Timeout: config.ClientOptions.Timeout.CustomTimeout.Duration(),
 	}
 
 	// Conditionally setup cookie jar
@@ -206,9 +213,9 @@ func BuildClient(config ClientConfig) (*Client, error) {
 		zap.Int("Max Concurrent Requests", config.ClientOptions.Concurrency.MaxConcurrentRequests),
 		zap.Bool("Follow Redirects", config.ClientOptions.Redirect.FollowRedirects),
 		zap.Int("Max Redirects", config.ClientOptions.Redirect.MaxRedirects),
-		zap.Duration("Token Refresh Buffer Period", config.ClientOptions.Timeout.TokenRefreshBufferPeriod),
-		zap.Duration("Total Retry Duration", config.ClientOptions.Timeout.TotalRetryDuration),
-		zap.Duration("Custom Timeout", config.ClientOptions.Timeout.CustomTimeout),
+		zap.Duration("Token Refresh Buffer Period", config.ClientOptions.Timeout.TokenRefreshBufferPeriod.Duration()),
+		zap.Duration("Total Retry Duration", config.ClientOptions.Timeout.TotalRetryDuration.Duration()),
+		zap.Duration("Custom Timeout", config.ClientOptions.Timeout.CustomTimeout.Duration()),
 	)
 
 	return client, nil

httpclient/client_configuration.go

@@ -12,6 +12,7 @@ import (
 	"strings"
 	"time"
 
+	"github.com/deploymenttheory/go-api-http-client/helpers"
 	"github.com/deploymenttheory/go-api-http-client/logger"
 )
 
@@ -20,9 +21,9 @@ const (
 	DefaultMaxRetryAttempts          = 3
 	DefaultEnableDynamicRateLimiting = true
 	DefaultMaxConcurrentRequests     = 5
-	DefaultTokenBufferPeriod         = 5 * time.Minute
-	DefaultTotalRetryDuration        = 5 * time.Minute
-	DefaultTimeout                   = 10 * time.Second
+	DefaultTokenBufferPeriod         = helpers.JSONDuration(5 * time.Minute)
+	DefaultTotalRetryDuration        = helpers.JSONDuration(5 * time.Minute)
+	DefaultTimeout                   = helpers.JSONDuration(10 * time.Second)
 	FollowRedirects                  = true
 	MaxRedirects                     = 10
 	ConfigFileExtension              = ".json"
@@ -159,13 +160,13 @@ func LoadConfigFromEnv(config *ClientConfig) (*ClientConfig, error) {
 	log.Printf("MaxConcurrentRequests env value found and set to: %d", config.ClientOptions.Concurrency.MaxConcurrentRequests)
 
 	// timeouts
-	config.ClientOptions.Timeout.TokenRefreshBufferPeriod = parseDuration(getEnvOrDefault("TOKEN_REFRESH_BUFFER_PERIOD", config.ClientOptions.Timeout.TokenRefreshBufferPeriod.String()), DefaultTokenBufferPeriod)
+	config.ClientOptions.Timeout.TokenRefreshBufferPeriod = helpers.ParseJSONDuration(getEnvOrDefault("TOKEN_REFRESH_BUFFER_PERIOD", config.ClientOptions.Timeout.TokenRefreshBufferPeriod.String()), DefaultTokenBufferPeriod)
 	log.Printf("TokenRefreshBufferPeriod env value found and set to: %s", config.ClientOptions.Timeout.TokenRefreshBufferPeriod)
 
-	config.ClientOptions.Timeout.TotalRetryDuration = parseDuration(getEnvOrDefault("TOTAL_RETRY_DURATION", config.ClientOptions.Timeout.TotalRetryDuration.String()), DefaultTotalRetryDuration)
+	config.ClientOptions.Timeout.TotalRetryDuration = helpers.ParseJSONDuration(getEnvOrDefault("TOTAL_RETRY_DURATION", config.ClientOptions.Timeout.TotalRetryDuration.String()), DefaultTotalRetryDuration)
 	log.Printf("TotalRetryDuration env value found and set to: %s", config.ClientOptions.Timeout.TotalRetryDuration)
 
-	config.ClientOptions.Timeout.CustomTimeout = parseDuration(getEnvOrDefault("CUSTOM_TIMEOUT", config.ClientOptions.Timeout.CustomTimeout.String()), DefaultTimeout)
+	config.ClientOptions.Timeout.CustomTimeout = helpers.ParseJSONDuration(getEnvOrDefault("CUSTOM_TIMEOUT", config.ClientOptions.Timeout.CustomTimeout.String()), DefaultTimeout)
 	log.Printf("CustomTimeout env value found and set to: %s", config.ClientOptions.Timeout.CustomTimeout)
 
 	// Redirects

httpclient/multipartrequest.go

@@ -48,7 +48,7 @@ func (c *Client) DoMultipartRequest(method, endpoint string, fields map[string]s
 		ClientSecret: c.clientConfig.Auth.ClientSecret,
 	}
 
-	valid, err := c.AuthTokenHandler.CheckAndRefreshAuthToken(c.APIHandler, c.httpClient, clientCredentials, c.clientConfig.ClientOptions.Timeout.TokenRefreshBufferPeriod)
+	valid, err := c.AuthTokenHandler.CheckAndRefreshAuthToken(c.APIHandler, c.httpClient, clientCredentials, c.clientConfig.ClientOptions.Timeout.TokenRefreshBufferPeriod.Duration())
 	if err != nil || !valid {
 		return nil, err
 	}

httpclient/request.go

@@ -124,7 +124,7 @@ func (c *Client) executeRequestWithRetries(method, endpoint string, body, out in
 		ClientSecret: c.clientConfig.Auth.ClientSecret,
 	}
 
-	valid, err := c.AuthTokenHandler.CheckAndRefreshAuthToken(c.APIHandler, c.httpClient, clientCredentials, c.clientConfig.ClientOptions.Timeout.TokenRefreshBufferPeriod)
+	valid, err := c.AuthTokenHandler.CheckAndRefreshAuthToken(c.APIHandler, c.httpClient, clientCredentials, c.clientConfig.ClientOptions.Timeout.TokenRefreshBufferPeriod.Duration())
 	if err != nil || !valid {
 		return nil, err
 	}
@@ -169,7 +169,7 @@ func (c *Client) executeRequestWithRetries(method, endpoint string, body, out in
 	headerHandler.LogHeaders(c.clientConfig.ClientOptions.Logging.HideSensitiveData)
 
 	// Define a retry deadline based on the client's total retry duration configuration
-	totalRetryDeadline := time.Now().Add(c.clientConfig.ClientOptions.Timeout.TotalRetryDuration)
+	totalRetryDeadline := time.Now().Add(c.clientConfig.ClientOptions.Timeout.TotalRetryDuration.Duration())
 
 	var resp *http.Response
 	var retryCount int
@@ -290,7 +290,7 @@ func (c *Client) executeRequest(method, endpoint string, body, out interface{})
 		ClientSecret: c.clientConfig.Auth.ClientSecret,
 	}
 
-	valid, err := c.AuthTokenHandler.CheckAndRefreshAuthToken(c.APIHandler, c.httpClient, clientCredentials, c.clientConfig.ClientOptions.Timeout.TokenRefreshBufferPeriod)
+	valid, err := c.AuthTokenHandler.CheckAndRefreshAuthToken(c.APIHandler, c.httpClient, clientCredentials, c.clientConfig.ClientOptions.Timeout.TokenRefreshBufferPeriod.Duration())
 	if err != nil || !valid {
 		return nil, err
 	}