Skip to content

Commit b77cccb

Browse files
Refactor middleware naming
We have a mix of "Middleware" and "Handler" names. Let's standardise on "Handler" everywhere, as it's more conventional.
1 parent cccdad8 commit b77cccb

File tree

7 files changed

+20
-20
lines changed

7 files changed

+20
-20
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import (
99
"github.com/klauspost/compress/gzhttp"
1010
)
1111

12-
func NewCompressionGuardMiddleware(next http.Handler) http.Handler {
12+
func NewCompressionGuardHandler(next http.Handler) http.Handler {
1313
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
1414
// Check for user-specific headers in the request
1515
if hasUserSpecificRequestHeaders(r) {

internal/compression_guard_middleware_test.go renamed to internal/compression_guard_handler_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import (
99
"github.com/stretchr/testify/assert"
1010
)
1111

12-
func TestCompressionGuardMiddleware(t *testing.T) {
12+
func TestCompressionGuardHandler(t *testing.T) {
1313
tests := []struct {
1414
name string
1515
requestHeaders map[string]string
@@ -85,7 +85,7 @@ func TestCompressionGuardMiddleware(t *testing.T) {
8585

8686
for _, tt := range tests {
8787
t.Run(tt.name, func(t *testing.T) {
88-
handler := NewCompressionGuardMiddleware(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
88+
handler := NewCompressionGuardHandler(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
8989
for k, v := range tt.responseHeader {
9090
w.Header().Set(k, v)
9191
}

internal/handler.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ func NewHandler(options HandlerOptions) http.Handler {
2626
handler := NewProxyHandler(options.targetUrl, options.badGatewayPage, options.forwardHeaders)
2727
handler = NewCacheHandler(options.cache, options.maxCacheableResponseBody, handler)
2828
handler = NewSendfileHandler(options.xSendfileEnabled, handler)
29-
handler = NewRequestStartMiddleware(handler)
29+
handler = NewRequestStartHandler(handler)
3030

3131
if options.gzipCompressionEnabled {
3232
var wrapper func(http.Handler) http.HandlerFunc
@@ -54,7 +54,7 @@ func NewHandler(options HandlerOptions) http.Handler {
5454
gzipHandler := wrapper(handler)
5555

5656
if options.gzipCompressionDisableOnAuth {
57-
handler = NewCompressionGuardMiddleware(gzipHandler)
57+
handler = NewCompressionGuardHandler(gzipHandler)
5858
} else {
5959
handler = gzipHandler
6060
}
@@ -65,7 +65,7 @@ func NewHandler(options HandlerOptions) http.Handler {
6565
}
6666

6767
if options.logRequests {
68-
handler = NewLoggingMiddleware(slog.Default(), handler)
68+
handler = NewLoggingHandler(slog.Default(), handler)
6969
}
7070

7171
return handler
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,19 @@ import (
99
"time"
1010
)
1111

12-
type LoggingMiddleware struct {
12+
type LoggingHandler struct {
1313
logger *slog.Logger
1414
next http.Handler
1515
}
1616

17-
func NewLoggingMiddleware(logger *slog.Logger, next http.Handler) *LoggingMiddleware {
18-
return &LoggingMiddleware{
17+
func NewLoggingHandler(logger *slog.Logger, next http.Handler) *LoggingHandler {
18+
return &LoggingHandler{
1919
logger: logger,
2020
next: next,
2121
}
2222
}
2323

24-
func (h *LoggingMiddleware) ServeHTTP(w http.ResponseWriter, r *http.Request) {
24+
func (h *LoggingHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
2525
writer := newResponseWriter(w)
2626

2727
started := time.Now()
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ import (
1414
"github.com/stretchr/testify/require"
1515
)
1616

17-
func TestMiddleware_LoggingMiddleware(t *testing.T) {
17+
func TestLoggingHandler(t *testing.T) {
1818
out := &strings.Builder{}
1919
logger := slog.New(slog.NewJSONHandler(out, nil))
20-
middleware := NewLoggingMiddleware(logger, http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
20+
handler := NewLoggingHandler(logger, http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
2121
w.Header().Set("X-Cache", "miss")
2222
w.Header().Set("Content-Type", "text/html")
2323
w.WriteHeader(http.StatusCreated)
@@ -29,7 +29,7 @@ func TestMiddleware_LoggingMiddleware(t *testing.T) {
2929
req.Header.Set("User-Agent", "Robot/1")
3030
req.Header.Set("Content-Type", "application/json")
3131

32-
middleware.ServeHTTP(httptest.NewRecorder(), req)
32+
handler.ServeHTTP(httptest.NewRecorder(), req)
3333

3434
logline := struct {
3535
Path string `json:"path"`
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import (
66
"time"
77
)
88

9-
func NewRequestStartMiddleware(next http.Handler) http.Handler {
9+
func NewRequestStartHandler(next http.Handler) http.Handler {
1010
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
1111
if r.Header.Get("X-Request-Start") == "" {
1212
timestamp := time.Now().UnixMilli()
Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,18 @@ import (
1010
"github.com/stretchr/testify/assert"
1111
)
1212

13-
func TestRequestStartMiddleware(t *testing.T) {
13+
func TestRequestStartHandler(t *testing.T) {
1414
var capturedHeader string
1515
nextHandler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
1616
capturedHeader = r.Header.Get("X-Request-Start")
1717
})
1818

19-
middleware := NewRequestStartMiddleware(nextHandler)
19+
handler := NewRequestStartHandler(nextHandler)
2020

2121
before := time.Now().UnixMilli()
2222
req := httptest.NewRequest("GET", "/", nil)
2323
w := httptest.NewRecorder()
24-
middleware.ServeHTTP(w, req)
24+
handler.ServeHTTP(w, req)
2525
after := time.Now().UnixMilli()
2626

2727
assert.NotEmpty(t, capturedHeader)
@@ -34,19 +34,19 @@ func TestRequestStartMiddleware(t *testing.T) {
3434
assert.LessOrEqual(t, timestamp, after)
3535
}
3636

37-
func TestRequestStartMiddlewareDoesNotOverwriteExistingHeader(t *testing.T) {
37+
func TestRequestStartHandlerDoesNotOverwriteExistingHeader(t *testing.T) {
3838
existingHeader := "t=1234567890"
3939
var capturedHeader string
4040
nextHandler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
4141
capturedHeader = r.Header.Get("X-Request-Start")
4242
})
4343

44-
middleware := NewRequestStartMiddleware(nextHandler)
44+
handler := NewRequestStartHandler(nextHandler)
4545

4646
req := httptest.NewRequest("GET", "/", nil)
4747
req.Header.Set("X-Request-Start", existingHeader)
4848
w := httptest.NewRecorder()
49-
middleware.ServeHTTP(w, req)
49+
handler.ServeHTTP(w, req)
5050

5151
assert.Equal(t, existingHeader, capturedHeader)
5252
}

0 commit comments

Comments
 (0)