Pre-release cleanup.

2026-10-15 04:18:03 +00:00 · 2025-09-16 23:04:20 +01:00
parent 99c30c0e29
commit ff2562f9fe
22 changed files with 4353 additions and 52 deletions
@@ -0,0 +1,83 @@
+package logger
+
+import (
+	"fmt"
+	"log"
+)
+
+// LegacyLoggerAdapter wraps the old Logger struct from the main package
+// to implement the new unified Logger interface. This allows for gradual
+// migration of the codebase to the new logger interface.
+type LegacyLoggerAdapter struct {
+	logError *log.Logger
+	logInfo  *log.Logger
+	logDebug *log.Logger
+}
+
+// NewLegacyAdapter creates a new adapter from the old logger components
+func NewLegacyAdapter(logError, logInfo, logDebug *log.Logger) Logger {
+	if logError == nil || logInfo == nil || logDebug == nil {
+		return GetNoOpLogger()
+	}
+	return &LegacyLoggerAdapter{
+		logError: logError,
+		logInfo:  logInfo,
+		logDebug: logDebug,
+	}
+}
+
+// Debug logs a debug message
+func (l *LegacyLoggerAdapter) Debug(msg string) {
+	l.logDebug.Print(msg)
+}
+
+// Debugf logs a formatted debug message
+func (l *LegacyLoggerAdapter) Debugf(format string, args ...interface{}) {
+	l.logDebug.Printf(format, args...)
+}
+
+// Info logs an info message
+func (l *LegacyLoggerAdapter) Info(msg string) {
+	l.logInfo.Print(msg)
+}
+
+// Infof logs a formatted info message
+func (l *LegacyLoggerAdapter) Infof(format string, args ...interface{}) {
+	l.logInfo.Printf(format, args...)
+}
+
+// Error logs an error message
+func (l *LegacyLoggerAdapter) Error(msg string) {
+	l.logError.Print(msg)
+}
+
+// Errorf logs a formatted error message
+func (l *LegacyLoggerAdapter) Errorf(format string, args ...interface{}) {
+	l.logError.Printf(format, args...)
+}
+
+// Printf logs a formatted message at info level
+func (l *LegacyLoggerAdapter) Printf(format string, args ...interface{}) {
+	l.logInfo.Printf(format, args...)
+}
+
+// Println logs a message at info level
+func (l *LegacyLoggerAdapter) Println(args ...interface{}) {
+	l.logInfo.Print(args...)
+}
+
+// Fatalf logs a formatted error message and panics
+func (l *LegacyLoggerAdapter) Fatalf(format string, args ...interface{}) {
+	l.logError.Printf(format, args...)
+	panic(fmt.Sprintf(format, args...))
+}
+
+// WithField returns the same logger (no structured logging support in legacy adapter)
+func (l *LegacyLoggerAdapter) WithField(key string, value interface{}) Logger {
+	return l
+}
+
+// WithFields returns the same logger (no structured logging support in legacy adapter)
+func (l *LegacyLoggerAdapter) WithFields(fields map[string]interface{}) Logger {
+	return l
+}
@@ -0,0 +1,182 @@
+package logger
+
+import (
+	"io"
+	"os"
+	"sync"
+)
+
+// Factory creates and manages logger instances with singleton support
+// for common logger types to reduce memory allocation.
+type Factory struct {
+	mu              sync.RWMutex
+	defaultLogger   Logger
+	noOpLogger      Logger
+	loggers         map[string]Logger
+	defaultLogLevel string
+}
+
+var (
+	// globalFactory is the singleton factory instance
+	globalFactory *Factory
+	// factoryOnce ensures the factory is created only once
+	factoryOnce sync.Once
+)
+
+// GetFactory returns the global logger factory instance
+func GetFactory() *Factory {
+	factoryOnce.Do(func() {
+		globalFactory = &Factory{
+			loggers:         make(map[string]Logger),
+			defaultLogLevel: "info",
+		}
+	})
+	return globalFactory
+}
+
+// SetDefaultLogLevel sets the default log level for new loggers
+func (f *Factory) SetDefaultLogLevel(level string) {
+	f.mu.Lock()
+	defer f.mu.Unlock()
+	f.defaultLogLevel = level
+}
+
+// GetLogger returns a logger for the given name, creating one if it doesn't exist
+func (f *Factory) GetLogger(name string) Logger {
+	f.mu.RLock()
+	if logger, exists := f.loggers[name]; exists {
+		f.mu.RUnlock()
+		return logger
+	}
+	f.mu.RUnlock()
+
+	// Create new logger
+	f.mu.Lock()
+	defer f.mu.Unlock()
+
+	// Double check after acquiring write lock
+	if logger, exists := f.loggers[name]; exists {
+		return logger
+	}
+
+	logger := f.createLogger(name)
+	f.loggers[name] = logger
+	return logger
+}
+
+// createLogger creates a new logger instance
+func (f *Factory) createLogger(name string) Logger {
+	if name == "noop" || name == "no-op" || name == "discard" {
+		return f.GetNoOpLogger()
+	}
+
+	// Create logger with appropriate outputs based on environment
+	var errorOut, infoOut, debugOut io.Writer
+
+	if os.Getenv("OIDC_LOG_TO_FILE") == "true" {
+		// Log to files if configured
+		errorOut = getOrCreateLogFile("error.log")
+		infoOut = getOrCreateLogFile("info.log")
+		debugOut = getOrCreateLogFile("debug.log")
+	} else {
+		// Default to stdout/stderr
+		errorOut = os.Stderr
+		infoOut = os.Stdout
+		debugOut = os.Stdout
+	}
+
+	return NewStandardLogger(f.defaultLogLevel, errorOut, infoOut, debugOut)
+}
+
+// GetDefaultLogger returns the default logger instance
+func (f *Factory) GetDefaultLogger() Logger {
+	f.mu.RLock()
+	if f.defaultLogger != nil {
+		f.mu.RUnlock()
+		return f.defaultLogger
+	}
+	f.mu.RUnlock()
+
+	f.mu.Lock()
+	defer f.mu.Unlock()
+
+	if f.defaultLogger == nil {
+		f.defaultLogger = f.createLogger("default")
+	}
+
+	return f.defaultLogger
+}
+
+// GetNoOpLogger returns the singleton no-op logger
+func (f *Factory) GetNoOpLogger() Logger {
+	f.mu.RLock()
+	if f.noOpLogger != nil {
+		f.mu.RUnlock()
+		return f.noOpLogger
+	}
+	f.mu.RUnlock()
+
+	f.mu.Lock()
+	defer f.mu.Unlock()
+
+	if f.noOpLogger == nil {
+		f.noOpLogger = GetNoOpLogger()
+	}
+
+	return f.noOpLogger
+}
+
+// Clear removes all cached loggers (useful for testing)
+func (f *Factory) Clear() {
+	f.mu.Lock()
+	defer f.mu.Unlock()
+
+	f.loggers = make(map[string]Logger)
+	f.defaultLogger = nil
+	// Don't clear noOpLogger as it's a singleton
+}
+
+// getOrCreateLogFile returns a file writer for the given log file
+func getOrCreateLogFile(filename string) io.Writer {
+	logDir := os.Getenv("OIDC_LOG_DIR")
+	if logDir == "" {
+		logDir = "/var/log/traefik-oidc"
+	}
+
+	// Ensure log directory exists
+	if err := os.MkdirAll(logDir, 0755); err != nil {
+		// Fall back to stderr if we can't create the directory
+		return os.Stderr
+	}
+
+	filepath := logDir + "/" + filename
+	file, err := os.OpenFile(filepath, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0644)
+	if err != nil {
+		// Fall back to stderr if we can't open the file
+		return os.Stderr
+	}
+
+	return file
+}
+
+// Global convenience functions
+
+// New creates a new logger with the specified level
+func New(level string) Logger {
+	return GetFactory().GetLogger(level)
+}
+
+// Default returns the default logger
+func Default() Logger {
+	return GetFactory().GetDefaultLogger()
+}
+
+// NoOp returns a no-op logger
+func NoOp() Logger {
+	return GetFactory().GetNoOpLogger()
+}
+
+// WithLevel creates a new logger with the specified level
+func WithLevel(level string) Logger {
+	return NewStandardLogger(level, os.Stderr, os.Stdout, os.Stdout)
+}
@@ -0,0 +1,312 @@
+// Package logger provides a unified logging interface for the entire application.
+// It consolidates all the duplicate logger interfaces into a single, comprehensive
+// interface that supports different log levels and structured logging.
+package logger
+
+import (
+	"fmt"
+	"io"
+	"log"
+	"sync"
+)
+
+// Logger is the unified interface for all logging operations in the application.
+// It combines all the methods from the various logger interfaces that were
+// previously scattered across different packages.
+type Logger interface {
+	// Basic logging methods
+	Debug(msg string)
+	Debugf(format string, args ...interface{})
+	Info(msg string)
+	Infof(format string, args ...interface{})
+	Error(msg string)
+	Errorf(format string, args ...interface{})
+
+	// Additional methods for compatibility with existing code
+	Printf(format string, args ...interface{})
+	Println(args ...interface{})
+	Fatalf(format string, args ...interface{})
+
+	// Structured logging support
+	WithField(key string, value interface{}) Logger
+	WithFields(fields map[string]interface{}) Logger
+}
+
+// StandardLogger implements the Logger interface using Go's standard log package.
+// It provides thread-safe logging with different output streams for different log levels.
+type StandardLogger struct {
+	mu       sync.RWMutex
+	logError *log.Logger
+	logInfo  *log.Logger
+	logDebug *log.Logger
+	fields   map[string]interface{}
+	level    LogLevel
+}
+
+// LogLevel represents the logging level
+type LogLevel int
+
+const (
+	// LogLevelDebug enables all log messages
+	LogLevelDebug LogLevel = iota
+	// LogLevelInfo enables info and error messages
+	LogLevelInfo
+	// LogLevelError enables only error messages
+	LogLevelError
+	// LogLevelNone disables all logging
+	LogLevelNone
+)
+
+// ParseLogLevel converts a string log level to LogLevel
+func ParseLogLevel(level string) LogLevel {
+	switch level {
+	case "debug", "DEBUG":
+		return LogLevelDebug
+	case "info", "INFO":
+		return LogLevelInfo
+	case "error", "ERROR":
+		return LogLevelError
+	case "none", "NONE":
+		return LogLevelNone
+	default:
+		return LogLevelInfo
+	}
+}
+
+// NewStandardLogger creates a new StandardLogger with the specified log level
+func NewStandardLogger(level string, errorOutput, infoOutput, debugOutput io.Writer) *StandardLogger {
+	logLevel := ParseLogLevel(level)
+
+	if errorOutput == nil {
+		errorOutput = io.Discard
+	}
+	if infoOutput == nil {
+		infoOutput = io.Discard
+	}
+	if debugOutput == nil {
+		debugOutput = io.Discard
+	}
+
+	return &StandardLogger{
+		logError: log.New(errorOutput, "ERROR: ", log.Ldate|log.Ltime|log.Lshortfile),
+		logInfo:  log.New(infoOutput, "INFO: ", log.Ldate|log.Ltime),
+		logDebug: log.New(debugOutput, "DEBUG: ", log.Ldate|log.Ltime|log.Lshortfile),
+		fields:   make(map[string]interface{}),
+		level:    logLevel,
+	}
+}
+
+// Debug logs a debug message
+func (l *StandardLogger) Debug(msg string) {
+	if l.level <= LogLevelDebug {
+		l.mu.RLock()
+		defer l.mu.RUnlock()
+		if len(l.fields) > 0 {
+			msg = l.formatWithFields(msg)
+		}
+		l.logDebug.Print(msg)
+	}
+}
+
+// Debugf logs a formatted debug message
+func (l *StandardLogger) Debugf(format string, args ...interface{}) {
+	if l.level <= LogLevelDebug {
+		l.mu.RLock()
+		defer l.mu.RUnlock()
+		msg := fmt.Sprintf(format, args...)
+		if len(l.fields) > 0 {
+			msg = l.formatWithFields(msg)
+		}
+		l.logDebug.Print(msg)
+	}
+}
+
+// Info logs an info message
+func (l *StandardLogger) Info(msg string) {
+	if l.level <= LogLevelInfo {
+		l.mu.RLock()
+		defer l.mu.RUnlock()
+		if len(l.fields) > 0 {
+			msg = l.formatWithFields(msg)
+		}
+		l.logInfo.Print(msg)
+	}
+}
+
+// Infof logs a formatted info message
+func (l *StandardLogger) Infof(format string, args ...interface{}) {
+	if l.level <= LogLevelInfo {
+		l.mu.RLock()
+		defer l.mu.RUnlock()
+		msg := fmt.Sprintf(format, args...)
+		if len(l.fields) > 0 {
+			msg = l.formatWithFields(msg)
+		}
+		l.logInfo.Print(msg)
+	}
+}
+
+// Error logs an error message
+func (l *StandardLogger) Error(msg string) {
+	if l.level <= LogLevelError {
+		l.mu.RLock()
+		defer l.mu.RUnlock()
+		if len(l.fields) > 0 {
+			msg = l.formatWithFields(msg)
+		}
+		l.logError.Print(msg)
+	}
+}
+
+// Errorf logs a formatted error message
+func (l *StandardLogger) Errorf(format string, args ...interface{}) {
+	if l.level <= LogLevelError {
+		l.mu.RLock()
+		defer l.mu.RUnlock()
+		msg := fmt.Sprintf(format, args...)
+		if len(l.fields) > 0 {
+			msg = l.formatWithFields(msg)
+		}
+		l.logError.Print(msg)
+	}
+}
+
+// Printf logs a formatted message at info level
+func (l *StandardLogger) Printf(format string, args ...interface{}) {
+	l.Infof(format, args...)
+}
+
+// Println logs a message at info level
+func (l *StandardLogger) Println(args ...interface{}) {
+	l.Info(fmt.Sprint(args...))
+}
+
+// Fatalf logs a formatted error message and exits the program
+func (l *StandardLogger) Fatalf(format string, args ...interface{}) {
+	l.Errorf(format, args...)
+	panic(fmt.Sprintf(format, args...))
+}
+
+// WithField returns a new logger with an additional field
+func (l *StandardLogger) WithField(key string, value interface{}) Logger {
+	l.mu.Lock()
+	defer l.mu.Unlock()
+
+	newLogger := &StandardLogger{
+		logError: l.logError,
+		logInfo:  l.logInfo,
+		logDebug: l.logDebug,
+		fields:   make(map[string]interface{}, len(l.fields)+1),
+		level:    l.level,
+	}
+
+	for k, v := range l.fields {
+		newLogger.fields[k] = v
+	}
+	newLogger.fields[key] = value
+
+	return newLogger
+}
+
+// WithFields returns a new logger with additional fields
+func (l *StandardLogger) WithFields(fields map[string]interface{}) Logger {
+	l.mu.Lock()
+	defer l.mu.Unlock()
+
+	newLogger := &StandardLogger{
+		logError: l.logError,
+		logInfo:  l.logInfo,
+		logDebug: l.logDebug,
+		fields:   make(map[string]interface{}, len(l.fields)+len(fields)),
+		level:    l.level,
+	}
+
+	for k, v := range l.fields {
+		newLogger.fields[k] = v
+	}
+	for k, v := range fields {
+		newLogger.fields[k] = v
+	}
+
+	return newLogger
+}
+
+// formatWithFields formats a message with structured fields
+func (l *StandardLogger) formatWithFields(msg string) string {
+	if len(l.fields) == 0 {
+		return msg
+	}
+
+	fieldsStr := ""
+	for k, v := range l.fields {
+		if fieldsStr != "" {
+			fieldsStr += " "
+		}
+		fieldsStr += fmt.Sprintf("%s=%v", k, v)
+	}
+
+	return fmt.Sprintf("%s [%s]", msg, fieldsStr)
+}
+
+// NoOpLogger is a logger that discards all output.
+// It's useful for testing and for cases where logging should be disabled.
+type NoOpLogger struct{}
+
+// Debug discards the message
+func (n *NoOpLogger) Debug(msg string) {}
+
+// Debugf discards the formatted message
+func (n *NoOpLogger) Debugf(format string, args ...interface{}) {}
+
+// Info discards the message
+func (n *NoOpLogger) Info(msg string) {}
+
+// Infof discards the formatted message
+func (n *NoOpLogger) Infof(format string, args ...interface{}) {}
+
+// Error discards the message
+func (n *NoOpLogger) Error(msg string) {}
+
+// Errorf discards the formatted message
+func (n *NoOpLogger) Errorf(format string, args ...interface{}) {}
+
+// Printf discards the formatted message
+func (n *NoOpLogger) Printf(format string, args ...interface{}) {}
+
+// Println discards the message
+func (n *NoOpLogger) Println(args ...interface{}) {}
+
+// Fatalf discards the message and does not exit
+func (n *NoOpLogger) Fatalf(format string, args ...interface{}) {}
+
+// WithField returns the same NoOpLogger
+func (n *NoOpLogger) WithField(key string, value interface{}) Logger {
+	return n
+}
+
+// WithFields returns the same NoOpLogger
+func (n *NoOpLogger) WithFields(fields map[string]interface{}) Logger {
+	return n
+}
+
+var (
+	// singletonNoOpLogger is the global instance of the no-op logger
+	singletonNoOpLogger *NoOpLogger
+	// noOpLoggerOnce ensures the singleton is created only once
+	noOpLoggerOnce sync.Once
+)
+
+// GetNoOpLogger returns the singleton no-op logger instance.
+// This reduces memory allocation by reusing the same no-op logger
+// instance across the entire application.
+func GetNoOpLogger() Logger {
+	noOpLoggerOnce.Do(func() {
+		singletonNoOpLogger = &NoOpLogger{}
+	})
+	return singletonNoOpLogger
+}
+
+// DefaultLogger creates a default logger based on the provided configuration
+func DefaultLogger(level string) Logger {
+	return NewStandardLogger(level, log.Writer(), log.Writer(), log.Writer())
+}