chore: replace vendored gorilla/schema package

gofiber · Oct 7, 2024 · 7644256 · 7644256
1 parent 44cd700
commit 7644256
Show file tree

Hide file tree

Showing 13 changed files with 104 additions and 1,383 deletions.
diff --git a/bind_test.go b/bind_test.go
@@ -55,9 +55,11 @@ func Test_Bind_Query(t *testing.T) {
 	type Query2 struct {
 		Name            string
 		Hobby           string
+		Default         string `query:"default,default:hello"`
 		FavouriteDrinks []string
 		Empty           []string
 		Alloc           []string
+		Defaults        []string `query:"defaults,default:hello|world"`
 		No              []int64
 		ID              int
 		Bool            bool
@@ -76,13 +78,15 @@ func Test_Bind_Query(t *testing.T) {
 	require.Equal(t, nilSlice, q2.Empty)
 	require.Equal(t, []string{""}, q2.Alloc)
 	require.Equal(t, []int64{1}, q2.No)
+	require.Equal(t, "hello", q2.Default)
+	require.Equal(t, []string{"hello", "world"}, q2.Defaults)
 
 	type RequiredQuery struct {
 		Name string `query:"name,required"`
 	}
 	rq := new(RequiredQuery)
 	c.Request().URI().SetQueryString("")
-	require.Equal(t, "name is empty", c.Bind().Query(rq).Error())
+	require.Equal(t, "bind: name is empty", c.Bind().Query(rq).Error())
 
 	type ArrayQuery struct {
 		Data []string
@@ -204,15 +208,15 @@ func Test_Bind_Query_Schema(t *testing.T) {
 
 	c.Request().URI().SetQueryString("namex=tom&nested.age=10")
 	q = new(Query1)
-	require.Equal(t, "name is empty", c.Bind().Query(q).Error())
+	require.Equal(t, "bind: name is empty", c.Bind().Query(q).Error())
 
 	c.Request().URI().SetQueryString("name=tom&nested.agex=10")
 	q = new(Query1)
 	require.NoError(t, c.Bind().Query(q))
 
 	c.Request().URI().SetQueryString("name=tom&test.age=10")
 	q = new(Query1)
-	require.Equal(t, "nested is empty", c.Bind().Query(q).Error())
+	require.Equal(t, "bind: nested is empty", c.Bind().Query(q).Error())
 
 	type Query2 struct {
 		Name   string `query:"name"`
@@ -230,11 +234,11 @@ func Test_Bind_Query_Schema(t *testing.T) {
 
 	c.Request().URI().SetQueryString("nested.agex=10")
 	q2 = new(Query2)
-	require.Equal(t, "nested.age is empty", c.Bind().Query(q2).Error())
+	require.Equal(t, "bind: nested.age is empty", c.Bind().Query(q2).Error())
 
 	c.Request().URI().SetQueryString("nested.agex=10")
 	q2 = new(Query2)
-	require.Equal(t, "nested.age is empty", c.Bind().Query(q2).Error())
+	require.Equal(t, "bind: nested.age is empty", c.Bind().Query(q2).Error())
 
 	type Node struct {
 		Next  *Node `query:"next,required"`
@@ -248,7 +252,7 @@ func Test_Bind_Query_Schema(t *testing.T) {
 
 	c.Request().URI().SetQueryString("next.val=2")
 	n = new(Node)
-	require.Equal(t, "val is empty", c.Bind().Query(n).Error())
+	require.Equal(t, "bind: val is empty", c.Bind().Query(n).Error())
 
 	c.Request().URI().SetQueryString("val=3&next.value=2")
 	n = new(Node)
@@ -354,7 +358,7 @@ func Test_Bind_Header(t *testing.T) {
 	}
 	rh := new(RequiredHeader)
 	c.Request().Header.Del("name")
-	require.Equal(t, "name is empty", c.Bind().Header(rh).Error())
+	require.Equal(t, "bind: name is empty", c.Bind().Header(rh).Error())
 }
 
 // go test -run Test_Bind_Header_Map -v
@@ -463,7 +467,7 @@ func Test_Bind_Header_Schema(t *testing.T) {
 
 	c.Request().Header.Del("Name")
 	q = new(Header1)
-	require.Equal(t, "Name is empty", c.Bind().Header(q).Error())
+	require.Equal(t, "bind: Name is empty", c.Bind().Header(q).Error())
 
 	c.Request().Header.Add("Name", "tom")
 	c.Request().Header.Del("Nested.Age")
@@ -473,7 +477,7 @@ func Test_Bind_Header_Schema(t *testing.T) {
 
 	c.Request().Header.Del("Nested.Agex")
 	q = new(Header1)
-	require.Equal(t, "Nested is empty", c.Bind().Header(q).Error())
+	require.Equal(t, "bind: Nested is empty", c.Bind().Header(q).Error())
 
 	c.Request().Header.Del("Nested.Agex")
 	c.Request().Header.Del("Name")
@@ -499,7 +503,7 @@ func Test_Bind_Header_Schema(t *testing.T) {
 	c.Request().Header.Del("Nested.Age")
 	c.Request().Header.Add("Nested.Agex", "10")
 	h2 = new(Header2)
-	require.Equal(t, "Nested.age is empty", c.Bind().Header(h2).Error())
+	require.Equal(t, "bind: Nested.age is empty", c.Bind().Header(h2).Error())
 
 	type Node struct {
 		Next  *Node `header:"Next,required"`
@@ -514,7 +518,7 @@ func Test_Bind_Header_Schema(t *testing.T) {
 
 	c.Request().Header.Del("Val")
 	n = new(Node)
-	require.Equal(t, "Val is empty", c.Bind().Header(n).Error())
+	require.Equal(t, "bind: Val is empty", c.Bind().Header(n).Error())
 
 	c.Request().Header.Add("Val", "3")
 	c.Request().Header.Del("Next.Val")
@@ -595,7 +599,7 @@ func Test_Bind_RespHeader(t *testing.T) {
 	}
 	rh := new(RequiredHeader)
 	c.Response().Header.Del("name")
-	require.Equal(t, "name is empty", c.Bind().RespHeader(rh).Error())
+	require.Equal(t, "bind: name is empty", c.Bind().RespHeader(rh).Error())
 }
 
 // go test -run Test_Bind_RespHeader_Map -v
@@ -648,7 +652,40 @@ func Benchmark_Bind_Query(b *testing.B) {
 	for n := 0; n < b.N; n++ {
 		err = c.Bind().Query(q)
 	}
+
+	require.NoError(b, err)
+	require.Equal(b, "tom", q.Name)
+	require.Equal(b, 1, q.ID)
+	require.Len(b, q.Hobby, 2)
+}
+
+// go test -v  -run=^$ -bench=Benchmark_Bind_Query_Default -benchmem -count=4
+func Benchmark_Bind_Query_Default(b *testing.B) {
+	var err error
+
+	app := New()
+	c := app.AcquireCtx(&fasthttp.RequestCtx{})
+
+	type Query struct {
+		Name  string   `query:"name,default:tom"`
+		Hobby []string `query:"hobby,default:football|basketball"`
+		ID    int      `query:"id,default:1"`
+	}
+	c.Request().SetBody([]byte(``))
+	c.Request().Header.SetContentType("")
+	c.Request().URI().SetQueryString("")
+	q := new(Query)
+	b.ReportAllocs()
+	b.ResetTimer()
+	for n := 0; n < b.N; n++ {
+		*q = Query{}
+		err = c.Bind().Query(q)
+	}
+
 	require.NoError(b, err)
+	require.Equal(b, "tom", q.Name)
+	require.Equal(b, 1, q.ID)
+	require.Len(b, q.Hobby, 2)
 }
 
 // go test -v  -run=^$ -bench=Benchmark_Bind_Query_Map -benchmem -count=4
@@ -1314,7 +1351,7 @@ func Test_Bind_Cookie(t *testing.T) {
 	}
 	rh := new(RequiredCookie)
 	c.Request().Header.DelCookie("name")
-	require.Equal(t, "name is empty", c.Bind().Cookie(rh).Error())
+	require.Equal(t, "bind: name is empty", c.Bind().Cookie(rh).Error())
 }
 
 // go test -run Test_Bind_Cookie_Map -v
@@ -1424,7 +1461,7 @@ func Test_Bind_Cookie_Schema(t *testing.T) {
 
 	c.Request().Header.DelCookie("Name")
 	q = new(Cookie1)
-	require.Equal(t, "Name is empty", c.Bind().Cookie(q).Error())
+	require.Equal(t, "bind: Name is empty", c.Bind().Cookie(q).Error())
 
 	c.Request().Header.SetCookie("Name", "tom")
 	c.Request().Header.DelCookie("Nested.Age")
@@ -1434,7 +1471,7 @@ func Test_Bind_Cookie_Schema(t *testing.T) {
 
 	c.Request().Header.DelCookie("Nested.Agex")
 	q = new(Cookie1)
-	require.Equal(t, "Nested is empty", c.Bind().Cookie(q).Error())
+	require.Equal(t, "bind: Nested is empty", c.Bind().Cookie(q).Error())
 
 	c.Request().Header.DelCookie("Nested.Agex")
 	c.Request().Header.DelCookie("Name")
@@ -1460,7 +1497,7 @@ func Test_Bind_Cookie_Schema(t *testing.T) {
 	c.Request().Header.DelCookie("Nested.Age")
 	c.Request().Header.SetCookie("Nested.Agex", "10")
 	h2 = new(Cookie2)
-	require.Equal(t, "Nested.Age is empty", c.Bind().Cookie(h2).Error())
+	require.Equal(t, "bind: Nested.Age is empty", c.Bind().Cookie(h2).Error())
 
 	type Node struct {
 		Next  *Node `cookie:"Next,required"`
@@ -1475,7 +1512,7 @@ func Test_Bind_Cookie_Schema(t *testing.T) {
 
 	c.Request().Header.DelCookie("Val")
 	n = new(Node)
-	require.Equal(t, "Val is empty", c.Bind().Cookie(n).Error())
+	require.Equal(t, "bind: Val is empty", c.Bind().Cookie(n).Error())
 
 	c.Request().Header.SetCookie("Val", "3")
 	c.Request().Header.DelCookie("Next.Val")
@@ -1591,7 +1628,7 @@ func Test_Bind_Must(t *testing.T) {
 	c.Request().URI().SetQueryString("")
 	err := c.Bind().Must().Query(rq)
 	require.Equal(t, StatusBadRequest, c.Response().StatusCode())
-	require.Equal(t, "Bad request: name is empty", err.Error())
+	require.Equal(t, "Bad request: bind: name is empty", err.Error())
 }
 
 // simple struct validator for testing

diff --git a/binder/mapping.go b/binder/mapping.go
@@ -2,14 +2,15 @@ package binder
 
 import (
 	"errors"
+	"fmt"
 	"reflect"
 	"strings"
 	"sync"
 
 	"github.com/gofiber/utils/v2"
 	"github.com/valyala/bytebufferpool"
 
-	"github.com/gofiber/fiber/v3/internal/schema"
+	"github.com/gofiber/schema"
 )
 
 // ParserConfig form decoder config for SetParserDecoder
@@ -94,7 +95,11 @@ func parseToStruct(aliasTag string, out any, data map[string][]string) error {
 	// Set alias tag
 	schemaDecoder.SetAliasTag(aliasTag)
 
-	return schemaDecoder.Decode(out, data)
+	if err := schemaDecoder.Decode(out, data); err != nil {
+		return fmt.Errorf("bind: %w", err)
+	}
+
+	return nil
 }
 
 // Parse data into the map

diff --git a/docs/api/bind.md b/docs/api/bind.md
@@ -573,3 +573,40 @@ app.Post("/", func(c fiber.Ctx) error {
     }
 })
 ```
+
+## Default Fields
+
+You can set default values for fields in the struct by using the `default` struct tag. Supported types:
+
+- bool
+- float variants (float32, float64)
+- int variants (int, int8, int16, int32, int64)
+- uint variants (uint, uint8, uint16, uint32, uint64)
+- string
+- a slice of the above types. As shown in the example above, **| should be used to separate between slice items**.
+- a pointer to one of the above types **(pointer to slice and slice of pointers are not supported)**.
+
+```go title="Example"
+type Person struct {
+    Name     string     `query:"name,default:john"`
+    Pass     string     `query:"pass"`
+    Products []string   `query:"products,default:shoe|hat"`
+}
+
+app.Get("/", func(c fiber.Ctx) error {
+    p := new(Person)
+
+    if err := c.Bind().Query(p); err != nil {
+        return err
+    }
+
+    log.Println(p.Name)        // john
+    log.Println(p.Pass)        // doe
+    log.Println(p.Products)    // ["shoe,hat"]    
+
+    // ...
+})
+// Run tests with the following curl command
+
+// curl "http://localhost:3000/?pass=doe"
+```
diff --git a/error.go b/error.go
@@ -4,7 +4,7 @@ import (
 	"encoding/json"
 	"errors"
 
-	"github.com/gofiber/fiber/v3/internal/schema"
+	"github.com/gofiber/schema"
 )
 
 // Wrap and return this for unreachable code if panicking is undesirable (i.e., in a handler).

diff --git a/error_test.go b/error_test.go
@@ -5,7 +5,7 @@ import (
 	"errors"
 	"testing"
 
-	"github.com/gofiber/fiber/v3/internal/schema"
+	"github.com/gofiber/schema"
 	"github.com/stretchr/testify/require"
 )
 

diff --git a/go.mod b/go.mod
@@ -16,6 +16,7 @@ require (
 require (
 	github.com/andybalholm/brotli v1.1.0 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/gofiber/schema v0.0.0-20240930192558-a38168951d4b // indirect
 	github.com/klauspost/compress v1.17.9 // indirect
 	github.com/philhofer/fwd v1.1.3-0.20240612014219-fbbf4953d986 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect

diff --git a/go.sum b/go.sum
@@ -2,6 +2,8 @@ github.com/andybalholm/brotli v1.1.0 h1:eLKJA0d02Lf0mVpIDgYnqXcUn0GqVmEFny3VuID1
 github.com/andybalholm/brotli v1.1.0/go.mod h1:sms7XGricyQI9K10gOSf56VKKWS4oLer58Q+mhRPtnY=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/gofiber/schema v0.0.0-20240930192558-a38168951d4b h1:V18jx4lrq1QwBHKfQpiEAezWxlMLwBA5WRuwx7A1Mjo=
+github.com/gofiber/schema v0.0.0-20240930192558-a38168951d4b/go.mod h1:YYwj01w3hVfaNjhtJzaqetymL56VW642YS3qZPhuE6c=
 github.com/gofiber/utils/v2 v2.0.0-beta.6 h1:ED62bOmpRXdgviPlfTmf0Q+AXzhaTUAFtdWjgx+XkYI=
 github.com/gofiber/utils/v2 v2.0.0-beta.6/go.mod h1:3Kz8Px3jInKFvqxDzDeoSygwEOO+3uyubTmUa6PqY+0=
 github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=

diff --git a/internal/schema/LICENSE b/internal/schema/LICENSE