[public-api-server] Use logging middleware globally

gitpod-io · Mar 3, 2023 · c8ec88d · c8ec88d
1 parent f334af8
commit c8ec88d
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 23 deletions.
diff --git a/components/public-api-server/middleware/logging.go b/components/public-api-server/middleware/logging.go
@@ -5,28 +5,27 @@
 package middleware
 
 import (
-	"github.com/sirupsen/logrus"
 	"net/http"
 	"time"
+
+	"github.com/gitpod-io/gitpod/common-go/log"
+	"github.com/sirupsen/logrus"
 )
 
 type Middleware func(handler http.Handler) http.Handler
 
-func NewLoggingMiddleware(l *logrus.Entry) Middleware {
-
+func NewLoggingMiddleware() Middleware {
 	return func(next http.Handler) http.Handler {
 		logging := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 			start := time.Now()
-			uri := r.RequestURI
-			method := r.Method
-			duration := time.Since(start)
 			next.ServeHTTP(w, r)
+			duration := time.Since(start)
 
-			l.WithFields(logrus.Fields{
-				"uri":      uri,
-				"method":   method,
+			log.WithFields(logrus.Fields{
+				"uri":      r.RequestURI,
+				"method":   r.Method,
 				"duration": duration,
-			}).Infof("Handled HTTP request %s %s", method, uri)
+			}).Debug("Handled HTTP request")
 		})
 
 		return logging

diff --git a/components/public-api-server/middleware/logging_test.go b/components/public-api-server/middleware/logging_test.go
@@ -6,12 +6,13 @@ package middleware
 
 import (
 	"bytes"
-	"github.com/sirupsen/logrus"
-	_ "github.com/sirupsen/logrus/hooks/test"
-	"github.com/stretchr/testify/require"
 	"net/http"
 	"net/http/httptest"
 	"testing"
+
+	"github.com/sirupsen/logrus"
+	_ "github.com/sirupsen/logrus/hooks/test"
+	"github.com/stretchr/testify/require"
 )
 
 func TestLoggingMiddleware(t *testing.T) {
@@ -23,12 +24,12 @@ func TestLoggingMiddleware(t *testing.T) {
 	expectedBody := `hello world`
 
 	someHandler := http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
-		w.Write([]byte(expectedBody))
+		_, _ = w.Write([]byte(expectedBody))
 	})
 	req := httptest.NewRequest("GET", "/", nil)
 	rec := httptest.NewRecorder() // this records the response
 
-	m := NewLoggingMiddleware(logrus.NewEntry(logger))
+	m := NewLoggingMiddleware()
 	wrappedHandler := m(someHandler)
 	wrappedHandler.ServeHTTP(rec, req)
 

diff --git a/components/public-api-server/pkg/identityprovider/idp.go b/components/public-api-server/pkg/identityprovider/idp.go
@@ -12,7 +12,6 @@ import (
 	"fmt"
 	"io"
 	"net/http"
-	"net/http/httputil"
 	"net/url"
 	"time"
 
@@ -55,13 +54,6 @@ type Service struct {
 
 func (kp *Service) Router() http.Handler {
 	mux := chi.NewRouter()
-	mux.Use(func(h http.Handler) http.Handler {
-		return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-			c, _ := httputil.DumpRequest(r, false)
-			log.WithField("req", string(c)).Debug("IDP request")
-			h.ServeHTTP(w, r)
-		})
-	})
 	mux.Get(oidc.DiscoveryEndpoint, http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		keysURL, err := url.JoinPath(kp.IssuerBaseURL, "keys")
 		if err != nil {

diff --git a/components/public-api-server/pkg/server/server.go b/components/public-api-server/pkg/server/server.go
@@ -27,6 +27,7 @@ import (
 
 	"github.com/gitpod-io/gitpod/common-go/baseserver"
 	db "github.com/gitpod-io/gitpod/components/gitpod-db/go"
+	"github.com/gitpod-io/gitpod/public-api-server/middleware"
 	"github.com/gitpod-io/gitpod/public-api-server/pkg/apiv1"
 	"github.com/gitpod-io/gitpod/public-api-server/pkg/auth"
 	"github.com/gitpod-io/gitpod/public-api-server/pkg/billingservice"
@@ -175,6 +176,7 @@ func register(srv *baseserver.Server, deps *registerDependencies) error {
 	}
 
 	rootHandler := chi.NewRouter()
+	rootHandler.Use(middleware.NewLoggingMiddleware())
 
 	handlerOptions := []connect.HandlerOption{
 		connect.WithInterceptors(