Merge branch 'master' into delint-ioutil

Author: VojtechVitek

Diff for: .github/workflows/ci.yml

@@ -1,12 +1,12 @@
 on:
   push:
-    branches: '**'
+    branches: "**"
     paths-ignore:
-      - 'docs/**'
+      - "docs/**"
   pull_request:
-    branches: '**'
+    branches: "**"
     paths-ignore:
-      - 'docs/**'
+      - "docs/**"
 
 name: Test
 jobs:
@@ -20,23 +20,23 @@ jobs:
 
     strategy:
       matrix:
-        go-version: [1.15.x, 1.16.x, 1.17.x, 1.18.x, 1.19.x, 1.20.x, 1.21.x, 1.22.x, 1.23.x]
+        go-version: [1.20.x, 1.21.x, 1.22.x, 1.23.x, 1.24.x]
         os: [ubuntu-latest, windows-latest]
 
     runs-on: ${{ matrix.os }}
 
     steps:
-    - name: Install Go
-      uses: actions/setup-go@v5
-      with:
-        go-version: ${{ matrix.go-version }}
-        check-latest: true
-        cache: false
-    - name: Checkout code
-      uses: actions/checkout@v4
-      with:
-        path: ${{ env.GOPATH }}/src/github.com/${{ github.repository }}
-    - name: Test
-      run: |
-        go get -d -t ./...
-        make test
+      - name: Install Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: ${{ matrix.go-version }}
+          check-latest: true
+          cache: false
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          path: ${{ env.GOPATH }}/src/github.com/${{ github.repository }}
+      - name: Test
+        run: |
+          go get -d -t ./...
+          make test

Diff for: go.mod

@@ -1,3 +1,5 @@
 module github.com/go-chi/chi/v5
 
-go 1.16
+// Chi supports the four most recent major versions of Go.
+// See https://github.com/go-chi/chi/issues/963.
+go 1.20

Diff for: middleware/compress.go

