这是indexloc提供的服务，不要输入任何密码
Skip to content

fix: race by deferring the return of buf to sync.Pool when using RawBody #542

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 15, 2024
Merged

fix: race by deferring the return of buf to sync.Pool when using RawBody #542

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0534ce8
Defer buf
nunoo Aug 14, 2024
6ca70c3
fix: add test & only defer when using RawBody
danielgtaylor Aug 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions huma.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1292,8 +1292,20 @@ func Register[I, O any](api API, op Operation, handler func(context.Context, *I)
}
}

buf.Reset()
bufPool.Put(buf)
if rawBodyIndex != -1 {
// If the raw body is used, then we must wait until *AFTER* the
// handler has run to return the body byte buffer to the pool, as
// the handler can read and modify this buffer. The safest way is
// to just wait until the end of this handler via defer.
defer bufPool.Put(buf)
defer buf.Reset()
} else {
// No raw body, and the body has already been unmarshalled above, so
// we can return the buffer to the pool now as we don't need the
// bytes any more.
bufPool.Put(buf)
buf.Reset()
}
}
}
}
Expand Down
24 changes: 24 additions & 0 deletions huma_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2160,6 +2160,30 @@ func TestSchemaWithExample(t *testing.T) {
assert.Equal(t, 1, example)
}

func TestBodyRace(t *testing.T) {
// Run with the following:
// go test -run=TestBodyRace -race -parallel=100
_, api := humatest.New(t, huma.DefaultConfig("Test API", "1.0.0"))
huma.Post(api, "/ping", func(ctx context.Context, input *struct {
Body struct {
Value string `json:"value"`
}
RawBody []byte
}) (*struct{}, error) {
// Access/modify the raw input to detect races.
input.RawBody[1] = 'a'
return nil, nil
})

for i := 0; i < 100; i++ {
t.Run(fmt.Sprintf("test-%d", i), func(tt *testing.T) {
tt.Parallel()
resp := api.Post("/ping", map[string]any{"value": "hello"})
assert.Equal(tt, 204, resp.Result().StatusCode)
})
}
}

// func BenchmarkSecondDecode(b *testing.B) {
// //nolint: musttag
// type MediumSized struct {
Expand Down