valyala/fasthttp

Improve RequestCtx context documentation

Closed

#1,219 opened on Feb 16, 2022

 (3 comments) (0 reactions) (0 assignees)Go (1,755 forks)batch import
help wantedpending/development

Repository metrics

Stars
 (21,741 stars)
PR merge metrics
 (Avg merge 3d) (44 merged PRs in 30d)

Description

The context doesnt become Done() on the timeout.

for example, this code:

func main() {
	fasthttp.ListenAndServe(":8080", fasthttp.TimeoutHandler(func(ctx *fasthttp.RequestCtx) {
		log.Println("begin")

		tm := time.NewTimer(10 * time.Second)

		select {
		case <-ctx.Done():
			log.Println("context cancelled")
			return
		case <-tm.C:
			log.Println("process finished ok")
		}

		log.Println("end")
	}, time.Second*2, "timeout"))
}

prints:

2022/02/16 12:52:56 begin
2022/02/16 12:53:06 process finished ok
2022/02/16 12:53:06 end

The client receives the timeout after 2 seconds, and the handler finishes after 10 seconds yet. It would be nice if the context became Done() in this case. If this would break existing code expectations then it can be made optional (via setting or a new TimeoutHandlerWithShutdown or something like it).

Will you accept a PR for this?

Contributor guide