1
0
mirror of https://github.com/golang/go synced 2024-11-11 22:20:22 -07:00

net/http/pprof: use Request.Context, not the deprecated CloseNotifier

Prior to this commit, the profiling code had a sleep() function that
waits and unblocks on either time.After() or a channel provided by an
http.CloseNotifier derived from a supplied http.ResponseWriter.

According to the documentation, http.CloseNotifier is deprecated:

  Deprecated: the CloseNotifier interface predates Go's context package.
  New code should use Request.Context instead.

This patch does just that -- sleep() now takes an *http.Request and uses
http.Request.Context() to signal when a request has been cancelled.

Change-Id: I98702314addf494f5743a4f99172dc607389dbb8
GitHub-Last-Rev: c1e37a03ca
GitHub-Pull-Request: golang/go#41756
Reviewed-on: https://go-review.googlesource.com/c/go/+/259157
Reviewed-by: Bryan C. Mills <bcmills@google.com>
Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com>
Reviewed-by: Emmanuel Odeke <emm.odeke@gmail.com>
Trust: Bryan C. Mills <bcmills@google.com>
Trust: Emmanuel Odeke <emm.odeke@gmail.com>
Run-TryBot: Bryan C. Mills <bcmills@google.com>
TryBot-Result: Go Bot <gobot@golang.org>
This commit is contained in:
Ayan George 2020-10-06 18:40:40 +00:00 committed by Emmanuel Odeke
parent 4922585497
commit 5c1567cdc0

View File

@ -93,14 +93,10 @@ func Cmdline(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, strings.Join(os.Args, "\x00")) fmt.Fprintf(w, strings.Join(os.Args, "\x00"))
} }
func sleep(w http.ResponseWriter, d time.Duration) { func sleep(r *http.Request, d time.Duration) {
var clientGone <-chan bool
if cn, ok := w.(http.CloseNotifier); ok {
clientGone = cn.CloseNotify()
}
select { select {
case <-time.After(d): case <-time.After(d):
case <-clientGone: case <-r.Context().Done():
} }
} }
@ -142,7 +138,7 @@ func Profile(w http.ResponseWriter, r *http.Request) {
fmt.Sprintf("Could not enable CPU profiling: %s", err)) fmt.Sprintf("Could not enable CPU profiling: %s", err))
return return
} }
sleep(w, time.Duration(sec)*time.Second) sleep(r, time.Duration(sec)*time.Second)
pprof.StopCPUProfile() pprof.StopCPUProfile()
} }
@ -171,7 +167,7 @@ func Trace(w http.ResponseWriter, r *http.Request) {
fmt.Sprintf("Could not enable tracing: %s", err)) fmt.Sprintf("Could not enable tracing: %s", err))
return return
} }
sleep(w, time.Duration(sec*float64(time.Second))) sleep(r, time.Duration(sec*float64(time.Second)))
trace.Stop() trace.Stop()
} }