Proposal/capture error 983

.github/workflows/ci.yml

@@ -1,41 +1,42 @@
 on:
   push:
-    branches: '**'
+    branches: "**"
     paths-ignore:
-      - 'docs/**'
+      - "docs/**"
   pull_request:
-    branches: '**'
+    branches: "**"
     paths-ignore:
-      - 'docs/**'
+      - "docs/**"
 
 name: Test
 jobs:
   test:
     env:
       GOPATH: ${{ github.workspace }}
-      GO111MODULE: off
 
     defaults:
       run:
         working-directory: ${{ env.GOPATH }}/src/github.com/${{ github.repository }}
 
     strategy:
       matrix:
-        go-version: [1.15.x, 1.16.x, 1.17.x, 1.18.x, 1.19.x, 1.20.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@v3
-      with:
-        go-version: ${{ matrix.go-version }}
-    - name: Checkout code
-      uses: actions/checkout@v3
-      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

CHANGELOG.md

@@ -1,9 +1,19 @@
 # Changelog
 
+## v5.0.12 (2024-02-16)
+
+- History of changes: see https://github.com/go-chi/chi/compare/v5.0.11...v5.0.12
+
+
+## v5.0.11 (2023-12-19)
+
+- History of changes: see https://github.com/go-chi/chi/compare/v5.0.10...v5.0.11
+
+
 ## v5.0.10 (2023-07-13)
 
 - Fixed small edge case in tests of v5.0.9 for older Go versions
-- History of changes: see https://github.com/go-chi/chi/compare/v5.0.8...v5.0.10
+- History of changes: see https://github.com/go-chi/chi/compare/v5.0.9...v5.0.10
 
 
 ## v5.0.9 (2023-07-13)
@@ -306,7 +316,7 @@ Cheers all, happy coding!
   request-scoped values. We're very excited about the new context addition and are proud to
   introduce chi v2, a minimal and powerful routing package for building large HTTP services,
   with zero external dependencies. Chi focuses on idiomatic design and encourages the use of 
-  stdlib HTTP handlers and middlwares.
+  stdlib HTTP handlers and middlewares.
 - chi v2 deprecates its `chi.Handler` interface and requires `http.Handler` or `http.HandlerFunc`
 - chi v2 stores URL routing parameters and patterns in the standard request context: `r.Context()`
 - chi v2 lower-level routing context is accessible by `chi.RouteContext(r.Context()) *chi.Context`,

CONTRIBUTING.md

@@ -14,7 +14,7 @@
 
 A typical workflow is:
 
-1. [Fork the repository.][fork] [This tip maybe also helpful.][go-fork-tip]
+1. [Fork the repository.][fork]
 2. [Create a topic branch.][branch]
 3. Add tests for your change.
 4. Run `go test`. If your tests pass, return to the step 3.
@@ -24,8 +24,8 @@ A typical workflow is:
 8. [Submit a pull request.][pull-req]
 
 [go-install]: https://golang.org/doc/install
-[go-fork-tip]: http://blog.campoy.cat/2014/03/github-and-go-forking-pull-requests-and.html
-[fork]: https://help.github.com/articles/fork-a-repo
-[branch]: http://learn.github.com/p/branching.html
-[git-help]: https://guides.github.com
-[pull-req]: https://help.github.com/articles/using-pull-requests
+[fork]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo
+[branch]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches 
+[git-help]: https://docs.github.com/en
+[pull-req]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests
+

README.md

@@ -65,7 +65,7 @@ func main() {
 
 **REST Preview:**
 
-Here is a little preview of how routing looks like with chi. Also take a look at the generated routing docs
+Here is a little preview of what routing looks like with chi. Also take a look at the generated routing docs
 in JSON ([routes.json](https://github.com/go-chi/chi/blob/master/_examples/rest/routes.json)) and in
 Markdown ([routes.md](https://github.com/go-chi/chi/blob/master/_examples/rest/routes.md)).
 
@@ -194,7 +194,7 @@ type Router interface {
 	// path, with a fresh middleware stack for the inline-Router.
 	Group(fn func(r Router)) Router
 
-	// Route mounts a sub-Router along a `pattern`` string.
+	// Route mounts a sub-Router along a `pattern` string.
 	Route(pattern string, fn func(r Router)) Router
 
 	// Mount attaches another http.Handler along ./pattern/*
@@ -354,6 +354,7 @@ with `net/http` can be used with chi's mux.
 | [RouteHeaders]         | Route handling for request headers                                      |
 | [SetHeader]            | Short-hand middleware to set a response header key/value                |
 | [StripSlashes]         | Strip slashes on routing paths                                          |
+| [Sunset]               | Sunset set Deprecation/Sunset header to response                        |
 | [Throttle]             | Puts a ceiling on the number of concurrent requests                     |
 | [Timeout]              | Signals to the request context when the timeout deadline is reached     |
 | [URLFormat]            | Parse extension from url and put it on request context                  |
@@ -380,6 +381,7 @@ with `net/http` can be used with chi's mux.
 [RouteHeaders]: https://pkg.go.dev/github.com/go-chi/chi/middleware#RouteHeaders
 [SetHeader]: https://pkg.go.dev/github.com/go-chi/chi/middleware#SetHeader
 [StripSlashes]: https://pkg.go.dev/github.com/go-chi/chi/middleware#StripSlashes
+[Sunset]: https://pkg.go.dev/github.com/go-chi/chi/v5/middleware#Sunset
 [Throttle]: https://pkg.go.dev/github.com/go-chi/chi/middleware#Throttle
 [ThrottleBacklog]: https://pkg.go.dev/github.com/go-chi/chi/middleware#ThrottleBacklog
 [ThrottleWithOpts]: https://pkg.go.dev/github.com/go-chi/chi/middleware#ThrottleWithOpts
@@ -467,7 +469,8 @@ how setting context on a request in Go works.
 
 * Carl Jackson for https://github.com/zenazn/goji
   * Parts of chi's thinking comes from goji, and chi's middleware package
-    sources from goji.
+    sources from [goji](https://github.com/zenazn/goji/tree/master/web/middleware).
+  * Please see goji's [LICENSE](https://github.com/zenazn/goji/blob/master/LICENSE) (MIT)
 * Armon Dadgar for https://github.com/armon/go-radix
 * Contributions: [@VojtechVitek](https://github.com/VojtechVitek)
 
@@ -494,7 +497,7 @@ Copyright (c) 2015-present [Peter Kieltyka](https://github.com/pkieltyka)
 
 Licensed under [MIT License](./LICENSE)
 
-[GoDoc]: https://pkg.go.dev/github.com/go-chi/chi?tab=versions
+[GoDoc]: https://pkg.go.dev/github.com/go-chi/chi/v5
 [GoDoc Widget]: https://godoc.org/github.com/go-chi/chi?status.svg
 [Travis]: https://travis-ci.org/go-chi/chi
 [Travis Widget]: https://travis-ci.org/go-chi/chi.svg?branch=master

SECURITY.md

@@ -0,0 +1,5 @@
+# Reporting Security Issues
+
+We appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions.
+
+To report a security issue, please use the GitHub Security Advisory ["Report a Vulnerability"](https://github.com/go-chi/chi/security/advisories/new) tab.

_examples/fileserver/main.go

@@ -1,23 +1,18 @@
-//
-// FileServer
-// ===========
 // This example demonstrates how to serve static files from your filesystem.
 //
-//
 // Boot the server:
-// ----------------
-// $ go run main.go
+//
+//	$ go run main.go
 //
 // Client requests:
-// ----------------
-// $ curl http://localhost:3333/files/
-// <pre>
-// <a href="notes.txt">notes.txt</a>
-// </pre>
 //
-// $ curl http://localhost:3333/files/notes.txt
-// Notessszzz
+//	$ curl http://localhost:3333/files/
+//	<pre>
+//	<a href="notes.txt">notes.txt</a>
+//	</pre>
 //
+//	$ curl http://localhost:3333/files/notes.txt
+//	Notessszzz
 package main
 
 import (

_examples/limits/main.go

@@ -1,16 +1,10 @@
-//
-// Limits
-// ======
 // This example demonstrates the use of Timeout, and Throttle middlewares.
 //
-// Timeout:
-//   cancel a request if processing takes longer than 2.5 seconds,
-//   server will respond with a http.StatusGatewayTimeout.
-//
-// Throttle:
-//   limit the number of in-flight requests along a particular
-//   routing path and backlog the others.
+// Timeout: cancel a request if processing takes longer than 2.5 seconds,
+// server will respond with a http.StatusGatewayTimeout.
 //
+// Throttle: limit the number of in-flight requests along a particular
+// routing path and backlog the others.
 package main
 
 import (

_examples/logging/main.go

@@ -1,143 +1,9 @@
-// Custom Structured Logger
-// ========================
-// This example demonstrates how to use middleware.RequestLogger,
-// middleware.LogFormatter and middleware.LogEntry to build a structured
-// logger using the preview version of the new log/slog package as the logging
-// backend.
-//
-// Also: check out https://github.com/goware/httplog for an improved context
-// logger with support for HTTP request logging, based on the example below.
 package main
 
-import (
-	"fmt"
-	"net/http"
-	"os"
-	"time"
-
-	"golang.org/x/exp/slog"
-
-	"github.com/go-chi/chi/v5"
-	"github.com/go-chi/chi/v5/middleware"
-)
+// Please see https://github.com/go-chi/httplog for a complete package
+// and example for writing a structured logger on chi built on
+// the Go 1.21+ "log/slog" package.
 
 func main() {
-	// Setup a JSON handler for the new log/slog library
-	slogJSONHandler := slog.HandlerOptions{
-		// Remove default time slog.Attr, we create our own later
-		ReplaceAttr: func(groups []string, a slog.Attr) slog.Attr {
-			if a.Key == slog.TimeKey {
-				return slog.Attr{}
-			}
-			return a
-		},
-	}.NewJSONHandler(os.Stdout)
-
-	// Routes
-	r := chi.NewRouter()
-	r.Use(middleware.RequestID)
-	r.Use(NewStructuredLogger(slogJSONHandler))
-	r.Use(middleware.Recoverer)
-
-	r.Get("/", func(w http.ResponseWriter, r *http.Request) {
-		w.Write([]byte("welcome"))
-	})
-	r.Get("/wait", func(w http.ResponseWriter, r *http.Request) {
-		time.Sleep(1 * time.Second)
-		LogEntrySetField(r, "wait", true)
-		w.Write([]byte("hi"))
-	})
-	r.Get("/panic", func(w http.ResponseWriter, r *http.Request) {
-		panic("oops")
-	})
-	r.Get("/add_fields", func(w http.ResponseWriter, r *http.Request) {
-		LogEntrySetFields(r, map[string]interface{}{"foo": "bar", "bar": "foo"})
-	})
-	http.ListenAndServe(":3333", r)
-}
-
-// StructuredLogger is a simple, but powerful implementation of a custom structured
-// logger backed on log/slog. I encourage users to copy it, adapt it and make it their
-// own. Also take a look at https://github.com/go-chi/httplog for a dedicated pkg based
-// on this work, designed for context-based http routers.
-
-func NewStructuredLogger(handler slog.Handler) func(next http.Handler) http.Handler {
-	return middleware.RequestLogger(&StructuredLogger{Logger: handler})
-}
-
-type StructuredLogger struct {
-	Logger slog.Handler
-}
-
-func (l *StructuredLogger) NewLogEntry(r *http.Request) middleware.LogEntry {
-	var logFields []slog.Attr
-	logFields = append(logFields, slog.String("ts", time.Now().UTC().Format(time.RFC1123)))
-
-	if reqID := middleware.GetReqID(r.Context()); reqID != "" {
-		logFields = append(logFields, slog.String("req_id", reqID))
-	}
-
-	scheme := "http"
-	if r.TLS != nil {
-		scheme = "https"
-	}
-
-	handler := l.Logger.WithAttrs(append(logFields,
-		slog.String("http_scheme", scheme),
-		slog.String("http_proto", r.Proto),
-		slog.String("http_method", r.Method),
-		slog.String("remote_addr", r.RemoteAddr),
-		slog.String("user_agent", r.UserAgent()),
-		slog.String("uri", fmt.Sprintf("%s://%s%s", scheme, r.Host, r.RequestURI))))
-
-	entry := StructuredLoggerEntry{Logger: slog.New(handler)}
-
-	entry.Logger.LogAttrs(slog.LevelInfo, "request started")
-
-	return &entry
-}
-
-type StructuredLoggerEntry struct {
-	Logger *slog.Logger
-}
-
-func (l *StructuredLoggerEntry) Write(status, bytes int, header http.Header, elapsed time.Duration, extra interface{}) {
-	l.Logger.LogAttrs(slog.LevelInfo, "request complete",
-		slog.Int("resp_status", status),
-		slog.Int("resp_byte_length", bytes),
-		slog.Float64("resp_elapsed_ms", float64(elapsed.Nanoseconds())/1000000.0),
-	)
-}
-
-func (l *StructuredLoggerEntry) Panic(v interface{}, stack []byte) {
-	l.Logger.LogAttrs(slog.LevelInfo, "",
-		slog.String("stack", string(stack)),
-		slog.String("panic", fmt.Sprintf("%+v", v)),
-	)
-}
-
-// Helper methods used by the application to get the request-scoped
-// logger entry and set additional fields between handlers.
-//
-// This is a useful pattern to use to set state on the entry as it
-// passes through the handler chain, which at any point can be logged
-// with a call to .Print(), .Info(), etc.
-
-func GetLogEntry(r *http.Request) *slog.Logger {
-	entry := middleware.GetLogEntry(r).(*StructuredLoggerEntry)
-	return entry.Logger
-}
-
-func LogEntrySetField(r *http.Request, key string, value interface{}) {
-	if entry, ok := r.Context().Value(middleware.LogEntryCtxKey).(*StructuredLoggerEntry); ok {
-		entry.Logger = entry.Logger.With(key, value)
-	}
-}
-
-func LogEntrySetFields(r *http.Request, fields map[string]interface{}) {
-	if entry, ok := r.Context().Value(middleware.LogEntryCtxKey).(*StructuredLoggerEntry); ok {
-		for k, v := range fields {
-			entry.Logger = entry.Logger.With(k, v)
-		}
-	}
+	// See https://github.com/go-chi/httplog/blob/master/_example/main.go
 }