fix: avoid agent runLoop exiting due to ws ping (#8852)

deansheather · web-flow · commit b955c5fefc3c · 2023-08-02T07:25:07.000Z
diff --git a/agent/agent.go b/agent/agent.go
@@ -236,7 +236,9 @@ func (a *agent) runLoop(ctx context.Context) {
 		if err == nil {
 			continue
 		}
-		if errors.Is(err, context.Canceled) {
+		if ctx.Err() != nil {
+			// Context canceled errors may come from websocket pings, so we
+			// don't want to use `errors.Is(err, context.Canceled)` here.
 			return
 		}
 		if a.isClosed() {
diff --git a/codersdk/agentsdk/agentsdk.go b/codersdk/agentsdk/agentsdk.go
@@ -204,7 +204,7 @@ func (c *Client) DERPMapUpdates(ctx context.Context) (<-chan DERPMapUpdate, io.C
 		defer close(updates)
 		defer close(updatesClosed)
 		defer cancelFunc()
-		defer conn.Close(websocket.StatusGoingAway, "Listen closed")
+		defer conn.Close(websocket.StatusGoingAway, "DERPMapUpdates closed")
 		for {
 			var update DERPMapUpdate
 			err := dec.Decode(&update.DERPMap)
@@ -240,7 +240,7 @@ func (c *Client) DERPMapUpdates(ctx context.Context) (<-chan DERPMapUpdate, io.C
 		closeFunc: func() error {
 			cancelFunc()
 			<-pingClosed
-			_ = conn.Close(websocket.StatusGoingAway, "Listen closed")
+			_ = conn.Close(websocket.StatusGoingAway, "DERPMapUpdates closed")
 			<-updatesClosed
 			return nil
 		},

Original file line number	Diff line number	Diff line change
`@@ -236,7 +236,9 @@ func (a *agent) runLoop(ctx context.Context) {`
`236`	`236`	`if err == nil {`
`237`	`237`	`continue`
`238`	`238`	`}`
`239`		`- if errors.Is(err, context.Canceled) {`
	`239`	`+ if ctx.Err() != nil {`
	`240`	`+ // Context canceled errors may come from websocket pings, so we`
	`241`	+ // don't want to use `errors.Is(err, context.Canceled)` here.
`240`	`242`	`return`
`241`	`243`	`}`
`242`	`244`	`if a.isClosed() {`