🔥 feat: Add support for CBOR encoding (#3173)

* feat(cbor): allow encoding response bodies in cbor

* fix(tests::cbor): encode struct instead of a randomly ordered hashmap

* docs(whats_new): add cbor in context section

* feat(binder): introduce CBOR

* feat(client): allow cbor in fiber client

* chore(tests): add more test

* chore(packages): go mod tidy

* fix(binder): update CBOR name and test

* improve test coverage

* improve test coverage

* update1

* add docs

* doc fixes

* update

* Fix markdown lint

* Add missing entry from binder README

* add/refresh documentation

---------

Co-authored-by: Juan Calderon-Perez <835733+gaby@users.noreply.github.com>
Co-authored-by: M. Efe Çetin <efectn@protonmail.com>
Co-authored-by: RW <rene@gofiber.io>

Author: 4 people

app.go

@@ -25,9 +25,9 @@ import (
 	"sync"
 	"time"
 
+	"github.com/fxamacker/cbor/v2"
 	"github.com/gofiber/fiber/v3/log"
 	"github.com/gofiber/utils/v2"
-
 	"github.com/valyala/fasthttp"
 )
 
@@ -320,6 +320,20 @@ type Config struct { //nolint:govet // Aligning the struct fields is not necessa
 	// Default: json.Unmarshal
 	JSONDecoder utils.JSONUnmarshal `json:"-"`
 
+	// When set by an external client of Fiber it will use the provided implementation of a
+	// CBORMarshal
+	//
+	// Allowing for flexibility in using another cbor library for encoding
+	// Default: cbor.Marshal
+	CBOREncoder utils.CBORMarshal `json:"-"`
+
+	// When set by an external client of Fiber it will use the provided implementation of a
+	// CBORUnmarshal
+	//
+	// Allowing for flexibility in using another cbor library for decoding
+	// Default: cbor.Unmarshal
+	CBORDecoder utils.CBORUnmarshal `json:"-"`
+
 	// XMLEncoder set by an external client of Fiber it will use the provided implementation of a
 	// XMLMarshal
 	//
@@ -537,6 +551,12 @@ func New(config ...Config) *App {
 	if app.config.JSONDecoder == nil {
 		app.config.JSONDecoder = json.Unmarshal
 	}
+	if app.config.CBOREncoder == nil {
+		app.config.CBOREncoder = cbor.Marshal
+	}
+	if app.config.CBORDecoder == nil {
+		app.config.CBORDecoder = cbor.Unmarshal
+	}
 	if app.config.XMLEncoder == nil {
 		app.config.XMLEncoder = xml.Marshal
 	}

bind.go

@@ -23,15 +23,15 @@ type Bind struct {
 	dontHandleErrs bool
 }
 
-// If you want to handle binder errors manually, you can use `WithoutAutoHandling`.
+// WithoutAutoHandling If you want to handle binder errors manually, you can use `WithoutAutoHandling`.
 // It's default behavior of binder.
 func (b *Bind) WithoutAutoHandling() *Bind {
 	b.dontHandleErrs = true
 
 	return b
 }
 
-// If you want to handle binder errors automatically, you can use `WithAutoHandling`.
+// WithAutoHandling If you want to handle binder errors automatically, you can use `WithAutoHandling`.
 // If there's an error, it will return the error and set HTTP status to `400 Bad Request`.
 // You must still return on error explicitly
 func (b *Bind) WithAutoHandling() *Bind {
@@ -121,6 +121,14 @@ func (b *Bind) JSON(out any) error {
 	return b.validateStruct(out)
 }
 
+// CBOR binds the body string into the struct.
+func (b *Bind) CBOR(out any) error {
+	if err := b.returnErr(binder.CBORBinder.Bind(b.ctx.Body(), b.ctx.App().Config().CBORDecoder, out)); err != nil {
+		return err
+	}
+	return b.validateStruct(out)
+}
+
 // XML binds the body string into the struct.
 func (b *Bind) XML(out any) error {
 	if err := b.returnErr(binder.XMLBinder.Bind(b.ctx.Body(), out)); err != nil {
@@ -183,6 +191,8 @@ func (b *Bind) Body(out any) error {
 		return b.JSON(out)
 	case MIMETextXML, MIMEApplicationXML:
 		return b.XML(out)
+	case MIMEApplicationCBOR:
+		return b.CBOR(out)
 	case MIMEApplicationForm:
 		return b.Form(out)
 	case MIMEMultipartForm:

bind_test.go

@@ -12,6 +12,7 @@ import (
 	"testing"
 	"time"
 
+	"github.com/fxamacker/cbor/v2"
 	"github.com/gofiber/fiber/v3/binder"
 	"github.com/stretchr/testify/require"
 	"github.com/valyala/fasthttp"
@@ -157,7 +158,7 @@ func Test_Bind_Query_WithSetParserDecoder(t *testing.T) {
 	}
 
 	nonRFCTime := binder.ParserType{
-		Customtype: NonRFCTime{},
+		CustomType: NonRFCTime{},
 		Converter:  nonRFCConverter,
 	}
 
@@ -411,7 +412,7 @@ func Test_Bind_Header_WithSetParserDecoder(t *testing.T) {
 	}
 
 	nonRFCTime := binder.ParserType{
-		Customtype: NonRFCTime{},
+		CustomType: NonRFCTime{},
 		Converter:  nonRFCConverter,
 	}
 
@@ -922,31 +923,48 @@ func Test_Bind_Body(t *testing.T) {
 		testCompressedBody(t, compressedBody, "zstd")
 	})
 
-	testDecodeParser := func(t *testing.T, contentType, body string) {
+	testDecodeParser := func(t *testing.T, contentType string, body []byte) {
 		t.Helper()
 		c := app.AcquireCtx(&fasthttp.RequestCtx{})
 		c.Request().Header.SetContentType(contentType)
-		c.Request().SetBody([]byte(body))
+		c.Request().SetBody(body)
 		c.Request().Header.SetContentLength(len(body))
 		d := new(Demo)
 		require.NoError(t, c.Bind().Body(d))
 		require.Equal(t, "john", d.Name)
 	}
 
 	t.Run("JSON", func(t *testing.T) {
-		testDecodeParser(t, MIMEApplicationJSON, `{"name":"john"}`)
+		testDecodeParser(t, MIMEApplicationJSON, []byte(`{"name":"john"}`))
+	})
+	t.Run("CBOR", func(t *testing.T) {
+		enc, err := cbor.Marshal(&Demo{Name: "john"})
+		if err != nil {
+			t.Error(err)
+		}
+		testDecodeParser(t, MIMEApplicationCBOR, enc)
+
+		// Test invalid CBOR data
+		t.Run("Invalid", func(t *testing.T) {
+			invalidData := []byte{0xFF, 0xFF} // Invalid CBOR data
+			c := app.AcquireCtx(&fasthttp.RequestCtx{})
+			c.Request().Header.SetContentType(MIMEApplicationCBOR)
+			c.Request().SetBody(invalidData)
+			d := new(Demo)
+			require.Error(t, c.Bind().Body(d))
+		})
 	})
 
 	t.Run("XML", func(t *testing.T) {
-		testDecodeParser(t, MIMEApplicationXML, `<Demo><name>john</name></Demo>`)
+		testDecodeParser(t, MIMEApplicationXML, []byte(`<Demo><name>john</name></Demo>`))
 	})
 
 	t.Run("Form", func(t *testing.T) {
-		testDecodeParser(t, MIMEApplicationForm, "name=john")
+		testDecodeParser(t, MIMEApplicationForm, []byte("name=john"))
 	})
 
 	t.Run("MultipartForm", func(t *testing.T) {
-		testDecodeParser(t, MIMEMultipartForm+`;boundary="b"`, "--b\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\njohn\r\n--b--")
+		testDecodeParser(t, MIMEMultipartForm+`;boundary="b"`, []byte("--b\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\njohn\r\n--b--"))
 	})
 
 	testDecodeParserError := func(t *testing.T, contentType, body string) {
@@ -1009,7 +1027,7 @@ func Test_Bind_Body_WithSetParserDecoder(t *testing.T) {
 	}
 
 	customTime := binder.ParserType{
-		Customtype: CustomTime{},
+		CustomType: CustomTime{},
 		Converter:  timeConverter,
 	}
 
@@ -1100,6 +1118,35 @@ func Benchmark_Bind_Body_XML(b *testing.B) {
 	require.Equal(b, "john", d.Name)
 }
 
+// go test -v -run=^$ -bench=Benchmark_Bind_Body_CBOR -benchmem -count=4
+func Benchmark_Bind_Body_CBOR(b *testing.B) {
+	var err error
+
+	app := New()
+	c := app.AcquireCtx(&fasthttp.RequestCtx{})
+
+	type Demo struct {
+		Name string `json:"name"`
+	}
+	body, err := cbor.Marshal(&Demo{Name: "john"})
+	if err != nil {
+		b.Error(err)
+	}
+	c.Request().SetBody(body)
+	c.Request().Header.SetContentType(MIMEApplicationCBOR)
+	c.Request().Header.SetContentLength(len(body))
+	d := new(Demo)
+
+	b.ReportAllocs()
+	b.ResetTimer()
+
+	for n := 0; n < b.N; n++ {
+		err = c.Bind().Body(d)
+	}
+	require.NoError(b, err)
+	require.Equal(b, "john", d.Name)
+}
+
 // go test -v -run=^$ -bench=Benchmark_Bind_Body_Form -benchmem -count=4
 func Benchmark_Bind_Body_Form(b *testing.B) {
 	var err error
@@ -1404,7 +1451,7 @@ func Test_Bind_Cookie_WithSetParserDecoder(t *testing.T) {
 	}
 
 	nonRFCTime := binder.ParserType{
-		Customtype: NonRFCTime{},
+		CustomType: NonRFCTime{},
 		Converter:  nonRFCConverter,
 	}
 
@@ -1720,8 +1767,12 @@ func Test_Bind_RepeatParserWithSameStruct(t *testing.T) {
 		require.Equal(t, "body_param", r.BodyParam)
 	}
 
+	cb, err := cbor.Marshal(&Request{BodyParam: "body_param"})
+	require.NoError(t, err, "Failed to marshal CBOR data")
+
 	testDecodeParser(MIMEApplicationJSON, `{"body_param":"body_param"}`)
 	testDecodeParser(MIMEApplicationXML, `<Demo><body_param>body_param</body_param></Demo>`)
+	testDecodeParser(MIMEApplicationCBOR, string(cb))
 	testDecodeParser(MIMEApplicationForm, "body_param=body_param")
 	testDecodeParser(MIMEMultipartForm+`;boundary="b"`, "--b\r\nContent-Disposition: form-data; name=\"body_param\"\r\n\r\nbody_param\r\n--b--")
 }

binder/README.md

@@ -22,6 +22,7 @@ Fiber provides several default binders out of the box:
 - [Cookie](cookie.go)
 - [JSON](json.go)
 - [XML](xml.go)
+- [CBOR](cbor.go)
 
 ## Guides
 

binder/binder.go

@@ -20,4 +20,5 @@ var (
 	URIBinder        = &uriBinding{}
 	XMLBinder        = &xmlBinding{}
 	JSONBinder       = &jsonBinding{}
+	CBORBinder       = &cborBinding{}
 )

binder/cbor.go

@@ -0,0 +1,18 @@
+package binder
+
+import (
+	"github.com/gofiber/utils/v2"
+)
+
+// cborBinding is the CBOR binder for CBOR request body.
+type cborBinding struct{}
+
+// Name returns the binding name.
+func (*cborBinding) Name() string {
+	return "cbor"
+}
+
+// Bind parses the request body as CBOR and returns the result.
+func (*cborBinding) Bind(body []byte, cborDecoder utils.CBORUnmarshal, out any) error {
+	return cborDecoder(body, out)
+}

binder/cookie.go

@@ -8,12 +8,15 @@ import (
 	"github.com/valyala/fasthttp"
 )
 
+// cookieBinding is the cookie binder for cookie request body.
 type cookieBinding struct{}
 
+// Name returns the binding name.
 func (*cookieBinding) Name() string {
 	return "cookie"
 }
 
+// Bind parses the request cookie and returns the result.
 func (b *cookieBinding) Bind(reqCtx *fasthttp.RequestCtx, out any) error {
 	data := make(map[string][]string)
 	var err error

binder/form.go

@@ -8,12 +8,15 @@ import (
 	"github.com/valyala/fasthttp"
 )
 
+// formBinding is the form binder for form request body.
 type formBinding struct{}
 
+// Name returns the binding name.
 func (*formBinding) Name() string {
 	return "form"
 }
 
+// Bind parses the request body and returns the result.
 func (b *formBinding) Bind(reqCtx *fasthttp.RequestCtx, out any) error {
 	data := make(map[string][]string)
 	var err error
@@ -47,6 +50,7 @@ func (b *formBinding) Bind(reqCtx *fasthttp.RequestCtx, out any) error {
 	return parse(b.Name(), out, data)
 }
 
+// BindMultipart parses the request body and returns the result.
 func (b *formBinding) BindMultipart(reqCtx *fasthttp.RequestCtx, out any) error {
 	data, err := reqCtx.MultipartForm()
 	if err != nil {

binder/header.go

@@ -8,12 +8,15 @@ import (
 	"github.com/valyala/fasthttp"
 )
 
+// headerBinding is the header binder for header request body.
 type headerBinding struct{}
 
+// Name returns the binding name.
 func (*headerBinding) Name() string {
 	return "header"
 }
 
+// Bind parses the request header and returns the result.
 func (b *headerBinding) Bind(req *fasthttp.Request, out any) error {
 	data := make(map[string][]string)
 	req.Header.VisitAll(func(key, val []byte) {

binder/json.go

@@ -4,12 +4,15 @@ import (
 	"github.com/gofiber/utils/v2"
 )
 
+// jsonBinding is the JSON binder for JSON request body.
 type jsonBinding struct{}
 
+// Name returns the binding name.
 func (*jsonBinding) Name() string {
 	return "json"
 }
 
+// Bind parses the request body as JSON and returns the result.
 func (*jsonBinding) Bind(body []byte, jsonDecoder utils.JSONUnmarshal, out any) error {
 	return jsonDecoder(body, out)
 }