Add logging for outgoing and incoming cookies

Author: ShocOne

httpclient/httpclient_mocklogger.go

@@ -96,3 +96,7 @@ func (m *MockLogger) LogRateLimiting(event string, method string, url string, re
 func (m *MockLogger) LogResponse(event string, method string, url string, statusCode int, responseBody string, responseHeaders map[string][]string, duration time.Duration) {
 	m.Called(event, method, url, statusCode, responseBody, responseHeaders, duration)
 }
+
+func (m *MockLogger) LogCookies(direction string, obj interface{}, method, url string) {
+	m.Called(direction, obj, method, url)
+}

httpclient/httpclient_request.go

@@ -160,7 +160,16 @@ func (c *Client) executeRequestWithRetries(method, endpoint string, body, out in
 	var retryCount int
 	for time.Now().Before(totalRetryDeadline) { // Check if the current time is before the total retry deadline
 		req = req.WithContext(ctx)
+
+		// Log outgoing cookies
+		log.LogCookies("outgoing", req, method, endpoint)
+
+		// Execute the HTTP request
 		resp, err = c.do(req, log, method, endpoint)
+
+		// Log outgoing cookies
+		log.LogCookies("incoming", req, method, endpoint)
+
 		// Check for successful status code
 		if err == nil && resp.StatusCode >= 200 && resp.StatusCode < 400 {
 			if resp.StatusCode >= 300 {
@@ -301,12 +310,18 @@ func (c *Client) executeRequest(method, endpoint string, body, out interface{})
 
 	req = req.WithContext(ctx)
 
+	// Log outgoing cookies
+	log.LogCookies("outgoing", req, method, endpoint)
+
 	// Execute the HTTP request
 	resp, err := c.do(req, log, method, endpoint)
 	if err != nil {
 		return nil, err
 	}
 
+	// Log incoming cookies
+	log.LogCookies("incoming", req, method, endpoint)
+
 	// Checks for the presence of a deprecation header in the HTTP response and logs if found.
 	CheckDeprecationHeader(resp, log)
 
@@ -341,7 +356,9 @@ func (c *Client) executeRequest(method, endpoint string, body, out interface{})
 // This function should be used whenever the client needs to send an HTTP request. It abstracts away the common logic of
 // request execution and error handling, providing detailed logs for debugging and monitoring.
 func (c *Client) do(req *http.Request, log logger.Logger, method, endpoint string) (*http.Response, error) {
+
 	resp, err := c.httpClient.Do(req)
+
 	if err != nil {
 		// Log the error with structured logging, including method, endpoint, and the error itself
 		log.Error("Failed to send request",

logger/zaplogger_logfields.go

@@ -1,6 +1,7 @@
 package logger
 
 import (
+	"net/http"
 	"time"
 
 	"go.uber.org/zap"
@@ -115,3 +116,37 @@ func (d *defaultLogger) LogResponse(event string, method string, url string, sta
 		d.logger.Info("HTTP response details", fields...)
 	}
 }
+
+// LogCookies logs the cookies associated with an HTTP request or response.
+// `direction` indicates whether the cookies are being sent ("outgoing") or received ("incoming").
+// `obj` can be either *http.Request or *http.Response.
+func (d *defaultLogger) LogCookies(direction string, obj interface{}, method, url string) {
+	var cookies []*http.Cookie
+	var objectType string
+
+	// Determine the type and extract cookies
+	switch v := obj.(type) {
+	case *http.Request:
+		cookies = v.Cookies()
+		objectType = "request"
+	case *http.Response:
+		cookies = v.Cookies()
+		objectType = "response"
+	default:
+		// Log a warning if the object is not a request or response
+		d.logger.Warn("Invalid object type for cookie logging", zap.Any("object", obj))
+		return
+	}
+
+	// Log the cookies if any are present
+	if len(cookies) > 0 {
+		fields := []zap.Field{
+			zap.String("direction", direction),
+			zap.String("object_type", objectType),
+			zap.String("method", method),
+			zap.String("url", url),
+			zap.Any("cookies", cookies),
+		}
+		d.logger.Debug("Cookies logged", fields...)
+	}
+}

logger/zaplogger_logger.go

@@ -39,6 +39,7 @@ type Logger interface {
 	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)
 	LogResponse(event string, method string, url string, statusCode int, responseBody string, responseHeaders map[string][]string, duration time.Duration)
+	LogCookies(direction string, obj interface{}, method, url string)
 }
 
 // GetLogLevel returns the current logging level of the logger. This allows for checking the logger's