feat: Change log middleware and inject logger in context

BREAKING CHANGE

pkg/s3-proxy/authx/authentication/basic-auth.go

@@ -6,6 +6,7 @@ import (
 
 	"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/authx/models"
 	"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/config"
+	"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/log"
 	"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/server/middlewares"
 	"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/server/utils"
 	"github.com/thoas/go-funk"
@@ -19,7 +20,7 @@ func (s *service) basicAuthMiddleware(res *config.Resource) func(http.Handler) h
 			basicConfig := s.cfg.AuthProviders.Basic[res.Provider]
 			basicAuthUserConfigList := res.Basic.Credentials
 			// Get logger from request
-			logEntry := middlewares.GetLogEntry(r)
+			logEntry := log.GetLoggerFromContext(r.Context())
 			path := r.URL.RequestURI()
 			// Get bucket request context from request
 			brctx := middlewares.GetBucketRequestContext(r)

pkg/s3-proxy/authx/authentication/main.go

@@ -8,6 +8,7 @@ import (
 	"github.com/gobwas/glob"
 	"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/authx/models"
 	"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/config"
+	"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/log"
 	"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/metrics"
 	"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/server/middlewares"
 	"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/server/utils"
@@ -29,7 +30,7 @@ type service struct {
 func (s *service) Middleware(resources []*config.Resource) func(http.Handler) http.Handler {
 	return func(next http.Handler) http.Handler {
 		return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-			logEntry := middlewares.GetLogEntry(r)
+			logEntry := log.GetLoggerFromContext(r.Context())
 
 			// Check if resources are empty
 			if len(resources) == 0 {

pkg/s3-proxy/authx/authentication/oidc.go

@@ -78,7 +78,7 @@ func (s *service) OIDCEndpoints(providerKey string, oidcCfg *config.OIDCAuthConf
 
 	mux.HandleFunc(mainRedirectURLObject.Path, func(w http.ResponseWriter, r *http.Request) {
 		// Get logger from request
-		logEntry := middlewares.GetLogEntry(r)
+		logEntry := log.GetLoggerFromContext(r.Context())
 
 		// ! In this particular case, no bucket request context because mounted in general and not per target
 
@@ -188,7 +188,7 @@ func (s *service) oidcAuthorizationMiddleware(res *config.Resource) func(http.Ha
 		return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 			oidcAuthCfg := s.cfg.AuthProviders.OIDC[res.Provider]
 			// Get logger from request
-			logEntry := middlewares.GetLogEntry(r)
+			logEntry := log.GetLoggerFromContext(r.Context())
 			path := r.URL.RequestURI()
 			// Get bucket request context from request
 			brctx := middlewares.GetBucketRequestContext(r)

pkg/s3-proxy/authx/authorization/main.go

@@ -7,6 +7,7 @@ import (
 	"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/authx/authentication"
 	"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/authx/models"
 	"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/config"
+	"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/log"
 	"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/metrics"
 	"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/server/middlewares"
 	"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/server/utils"
@@ -17,7 +18,7 @@ var errAuthorizationMiddlewareNotSupported = errors.New("authorization not suppo
 func Middleware(cfg *config.Config, metricsCl metrics.Client) func(http.Handler) http.Handler {
 	return func(next http.Handler) http.Handler {
 		return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-			logger := middlewares.GetLogEntry(r)
+			logger := log.GetLoggerFromContext(r.Context())
 
 			// Get request resource from request
 			resource := authentication.GetRequestResource(r)
@@ -58,7 +59,6 @@ func Middleware(cfg *config.Config, metricsCl metrics.Client) func(http.Handler)
 
 			// Get request data
 			requestURI := r.URL.RequestURI()
-			// httpMethod := r.Method
 
 			// Get bucket request context
 			brctx := middlewares.GetBucketRequestContext(r)

pkg/s3-proxy/log/contextkey.go

@@ -0,0 +1,8 @@
+package log
+
+// contextKey is a value for use with context.WithValue. It's used as
+// a pointer so it fits in an interface{} without allocation. This technique
+// for defining context keys was copied from Go 1.7's new use of context in net/http.
+type contextKey struct {
+	name string
+}

pkg/s3-proxy/server/middlewares/log-middleware.go → pkg/s3-proxy/log/http-middleware.go

@@ -1,41 +1,66 @@
-package middlewares
+package log
 
 import (
+	"context"
 	"fmt"
 	"net/http"
 	"time"
 
 	"github.com/go-chi/chi/v5/middleware"
-	"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/log"
-	"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/server/utils"
-	"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/tracing"
 	"github.com/sirupsen/logrus"
 )
 
+// HTTPAddLoggerToContextMiddleware HTTP Middleware that will add request logger to request context.
+func HTTPAddLoggerToContextMiddleware() func(next http.Handler) http.Handler {
+	return func(h http.Handler) http.Handler {
+		return http.HandlerFunc(func(rw http.ResponseWriter, r *http.Request) {
+			// Get logger from request
+			logger := GetLogEntry(r)
+			// Add logger to request context in order to keep it
+			ctx := context.WithValue(r.Context(), loggerContextKey, logger)
+			// Create new request with new context
+			r = r.WithContext(ctx)
+
+			// Next
+			h.ServeHTTP(rw, r)
+		})
+	}
+}
+
 // Copied and modified from https://github.com/go-chi/chi/blob/master/_examples/logging/main.go
 
 // NewStructuredLogger Generate a new structured logger.
-func NewStructuredLogger(logger log.Logger) func(next http.Handler) http.Handler {
-	return middleware.RequestLogger(&StructuredLogger{logger})
+func NewStructuredLogger(
+	logger Logger,
+	getTraceID func(r *http.Request) string,
+	getClientIP func(r *http.Request) string,
+	getRequestURI func(r *http.Request) string,
+) func(next http.Handler) http.Handler {
+	return middleware.RequestLogger(&StructuredLogger{
+		Logger:        logger,
+		GetTraceID:    getTraceID,
+		GetClientIP:   getClientIP,
+		GetRequestURI: getRequestURI,
+	})
 }
 
 // StructuredLogger structured logger.
 type StructuredLogger struct {
-	Logger log.Logger
+	Logger        Logger
+	GetTraceID    func(r *http.Request) string
+	GetClientIP   func(r *http.Request) string
+	GetRequestURI func(r *http.Request) string
 }
 
 // NewLogEntry new log entry.
 func (l *StructuredLogger) NewLogEntry(r *http.Request) middleware.LogEntry {
 	entry := &StructuredLoggerEntry{Logger: l.Logger}
 	logFields := map[string]interface{}{}
 
-	// Get request trace
-	trace := tracing.GetTraceFromRequest(r)
-	if trace != nil {
-		traceIDStr := trace.GetTraceID()
-		if traceIDStr != "" {
-			logFields["span_id"] = traceIDStr
-		}
+	// Get trace id
+	traceIDStr := l.GetTraceID(r)
+	if traceIDStr != "" {
+		logFields["span_id"] = traceIDStr
 	}
 
 	if reqID := middleware.GetReqID(r.Context()); reqID != "" {
@@ -53,9 +78,9 @@ func (l *StructuredLogger) NewLogEntry(r *http.Request) middleware.LogEntry {
 
 	logFields["remote_addr"] = r.RemoteAddr
 	logFields["user_agent"] = r.UserAgent()
-	logFields["client_ip"] = utils.ClientIP(r)
+	logFields["client_ip"] = l.GetClientIP(r)
 
-	logFields["uri"] = utils.GetRequestURI(r)
+	logFields["uri"] = l.GetRequestURI(r)
 
 	entry.Logger = entry.Logger.WithFields(logFields)
 
@@ -66,7 +91,7 @@ func (l *StructuredLogger) NewLogEntry(r *http.Request) middleware.LogEntry {
 
 // StructuredLoggerEntry Structured logger entry.
 type StructuredLoggerEntry struct {
-	Logger log.Logger
+	Logger Logger
 }
 
 // Write Write.
@@ -105,22 +130,8 @@ func (l *StructuredLoggerEntry) Panic(v interface{}, stack []byte) {
 // with a call to .Print(), .Info(), etc.
 
 // GetLogEntry get log entry.
-func GetLogEntry(r *http.Request) log.Logger {
+func GetLogEntry(r *http.Request) Logger {
 	entry := middleware.GetLogEntry(r).(*StructuredLoggerEntry)
 
 	return entry.Logger
 }
-
-// LogEntrySetField Log entry set field.
-func LogEntrySetField(r *http.Request, key string, value interface{}) {
-	if entry, ok := r.Context().Value(middleware.LogEntryCtxKey).(*StructuredLoggerEntry); ok {
-		entry.Logger = entry.Logger.WithField(key, value)
-	}
-}
-
-// LogEntrySetFields Log entry set fields.
-func LogEntrySetFields(r *http.Request, fields map[string]interface{}) {
-	if entry, ok := r.Context().Value(middleware.LogEntryCtxKey).(*StructuredLoggerEntry); ok {
-		entry.Logger = entry.Logger.WithFields(fields)
-	}
-}

pkg/s3-proxy/log/log.go

@@ -1,9 +1,13 @@
 package log
 
 import (
+	"context"
+
 	"github.com/sirupsen/logrus"
 )
 
+var loggerContextKey = &contextKey{name: "LOGGER_CONTEXT_KEY"}
+
 type Logger interface {
 	Configure(level string, format string, filePath string) error
 
@@ -57,3 +61,9 @@ func NewLogger() Logger {
 		FieldLogger: logrus.New(),
 	}
 }
+
+func GetLoggerFromContext(ctx context.Context) Logger {
+	res, _ := ctx.Value(loggerContextKey).(Logger)
+
+	return res
+}

pkg/s3-proxy/server/internal-server.go

@@ -11,6 +11,8 @@ import (
 	"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/log"
 	"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/metrics"
 	"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/server/middlewares"
+	"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/server/utils"
+	"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/tracing"
 )
 
 type InternalServer struct {
@@ -75,7 +77,21 @@ func (svr *InternalServer) generateInternalRouter() http.Handler {
 
 	r.Use(middleware.RequestID)
 	r.Use(middleware.RealIP)
-	r.Use(middlewares.NewStructuredLogger(svr.logger))
+	r.Use(log.NewStructuredLogger(
+		svr.logger,
+		func(r *http.Request) string {
+			// Get request trace
+			trace := tracing.GetTraceFromRequest(r)
+			if trace != nil {
+				return trace.GetTraceID()
+			}
+
+			return ""
+		},
+		utils.ClientIP,
+		utils.GetRequestURI,
+	))
+	r.Use(log.HTTPAddLoggerToContextMiddleware())
 	r.Use(svr.metricsCl.Instrument("internal"))
 	r.Use(middleware.Recoverer)
 

pkg/s3-proxy/server/middlewares/bucket-request-context.go

@@ -5,6 +5,7 @@ import (
 
 	"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/bucket"
 	"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/config"
+	"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/log"
 	"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/metrics"
 	"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/server/utils"
 	"github.com/oxyno-zeta/s3-proxy/pkg/s3-proxy/tracing"
@@ -27,7 +28,7 @@ func BucketRequestContext(
 	return func(next http.Handler) http.Handler {
 		return http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {
 			// Get logger
-			logEntry := GetLogEntry(req)
+			logEntry := log.GetLoggerFromContext(req.Context())
 			// Get request URI
 			requestURI := req.URL.RequestURI()
 			errorhandlers := &bucket.ErrorHandlers{

pkg/s3-proxy/server/server.go

@@ -122,7 +122,21 @@ func (svr *Server) generateRouter() (http.Handler, error) {
 	// Put tracing middlewares
 	r.Use(httptracer.Tracer(svr.tracingSvc.GetTracer(), httptraCfg))
 	r.Use(middlewares.ImproveTracing())
-	r.Use(middlewares.NewStructuredLogger(svr.logger))
+	r.Use(log.NewStructuredLogger(
+		svr.logger,
+		func(r *http.Request) string {
+			// Get request trace
+			trace := tracing.GetTraceFromRequest(r)
+			if trace != nil {
+				return trace.GetTraceID()
+			}
+
+			return ""
+		},
+		utils.ClientIP,
+		utils.GetRequestURI,
+	))
+	r.Use(log.HTTPAddLoggerToContextMiddleware())
 	r.Use(svr.metricsCl.Instrument("business"))
 
 	// Check if cors is enabled
@@ -145,7 +159,7 @@ func (svr *Server) generateRouter() (http.Handler, error) {
 
 	notFoundHandler := func(w http.ResponseWriter, r *http.Request) {
 		// Get logger
-		logger := middlewares.GetLogEntry(r)
+		logger := log.GetLoggerFromContext(r.Context())
 		// Get request URI
 		requestURI := r.URL.RequestURI()
 		utils.HandleNotFound(logger, w, cfg.Templates, requestURI)
@@ -154,7 +168,7 @@ func (svr *Server) generateRouter() (http.Handler, error) {
 	internalServerHandlerGen := func(err error) http.HandlerFunc {
 		return func(w http.ResponseWriter, r *http.Request) {
 			// Get logger
-			logger := middlewares.GetLogEntry(r)
+			logger := log.GetLoggerFromContext(r.Context())
 			// Get request URI
 			requestURI := r.URL.RequestURI()
 			utils.HandleInternalServerError(logger, w, cfg.Templates, requestURI, err)
@@ -184,7 +198,7 @@ func (svr *Server) generateRouter() (http.Handler, error) {
 				rt2 = rt2.With(authorization.Middleware(cfg, svr.metricsCl))
 
 				rt2.Get("/", func(rw http.ResponseWriter, req *http.Request) {
-					logEntry := middlewares.GetLogEntry(req)
+					logEntry := log.GetLoggerFromContext(req.Context())
 					generateTargetList(rw, req.RequestURI, logEntry, cfg)
 				})
 			})
@@ -301,7 +315,7 @@ func (svr *Server) generateRouter() (http.Handler, error) {
 						// Get request path
 						requestPath := chi.URLParam(req, "*")
 						// Get logger
-						logEntry := middlewares.GetLogEntry(req)
+						logEntry := log.GetLoggerFromContext(req.Context())
 						if err := req.ParseForm(); err != nil {
 							logEntry.Error(err)
 							brctx.HandleInternalServerError(err, path)