Refactor authentication token management and logging

Author: ShocOne

internal/httpclient/http_client_auth_token_management.go

@@ -21,12 +21,12 @@ func (c *Client) ValidAuthTokenCheck(log logger.Logger) (bool, error) {
 	if c.Token == "" {
 		c.Logger.Debug("No token found, attempting to obtain a new one")
 		if c.AuthMethod == "bearer" {
-			err := c.ObtainToken()
+			err := c.ObtainToken(log)
 			if err != nil {
 				return false, c.Logger.Error("Failed to obtain bearer token", zap.Error(err))
 			}
 		} else if c.AuthMethod == "oauth" {
-			if err := c.ObtainOAuthToken(c.config.Auth); err != nil {
+			if err := c.ObtainOAuthToken(c.config.Auth, log); err != nil {
 				return false, c.Logger.Error("Failed to obtain OAuth token", zap.Error(err))
 			}
 		} else {
@@ -37,9 +37,9 @@ func (c *Client) ValidAuthTokenCheck(log logger.Logger) (bool, error) {
 	if time.Until(c.Expiry) < c.config.TokenRefreshBufferPeriod {
 		var err error
 		if c.BearerTokenAuthCredentials.Username != "" && c.BearerTokenAuthCredentials.Password != "" {
-			err = c.RefreshToken()
+			err = c.RefreshToken(log)
 		} else if c.OAuthCredentials.ClientID != "" && c.OAuthCredentials.ClientSecret != "" {
-			err = c.ObtainOAuthToken(c.config.Auth)
+			err = c.ObtainOAuthToken(c.config.Auth, log)
 		} else {
 			return false, c.Logger.Error("Unknown auth method", zap.String("authMethod", c.AuthMethod))
 		}

internal/httpclient/http_client_bearer_token_auth.go

@@ -28,7 +28,7 @@ func (c *Client) SetBearerTokenAuthCredentials(credentials BearerTokenAuthCreden
 
 // ObtainToken fetches and sets an authentication token using the stored basic authentication credentials.
 func (c *Client) ObtainToken(log logger.Logger) error {
-	authenticationEndpoint := c.ConstructAPIAuthEndpoint(BearerTokenEndpoint)
+	authenticationEndpoint := APIHandler.ConstructAPIAuthEndpoint(BearerTokenEndpoint)
 
 	log.Debug("Attempting to obtain token for user", zap.String("Username", c.BearerTokenAuthCredentials.Username))
 

internal/httpclient/http_client_defaultconfig.go

@@ -2,10 +2,12 @@ package httpclient
 
 import (
 	"time"
+
+	"github.com/deploymenttheory/go-api-http-client/internal/logger"
 )
 
 const (
-	DefaultLogLevel                  = LogLevelInfo
+	DefaultLogLevel                  = logger.LogLevelInfo
 	DefaultMaxRetryAttempts          = 3
 	DefaultEnableDynamicRateLimiting = true
 	DefaultMaxConcurrentRequests     = 5

internal/httpclient/http_client_oauth.go

@@ -14,6 +14,7 @@ import (
 	"strings"
 	"time"
 
+	"github.com/deploymenttheory/go-api-http-client/internal/logger"
 	"go.uber.org/zap"
 )
 
@@ -41,32 +42,32 @@ func (c *Client) SetOAuthCredentials(credentials OAuthCredentials) {
 
 // ObtainOAuthToken fetches an OAuth access token using the provided OAuthCredentials (Client ID and Client Secret).
 // It updates the client's Token and Expiry fields with the obtained values.
-func (c *Client) ObtainOAuthToken(credentials AuthConfig) error {
+func (c *Client) ObtainOAuthToken(credentials AuthConfig, log logger.Logger) error {
 	authenticationEndpoint := c.ConstructAPIAuthEndpoint(OAuthTokenEndpoint)
 	data := url.Values{}
 	data.Set("client_id", credentials.ClientID)
 	data.Set("client_secret", credentials.ClientSecret)
 	data.Set("grant_type", "client_credentials")
 
-	c.logger.Debug("Attempting to obtain OAuth token", zap.String("ClientID", credentials.ClientID))
+	log.Debug("Attempting to obtain OAuth token", zap.String("ClientID", credentials.ClientID))
 
 	req, err := http.NewRequest("POST", authenticationEndpoint, strings.NewReader(data.Encode()))
 	if err != nil {
-		c.logger.Error("Failed to create request for OAuth token", zap.Error(err))
+		log.Error("Failed to create request for OAuth token", zap.Error(err))
 		return err
 	}
 	req.Header.Add("Content-Type", "application/x-www-form-urlencoded")
 
 	resp, err := c.httpClient.Do(req)
 	if err != nil {
-		c.logger.Error("Failed to execute request for OAuth token", zap.Error(err))
+		log.Error("Failed to execute request for OAuth token", zap.Error(err))
 		return err
 	}
 	defer resp.Body.Close()
 
 	bodyBytes, err := io.ReadAll(resp.Body)
 	if err != nil {
-		c.logger.Error("Failed to read response body", zap.Error(err))
+		log.Error("Failed to read response body", zap.Error(err))
 		return err
 	}
 
@@ -76,23 +77,23 @@ func (c *Client) ObtainOAuthToken(credentials AuthConfig) error {
 	oauthResp := &OAuthResponse{}
 	err = json.Unmarshal(bodyBytes, oauthResp)
 	if err != nil {
-		c.logger.Error("Failed to decode OAuth response", zap.Error(err))
+		log.Error("Failed to decode OAuth response", zap.Error(err))
 		return err
 	}
 
 	if oauthResp.Error != "" {
-		c.logger.Error("Error obtaining OAuth token", zap.String("Error", oauthResp.Error))
+		log.Error("Error obtaining OAuth token", zap.String("Error", oauthResp.Error))
 		return fmt.Errorf("error obtaining OAuth token: %s", oauthResp.Error)
 	}
 
 	if oauthResp.AccessToken == "" {
-		c.logger.Error("Empty access token received")
+		log.Error("Empty access token received")
 		return fmt.Errorf("empty access token received")
 	}
 
 	expiresIn := time.Duration(oauthResp.ExpiresIn) * time.Second
 	expirationTime := time.Now().Add(expiresIn)
-	c.logger.Info("OAuth token obtained successfully", zap.String("AccessToken", oauthResp.AccessToken), zap.Duration("ExpiresIn", expiresIn), zap.Time("ExpirationTime", expirationTime))
+	log.Info("OAuth token obtained successfully", zap.String("AccessToken", oauthResp.AccessToken), zap.Duration("ExpiresIn", expiresIn), zap.Time("ExpirationTime", expirationTime))
 
 	c.Token = oauthResp.AccessToken
 	c.Expiry = expirationTime
@@ -102,32 +103,32 @@ func (c *Client) ObtainOAuthToken(credentials AuthConfig) error {
 
 // InvalidateOAuthToken invalidates the current OAuth access token.
 // After invalidation, the token cannot be used for further API requests.
-func (c *Client) InvalidateOAuthToken() error {
+func (c *Client) InvalidateOAuthToken(log logger.Logger) error {
 	invalidateTokenEndpoint := c.ConstructAPIAuthEndpoint(TokenInvalidateEndpoint)
 
-	c.logger.Debug("Attempting to invalidate OAuth token", zap.String("Endpoint", invalidateTokenEndpoint))
+	log.Debug("Attempting to invalidate OAuth token", zap.String("Endpoint", invalidateTokenEndpoint))
 
 	req, err := http.NewRequest("POST", invalidateTokenEndpoint, nil)
 	if err != nil {
-		c.logger.Error("Failed to create new request for token invalidation", zap.Error(err))
+		log.Error("Failed to create new request for token invalidation", zap.Error(err))
 		return err
 	}
 	req.Header.Add("Authorization", "Bearer "+c.Token)
 
 	resp, err := c.httpClient.Do(req)
 	if err != nil {
-		c.logger.Error("Failed to make request for token invalidation", zap.Error(err))
+		log.Error("Failed to make request for token invalidation", zap.Error(err))
 		return err
 	}
 	defer resp.Body.Close()
 
 	if resp.StatusCode != http.StatusNoContent {
 		errMsg := fmt.Errorf("failed to invalidate token, status code: %d", resp.StatusCode)
-		c.logger.Error("Failed to invalidate OAuth token", zap.Int("StatusCode", resp.StatusCode), zap.Error(errMsg))
+		log.Error("Failed to invalidate OAuth token", zap.Int("StatusCode", resp.StatusCode), zap.Error(errMsg))
 		return errMsg
 	}
 
-	c.logger.Info("OAuth token invalidated successfully", zap.String("Endpoint", invalidateTokenEndpoint))
+	log.Info("OAuth token invalidated successfully", zap.String("Endpoint", invalidateTokenEndpoint))
 
 	return nil
 }