feat: add read and write timeout annotations and update fox to v0.26.0

Author: tigerwill90

README.md

@@ -31,6 +31,7 @@ package main
 
 import (
 	"errors"
+	"fmt"
 	"log"
 	"net/http"
 	"time"
@@ -40,23 +41,22 @@ import (
 )
 
 func main() {
-	f, err := fox.New(
+	f := fox.MustRouter(
 		fox.DefaultOptions(),
 		fox.WithMiddleware(
 			foxtimeout.Middleware(2*time.Second),
 		),
 	)
-	if err != nil {
-		panic(err)
-	}
 
-	f.MustHandle(http.MethodGet, "/hello/{name}", func(c fox.Context) {
-		_ = c.String(http.StatusOK, "hello %s\n", c.Param("name"))
+	f.MustAdd(fox.MethodGet, "/hello/{name}", func(c *fox.Context) {
+		_ = c.String(http.StatusOK, fmt.Sprintf("Hello %s\n", c.Param("name")))
 	})
-	f.MustHandle(http.MethodGet, "/download/{filepath}", DownloadHandler, foxtimeout.None())
-	f.MustHandle(http.MethodGet, "/workflow/{id}/start", WorkflowHandler, foxtimeout.After(15*time.Second))
+	// Disable timeout the middleware for this route
+	f.MustAdd(fox.MethodGet, "/download/{filepath}", DownloadHandler, foxtimeout.HandlerTimeout(foxtimeout.NoTimeout))
+	// Use 15s timeout instead of the global 2s for this route
+	f.MustAdd(fox.MethodGet, "/workflow/{id}/start", WorkflowHandler, foxtimeout.HandlerTimeout(15*time.Second))
 
-	if err = http.ListenAndServe(":8080", f); err != nil && !errors.Is(err, http.ErrServerClosed) {
+	if err := http.ListenAndServe(":8080", f); err != nil && !errors.Is(err, http.ErrServerClosed) {
 		log.Fatalln(err)
 	}
 }

annotation.go

@@ -8,23 +8,38 @@ import (
 
 type key struct{}
 
-var ctxKey key
+var (
+	timeoutKey      key
+	readTimeoutKey  key
+	writeTimeoutKey key
+)
+
+const NoTimeout = time.Duration(0)
 
-// After returns a RouteOption that sets a custom timeout duration for a specific route.
+// HandlerTimeout returns a RouteOption that sets a custom timeout duration for a specific route.
 // This allows individual routes to have different timeout values than the global timeout.
-func After(dt time.Duration) fox.RouteOption {
-	return fox.WithAnnotation(ctxKey, dt)
+// Passing a value <= 0 (or NoTimeout) disables the timeout for this route.
+func HandlerTimeout(dt time.Duration) fox.RouteOption {
+	return fox.WithAnnotation(timeoutKey, dt)
+}
+
+// ReadTimeout returns a RouteOption that sets the read deadline for the underlying connection.
+// This controls how long the server will wait for the client to send request data.
+// A zero duration is not allowed and will return an error during route registration.
+func ReadTimeout(dt time.Duration) fox.RouteOption {
+	return fox.WithAnnotation(readTimeoutKey, dt)
 }
 
-// None returns a RouteOption that disables the timeout for a specific route.
-// This is useful for long-running operations like file uploads or SSE endpoints.
-func None() fox.RouteOption {
-	return fox.WithAnnotation(ctxKey, time.Duration(0))
+// WriteTimeout returns a RouteOption that sets the write deadline for the underlying connection.
+// This controls how long the server will wait before timing out writes to the client.
+// A zero duration is not allowed and will return an error during route registration.
+func WriteTimeout(dt time.Duration) fox.RouteOption {
+	return fox.WithAnnotation(writeTimeoutKey, dt)
 }
 
-func unwrapRouteTimeout(r *fox.Route) (time.Duration, bool) {
+func unwrapRouteTimeout(r *fox.Route, k key) (time.Duration, bool) {
 	if r != nil {
-		dt := r.Annotation(ctxKey)
+		dt := r.Annotation(k)
 		if dt != nil {
 			return dt.(time.Duration), true
 		}

go.mod

@@ -6,15 +6,15 @@ toolchain go1.24.2
 
 require (
 	github.com/stretchr/testify v1.11.1
-	github.com/tigerwill90/fox v0.25.0
+	github.com/tigerwill90/fox v0.26.0
 )
 
 require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/kr/text v0.2.0 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
-	golang.org/x/net v0.46.0 // indirect
-	golang.org/x/sys v0.38.0 // indirect
-	golang.org/x/text v0.30.0 // indirect
+	golang.org/x/net v0.48.0 // indirect
+	golang.org/x/sys v0.39.0 // indirect
+	golang.org/x/text v0.32.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.sum

@@ -3,24 +3,24 @@ github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/google/gofuzz v1.2.0 h1:xRy4A+RhZaiKjJ1bPfwQ8sedCA+YS2YcCHW6ec7JMi0=
 github.com/google/gofuzz v1.2.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
-github.com/kr/pretty v0.3.0 h1:WgNl7dwNpEZ6jJ9k1snq4pZsg7DOEN8hP9Xw0Tsjwk0=
-github.com/kr/pretty v0.3.0/go.mod h1:640gp4NfQd8pI5XOwp5fnNeVWj67G7CFk/SaSQn7NBk=
+github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
+github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=
 github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
 github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/rogpeppe/go-internal v1.8.0 h1:FCbCCtXNOY3UtUuHUYaghJg4y7Fd14rXifAYUAtL9R8=
-github.com/rogpeppe/go-internal v1.8.0/go.mod h1:WmiCO8CzOY8rg0OYDC4/i/2WRWAB6poM+XZ2dLUbcbE=
+github.com/rogpeppe/go-internal v1.10.0 h1:TMyTOH3F/DB16zRVcYyreMH6GnZZrwQVAoYjRBZyWFQ=
+github.com/rogpeppe/go-internal v1.10.0/go.mod h1:UQnix2H7Ngw/k4C5ijL5+65zddjncjaFoBhdsK/akog=
 github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U=
 github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
-github.com/tigerwill90/fox v0.25.0 h1:NRCHxo7PA1Oh5jQoDhknA/FpCCqrADSievOpDmvtd68=
-github.com/tigerwill90/fox v0.25.0/go.mod h1:dak3QMoa50lO3sFjZ268HRMmF9DxxaXfYuqakO/+QZw=
-golang.org/x/net v0.46.0 h1:giFlY12I07fugqwPuWJi68oOnpfqFnJIJzaIIm2JVV4=
-golang.org/x/net v0.46.0/go.mod h1:Q9BGdFy1y4nkUwiLvT5qtyhAnEHgnQ/zd8PfU6nc210=
-golang.org/x/sys v0.38.0 h1:3yZWxaJjBmCWXqhN1qh02AkOnCQ1poK6oF+a7xWL6Gc=
-golang.org/x/sys v0.38.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
-golang.org/x/text v0.30.0 h1:yznKA/E9zq54KzlzBEAWn1NXSQ8DIp/NYMy88xJjl4k=
-golang.org/x/text v0.30.0/go.mod h1:yDdHFIX9t+tORqspjENWgzaCVXgk0yYnYuSZ8UzzBVM=
+github.com/tigerwill90/fox v0.26.0 h1:DeyDt2sn4GBuBDFD3sTAMaoN1C6plLZ3eh60UEiIWP8=
+github.com/tigerwill90/fox v0.26.0/go.mod h1:zXZwe2JG+YYD1hkVnOtphURr/RArlnIgUH1f9WeP43w=
+golang.org/x/net v0.48.0 h1:zyQRTTrjc33Lhh0fBgT/H3oZq9WuvRR5gPC70xpDiQU=
+golang.org/x/net v0.48.0/go.mod h1:+ndRgGjkh8FGtu1w1FGbEC31if4VrNVMuKTgcAAnQRY=
+golang.org/x/sys v0.39.0 h1:CvCKL8MeisomCi6qNZ+wbb0DN9E5AATixKsvNtMoMFk=
+golang.org/x/sys v0.39.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
+golang.org/x/text v0.32.0 h1:ZD01bjUt1FQ9WJ0ClOL5vxgxOI/sVCNgX1YtKwcY0mU=
+golang.org/x/text v0.32.0/go.mod h1:o/rUWzghvpD5TXrTIBuJU77MTaN0ljMWE47kxGJQ7jY=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
 gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=

options.go

@@ -11,16 +11,15 @@ import (
 )
 
 type config struct {
-	resp                   fox.HandlerFunc
-	filters                []Filter
-	enableAbortRequestBody bool
+	resp    fox.HandlerFunc
+	filters []Filter
 }
 
 type Option interface {
 	apply(*config)
 }
 
-type Filter func(c fox.Context) (skip bool)
+type Filter func(c *fox.Context) (skip bool)
 
 type optionFunc func(*config)
 
@@ -56,15 +55,6 @@ func WithResponse(h fox.HandlerFunc) Option {
 }
 
 // DefaultTimeoutResponse sends a default 503 Service Unavailable response.
-func DefaultTimeoutResponse(c fox.Context) {
+func DefaultTimeoutResponse(c *fox.Context) {
 	http.Error(c.Writer(), http.StatusText(http.StatusServiceUnavailable), http.StatusServiceUnavailable)
 }
-
-// WithAbortRequestBody controls whether to set a read deadline on the request
-// when a timeout occurs. When enabled, subsequent reads from the request body
-// will immediately fail after a timeout.
-func WithAbortRequestBody(enable bool) Option {
-	return optionFunc(func(c *config) {
-		c.enableAbortRequestBody = enable
-	})
-}

timeout.go

@@ -42,7 +42,9 @@ type Timeout struct {
 //
 // The timeout middleware supports the [http.Pusher] interface but does not support the [http.Hijacker] or [http.Flusher] interfaces.
 //
-// Individual routes can override the timeout duration using the [After] option or disable it entirely using [None]:
+// Individual routes can override the timeout duration using the [HandlerTimeout] option. It's also possible to set the read
+// and write deadline for individual route using the [ReadTimeout] and [WriteTimeout] option.
+// If dt <= 0 (or NoTimeout), this is a passthrough middleware but per-route options remain effective.
 func Middleware(dt time.Duration, opts ...Option) fox.MiddlewareFunc {
 	return create(dt, opts...).run
 }
@@ -61,7 +63,7 @@ func create(dt time.Duration, opts ...Option) *Timeout {
 
 // run is the internal handler that applies the timeout logic.
 func (t *Timeout) run(next fox.HandlerFunc) fox.HandlerFunc {
-	return func(c fox.Context) {
+	return func(c *fox.Context) {
 
 		for _, f := range t.cfg.filters {
 			if f(c) {
@@ -70,6 +72,7 @@ func (t *Timeout) run(next fox.HandlerFunc) fox.HandlerFunc {
 			}
 		}
 
+		t.setDeadline(c)
 		dt := t.resolveTimeout(c)
 		if dt <= 0 {
 			next(c)
@@ -130,21 +133,27 @@ func (t *Timeout) run(next fox.HandlerFunc) fox.HandlerFunc {
 			default:
 				tw.err = err
 			}
-			if t.cfg.enableAbortRequestBody {
-				_ = w.SetReadDeadline(time.Now())
-			}
 			t.cfg.resp(c)
 		}
 	}
 }
 
-func (t *Timeout) resolveTimeout(c fox.Context) time.Duration {
-	if dt, ok := unwrapRouteTimeout(c.Route()); ok {
+func (t *Timeout) resolveTimeout(c *fox.Context) time.Duration {
+	if dt, ok := unwrapRouteTimeout(c.Route(), timeoutKey); ok {
 		return dt
 	}
 	return t.dt
 }
 
+func (t *Timeout) setDeadline(c *fox.Context) {
+	if dt, ok := unwrapRouteTimeout(c.Route(), readTimeoutKey); ok {
+		_ = c.Writer().SetReadDeadline(time.Now().Add(dt))
+	}
+	if dt, ok := unwrapRouteTimeout(c.Route(), writeTimeoutKey); ok {
+		_ = c.Writer().SetWriteDeadline(time.Now().Add(dt))
+	}
+}
+
 func checkWriteHeaderCode(code int) {
 	if code < 100 || code > 999 {
 		panic(fmt.Sprintf("invalid status code %d", code))