support/http: allow services to specify the logger used by the logging middleware

exp/services/recoverysigner/internal/serve/serve.go

@@ -107,7 +107,7 @@ func getHandlerDeps(opts Options) (handlerDeps, error) {
 }
 
 func handler(deps handlerDeps) http.Handler {
-	mux := supporthttp.NewAPIMux()
+	mux := supporthttp.NewAPIMux(deps.Logger)
 
 	mux.NotFound(errorHandler{Error: notFound}.ServeHTTP)
 	mux.MethodNotAllowed(errorHandler{Error: methodNotAllowed}.ServeHTTP)

exp/services/webauth/internal/serve/serve.go

@@ -66,7 +66,7 @@ func handler(opts Options) (http.Handler, error) {
 	}
 	horizonClient.SetHorizonTimeOut(uint(horizonTimeout / time.Second))
 
-	mux := supporthttp.NewAPIMux()
+	mux := supporthttp.NewAPIMux(opts.Logger)
 
 	mux.NotFound(errorHandler{Error: notFound}.ServeHTTP)
 	mux.MethodNotAllowed(errorHandler{Error: methodNotAllowed}.ServeHTTP)

services/bridge/main.go

@@ -23,6 +23,7 @@ import (
 	"github.com/stellar/go/support/db/schema"
 	"github.com/stellar/go/support/errors"
 	supportHttp "github.com/stellar/go/support/http"
+	supportLog "github.com/stellar/go/support/log"
 )
 
 var app *App
@@ -231,7 +232,7 @@ func NewApp(config config.Config, migrateFlag bool, versionFlag bool, version st
 
 // Serve starts the server
 func (a *App) Serve() {
-	mux := supportHttp.NewAPIMux()
+	mux := supportHttp.NewAPIMux(supportLog.DefaultLogger)
 
 	// Middlewares
 	headers := make(http.Header)

services/compliance/main.go

@@ -22,6 +22,7 @@ import (
 	"github.com/stellar/go/support/db/schema"
 	"github.com/stellar/go/support/errors"
 	supportHttp "github.com/stellar/go/support/http"
+	supportLog "github.com/stellar/go/support/log"
 )
 
 var app *App
@@ -170,7 +171,7 @@ func NewApp(config config.Config, migrateFlag bool, versionFlag bool, version st
 // Serve starts the server
 func (a *App) Serve() {
 	// External endpoints
-	external := supportHttp.NewAPIMux()
+	external := supportHttp.NewAPIMux(supportLog.DefaultLogger)
 
 	// Middlewares
 	headers := http.Header{}
@@ -195,7 +196,7 @@ func (a *App) Serve() {
 	}()
 
 	// Internal endpoints
-	internal := supportHttp.NewAPIMux()
+	internal := supportHttp.NewAPIMux(supportLog.DefaultLogger)
 
 	internal.Use(supportHttp.StripTrailingSlashMiddleware("/admin"))
 	internal.Use(supportHttp.HeadersMiddleware(headers, "/admin/"))

services/federation/main.go

@@ -126,7 +126,7 @@ func initDriver(cfg Config) (federation.Driver, error) {
 }
 
 func initMux(driver federation.Driver) *chi.Mux {
-	mux := http.NewAPIMux()
+	mux := http.NewAPIMux(log.DefaultLogger)
 
 	fed := &federation.Handler{
 		Driver: driver,

services/friendbot/main.go

@@ -82,7 +82,7 @@ func run(cmd *cobra.Command, args []string) {
 }
 
 func initRouter(fb *internal.Bot) *chi.Mux {
-	mux := http.NewAPIMux()
+	mux := http.NewAPIMux(log.DefaultLogger)
 
 	handler := &internal.FriendbotHandler{Friendbot: fb}
 	mux.Get("/", handler.Handle)

support/http/logging_middleware.go

@@ -10,6 +10,18 @@ import (
 	"github.com/stellar/go/support/log"
 )
 
+// SetLogger is a middleware that sets a logger on the context.
+func SetLoggerMiddleware(l *log.Entry) func(stdhttp.Handler) stdhttp.Handler {
+	return func(next stdhttp.Handler) stdhttp.Handler {
+		return stdhttp.HandlerFunc(func(w stdhttp.ResponseWriter, r *stdhttp.Request) {
+			ctx := r.Context()
+			ctx = log.Set(ctx, l)
+			r = r.WithContext(ctx)
+			next.ServeHTTP(w, r)
+		})
+	}
+}
+
 // LoggingMiddleware is a middleware that logs requests to the logger.
 func LoggingMiddleware(next stdhttp.Handler) stdhttp.Handler {
 	return stdhttp.HandlerFunc(func(w stdhttp.ResponseWriter, r *stdhttp.Request) {

support/http/logging_middleware_test.go

@@ -43,3 +43,38 @@ func TestHTTPMiddleware(t *testing.T) {
 		assert.NotEmpty(t, line.Data["path"])
 	}
 }
+
+func TestHTTPMiddlewareWithLoggerSet(t *testing.T) {
+	logger := log.New()
+	done := logger.StartTest(log.InfoLevel)
+	mux := chi.NewMux()
+
+	mux.Use(middleware.RequestID)
+	mux.Use(SetLoggerMiddleware(logger))
+	mux.Use(LoggingMiddleware)
+
+	mux.Get("/", stdhttp.HandlerFunc(func(w stdhttp.ResponseWriter, r *stdhttp.Request) {
+	}))
+	mux.Handle("/not_found", stdhttp.NotFoundHandler())
+
+	src := httptest.NewServer(t, mux)
+	src.GET("/").Expect().Status(stdhttp.StatusOK)
+	src.GET("/not_found").Expect().Status(stdhttp.StatusNotFound)
+
+	// get the log buffer and ensure it has both the start and end log lines for
+	// each request
+	logged := done()
+	if assert.Len(t, logged, 4, "unexpected log line count") {
+		assert.Equal(t, "starting request", logged[0].Message)
+		assert.Equal(t, "starting request", logged[2].Message)
+		assert.Equal(t, "finished request", logged[1].Message)
+		assert.Equal(t, "finished request", logged[3].Message)
+	}
+
+	for _, line := range logged {
+		assert.Equal(t, "http", line.Data["subsys"])
+		assert.Equal(t, "GET", line.Data["method"])
+		assert.NotEmpty(t, line.Data["req"])
+		assert.NotEmpty(t, line.Data["path"])
+	}
+}

support/http/mux.go

@@ -4,24 +4,28 @@ import (
 	"github.com/go-chi/chi"
 	"github.com/go-chi/chi/middleware"
 	"github.com/rs/cors"
+	"github.com/stellar/go/support/log"
 )
 
 // NewMux returns a new server mux configured with the common defaults used across all
 // stellar services.
-func NewMux() *chi.Mux {
+func NewMux(l *log.Entry) *chi.Mux {
 	mux := chi.NewMux()
 
 	mux.Use(middleware.RequestID)
 	mux.Use(middleware.Recoverer)
+	if l != nil {
+		mux.Use(SetLoggerMiddleware(l))
+	}
 	mux.Use(LoggingMiddleware)
 
 	return mux
 }
 
 // NewAPIMux returns a new server mux configured with the common defaults used for a web API in
 // stellar.
-func NewAPIMux() *chi.Mux {
-	mux := NewMux()
+func NewAPIMux(l *log.Entry) *chi.Mux {
+	mux := NewMux(l)
 
 	c := cors.New(cors.Options{
 		AllowedOrigins: []string{"*"},

support/render/health/example_test.go

@@ -12,7 +12,7 @@ import (
 )
 
 func ExampleResponse() {
-	mux := supporthttp.NewAPIMux()
+	mux := supporthttp.NewAPIMux(nil)
 
 	mux.Get("/health", func(w http.ResponseWriter, r *http.Request) {
 		healthCheckResult := false
@@ -44,7 +44,7 @@ func ExampleResponse() {
 }
 
 func ExampleHandler() {
-	mux := supporthttp.NewAPIMux()
+	mux := supporthttp.NewAPIMux(nil)
 
 	mux.Get("/health", health.PassHandler{}.ServeHTTP)