public_git
/
orchard
mirror of https://github.com/cirruslabs/orchard.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Controller API: correctly detect WebSocket closure in Watch RPC (#259)

This commit is contained in:
Nikolay Edigaryev 2025-02-20 02:00:57 +04:00 committed by GitHub
parent 2dfdb40dea
commit 818f4288c2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 20 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
internal/controller/api_rpc_watch.go
View File

@ -4,6 +4,7 @@ import (
"context"
"encoding/json"
"errors"
"fmt"
"github.com/cirruslabs/orchard/internal/responder"
v1 "github.com/cirruslabs/orchard/pkg/resource/v1"
"github.com/cirruslabs/orchard/rpc"
@ -41,7 +42,7 @@ func (controller *Controller) rpcWatch(ctx *gin.Context) responder.Responder {
// from the connection in the background
//
// Otherwise the wsConn.Ping() will wait forever.
wsConn.CloseRead(ctx)
closeReadCtx := wsConn.CloseRead(ctx)
for {
select {
@ -86,10 +87,14 @@ func (controller *Controller) rpcWatch(ctx *gin.Context) responder.Responder {
}
pingCtxCancel()
case <-closeReadCtx.Done():
// Connection shouldn't be normally closed by the worker
return controller.wsErrorNoClose("watch RPC",
fmt.Sprintf("worker %s unexpectedly disconnected", workerName), closeReadCtx.Err())
case <-ctx.Done():
// Connection shouldn't be normally closed by the worker
return controller.wsError(wsConn, websocket.StatusAbnormalClosure, "watch RPC",
"unexpectedly disconnected worker", err)
return controller.wsErrorNoClose("watch RPC",
fmt.Sprintf("worker %s unexpectedly disconnected", workerName), ctx.Err())
}
}
}

16
internal/controller/wserror.go
View File

@ -13,14 +13,22 @@ func (controller *Controller) wsError(
reason string,
err error,
) responder.Responder {
message := fmt.Sprintf("%s: %v", reason, err)
responder := controller.wsErrorNoClose(component, reason, err)
controller.logger.Warn(message)
if err := wsConn.Close(code, message); err != nil {
if err := wsConn.Close(code, fmt.Sprintf("%s: %v", reason, err)); err != nil {
controller.logger.Warnf("%s: failed to close the WebSocket connection that entered error state"+
" due to %s: %v", component, reason, err)
}
return responder
}
func (controller *Controller) wsErrorNoClose(
component string,
reason string,
err error,
) responder.Responder {
controller.logger.Warnf("%s: %s: %v", component, reason, err)
return responder.Empty()
}