Commit 6c8e3ab

authored

docs: Fix docs and examples related to r.Context() usage (#477)

Contributes to #474

1 parent faf23b7 commit 6c8e3abCopy full SHA for 6c8e3ab

File tree

+12

-7

lines changed

+12

-7

lines changed

Lines changed: 3 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,9 @@ http.HandlerFunc(func (w http.ResponseWriter, r *http.Request) {`
`63`	`63`	`}`
`64`	`64`	`defer c.CloseNow()`
`65`	`65`
`66`		`- ctx, cancel := context.WithTimeout(r.Context(), time.Second*10)`
	`66`	`+ // Set the context as needed. Use of r.Context() is not recommended`
	`67`	`+ // to avoid surprising behavior (see http.Hijacker).`
	`68`	`+ ctx, cancel := context.WithTimeout(context.Background(), time.Second*10)`
`67`	`69`	`defer cancel()`
`68`	`70`
`69`	`71`	`var v interface{}`

Lines changed: 3 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -79,6 +79,9 @@ func (opts AcceptOptions) cloneWithDefaults() AcceptOptions {`
`79`	`79`	`// See the InsecureSkipVerify and OriginPatterns options to allow cross origin requests.`
`80`	`80`	`//`
`81`	`81`	`// Accept will write a response to w on all errors.`
	`82`	`+//`
	`83`	`+// Note that using the http.Request Context after Accept returns may lead to`
	`84`	`+// unexpected behavior (see http.Hijacker).`
`82`	`85`	`func Accept(w http.ResponseWriter, r http.Request, opts AcceptOptions) (*Conn, error) {`
`83`	`86`	`return accept(w, r, opts)`
`84`	`87`	`}`

Lines changed: 3 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ func (cs chatServer) ServeHTTP(w http.ResponseWriter, r http.Request) {`
`70`	`70`	`// subscribeHandler accepts the WebSocket connection and then subscribes`
`71`	`71`	`// it to all future messages.`
`72`	`72`	`func (cs chatServer) subscribeHandler(w http.ResponseWriter, r http.Request) {`
`73`		`- err := cs.subscribe(r.Context(), w, r)`
	`73`	`+ err := cs.subscribe(w, r)`
`74`	`74`	`if errors.Is(err, context.Canceled) {`
`75`	`75`	`return`
`76`	`76`	`}`
`@@ -111,7 +111,7 @@ func (cs chatServer) publishHandler(w http.ResponseWriter, r http.Request) {`
`111`	`111`	`//`
`112`	`112`	`// It uses CloseRead to keep reading from the connection to process control`
`113`	`113`	`// messages and cancel the context if the connection drops.`
`114`		`-func (cs chatServer) subscribe(ctx context.Context, w http.ResponseWriter, r http.Request) error {`
	`114`	`+func (cs chatServer) subscribe(w http.ResponseWriter, r http.Request) error {`
`115`	`115`	`var mu sync.Mutex`
`116`	`116`	`var c *websocket.Conn`
`117`	`117`	`var closed bool`
`@@ -142,7 +142,7 @@ func (cs chatServer) subscribe(ctx context.Context, w http.ResponseWriter, r h`
`142`	`142`	`mu.Unlock()`
`143`	`143`	`defer c.CloseNow()`
`144`	`144`
`145`		`- ctx = c.CloseRead(ctx)`
	`145`	`+ ctx := c.CloseRead(context.Background())`
`146`	`146`
`147`	`147`	`for {`
`148`	`148`	`select {`

Lines changed: 3 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ func (s echoServer) ServeHTTP(w http.ResponseWriter, r *http.Request) {`
`37`	`37`
`38`	`38`	`l := rate.NewLimiter(rate.Every(time.Millisecond*100), 10)`
`39`	`39`	`for {`
`40`		`- err = echo(r.Context(), c, l)`
	`40`	`+ err = echo(c, l)`
`41`	`41`	`if websocket.CloseStatus(err) == websocket.StatusNormalClosure {`
`42`	`42`	`return`
`43`	`43`	`}`
`@@ -51,8 +51,8 @@ func (s echoServer) ServeHTTP(w http.ResponseWriter, r *http.Request) {`
`51`	`51`	`// echo reads from the WebSocket connection and then writes`
`52`	`52`	`// the received message back to it.`
`53`	`53`	`// The entire function has 10s to complete.`
`54`		`-func echo(ctx context.Context, c websocket.Conn, l rate.Limiter) error {`
`55`		`- ctx, cancel := context.WithTimeout(ctx, time.Second*10)`
	`54`	`+func echo(c websocket.Conn, l rate.Limiter) error {`
	`55`	`+ ctx, cancel := context.WithTimeout(context.Background(), time.Second*10)`
`56`	`56`	`defer cancel()`
`57`	`57`
`58`	`58`	`err := l.Wait(ctx)`

Comments

(0)