@@ -274,16 +274,13 @@ type compressResponseWriter struct {
 func (cw *compressResponseWriter) isCompressible() bool {
 	// Parse the first part of the Content-Type response header.
 	contentType := cw.Header().Get("Content-Type")
-	if idx := strings.Index(contentType, ";"); idx >= 0 {
-		contentType = contentType[0:idx]
-	}
+	contentType, _, _ = strings.Cut(contentType, ";")
 
 	// Is the content type compressible?
 	if _, ok := cw.contentTypes[contentType]; ok {
 		return true
 	}
-	if idx := strings.Index(contentType, "/"); idx > 0 {
-		contentType = contentType[0:idx]
+	if contentType, _, hadSlash := strings.Cut(contentType, "/"); hadSlash {
 		_, ok := cw.contentWildcards[contentType]
 		return ok
 	}

Diff for: middleware/get_head_test.go

@@ -38,27 +38,27 @@ func TestGetHead(t *testing.T) {
 	defer ts.Close()
 
 	if _, body := testRequest(t, ts, "GET", "/hi", nil); body != "bye" {
-		t.Fatalf(body)
+		t.Fatal(body)
 	}
 	if req, body := testRequest(t, ts, "HEAD", "/hi", nil); body != "" || req.Header.Get("X-Test") != "yes" {
-		t.Fatalf(body)
+		t.Fatal(body)
 	}
 	if _, body := testRequest(t, ts, "GET", "/", nil); body != "404 page not found\n" {
-		t.Fatalf(body)
+		t.Fatal(body)
 	}
 	if req, body := testRequest(t, ts, "HEAD", "/", nil); body != "" || req.StatusCode != 404 {
-		t.Fatalf(body)
+		t.Fatal(body)
 	}
 
 	if _, body := testRequest(t, ts, "GET", "/articles/5", nil); body != "article:5" {
-		t.Fatalf(body)
+		t.Fatal(body)
 	}
 	if req, body := testRequest(t, ts, "HEAD", "/articles/5", nil); body != "" || req.Header.Get("X-Article") != "5" {
 		t.Fatalf("expecting X-Article header '5' but got '%s'", req.Header.Get("X-Article"))
 	}
 
 	if _, body := testRequest(t, ts, "GET", "/users/1", nil); body != "user:1" {
-		t.Fatalf(body)
+		t.Fatal(body)
 	}
 	if req, body := testRequest(t, ts, "HEAD", "/users/1", nil); body != "" || req.Header.Get("X-User") != "-" {
 		t.Fatalf("expecting X-User header '-' but got '%s'", req.Header.Get("X-User"))

Diff for: middleware/realip.go

@@ -9,11 +9,9 @@ import (
 	"strings"
 )
 
-var defaultHeaders = []string{
-	"True-Client-IP", // Cloudflare Enterprise plan
-	"X-Real-IP",
-	"X-Forwarded-For",
-}
+var trueClientIP = http.CanonicalHeaderKey("True-Client-IP")
+var xForwardedFor = http.CanonicalHeaderKey("X-Forwarded-For")
+var xRealIP = http.CanonicalHeaderKey("X-Real-IP")
 
 // RealIP is a middleware that sets a http.Request's RemoteAddr to the results
 // of parsing either the True-Client-IP, X-Real-IP or the X-Forwarded-For headers
@@ -32,7 +30,7 @@ var defaultHeaders = []string{
 // how you're using RemoteAddr, vulnerable to an attack of some sort).
 func RealIP(h http.Handler) http.Handler {
 	fn := func(w http.ResponseWriter, r *http.Request) {
-		if rip := getRealIP(r, defaultHeaders); rip != "" {
+		if rip := realIP(r); rip != "" {
 			r.RemoteAddr = rip
 		}
 		h.ServeHTTP(w, r)
@@ -41,33 +39,18 @@ func RealIP(h http.Handler) http.Handler {
 	return http.HandlerFunc(fn)
 }
 
-// RealIPFromHeaders is a middleware that sets a http.Request's RemoteAddr to the results
-// of parsing the custom headers.
-//
-// usage:
-// r.Use(RealIPFromHeaders("CF-Connecting-IP"))
-func RealIPFromHeaders(headers ...string) func(http.Handler) http.Handler {
-	f := func(h http.Handler) http.Handler {
-		fn := func(w http.ResponseWriter, r *http.Request) {
-			if rip := getRealIP(r, headers); rip != "" {
-				r.RemoteAddr = rip
-			}
-			h.ServeHTTP(w, r)
-		}
-		return http.HandlerFunc(fn)
-	}
-	return f
-}
+func realIP(r *http.Request) string {
+	var ip string
 
-func getRealIP(r *http.Request, headers []string) string {
-	for _, header := range headers {
-		if ip := r.Header.Get(header); ip != "" {
-			ips := strings.Split(ip, ",")
-			if ips[0] == "" || net.ParseIP(ips[0]) == nil {
-				continue
-			}
-			return ips[0]
-		}
+	if tcip := r.Header.Get(trueClientIP); tcip != "" {
+		ip = tcip
+	} else if xrip := r.Header.Get(xRealIP); xrip != "" {
+		ip = xrip
+	} else if xff := r.Header.Get(xForwardedFor); xff != "" {
+		ip, _, _ = strings.Cut(xff, ",")
+	}
+	if ip == "" || net.ParseIP(ip) == nil {
+		return ""
 	}
-	return ""
+	return ip
 }

Diff for: middleware/realip_test.go

@@ -113,52 +113,3 @@ func TestInvalidIP(t *testing.T) {
 		t.Fatal("Invalid IP used.")
 	}
 }
-
-func TestCustomIPHeader(t *testing.T) {
-	var customHeaderKey = "X-CUSTOM-IP"
-	req, _ := http.NewRequest("GET", "/", nil)
-	req.Header.Add(customHeaderKey, "100.100.100.100")
-	w := httptest.NewRecorder()
-
-	r := chi.NewRouter()
-	r.Use(RealIPFromHeaders(customHeaderKey))
-
-	realIP := ""
-	r.Get("/", func(w http.ResponseWriter, r *http.Request) {
-		realIP = r.RemoteAddr
-		w.Write([]byte("Hello World"))
-	})
-	r.ServeHTTP(w, req)
-
-	if w.Code != 200 {
-		t.Fatal("Response Code should be 200")
-	}
-
-	if realIP != "100.100.100.100" {
-		t.Fatal("Test get real IP precedence error.")
-	}
-}
-
-func TestCustomIPHeaderWithoutDefault(t *testing.T) {
-	req, _ := http.NewRequest("GET", "/", nil)
-	req.Header.Add("X-REAL-IP", "100.100.100.100")
-	w := httptest.NewRecorder()
-
-	r := chi.NewRouter()
-	r.Use(RealIPFromHeaders("CF-Connecting-IP"))
-
-	realIP := ""
-	r.Get("/", func(w http.ResponseWriter, r *http.Request) {
-		realIP = r.RemoteAddr
-		w.Write([]byte("Hello World"))
-	})
-	r.ServeHTTP(w, req)
-
-	if w.Code != 200 {
-		t.Fatal("Response Code should be 200")
-	}
-
-	if realIP != "" {
-		t.Fatal("Invalid IP used.")
-	}
-}

Diff for: middleware/route_headers.go

@@ -133,13 +133,7 @@ type Pattern struct {
 
 func NewPattern(value string) Pattern {
 	p := Pattern{}
-	if i := strings.IndexByte(value, '*'); i >= 0 {
-		p.wildcard = true
-		p.prefix = value[0:i]
-		p.suffix = value[i+1:]
-	} else {
-		p.prefix = value
-	}
+	p.prefix, p.suffix, p.wildcard = strings.Cut(value, "*")
 	return p
 }
 

Diff for: middleware/throttle.go

@@ -126,9 +126,9 @@ type token struct{}
 type throttler struct {
 	tokens         chan token
 	backlogTokens  chan token
+	retryAfterFn   func(ctxDone bool) time.Duration
 	backlogTimeout time.Duration
 	statusCode     int
-	retryAfterFn   func(ctxDone bool) time.Duration
 }
 
 // setRetryAfterHeaderIfNeeded sets Retry-After HTTP header if corresponding retryAfterFn option of throttler is initialized.

Diff for: middleware/url_format_test.go

@@ -36,16 +36,16 @@ func TestURLFormat(t *testing.T) {
 	defer ts.Close()
 
 	if _, resp := testRequest(t, ts, "GET", "/articles/1.json", nil); resp != "1" {
-		t.Fatalf(resp)
+		t.Fatal(resp)
 	}
 	if _, resp := testRequest(t, ts, "GET", "/articles/1.xml", nil); resp != "1" {
-		t.Fatalf(resp)
+		t.Fatal(resp)
 	}
 	if _, resp := testRequest(t, ts, "GET", "/samples/articles/samples.1.json", nil); resp != "1" {
-		t.Fatalf(resp)
+		t.Fatal(resp)
 	}
 	if _, resp := testRequest(t, ts, "GET", "/samples/articles/samples.1.xml", nil); resp != "1" {
-		t.Fatalf(resp)
+		t.Fatal(resp)
 	}
 }
 
@@ -64,6 +64,6 @@ func TestURLFormatInSubRouter(t *testing.T) {
 	defer ts.Close()
 
 	if _, resp := testRequest(t, ts, "GET", "/articles/1/subroute.json", nil); resp != "1" {
-		t.Fatalf(resp)
+		t.Fatal(resp)
 	}
 }

Diff for: middleware/wrap_writer.go

@@ -72,15 +72,19 @@ type WrapResponseWriter interface {
 // http.ResponseWriter interface.
 type basicWriter struct {
 	http.ResponseWriter
-	wroteHeader bool
+	tee         io.Writer
 	code        int
 	bytes       int
-	tee         io.Writer
+	wroteHeader bool
 	discard     bool
 }
 
 func (b *basicWriter) WriteHeader(code int) {
-	if !b.wroteHeader {
+	if code >= 100 && code <= 199 && code != http.StatusSwitchingProtocols {
+		if !b.discard {
+			b.ResponseWriter.WriteHeader(code)
+		}
+	} else if !b.wroteHeader {
 		b.code = code
 		b.wroteHeader = true
 		if !b.discard {