Skip to content

Commit b659c74

Browse files
mollyrobtme
andauthored
fix: preserve wrapped resolver error metadata (#1070)
* fix: preserve wrapped resolver error metadata * refactor: extract appendErrorHeaders helper for resolver and handler paths --------- Co-authored-by: Robert Thomas <[email protected]>
1 parent 14aea2f commit b659c74

3 files changed

Lines changed: 52 additions & 9 deletions

File tree

‎error.go‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,20 @@ func (e *errWithHeaders) GetHeaders() http.Header {
176176
return e.headers
177177
}
178178

179+
// appendErrorHeaders appends any headers carried by err (if it is or wraps a
180+
// HeadersError) onto the response, preserving multi-value headers such as
181+
// Set-Cookie.
182+
func appendErrorHeaders(ctx Context, err error) {
183+
var he HeadersError
184+
if errors.As(err, &he) {
185+
for k, values := range he.GetHeaders() {
186+
for _, v := range values {
187+
ctx.AppendHeader(k, v)
188+
}
189+
}
190+
}
191+
}
192+
179193
// ErrorWithHeaders wraps an error with additional headers to be sent to the
180194
// client. This is useful for e.g. caching, rate limiting, or other metadata.
181195
func ErrorWithHeaders(err error, headers http.Header) error {

‎huma.go‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1188,25 +1188,24 @@ func Register[I, O any](api API, op Operation, handler func(context.Context, *I)
11881188
// If there are errors, and they provide a status, then update the
11891189
// response status code to match. Otherwise, use the default status
11901190
// code is used. Since these run in order, the last error code wins.
1191-
if s, ok := res.Errors[i].(StatusError); ok {
1191+
var s StatusError
1192+
if errors.As(res.Errors[i], &s) {
11921193
errStatus = s.GetStatus()
11931194
break
11941195
}
11951196
}
1197+
// Resolver errors may be wrapped and may each carry response metadata,
1198+
// so preserve headers from every error, matching the handler path below.
1199+
for _, err := range res.Errors {
1200+
appendErrorHeaders(ctx, err)
1201+
}
11961202
WriteErr(api, ctx, errStatus, "validation failed", res.Errors...)
11971203
return
11981204
}
11991205

12001206
output, err := handler(ctx.Context(), &input)
12011207
if err != nil {
1202-
var he HeadersError
1203-
if errors.As(err, &he) {
1204-
for k, values := range he.GetHeaders() {
1205-
for _, v := range values {
1206-
ctx.AppendHeader(k, v)
1207-
}
1208-
}
1209-
}
1208+
appendErrorHeaders(ctx, err)
12101209

12111210
status := http.StatusInternalServerError
12121211

‎huma_test.go‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3819,6 +3819,36 @@ func TestExhaustiveErrors(t *testing.T) {
38193819
}`, w.Body.String())
38203820
}
38213821

3822+
type WrappedResolverErrorInput struct{}
3823+
3824+
func (*WrappedResolverErrorInput) Resolve(huma.Context) []error {
3825+
err := huma.ErrorWithHeaders(
3826+
huma.Error401Unauthorized("credentials required"),
3827+
http.Header{
3828+
"WWW-Authenticate": {"Bearer realm=\"protected\""},
3829+
"Set-Cookie": {"session=; Max-Age=0", "refresh=; Max-Age=0"},
3830+
},
3831+
)
3832+
return []error{fmt.Errorf("resolver failed: %w", err)}
3833+
}
3834+
3835+
func TestWrappedResolverErrorStatusAndHeaders(t *testing.T) {
3836+
router, api := humatest.New(t, huma.DefaultConfig("Test API", "1.0.0"))
3837+
handlerCalled := false
3838+
huma.Get(api, "/resolver-error", func(context.Context, *WrappedResolverErrorInput) (*struct{}, error) {
3839+
handlerCalled = true
3840+
return nil, nil
3841+
})
3842+
3843+
resp := httptest.NewRecorder()
3844+
router.ServeHTTP(resp, httptest.NewRequest(http.MethodGet, "/resolver-error", nil))
3845+
3846+
assert.Equal(t, http.StatusUnauthorized, resp.Code)
3847+
assert.Equal(t, "Bearer realm=\"protected\"", resp.Header().Get("WWW-Authenticate"))
3848+
assert.Equal(t, []string{"session=; Max-Age=0", "refresh=; Max-Age=0"}, resp.Header().Values("Set-Cookie"))
3849+
assert.False(t, handlerCalled)
3850+
}
3851+
38223852
type MyError struct {
38233853
status int
38243854
Message string `json:"message"`

0 commit comments

Comments
 (0)