Skip to content

Commit adb58ca

Browse files
piyushbagPiyush Bag
authored andcommitted
fix(handlers): return 499 on client cancel for get-server endpoints
Extend the ListServersError pattern from modelcontextprotocol#1335 to get-server-version and get-server-versions so benign client disconnects no longer log as 500s or trigger huma superfluous WriteHeader warnings. Fixes modelcontextprotocol#1323
1 parent 3fe10fc commit adb58ca

3 files changed

Lines changed: 73 additions & 7 deletions

File tree

‎internal/api/handlers/v0/list_errors.go‎

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,48 @@ import (
88
"github.com/danielgtaylor/huma/v2"
99
)
1010

11+
func clientClosedRequest(ctx context.Context, err error) (error, bool) {
12+
if errors.Is(err, context.Canceled) || errors.Is(ctx.Err(), context.Canceled) {
13+
return huma.NewError(499, "Client closed request", err), true
14+
}
15+
return nil, false
16+
}
17+
1118
// ListServersError maps ListServers failures; client disconnects must not log as 500s.
1219
func ListServersError(ctx context.Context, err error) error {
1320
if err == nil {
1421
return nil
1522
}
16-
if errors.Is(err, context.Canceled) || errors.Is(ctx.Err(), context.Canceled) {
17-
return huma.NewError(499, "Client closed request", err)
23+
if cerr, ok := clientClosedRequest(ctx, err); ok {
24+
return cerr
1825
}
1926
log.Printf("list servers failed: %v", err)
2027
// Do not pass err here: huma serializes extra error args into the response
2128
// body, which would leak internal (e.g. pgx) error detail to clients. Log it
2229
// server-side only, like the sibling handlers in servers.go.
2330
return huma.Error500InternalServerError("Failed to get registry list")
2431
}
32+
33+
// GetServerDetailsError maps get-server-version failures; client disconnects must not log as 500s.
34+
func GetServerDetailsError(ctx context.Context, err error, serverName, version string) error {
35+
if err == nil {
36+
return nil
37+
}
38+
if cerr, ok := clientClosedRequest(ctx, err); ok {
39+
return cerr
40+
}
41+
log.Printf("get server details (%q/%q) failed: %v", serverName, version, err)
42+
return huma.Error500InternalServerError("Failed to get server details")
43+
}
44+
45+
// GetServerVersionsError maps get-server-versions failures; client disconnects must not log as 500s.
46+
func GetServerVersionsError(ctx context.Context, err error, serverName string) error {
47+
if err == nil {
48+
return nil
49+
}
50+
if cerr, ok := clientClosedRequest(ctx, err); ok {
51+
return cerr
52+
}
53+
log.Printf("get server versions (%q) failed: %v", serverName, err)
54+
return huma.Error500InternalServerError("Failed to get server versions")
55+
}

‎internal/api/handlers/v0/list_errors_test.go‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,3 +43,41 @@ func TestListServersError_realFailureDoesNotLeakDetail(t *testing.T) {
4343
assert.NotContains(t, string(body), "database unavailable")
4444
assert.NotContains(t, string(body), "internal-host")
4545
}
46+
47+
func TestGetServerDetailsError_clientCanceled(t *testing.T) {
48+
ctx, cancel := context.WithCancel(context.Background())
49+
cancel()
50+
51+
err := v0.GetServerDetailsError(ctx, errors.New("query canceled"), "io.github.acme/widget", "1.0.0")
52+
require.Error(t, err)
53+
var se huma.StatusError
54+
require.True(t, errors.As(err, &se))
55+
assert.Equal(t, 499, se.GetStatus())
56+
}
57+
58+
func TestGetServerDetailsError_realFailure(t *testing.T) {
59+
err := v0.GetServerDetailsError(context.Background(), errors.New("database unavailable"), "io.github.acme/widget", "1.0.0")
60+
require.Error(t, err)
61+
var se huma.StatusError
62+
require.True(t, errors.As(err, &se))
63+
assert.Equal(t, 500, se.GetStatus())
64+
}
65+
66+
func TestGetServerVersionsError_clientCanceled(t *testing.T) {
67+
ctx, cancel := context.WithCancel(context.Background())
68+
cancel()
69+
70+
err := v0.GetServerVersionsError(ctx, errors.New("query canceled"), "io.github.acme/widget")
71+
require.Error(t, err)
72+
var se huma.StatusError
73+
require.True(t, errors.As(err, &se))
74+
assert.Equal(t, 499, se.GetStatus())
75+
}
76+
77+
func TestGetServerVersionsError_realFailure(t *testing.T) {
78+
err := v0.GetServerVersionsError(context.Background(), errors.New("database unavailable"), "io.github.acme/widget")
79+
require.Error(t, err)
80+
var se huma.StatusError
81+
require.True(t, errors.As(err, &se))
82+
assert.Equal(t, 500, se.GetStatus())
83+
}

‎internal/api/handlers/v0/servers.go‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ package v0
33
import (
44
"context"
55
"errors"
6-
"log"
76
"net/http"
87
"net/url"
98
"reflect"
@@ -185,8 +184,7 @@ func RegisterServersEndpoints(api huma.API, pathPrefix string, registry service.
185184
if err.Error() == errRecordNotFound || errors.Is(err, database.ErrNotFound) {
186185
return nil, huma.Error404NotFound("Server not found")
187186
}
188-
log.Printf("get server details (%q/%q) failed: %v", serverName, version, err)
189-
return nil, huma.Error500InternalServerError("Failed to get server details")
187+
return nil, GetServerDetailsError(ctx, err, serverName, version)
190188
}
191189

192190
return &Response[apiv0.ServerResponse]{
@@ -215,8 +213,7 @@ func RegisterServersEndpoints(api huma.API, pathPrefix string, registry service.
215213
if err.Error() == errRecordNotFound || errors.Is(err, database.ErrNotFound) {
216214
return nil, huma.Error404NotFound("Server not found")
217215
}
218-
log.Printf("get server versions (%q) failed: %v", serverName, err)
219-
return nil, huma.Error500InternalServerError("Failed to get server versions")
216+
return nil, GetServerVersionsError(ctx, err, serverName)
220217
}
221218

222219
// Convert []*ServerResponse to []ServerResponse

0 commit comments

Comments
 (0)