bind: add support for multipart file binding (#3309)

* deps: update schema to v1.3.0

* bind: add support for multipart file binding

* bind: fix linter

* improve coverage

* fix linter

* add test cases

---------

Co-authored-by: René <[email protected]>

Author: efectn

binder/form.go

@@ -1,6 +1,8 @@
 package binder
 
 import (
+	"mime/multipart"
+
 	"github.com/gofiber/utils/v2"
 	"github.com/valyala/fasthttp"
 )
@@ -59,7 +61,15 @@ func (b *FormBinding) bindMultipart(req *fasthttp.Request, out any) error {
 		}
 	}
 
-	return parse(b.Name(), out, data)
+	files := make(map[string][]*multipart.FileHeader)
+	for key, values := range multipartForm.File {
+		err = formatBindData(out, files, key, values, b.EnableSplitting, true)
+		if err != nil {
+			return err
+		}
+	}
+
+	return parse(b.Name(), out, data, files)
 }
 
 // Reset resets the FormBinding binder.

binder/form_test.go

@@ -2,6 +2,7 @@ package binder
 
 import (
 	"bytes"
+	"io"
 	"mime/multipart"
 	"testing"
 
@@ -98,10 +99,12 @@ func Test_FormBinder_BindMultipart(t *testing.T) {
 	}
 
 	type User struct {
-		Name  string   `form:"name"`
-		Names []string `form:"names"`
-		Posts []Post   `form:"posts"`
-		Age   int      `form:"age"`
+		Avatar  *multipart.FileHeader   `form:"avatar"`
+		Name    string                  `form:"name"`
+		Names   []string                `form:"names"`
+		Posts   []Post                  `form:"posts"`
+		Avatars []*multipart.FileHeader `form:"avatars"`
+		Age     int                     `form:"age"`
 	}
 	var user User
 
@@ -118,6 +121,24 @@ func Test_FormBinder_BindMultipart(t *testing.T) {
 	require.NoError(t, mw.WriteField("posts[1][title]", "post2"))
 	require.NoError(t, mw.WriteField("posts[2][title]", "post3"))
 
+	writer, err := mw.CreateFormFile("avatar", "avatar.txt")
+	require.NoError(t, err)
+
+	_, err = writer.Write([]byte("avatar"))
+	require.NoError(t, err)
+
+	writer, err = mw.CreateFormFile("avatars", "avatar1.txt")
+	require.NoError(t, err)
+
+	_, err = writer.Write([]byte("avatar1"))
+	require.NoError(t, err)
+
+	writer, err = mw.CreateFormFile("avatars", "avatar2.txt")
+	require.NoError(t, err)
+
+	_, err = writer.Write([]byte("avatar2"))
+	require.NoError(t, err)
+
 	require.NoError(t, mw.Close())
 
 	req.Header.SetContentType(mw.FormDataContentType())
@@ -127,7 +148,7 @@ func Test_FormBinder_BindMultipart(t *testing.T) {
 		fasthttp.ReleaseRequest(req)
 	})
 
-	err := b.Bind(req, &user)
+	err = b.Bind(req, &user)
 
 	require.NoError(t, err)
 	require.Equal(t, "john", user.Name)
@@ -139,6 +160,38 @@ func Test_FormBinder_BindMultipart(t *testing.T) {
 	require.Equal(t, "post1", user.Posts[0].Title)
 	require.Equal(t, "post2", user.Posts[1].Title)
 	require.Equal(t, "post3", user.Posts[2].Title)
+
+	require.NotNil(t, user.Avatar)
+	require.Equal(t, "avatar.txt", user.Avatar.Filename)
+	require.Equal(t, "application/octet-stream", user.Avatar.Header.Get("Content-Type"))
+
+	file, err := user.Avatar.Open()
+	require.NoError(t, err)
+
+	content, err := io.ReadAll(file)
+	require.NoError(t, err)
+	require.Equal(t, "avatar", string(content))
+
+	require.Len(t, user.Avatars, 2)
+	require.Equal(t, "avatar1.txt", user.Avatars[0].Filename)
+	require.Equal(t, "application/octet-stream", user.Avatars[0].Header.Get("Content-Type"))
+
+	file, err = user.Avatars[0].Open()
+	require.NoError(t, err)
+
+	content, err = io.ReadAll(file)
+	require.NoError(t, err)
+	require.Equal(t, "avatar1", string(content))
+
+	require.Equal(t, "avatar2.txt", user.Avatars[1].Filename)
+	require.Equal(t, "application/octet-stream", user.Avatars[1].Header.Get("Content-Type"))
+
+	file, err = user.Avatars[1].Open()
+	require.NoError(t, err)
+
+	content, err = io.ReadAll(file)
+	require.NoError(t, err)
+	require.Equal(t, "avatar2", string(content))
 }
 
 func Benchmark_FormBinder_BindMultipart(b *testing.B) {

binder/mapping.go

@@ -3,6 +3,7 @@ package binder
 import (
 	"errors"
 	"fmt"
+	"mime/multipart"
 	"reflect"
 	"strings"
 	"sync"
@@ -69,7 +70,7 @@ func init() {
 }
 
 // parse data into the map or struct
-func parse(aliasTag string, out any, data map[string][]string) error {
+func parse(aliasTag string, out any, data map[string][]string, files ...map[string][]*multipart.FileHeader) error {
 	ptrVal := reflect.ValueOf(out)
 
 	// Get pointer value
@@ -83,19 +84,19 @@ func parse(aliasTag string, out any, data map[string][]string) error {
 	}
 
 	// Parse into the struct
-	return parseToStruct(aliasTag, out, data)
+	return parseToStruct(aliasTag, out, data, files...)
 }
 
 // Parse data into the struct with gorilla/schema
-func parseToStruct(aliasTag string, out any, data map[string][]string) error {
+func parseToStruct(aliasTag string, out any, data map[string][]string, files ...map[string][]*multipart.FileHeader) error {
 	// Get decoder from pool
 	schemaDecoder := decoderPoolMap[aliasTag].Get().(*schema.Decoder) //nolint:errcheck,forcetypeassert // not needed
 	defer decoderPoolMap[aliasTag].Put(schemaDecoder)
 
 	// Set alias tag
 	schemaDecoder.SetAliasTag(aliasTag)
 
-	if err := schemaDecoder.Decode(out, data); err != nil {
+	if err := schemaDecoder.Decode(out, data, files...); err != nil {
 		return fmt.Errorf("bind: %w", err)
 	}
 
@@ -250,7 +251,7 @@ func FilterFlags(content string) string {
 	return content
 }
 
-func formatBindData[T any](out any, data map[string][]string, key string, value T, enableSplitting, supportBracketNotation bool) error { //nolint:revive // it's okay
+func formatBindData[T, K any](out any, data map[string][]T, key string, value K, enableSplitting, supportBracketNotation bool) error { //nolint:revive // it's okay
 	var err error
 	if supportBracketNotation && strings.Contains(key, "[") {
 		key, err = parseParamSquareBrackets(key)
@@ -261,10 +262,28 @@ func formatBindData[T any](out any, data map[string][]string, key string, value
 
 	switch v := any(value).(type) {
 	case string:
-		assignBindData(out, data, key, v, enableSplitting)
+		dataMap, ok := any(data).(map[string][]string)
+		if !ok {
+			return fmt.Errorf("unsupported value type: %T", value)
+		}
+
+		assignBindData(out, dataMap, key, v, enableSplitting)
 	case []string:
+		dataMap, ok := any(data).(map[string][]string)
+		if !ok {
+			return fmt.Errorf("unsupported value type: %T", value)
+		}
+
+		for _, val := range v {
+			assignBindData(out, dataMap, key, val, enableSplitting)
+		}
+	case []*multipart.FileHeader:
 		for _, val := range v {
-			assignBindData(out, data, key, val, enableSplitting)
+			valT, ok := any(val).(T)
+			if !ok {
+				return fmt.Errorf("unsupported value type: %T", value)
+			}
+			data[key] = append(data[key], valT)
 		}
 	default:
 		return fmt.Errorf("unsupported value type: %T", value)