Add httpclient package and update logger initialization

Author: ShocOne

internal/apihandlers/jamfpro/jamfpro_api_handler.go

@@ -49,6 +49,7 @@ import (
 
 	_ "embed"
 
+	"github.com/deploymenttheory/go-api-http-client/internal/httpclient"
 	"github.com/deploymenttheory/go-api-http-client/internal/logger"
 	"go.uber.org/zap"
 )
@@ -256,8 +257,8 @@ func (u *JamfAPIHandler) UnmarshalResponse(resp *http.Response, out interface{},
 	// If content type is HTML, extract the error message
 	if strings.Contains(contentType, "text/html") {
 		errMsg := ExtractErrorMessageFromHTML(string(bodyBytes))
-		log.Warn("Received HTML content", "error_message", errMsg, "status_code", resp.StatusCode)
-		return &APIError{
+		log.Warn("Received HTML content", zap.String("error_message", errMsg), zap.Int("status_code", resp.StatusCode))
+		return &httpclient.APIError{
 			StatusCode: resp.StatusCode,
 			Message:    errMsg,
 		}

internal/httpclient/http_client.go

@@ -73,8 +73,8 @@ type Client struct {
 
 // BuildClient creates a new HTTP client with the provided configuration.
 func BuildClient(config Config) (*Client, error) {
-	// Initialize the logger using the NewDefaultLogger function from the logger package.
-	log := logger.NewDefaultLogger()
+	// Initialize the zap logger.
+	log := logger.BuildLogger(config.LogLevel)
 
 	// Set the logger's level based on the provided configuration.
 	log.SetLevel(config.LogLevel)

internal/logger/logger.go

@@ -15,20 +15,19 @@ type LogLevel int
 
 const (
 	// LogLevelDebug is for messages that are useful during software debugging.
-	LogLevelDebug LogLevel = iota - 1 // Adjusted value to -1 to follow Zap's convention for DEBUG.
+	LogLevelDebug LogLevel = -1 // Zap's DEBUG level
 	// LogLevelInfo is for informational messages, indicating normal operation.
-	LogLevelInfo
+	LogLevelInfo LogLevel = 0 // Zap's INFO level
 	// LogLevelWarn is for messages that highlight potential issues in the system.
-	LogLevelWarn
+	LogLevelWarn LogLevel = 1 // Zap's WARN level
 	// LogLevelError is for messages that highlight errors in the application's execution.
-	LogLevelError
-	// LogLevelDPanic is for severe error conditions that are actionable in development. It panics in development and logs as an error in production.
-	LogLevelDPanic
+	LogLevelError LogLevel = 2 // Zap's ERROR level
+	// LogLevelDPanic is for severe error conditions that are actionable in development.
+	LogLevelDPanic LogLevel = 3 // Zap's DPANIC level
 	// LogLevelPanic is for severe error conditions that should cause the program to panic.
-	LogLevelPanic
+	LogLevelPanic LogLevel = 4 // Zap's PANIC level
 	// LogLevelFatal is for errors that require immediate program termination.
-	LogLevelFatal
-	// LogLevelNone is used to disable logging.
+	LogLevelFatal LogLevel = 5 // Zap's FATAL level
 	LogLevelNone
 )
 
@@ -53,41 +52,6 @@ type defaultLogger struct {
 	logLevel LogLevel    // logLevel determines the current logging level (e.g., DEBUG, INFO, WARN).
 }
 
-// NewDefaultLogger creates and returns a new logger instance with a default production configuration.
-// It uses JSON formatting for log messages and sets the initial log level to Info. If the logger cannot
-// be initialized, the function panics to indicate a critical setup failure.
-func NewDefaultLogger() Logger {
-	// Set up custom encoder configuration
-	encoderCfg := zap.NewProductionEncoderConfig()
-	encoderCfg.TimeKey = "timestamp"
-	encoderCfg.EncodeTime = zapcore.ISO8601TimeEncoder // Use ISO8601 format for timestamps
-
-	// Define the logger configuration
-	config := zap.Config{
-		Level:            zap.NewAtomicLevelAt(zap.InfoLevel), // Default log level is Info
-		Development:      false,                               // Set to true if the logger is used in a development environment
-		Encoding:         "json",                              // Use JSON format for structured logging
-		EncoderConfig:    encoderCfg,
-		OutputPaths:      []string{"stdout"}, // Log to standard output
-		ErrorOutputPaths: []string{"stderr"}, // Log internal Zap errors to standard error
-		InitialFields: map[string]interface{}{
-			"application": "your-application-name", // Customize this field to suit your needs
-		},
-	}
-
-	// Build the logger from the configuration
-	logger, err := config.Build()
-	if err != nil {
-		panic(err) // Panic if there is an error initializing the logger
-	}
-
-	// Wrap the Zap logger in your defaultLogger struct, which implements your Logger interface
-	return &defaultLogger{
-		logger:   logger,
-		logLevel: LogLevelInfo, // Assuming LogLevelInfo maps to zap.InfoLevel
-	}
-}
-
 // SetLevel updates the logging level of the logger. It controls the verbosity of the logs,
 // allowing the option to filter out less severe messages based on the specified level.
 func (d *defaultLogger) SetLevel(level LogLevel) {

internal/logger/loggerconfig.go

@@ -0,0 +1,73 @@
+// logger.go
+package logger
+
+// Ref: https://betterstack.com/community/guides/logging/go/zap/#logging-errors-with-zap
+
+import (
+	"go.uber.org/zap"
+	"go.uber.org/zap/zapcore"
+)
+
+// BuildLogger creates and returns a new logger instance with a default production configuration.
+// It uses JSON formatting for log messages and sets the initial log level to Info. If the logger cannot
+// be initialized, the function panics to indicate a critical setup failure.
+func BuildLogger(logLevel LogLevel) Logger {
+	// Set up custom encoder configuration
+	encoderCfg := zap.NewProductionEncoderConfig()
+	encoderCfg.TimeKey = "timestamp"
+	encoderCfg.EncodeTime = zapcore.ISO8601TimeEncoder // Use ISO8601 format for timestamps
+
+	// Convert the custom LogLevel to zap's logging level
+	zapLogLevel := convertToZapLevel(logLevel)
+
+	// Define the logger configuration
+	config := zap.Config{
+		Level:             zap.NewAtomicLevelAt(zapLogLevel), // Default log level is Info
+		Development:       false,                             // Set to true if the logger is used in a development environment
+		Encoding:          "json",                            // Use JSON format for structured logging
+		DisableCaller:     false,
+		DisableStacktrace: false,
+		Sampling:          nil,
+		EncoderConfig:     encoderCfg,
+		OutputPaths: []string{
+			"stdout", // Log info and above to standard output
+		},
+		ErrorOutputPaths: []string{
+			"stderr", // Log internal Zap errors to standard error
+		},
+		InitialFields: map[string]interface{}{
+			"application": "your-application-name", // Customize this field to suit your needs
+		},
+	}
+
+	// Build the logger from the configuration
+	logger := zap.Must(config.Build())
+
+	// Wrap the Zap logger in your defaultLogger struct, which implements your Logger interface
+	return &defaultLogger{
+		logger:   logger,
+		logLevel: LogLevelInfo, // Assuming LogLevelInfo maps to zap.InfoLevel
+	}
+}
+
+// convertToZapLevel converts the custom LogLevel to a zapcore.Level
+func convertToZapLevel(level LogLevel) zapcore.Level {
+	switch level {
+	case LogLevelDebug:
+		return zap.DebugLevel
+	case LogLevelInfo:
+		return zap.InfoLevel
+	case LogLevelWarn:
+		return zap.WarnLevel
+	case LogLevelError:
+		return zap.ErrorLevel
+	case LogLevelDPanic:
+		return zap.DPanicLevel
+	case LogLevelPanic:
+		return zap.PanicLevel
+	case LogLevelFatal:
+		return zap.FatalLevel
+	default:
+		return zap.InfoLevel // Default to InfoLevel
+	}
+}