Skip to content
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.

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

fix: ignore empty form values in http request #4542

Merged
merged 1 commit into from
Jan 12, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
79 changes: 77 additions & 2 deletions rest/httpx/requests_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,21 @@ func TestParseForm(t *testing.T) {
assert.Nil(t, Parse(r, &v))
assert.Equal(t, 0, len(v.NoValue))
})

t.Run("slice with one value on array format", func(t *testing.T) {
var v struct {
Names string `form:"names"`
}

r, err := http.NewRequest(
http.MethodGet,
"/a?names=1,2,3",
http.NoBody)
assert.NoError(t, err)
if assert.NoError(t, Parse(r, &v)) {
assert.Equal(t, "1,2,3", v.Names)
}
})
}

func TestParseFormArray(t *testing.T) {
Expand Down Expand Up @@ -114,7 +129,7 @@ func TestParseFormArray(t *testing.T) {
http.NoBody)
assert.NoError(t, err)
if assert.NoError(t, Parse(r, &v)) {
assert.ElementsMatch(t, []string{""}, v.Name)
assert.Empty(t, v.Name)
}
})

Expand All @@ -129,7 +144,7 @@ func TestParseFormArray(t *testing.T) {
http.NoBody)
assert.NoError(t, err)
if assert.NoError(t, Parse(r, &v)) {
assert.ElementsMatch(t, []string{"", "1"}, v.Name)
assert.ElementsMatch(t, []string{"1"}, v.Name)
}
})

Expand Down Expand Up @@ -192,6 +207,66 @@ func TestParseFormArray(t *testing.T) {
assert.ElementsMatch(t, []string{"1", "2", "3"}, v.Names)
}
})

t.Run("slice with one empty value on integer array format", func(t *testing.T) {
var v struct {
Numbers []int `form:"numbers,optional"`
}

r, err := http.NewRequest(
http.MethodGet,
"/a?numbers=",
http.NoBody)
assert.NoError(t, err)
if assert.NoError(t, Parse(r, &v)) {
assert.Empty(t, v.Numbers)
}
})

t.Run("slice with one value on integer array format", func(t *testing.T) {
var v struct {
Numbers []int `form:"numbers,optional"`
}

r, err := http.NewRequest(
http.MethodGet,
"/a?numbers=&numbers=2",
http.NoBody)
assert.NoError(t, err)
if assert.NoError(t, Parse(r, &v)) {
assert.ElementsMatch(t, []int{2}, v.Numbers)
}
})

t.Run("slice with one empty value on float64 array format", func(t *testing.T) {
var v struct {
Numbers []float64 `form:"numbers,optional"`
}

r, err := http.NewRequest(
http.MethodGet,
"/a?numbers=",
http.NoBody)
assert.NoError(t, err)
if assert.NoError(t, Parse(r, &v)) {
assert.Empty(t, v.Numbers)
}
})

t.Run("slice with one value on float64 array format", func(t *testing.T) {
var v struct {
Numbers []float64 `form:"numbers,optional"`
}

r, err := http.NewRequest(
http.MethodGet,
"/a?numbers=&numbers=2",
http.NoBody)
assert.NoError(t, err)
if assert.NoError(t, Parse(r, &v)) {
assert.ElementsMatch(t, []float64{2}, v.Numbers)
}
})
}

func TestParseForm_Error(t *testing.T) {
Expand Down
10 changes: 10 additions & 0 deletions rest/httpx/util.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,16 @@ func GetFormValues(r *http.Request) (map[string]any, error) {
for name, values := range r.Form {
filtered := make([]string, 0, len(values))
for _, v := range values {
// ignore empty values, especially for optional int parameters
// e.g. /api?ids=
// e.g. /api
// type Req struct {
// IDs []int `form:"ids,optional"`
// }
if len(v) == 0 {
continue
}

if n < maxFormParamCount {
filtered = append(filtered, v)
n++
Expand Down
Loading