feat: call to ensure logger in context

Author: hmoragrega

logctx/context.go

@@ -23,6 +23,15 @@ func WithLogger(ctx context.Context, logger suplog.Logger) context.Context {
 	})
 }
 
+// EnsureLogger sets the logger in the context only if it doesn't already exist.
+// It's recommended to use this in middleware to avoid overwriting existing loggers.
+func EnsureLogger(ctx context.Context, logger suplog.Logger) context.Context {
+	if _, ok := fromContext(ctx); ok {
+		return ctx
+	}
+	return WithLogger(ctx, logger)
+}
+
 // WithErr adds an error field to the logger in the context (thread-safe).
 func WithErr(ctx context.Context, err error) context.Context {
 	l, ok := fromContext(ctx)

logctx/context_test.go

@@ -139,3 +139,19 @@ func TestContextLogHelpers(t *testing.T) {
 		require.Contains(t, lines[1], `msg="debug downgraded 2"`)
 	})
 }
+
+func TestEnsureLogger(t *testing.T) {
+	var recorder strings.Builder
+	logger := log.NewLogger(&recorder, new(log.TextFormatter))
+	ctx := context.Background()
+
+	// Should set the logger since none exists
+	ctxWithLogger := EnsureLogger(ctx, logger)
+	require.NotNil(t, Logger(ctxWithLogger))
+	require.Equal(t, logger, Logger(ctxWithLogger))
+
+	// Should NOT overwrite existing logger
+	anotherLogger := log.NewLogger(&strings.Builder{}, new(log.TextFormatter))
+	ctxWithLogger2 := EnsureLogger(ctxWithLogger, anotherLogger)
+	require.Equal(t, logger, Logger(ctxWithLogger2))
+}