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.

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

Jump to bottom

🩹 fix: Embedded struct binding #3203

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

🩹 fix: Embedded struct binding #3203

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
257d725
fix: Embedded struct binding
michal-laskowski Nov 12, 2024
35d7ad1
Update bind_test.go
gaby Nov 13, 2024
ee247ed
Fix typo
gaby Nov 13, 2024
cc0971c
add: Support for other bindings fo embedded structs
michal-laskowski Nov 13, 2024
72a4cf6
Merge branch 'main' into main
gaby Nov 14, 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
36 changes: 36 additions & 0 deletions bind_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1091,6 +1091,42 @@ func Benchmark_Bind_Body_XML(b *testing.B) {
require.Equal(b, "john", d.Name)
}

// go test -run Test_Bind_Body_Form_Embedded
func Test_Bind_Body_Form_Embedded(b *testing.T) {
var err error

app := New()
c := app.AcquireCtx(&fasthttp.RequestCtx{})
type EmbeddedDemo struct {
EmbeddedString string `form:"embedded_string"`
EmbeddedStrings []string `form:"embedded_strings"`
}

type Demo struct {
String string `form:"some_string"`
OtherString string `form:"some_other_string"`
Strings []string `form:"strings"`
OtherStrings []string `form:"other_strings"`
EmbeddedDemo
}
body := []byte("some_string=john%2Clong&some_other_string=long&some_other_string=long&strings=long%2Cjohn&embedded_strings=john%2Clongest&embedded_string=johny%2Cwalker&other_strings=long&other_strings=johny")
c.Request().SetBody(body)
c.Request().Header.SetContentType(MIMEApplicationForm)
c.Request().Header.SetContentLength(len(body))
d := new(Demo)

err = c.Bind().Body(d)

require.NoError(b, err)
require.Equal(b, "john,long", d.String)
require.Equal(b, []string{"long", "john"}, d.Strings)
//! only one value is taken
require.Equal(b, "long", d.OtherString)
require.Equal(b, []string{"long", "johny"}, d.OtherStrings)
require.Equal(b, "johny,walker", d.EmbeddedString)
require.Equal(b, []string{"john", "longest"}, d.EmbeddedStrings)
}

// go test -v -run=^$ -bench=Benchmark_Bind_Body_Form -benchmem -count=4
func Benchmark_Bind_Body_Form(b *testing.B) {
var err error
Expand Down
12 changes: 1 addition & 11 deletions binder/cookie.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
package binder

import (
"reflect"
"strings"

"github.com/gofiber/utils/v2"
"github.com/valyala/fasthttp"
)
Expand All @@ -26,14 +23,7 @@
k := utils.UnsafeString(key)
v := utils.UnsafeString(val)

if strings.Contains(v, ",") && equalFieldType(out, reflect.Slice, k) {
values := strings.Split(v, ",")
for i := 0; i < len(values); i++ {
data[k] = append(data[k], values[i])
}
} else {
data[k] = append(data[k], v)
}
appendValue(data, v, out, k, b.Name())

Check warning on line 26 in binder/cookie.go

View check run for this annotation

Codecov / codecov/patch

binder/cookie.go#L26 

Added line #L26 was not covered by tests
})

if err != nil {
Expand Down
10 changes: 1 addition & 9 deletions binder/form.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package binder

import (
"reflect"
"strings"

"github.com/gofiber/utils/v2"
Expand Down Expand Up @@ -30,14 +29,7 @@
k, err = parseParamSquareBrackets(k)
}

if strings.Contains(v, ",") && equalFieldType(out, reflect.Slice, k) {
values := strings.Split(v, ",")
for i := 0; i < len(values); i++ {
data[k] = append(data[k], values[i])
}
} else {
data[k] = append(data[k], v)
}
appendValue(data, v, out, k, b.Name())

Check warning on line 32 in binder/form.go

View check run for this annotation

Codecov / codecov/patch

binder/form.go#L32 

Added line #L32 was not covered by tests
})

