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

fix: issue with default field values that can override payload field values #597

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

Closed
wants to merge 2 commits into from
Closed

fix: issue with default field values that can override payload field values #597

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
cd3a5d5
fix: issue with default field value that can override payload field v…
Oct 3, 2024
d332422
fix golangci-lint errors
Oct 3, 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
14 changes: 12 additions & 2 deletions huma.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1293,12 +1293,22 @@ func Register[I, O any](api API, op Operation, handler func(context.Context, *I)
})
}
} else {
// Set defaults for any fields that were not in the input.
// Set defaults for any fields that were not in the input:
atLeastOneFieldIsOverridden := false
defaults.Every(v, func(item reflect.Value, def any) {
if item.IsZero() {
if item.IsZero() && !reflect.ValueOf(def).IsZero() {
// There is one caveat here:
// - IF the default value is not the 'zero' of the field type
// - AND the 'zero' of the field type is a valid value specified in the input
// - THEN the input required field value is overridden with a different value
item.Set(reflect.Indirect(reflect.ValueOf(def)))
atLeastOneFieldIsOverridden = true
}
})
// Restore wrongly overridden input values if any
if atLeastOneFieldIsOverridden {
_ = api.Unmarshal(ctx.Header("Content-Type"), body, f.Addr().Interface())
Copy link
Owner

@danielgtaylor danielgtaylor Oct 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems kind of inefficient and I'm wondering if there are any edge cases where it would inadvertently overwrite something... 🤔

Copy link

@barata0 barata0 Oct 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here I propose a different way to fix this.

}
}
}

Expand Down
5 changes: 4 additions & 1 deletion huma_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -627,14 +627,17 @@ func TestFeatures(t *testing.T) {
assert.Equal(t, 5, input.Body.Count)
assert.Equal(t, []string{"foo", "bar"}, input.Body.Tags)
assert.Equal(t, []int{1, 2, 3}, input.Body.Numbers)
assert.Len(t, input.Body.Items, 2)
assert.Equal(t, 1, input.Body.Items[0].ID)
assert.True(t, input.Body.Items[0].Verified)
assert.Equal(t, 1, input.Body.Items[1].ID)
assert.False(t, input.Body.Items[1].Verified)
return nil, nil
})
},
Method: http.MethodPut,
URL: "/body",
Body: `{"items": [{"id": 1}]}`,
Body: `{"items": [{"id": 1}, {"id": 1, "verified": false}]}`,
},
{
Name: "request-body-required",
Expand Down