Refactor error handling and logging in httpclient package

Author: ShocOne

httpclient/httpclient_error_response.go

@@ -7,7 +7,6 @@ import (
 	"fmt"
 	"io"
 	"net/http"
-	"runtime/debug"
 	"strings"
 
 	"github.com/deploymenttheory/go-api-http-client/logger"
@@ -49,20 +48,17 @@ func handleAPIErrorResponse(resp *http.Response, log logger.Logger) *APIError {
 		return apiError
 	}
 
-	stackTrace := string(debug.Stack())
-
 	// Check if the response is JSON
 	if isJSONResponse(resp) {
 		// Attempt to parse the response into a StructuredError
 		if err := json.Unmarshal(bodyBytes, &apiError); err == nil && apiError.Message != "" {
-			stackTrace := string(debug.Stack())
 			log.LogError(
 				"json_structured_error_detected", // event
 				resp.Request.Method,              // method
 				resp.Request.URL.String(),        // url
 				resp.StatusCode,                  // statusCode
 				fmt.Errorf(apiError.Message),     // err
-				stackTrace,                       // stacktrace
+				apiError.Raw,                     // raw resp
 			)
 			return apiError
 		}
@@ -83,7 +79,7 @@ func handleAPIErrorResponse(resp *http.Response, log logger.Logger) *APIError {
 			resp.Request.URL.String(),    // url
 			resp.StatusCode,              // statusCode
 			fmt.Errorf(apiError.Message), // err
-			stackTrace,                   // stacktrace
+			apiError.Raw,                 // raw resp
 		)
 		return apiError
 	} else {
@@ -95,7 +91,7 @@ func handleAPIErrorResponse(resp *http.Response, log logger.Logger) *APIError {
 			resp.Request.URL.String(),                      // url
 			resp.StatusCode,                                // statusCode
 			fmt.Errorf("Non-JSON error response received"), // err
-			stackTrace,                                     // stacktrace
+			apiError.Raw,                                   // raw resp
 		)
 		return apiError
 	}

httpclient/httpclient_mocklogger.go

@@ -77,8 +77,8 @@ func (m *MockLogger) LogRequestEnd(event string, method string, url string, stat
 	m.Called(event, method, url, statusCode, duration)
 }
 
-func (m *MockLogger) LogError(event string, method string, url string, statusCode int, err error, stacktrace string) {
-	m.Called(event, method, url, statusCode, err, stacktrace)
+func (m *MockLogger) LogError(event string, method string, url string, statusCode int, serverStatusMessage string, err error, stacktrace string) {
+	m.Called(event, method, url, statusCode, serverStatusMessage, err, stacktrace)
 }
 
 func (m *MockLogger) LogAuthTokenError(event string, method string, url string, statusCode int, err error) {

httpclient/httpclient_request.go

@@ -207,8 +207,7 @@ func (c *Client) executeRequestWithRetries(method, endpoint string, body, out in
 			if apiErr := handleAPIErrorResponse(resp, log); apiErr != nil {
 				err = apiErr
 			}
-			log.LogError("request_error", method, endpoint, resp.StatusCode, err, status.TranslateStatusCode(resp))
-
+			log.LogError("request_error", method, endpoint, resp.StatusCode, resp.Status, err, status.TranslateStatusCode(resp))
 			break
 		}
 	}

logger/zaplogger_logfields.go

@@ -36,7 +36,7 @@ func (d *defaultLogger) LogRequestEnd(event string, method string, url string, s
 }
 
 // LogError logs an error that occurs during the processing of an HTTP request or any other event, if the current log level permits.
-func (d *defaultLogger) LogError(event string, method, url string, statusCode int, err error, stacktrace string) {
+func (d *defaultLogger) LogError(event string, method, url string, statusCode int, serverStatusMessage string, err error, stacktrace string) {
 	if d.logLevel <= LogLevelError {
 		errorMessage := ""
 		if err != nil {
@@ -48,6 +48,7 @@ func (d *defaultLogger) LogError(event string, method, url string, statusCode in
 			zap.String("method", method),
 			zap.String("url", url),
 			zap.Int("status_code", statusCode),
+			zap.String("status_message", serverStatusMessage),
 			zap.String("error_message", errorMessage),
 			zap.String("stacktrace", stacktrace),
 		}

logger/zaplogger_logger.go

@@ -34,7 +34,7 @@ type Logger interface {
 	// Updated method signatures to include the 'event' parameter
 	LogRequestStart(event string, requestID string, userID string, method string, url string, headers map[string][]string)
 	LogRequestEnd(event string, method string, url string, statusCode int, duration time.Duration)
-	LogError(event string, method string, url string, statusCode int, err error, stacktrace string)
+	LogError(event string, method string, url string, statusCode int, serverStatusMessage string, err error, stacktrace string)
 	LogAuthTokenError(event string, method string, url string, statusCode int, err error)
 	LogRetryAttempt(event string, method string, url string, attempt int, reason string, waitDuration time.Duration, err error)
 	LogRateLimiting(event string, method string, url string, retryAfter string, waitDuration time.Duration)