if err != nil {
Expand Down
12 changes: 1 addition & 11 deletions binder/header.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
package binder

import (
"reflect"
"strings"

"github.com/gofiber/utils/v2"
"github.com/valyala/fasthttp"
)
Expand All @@ -20,14 +17,7 @@
k := utils.UnsafeString(key)
v := utils.UnsafeString(val)

if strings.Contains(v, ",") && equalFieldType(out, reflect.Slice, k) {
values := strings.Split(v, ",")
for i := 0; i < len(values); i++ {
data[k] = append(data[k], values[i])
}
} else {
data[k] = append(data[k], v)
}
appendValue(data, v, out, k, b.Name())

Check warning on line 20 in binder/header.go

View check run for this annotation

Codecov / codecov/patch

binder/header.go#L20 

Added line #L20 was not covered by tests
})

return parse(b.Name(), out, data)
Expand Down
80 changes: 49 additions & 31 deletions binder/mapping.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,18 @@
return bb.String(), nil
}

func equalFieldType(out any, kind reflect.Kind, key string) bool {
func appendValue(to map[string][]string, rawValue string, out any, k string, bindingName string) {
if strings.Contains(rawValue, ",") && equalFieldType(out, reflect.Slice, k, bindingName) {
values := strings.Split(rawValue, ",")
for i := 0; i < len(values); i++ {
to[k] = append(to[k], values[i])
}
} else {
to[k] = append(to[k], rawValue)
}

Check warning on line 183 in binder/mapping.go

View check run for this annotation

Codecov / codecov/patch

binder/mapping.go#L175-L183 

Added lines #L175 - L183 were not covered by tests
}

func equalFieldType(out any, kind reflect.Kind, key string, bindingName string) bool {
// Get type of interface
outTyp := reflect.TypeOf(out).Elem()
key = utils.ToLower(key)
Expand All @@ -196,47 +207,54 @@
if !structField.CanSet() {
continue
}

// Get field key data
typeField := outTyp.Field(i)
// Get type of field key
structFieldKind := structField.Kind()
// Does the field type equals input?
if structFieldKind != kind {
// Is the field an embedded struct?
if structFieldKind == reflect.Struct {
// Loop over embedded struct fields
for j := 0; j < structField.NumField(); j++ {
structFieldField := structField.Field(j)

// Can this embedded field be changed?
if !structFieldField.CanSet() {
continue
}

// Is the embedded struct field type equal to the input?
if structFieldField.Kind() == kind {
return true
}
}
}

continue
}
// Get tag from field if exist
inputFieldName := typeField.Tag.Get(QueryBinder.Name())
if inputFieldName == "" {
inputFieldName = typeField.Name
} else {
inputFieldName = strings.Split(inputFieldName, ",")[0]
}
// Compare field/tag with provided key
if utils.ToLower(inputFieldName) == key {
return true
if getFieldKey(typeField, bindingName) == key {
return structFieldKind == kind
}

// Is the field an embedded struct?
if typeField.Anonymous {
// Loop over embedded struct fields
for j := 0; j < structField.NumField(); j++ {
if getFieldKey(structField.Type().Field(j), bindingName) != key {
// this is not the field that we are looking for
continue

Check warning on line 227 in binder/mapping.go

View check run for this annotation

Codecov / codecov/patch

binder/mapping.go#L223-L227 

Added lines #L223 - L227 were not covered by tests
}

structFieldField := structField.Field(j)

// Can this embedded field be changed?
if !structFieldField.CanSet() {
continue

Check warning on line 234 in binder/mapping.go

View check run for this annotation

Codecov / codecov/patch

binder/mapping.go#L230-L234 

Added lines #L230 - L234 were not covered by tests
}

// Is the embedded struct field type equal to the input?
return structFieldField.Kind() == kind

Check warning on line 238 in binder/mapping.go

View check run for this annotation

Codecov / codecov/patch

binder/mapping.go#L238 

Added line #L238 was not covered by tests
}
}
}
return false
}

// Get binding key for a field
func getFieldKey(typeField reflect.StructField, bindingName string) string {
// Get tag from field if exist
inputFieldName := typeField.Tag.Get(bindingName)
if inputFieldName == "" {
inputFieldName = typeField.Name
} else {
inputFieldName = strings.Split(inputFieldName, ",")[0]
}
// Compare field key
return utils.ToLower(inputFieldName)
}

// Get content type from content type header
func FilterFlags(content string) string {
for i, char := range content {
Expand Down
18 changes: 9 additions & 9 deletions binder/mapping_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,25 +10,25 @@ import (

func Test_EqualFieldType(t *testing.T) {
var out int
require.False(t, equalFieldType(&out, reflect.Int, "key"))
require.False(t, equalFieldType(&out, reflect.Int, "key", "query"))

var dummy struct{ f string }
require.False(t, equalFieldType(&dummy, reflect.String, "key"))
require.False(t, equalFieldType(&dummy, reflect.String, "key", "query"))

var dummy2 struct{ f string }
require.False(t, equalFieldType(&dummy2, reflect.String, "f"))
require.False(t, equalFieldType(&dummy2, reflect.String, "f", "query"))

var user struct {
Name string
Address string `query:"address"`
Age int `query:"AGE"`
}
require.True(t, equalFieldType(&user, reflect.String, "name"))
require.True(t, equalFieldType(&user, reflect.String, "Name"))
require.True(t, equalFieldType(&user, reflect.String, "address"))
require.True(t, equalFieldType(&user, reflect.String, "Address"))
require.True(t, equalFieldType(&user, reflect.Int, "AGE"))
require.True(t, equalFieldType(&user, reflect.Int, "age"))
require.True(t, equalFieldType(&user, reflect.String, "name", "query"))
require.True(t, equalFieldType(&user, reflect.String, "Name", "query"))
require.True(t, equalFieldType(&user, reflect.String, "address", "query"))
require.True(t, equalFieldType(&user, reflect.String, "Address", "query"))
require.True(t, equalFieldType(&user, reflect.Int, "AGE", "query"))
require.True(t, equalFieldType(&user, reflect.Int, "age", "query"))
Comment on lines 22 to +31
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Add test cases for embedded structs

While the existing test cases provide good coverage for field names, tags, and case sensitivity, they don't cover the embedded struct binding that this PR aims to fix.

Consider adding test cases like:

type Address struct {
    Street string `query:"street"`
}

type User struct {
    Address   // embedded struct
    Name string `query:"name"`
}

var user User
require.True(t, equalFieldType(&user, reflect.String, "street", "query"))
require.True(t, equalFieldType(&user, reflect.String, "Street", "query"))

This will ensure the fix for embedded struct binding is properly tested.

}

func Test_ParseParamSquareBrackets(t *testing.T) {
Expand Down
10 changes: 1 addition & 9 deletions binder/query.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package binder

import (
"reflect"
"strings"

"github.com/gofiber/utils/v2"
Expand Down Expand Up @@ -30,14 +29,7 @@
k, err = parseParamSquareBrackets(k)
}

if strings.Contains(v, ",") && equalFieldType(out, reflect.Slice, k) {
values := strings.Split(v, ",")
for i := 0; i < len(values); i++ {
data[k] = append(data[k], values[i])
}
} else {
data[k] = append(data[k], v)
}
appendValue(data, v, out, k, b.Name())

Check warning on line 32 in binder/query.go

View check run for this annotation

Codecov / codecov/patch

binder/query.go#L32 

Added line #L32 was not covered by tests
})

if err != nil {
Expand Down
12 changes: 1 addition & 11 deletions binder/resp_header.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
package binder

import (
"reflect"
"strings"

"github.com/gofiber/utils/v2"
"github.com/valyala/fasthttp"
)
Expand All @@ -20,14 +17,7 @@
k := utils.UnsafeString(key)
v := utils.UnsafeString(val)

if strings.Contains(v, ",") && equalFieldType(out, reflect.Slice, k) {
values := strings.Split(v, ",")
for i := 0; i < len(values); i++ {
data[k] = append(data[k], values[i])
}
} else {
data[k] = append(data[k], v)
}
appendValue(data, v, out, k, b.Name())

Check warning on line 20 in binder/resp_header.go

View check run for this annotation

Codecov / codecov/patch

binder/resp_header.go#L20 

Added line #L20 was not covered by tests
})

return parse(b.Name(), out, data)
Expand Down
Loading