Skip to content

Repository navigation

fix: guard Push after timeout and sync with net/http TimeoutHandler #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tigerwill90 merged 2 commits into from
Oct 14, 2026
Merged

fix: guard Push after timeout and sync with net/http TimeoutHandler #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f053398
fix: guard Push after timeout and sync with net/http TimeoutHandler
tigerwill90 Oct 14, 2026
4d159e5
chore: remove redundant logf comment
tigerwill90 Oct 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions timeout.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import (
"bytes"
"context"
"fmt"
"log"
"maps"
"net/http"
"runtime"
Expand Down Expand Up @@ -159,13 +160,23 @@ func relevantCaller() runtime.Frame {
frames := runtime.CallersFrames(pc[:n])
var frame runtime.Frame
for {
f, more := frames.Next()
if !strings.HasPrefix(f.Function, "github.com/fox-toolkit/timeout.") {
return f
var more bool
frame, more = frames.Next()
if !strings.HasPrefix(frame.Function, "github.com/fox-toolkit/timeout.") {
return frame
}
if !more {
break
}
}
return frame
}

func logf(r *http.Request, format string, args ...any) {
s, _ := r.Context().Value(http.ServerContextKey).(*http.Server)
if s != nil && s.ErrorLog != nil {
s.ErrorLog.Printf(format, args...)
} else {
log.Printf(format, args...)
}
}
130 changes: 94 additions & 36 deletions timeout_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,16 @@ package timeout

import (
"bytes"
"context"
"fmt"
"io"
"log"
"log/slog"
"net"
"net/http"
"net/http/httptest"
"testing"
"testing/synctest"
"time"

"github.com/fox-toolkit/fox"
Expand All @@ -26,46 +29,58 @@ func success201response(c *fox.Context) {
}

func TestMiddleware_WithTimeout(t *testing.T) {
f, err := fox.NewRouter(fox.WithMiddleware(Middleware(50 * time.Microsecond)))
require.NoError(t, err)
f.MustAdd(fox.MethodGet, "/foo", success201response)
synctest.Test(t, func(t *testing.T) {
f, err := fox.NewRouter(fox.WithMiddleware(Middleware(50 * time.Microsecond)))
require.NoError(t, err)
f.MustAdd(fox.MethodGet, "/foo", success201response)

req := httptest.NewRequest(http.MethodGet, "/foo", nil)
w := httptest.NewRecorder()
f.ServeHTTP(w, req)
req := httptest.NewRequest(http.MethodGet, "/foo", nil)
w := httptest.NewRecorder()
f.ServeHTTP(w, req)

assert.Equal(t, http.StatusServiceUnavailable, w.Code)
assert.Equal(t, fmt.Sprintf("%s\n", http.StatusText(http.StatusServiceUnavailable)), w.Body.String())

assert.Equal(t, http.StatusServiceUnavailable, w.Code)
assert.Equal(t, fmt.Sprintf("%s\n", http.StatusText(http.StatusServiceUnavailable)), w.Body.String())
// Let the handler goroutine, which outlives the middleware after a timeout, finish.
time.Sleep(10 * time.Millisecond)
})
}

func TestMiddleware_WithoutTimeout(t *testing.T) {
f, err := fox.NewRouter(fox.WithMiddleware(Middleware(1 * time.Second)))
require.NoError(t, err)
f.MustAdd(fox.MethodGet, "/foo", success201response)
synctest.Test(t, func(t *testing.T) {
f, err := fox.NewRouter(fox.WithMiddleware(Middleware(1 * time.Second)))
require.NoError(t, err)
f.MustAdd(fox.MethodGet, "/foo", success201response)

req := httptest.NewRequest(http.MethodGet, "/foo", nil)
w := httptest.NewRecorder()
f.ServeHTTP(w, req)
req := httptest.NewRequest(http.MethodGet, "/foo", nil)
w := httptest.NewRecorder()
f.ServeHTTP(w, req)

assert.Equal(t, http.StatusCreated, w.Code)
assert.Equal(t, fmt.Sprintf("%s\n", http.StatusText(http.StatusCreated)), w.Body.String())
assert.Equal(t, http.StatusCreated, w.Code)
assert.Equal(t, fmt.Sprintf("%s\n", http.StatusText(http.StatusCreated)), w.Body.String())
})
}

func timeoutResponse(c *fox.Context) {
http.Error(c.Writer(), http.StatusText(http.StatusRequestTimeout), http.StatusRequestTimeout)
}

func TestMiddleware_WithResponse(t *testing.T) {
f, err := fox.NewRouter(fox.WithMiddleware(Middleware(50*time.Microsecond, WithResponse(timeoutResponse))))
require.NoError(t, err)
f.MustAdd(fox.MethodGet, "/foo", success201response)
synctest.Test(t, func(t *testing.T) {
f, err := fox.NewRouter(fox.WithMiddleware(Middleware(50*time.Microsecond, WithResponse(timeoutResponse))))
require.NoError(t, err)
f.MustAdd(fox.MethodGet, "/foo", success201response)

req := httptest.NewRequest(http.MethodGet, "/foo", nil)
w := httptest.NewRecorder()
f.ServeHTTP(w, req)
req := httptest.NewRequest(http.MethodGet, "/foo", nil)
w := httptest.NewRecorder()
f.ServeHTTP(w, req)

assert.Equal(t, http.StatusRequestTimeout, w.Code)
assert.Equal(t, fmt.Sprintf("%s\n", http.StatusText(http.StatusRequestTimeout)), w.Body.String())
assert.Equal(t, http.StatusRequestTimeout, w.Code)
assert.Equal(t, fmt.Sprintf("%s\n", http.StatusText(http.StatusRequestTimeout)), w.Body.String())

// Let the handler goroutine, which outlives the middleware after a timeout, finish.
time.Sleep(10 * time.Millisecond)
})
}

func panicResponse(c *fox.Context) {
Expand Down Expand Up @@ -123,30 +138,73 @@ func TestMiddleware_ErrNotSupported(t *testing.T) {
f.ServeHTTP(w, req)
}

func TestMiddleware_WithHandlerTimeout(t *testing.T) {
f, err := fox.NewRouter(fox.WithMiddleware(Middleware(1 * time.Millisecond)))
func TestMiddleware_PushAfterTimeout(t *testing.T) {
synctest.Test(t, func(t *testing.T) {
f, err := fox.NewRouter(fox.WithMiddleware(Middleware(10 * time.Millisecond)))
require.NoError(t, err)

pushErr := make(chan error, 1)
f.MustAdd(fox.MethodGet, "/foo", func(c *fox.Context) {
time.Sleep(20 * time.Millisecond)
pushErr <- c.Writer().Push("/style.css", nil)
})

req := httptest.NewRequest(http.MethodGet, "/foo", nil)
w := httptest.NewRecorder()
f.ServeHTTP(w, req)

assert.Equal(t, http.StatusServiceUnavailable, w.Code)
assert.ErrorIs(t, <-pushErr, http.ErrHandlerTimeout)
})
}

func TestMiddleware_SuperfluousWriteHeaderUsesServerErrorLog(t *testing.T) {
f, err := fox.NewRouter(fox.WithMiddleware(Middleware(1 * time.Second)))
require.NoError(t, err)
f.MustAdd(fox.MethodGet, "/foo", success201response, OverrideHandler(2*time.Second))
f.MustAdd(fox.MethodGet, "/foo", func(c *fox.Context) {
c.Writer().WriteHeader(http.StatusCreated)
c.Writer().WriteHeader(http.StatusAccepted)
})

buf := new(bytes.Buffer)
srv := &http.Server{ErrorLog: log.New(buf, "", 0)}
req := httptest.NewRequest(http.MethodGet, "/foo", nil)
req = req.WithContext(context.WithValue(req.Context(), http.ServerContextKey, srv))
w := httptest.NewRecorder()
f.ServeHTTP(w, req)

assert.Equal(t, http.StatusCreated, w.Code)
assert.Equal(t, fmt.Sprintf("%s\n", http.StatusText(http.StatusCreated)), w.Body.String())
assert.Contains(t, buf.String(), "http: superfluous response.WriteHeader call")
}

func TestMiddleware_WithHandlerTimeout(t *testing.T) {
synctest.Test(t, func(t *testing.T) {
f, err := fox.NewRouter(fox.WithMiddleware(Middleware(1 * time.Millisecond)))
require.NoError(t, err)
f.MustAdd(fox.MethodGet, "/foo", success201response, OverrideHandler(2*time.Second))

req := httptest.NewRequest(http.MethodGet, "/foo", nil)
w := httptest.NewRecorder()
f.ServeHTTP(w, req)

assert.Equal(t, http.StatusCreated, w.Code)
assert.Equal(t, fmt.Sprintf("%s\n", http.StatusText(http.StatusCreated)), w.Body.String())
})
}

func TestMiddleware_WithDisableTimeout(t *testing.T) {
f, err := fox.NewRouter(fox.WithMiddleware(Middleware(1 * time.Millisecond)))
require.NoError(t, err)
f.MustAdd(fox.MethodGet, "/foo", success201response, OverrideHandler(None))
synctest.Test(t, func(t *testing.T) {
f, err := fox.NewRouter(fox.WithMiddleware(Middleware(1 * time.Millisecond)))
require.NoError(t, err)
f.MustAdd(fox.MethodGet, "/foo", success201response, OverrideHandler(None))

req := httptest.NewRequest(http.MethodGet, "/foo", nil)
w := httptest.NewRecorder()
f.ServeHTTP(w, req)
req := httptest.NewRequest(http.MethodGet, "/foo", nil)
w := httptest.NewRecorder()
f.ServeHTTP(w, req)

assert.Equal(t, http.StatusCreated, w.Code)
assert.Equal(t, fmt.Sprintf("%s\n", http.StatusText(http.StatusCreated)), w.Body.String())
assert.Equal(t, http.StatusCreated, w.Code)
assert.Equal(t, fmt.Sprintf("%s\n", http.StatusText(http.StatusCreated)), w.Body.String())
})
}

func TestMiddleware_WithReadTimeout(t *testing.T) {
Expand Down
9 changes: 7 additions & 2 deletions writer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ import (
"bufio"
"bytes"
"io"
"log"
"net"
"net/http"
"path"
Expand Down Expand Up @@ -74,6 +73,12 @@ func (tw *timeoutWriter) WriteString(s string) (int, error) {
}

func (tw *timeoutWriter) Push(target string, opts *http.PushOptions) error {
tw.mu.Lock()
defer tw.mu.Unlock()
// After a timeout, the underlying writer may already belong to another request.
if tw.err != nil {
return tw.err
}
return tw.w.Push(target, opts)
}

Expand Down Expand Up @@ -103,7 +108,7 @@ func (tw *timeoutWriter) writeHeaderLocked(code int) {
return
case tw.written:
caller := relevantCaller()
log.Printf("http: superfluous response.WriteHeader call from %s (%s:%d)", caller.Function, path.Base(caller.File), caller.Line)
logf(tw.req, "http: superfluous response.WriteHeader call from %s (%s:%d)", caller.Function, path.Base(caller.File), caller.Line)
default:
tw.written = true
tw.code = code
Expand Down
Loading