Add mock implementations for structured logging methods

Author: ShocOne

httpclient/httpclient_mocklogger.go

@@ -2,6 +2,8 @@
 package httpclient
 
 import (
+	"time"
+
 	"github.com/deploymenttheory/go-api-http-client/logger"
 	"github.com/stretchr/testify/mock"
 	"go.uber.org/zap"
@@ -28,6 +30,8 @@ func (m *MockLogger) SetLevel(level logger.LogLevel) {
 	m.Called(level)
 }
 
+// Mock implementations for unstructured logging methods
+
 func (m *MockLogger) Debug(msg string, fields ...zap.Field) {
 	m.Called(msg, fields)
 }
@@ -40,7 +44,6 @@ func (m *MockLogger) Warn(msg string, fields ...zap.Field) {
 	m.Called(msg, fields)
 }
 
-// Error method
 func (m *MockLogger) Error(msg string, fields ...zap.Field) error {
 	args := m.Called(msg, fields)
 	return args.Error(0)
@@ -63,3 +66,29 @@ func (m *MockLogger) GetLogLevel() logger.LogLevel {
 	args := m.Called()
 	return args.Get(0).(logger.LogLevel)
 }
+
+// Mock implementations for structured logging methods
+
+func (m *MockLogger) LogRequestStart(requestID string, userID string, method string, url string, headers map[string][]string) {
+	m.Called(requestID, userID, method, url, headers)
+}
+
+func (m *MockLogger) LogRequestEnd(method string, url string, statusCode int, duration time.Duration) {
+	m.Called(method, url, statusCode, duration)
+}
+
+func (m *MockLogger) LogError(method string, url string, statusCode int, err error, stacktrace string) {
+	m.Called(method, url, statusCode, err, stacktrace)
+}
+
+func (m *MockLogger) LogRetryAttempt(method string, url string, attempt int, reason string, waitDuration time.Duration, err error) {
+	m.Called(method, url, attempt, reason, waitDuration, err)
+}
+
+func (m *MockLogger) LogRateLimiting(method string, url string, retryAfter string, waitDuration time.Duration) {
+	m.Called(method, url, retryAfter, waitDuration)
+}
+
+func (m *MockLogger) LogResponse(method string, url string, statusCode int, responseBody string, responseHeaders map[string][]string, duration time.Duration) {
+	m.Called(method, url, statusCode, responseBody, responseHeaders, duration)
+}

logger/zaplogger_logfields.go

@@ -8,7 +8,7 @@ import (
 
 // LogRequestStart logs the initiation of an HTTP request if the current log level permits.
 func (d *defaultLogger) LogRequestStart(requestID string, userID string, method string, url string, headers map[string][]string) {
-	if d.logLevel <= LogLevelInfo { // Assuming LogLevelInfo is appropriate for request start messages.
+	if d.logLevel <= LogLevelInfo {
 		fields := []zap.Field{
 			zap.String("event", "request_start"),
 			zap.String("method", method),
@@ -23,7 +23,7 @@ func (d *defaultLogger) LogRequestStart(requestID string, userID string, method
 
 // LogRequestEnd logs the completion of an HTTP request if the current log level permits.
 func (d *defaultLogger) LogRequestEnd(method string, url string, statusCode int, duration time.Duration) {
-	if d.logLevel <= LogLevelInfo { // Assuming LogLevelInfo is appropriate for request end messages.
+	if d.logLevel <= LogLevelInfo {
 		fields := []zap.Field{
 			zap.String("event", "request_end"),
 			zap.String("method", method),
@@ -52,7 +52,7 @@ func (d *defaultLogger) LogError(method string, url string, statusCode int, err
 
 // LogRetryAttempt logs a retry attempt for an HTTP request if the current log level permits, including wait duration and the error that triggered the retry.
 func (d *defaultLogger) LogRetryAttempt(method string, url string, attempt int, reason string, waitDuration time.Duration, err error) {
-	if d.logLevel <= LogLevelWarn { // Assuming LogLevelWarn is appropriate for retry attempt messages.
+	if d.logLevel <= LogLevelWarn {
 		fields := []zap.Field{
 			zap.String("event", "retry_attempt"),
 			zap.String("method", method),
@@ -68,7 +68,7 @@ func (d *defaultLogger) LogRetryAttempt(method string, url string, attempt int,
 
 // LogRateLimiting logs when an HTTP request is rate-limited, including the HTTP method, URL, the value of the 'Retry-After' header, and the actual wait duration.
 func (d *defaultLogger) LogRateLimiting(method string, url string, retryAfter string, waitDuration time.Duration) {
-	if d.logLevel <= LogLevelWarn { // Check if the log level permits warning messages.
+	if d.logLevel <= LogLevelWarn {
 		fields := []zap.Field{
 			zap.String("event", "rate_limited"),
 			zap.String("method", method),

logger/zaplogger_logger.go

@@ -51,6 +51,15 @@ func (d *defaultLogger) SetLevel(level LogLevel) {
 	d.logLevel = level
 }
 
+// With adds contextual key-value pairs to the logger, returning a new logger instance with the context.
+// This is useful for creating a logger with common fields that should be included in all subsequent log entries.
+func (d *defaultLogger) With(fields ...zapcore.Field) Logger {
+	return &defaultLogger{
+		logger:   d.logger.With(fields...),
+		logLevel: d.logLevel,
+	}
+}
+
 // Debug logs a message at the Debug level. This level is typically used for detailed troubleshooting
 // information that is only relevant during active development or debugging.
 func (d *defaultLogger) Debug(msg string, fields ...zapcore.Field) {
@@ -109,14 +118,14 @@ func GetLoggerBasedOnEnv() *zap.Logger {
 	if os.Getenv("APP_ENV") == "development" {
 		logger, err := zap.NewDevelopment()
 		if err != nil {
-			panic(err) // Handle error according to your application's error policy
+			panic(err)
 		}
 		return logger
 	}
 
 	logger, err := zap.NewProduction()
 	if err != nil {
-		panic(err) // Handle error according to your application's error policy
+		panic(err)
 	}
 	return logger
 }