🚀 Feature: Generate msgp tests (#2263)

* middleware: also generate msgp tests

* middleware/session: drop unused go:generate directive

* middleware: disable msgp's -io option to not generate unused methods

middleware/cache/manager.go

@@ -8,8 +8,7 @@ import (
 	"github.com/gofiber/fiber/v3/internal/memory"
 )
 
-// go:generate msgp
-// msgp -file="manager.go" -o="manager_msgp.go" -tests=false -unexported
+//go:generate msgp -o=manager_msgp.go -io=false -unexported
 type item struct {
 	body      []byte
 	ctype     []byte

middleware/cache/manager_msgp.go

@@ -6,189 +6,6 @@ import (
 	"github.com/tinylib/msgp/msgp"
 )
 
-// DecodeMsg implements msgp.Decodable
-func (z *item) DecodeMsg(dc *msgp.Reader) (err error) {
-	var field []byte
-	_ = field
-	var zb0001 uint32
-	zb0001, err = dc.ReadMapHeader()
-	if err != nil {
-		err = msgp.WrapError(err)
-		return
-	}
-	for zb0001 > 0 {
-		zb0001--
-		field, err = dc.ReadMapKeyPtr()
-		if err != nil {
-			err = msgp.WrapError(err)
-			return
-		}
-		switch msgp.UnsafeString(field) {
-		case "body":
-			z.body, err = dc.ReadBytes(z.body)
-			if err != nil {
-				err = msgp.WrapError(err, "body")
-				return
-			}
-		case "ctype":
-			z.ctype, err = dc.ReadBytes(z.ctype)
-			if err != nil {
-				err = msgp.WrapError(err, "ctype")
-				return
-			}
-		case "cencoding":
-			z.cencoding, err = dc.ReadBytes(z.cencoding)
-			if err != nil {
-				err = msgp.WrapError(err, "cencoding")
-				return
-			}
-		case "status":
-			z.status, err = dc.ReadInt()
-			if err != nil {
-				err = msgp.WrapError(err, "status")
-				return
-			}
-		case "exp":
-			z.exp, err = dc.ReadUint64()
-			if err != nil {
-				err = msgp.WrapError(err, "exp")
-				return
-			}
-		case "headers":
-			var zb0002 uint32
-			zb0002, err = dc.ReadMapHeader()
-			if err != nil {
-				err = msgp.WrapError(err, "headers")
-				return
-			}
-			if z.headers == nil {
-				z.headers = make(map[string][]byte, zb0002)
-			} else if len(z.headers) > 0 {
-				for key := range z.headers {
-					delete(z.headers, key)
-				}
-			}
-			for zb0002 > 0 {
-				zb0002--
-				var za0001 string
-				var za0002 []byte
-				za0001, err = dc.ReadString()
-				if err != nil {
-					err = msgp.WrapError(err, "headers")
-					return
-				}
-				za0002, err = dc.ReadBytes(za0002)
-				if err != nil {
-					err = msgp.WrapError(err, "headers", za0001)
-					return
-				}
-				z.headers[za0001] = za0002
-			}
-		case "heapidx":
-			z.heapidx, err = dc.ReadInt()
-			if err != nil {
-				err = msgp.WrapError(err, "heapidx")
-				return
-			}
-		default:
-			err = dc.Skip()
-			if err != nil {
-				err = msgp.WrapError(err)
-				return
-			}
-		}
-	}
-	return
-}
-
-// EncodeMsg implements msgp.Encodable
-func (z *item) EncodeMsg(en *msgp.Writer) (err error) {
-	// map header, size 7
-	// write "body"
-	err = en.Append(0x87, 0xa4, 0x62, 0x6f, 0x64, 0x79)
-	if err != nil {
-		return
-	}
-	err = en.WriteBytes(z.body)
-	if err != nil {
-		err = msgp.WrapError(err, "body")
-		return
-	}
-	// write "ctype"
-	err = en.Append(0xa5, 0x63, 0x74, 0x79, 0x70, 0x65)
-	if err != nil {
-		return
-	}
-	err = en.WriteBytes(z.ctype)
-	if err != nil {
-		err = msgp.WrapError(err, "ctype")
-		return
-	}
-	// write "cencoding"
-	err = en.Append(0xa9, 0x63, 0x65, 0x6e, 0x63, 0x6f, 0x64, 0x69, 0x6e, 0x67)
-	if err != nil {
-		return
-	}
-	err = en.WriteBytes(z.cencoding)
-	if err != nil {
-		err = msgp.WrapError(err, "cencoding")
-		return
-	}
-	// write "status"
-	err = en.Append(0xa6, 0x73, 0x74, 0x61, 0x74, 0x75, 0x73)
-	if err != nil {
-		return
-	}
-	err = en.WriteInt(z.status)
-	if err != nil {
-		err = msgp.WrapError(err, "status")
-		return
-	}
-	// write "exp"
-	err = en.Append(0xa3, 0x65, 0x78, 0x70)
-	if err != nil {
-		return
-	}
-	err = en.WriteUint64(z.exp)
-	if err != nil {
-		err = msgp.WrapError(err, "exp")
-		return
-	}
-	// write "headers"
-	err = en.Append(0xa7, 0x68, 0x65, 0x61, 0x64, 0x65, 0x72, 0x73)
-	if err != nil {
-		return
-	}
-	err = en.WriteMapHeader(uint32(len(z.headers)))
-	if err != nil {
-		err = msgp.WrapError(err, "headers")
-		return
-	}
-	for za0001, za0002 := range z.headers {
-		err = en.WriteString(za0001)
-		if err != nil {
-			err = msgp.WrapError(err, "headers")
-			return
-		}
-		err = en.WriteBytes(za0002)
-		if err != nil {
-			err = msgp.WrapError(err, "headers", za0001)
-			return
-		}
-	}
-	// write "heapidx"
-	err = en.Append(0xa7, 0x68, 0x65, 0x61, 0x70, 0x69, 0x64, 0x78)
-	if err != nil {
-		return
-	}
-	err = en.WriteInt(z.heapidx)
-	if err != nil {
-		err = msgp.WrapError(err, "heapidx")
-		return
-	}
-	return
-}
-
 // MarshalMsg implements msgp.Marshaler
 func (z *item) MarshalMsg(b []byte) (o []byte, err error) {
 	o = msgp.Require(b, z.Msgsize())

middleware/cache/manager_msgp_test.go

@@ -0,0 +1,67 @@
+package cache
+
+// Code generated by github.com/tinylib/msgp DO NOT EDIT.
+
+import (
+	"testing"
+
+	"github.com/tinylib/msgp/msgp"
+)
+
+func TestMarshalUnmarshalitem(t *testing.T) {
+	v := item{}
+	bts, err := v.MarshalMsg(nil)
+	if err != nil {
+		t.Fatal(err)
+	}
+	left, err := v.UnmarshalMsg(bts)
+	if err != nil {
+		t.Fatal(err)
+	}
+	if len(left) > 0 {
+		t.Errorf("%d bytes left over after UnmarshalMsg(): %q", len(left), left)
+	}
+
+	left, err = msgp.Skip(bts)
+	if err != nil {
+		t.Fatal(err)
+	}
+	if len(left) > 0 {
+		t.Errorf("%d bytes left over after Skip(): %q", len(left), left)
+	}
+}
+
+func BenchmarkMarshalMsgitem(b *testing.B) {
+	v := item{}
+	b.ReportAllocs()
+	b.ResetTimer()
+	for i := 0; i < b.N; i++ {
+		v.MarshalMsg(nil)
+	}
+}
+
+func BenchmarkAppendMsgitem(b *testing.B) {
+	v := item{}
+	bts := make([]byte, 0, v.Msgsize())
+	bts, _ = v.MarshalMsg(bts[0:0])
+	b.SetBytes(int64(len(bts)))
+	b.ReportAllocs()
+	b.ResetTimer()
+	for i := 0; i < b.N; i++ {
+		bts, _ = v.MarshalMsg(bts[0:0])
+	}
+}
+
+func BenchmarkUnmarshalitem(b *testing.B) {
+	v := item{}
+	bts, _ := v.MarshalMsg(nil)
+	b.ReportAllocs()
+	b.SetBytes(int64(len(bts)))
+	b.ResetTimer()
+	for i := 0; i < b.N; i++ {
+		_, err := v.UnmarshalMsg(bts)
+		if err != nil {
+			b.Fatal(err)
+		}
+	}
+}

middleware/csrf/manager.go

@@ -9,8 +9,7 @@ import (
 	"github.com/gofiber/utils/v2"
 )
 
-// go:generate msgp
-// msgp -file="manager.go" -o="manager_msgp.go" -tests=false -unexported
+//go:generate msgp -o=manager_msgp.go -io=false -unexported
 type item struct{}
 
 //msgp:ignore manager

middleware/csrf/manager_msgp.go

@@ -6,45 +6,6 @@ import (
 	"github.com/tinylib/msgp/msgp"
 )
 
-// DecodeMsg implements msgp.Decodable
-func (z *item) DecodeMsg(dc *msgp.Reader) (err error) {
-	var field []byte
-	_ = field
-	var zb0001 uint32
-	zb0001, err = dc.ReadMapHeader()
-	if err != nil {
-		err = msgp.WrapError(err)
-		return
-	}
-	for zb0001 > 0 {
-		zb0001--
-		field, err = dc.ReadMapKeyPtr()
-		if err != nil {
-			err = msgp.WrapError(err)
-			return
-		}
-		switch msgp.UnsafeString(field) {
-		default:
-			err = dc.Skip()
-			if err != nil {
-				err = msgp.WrapError(err)
-				return
-			}
-		}
-	}
-	return
-}
-
-// EncodeMsg implements msgp.Encodable
-func (z item) EncodeMsg(en *msgp.Writer) (err error) {
-	// map header, size 0
-	err = en.Append(0x80)
-	if err != nil {
-		return
-	}
-	return
-}
-
 // MarshalMsg implements msgp.Marshaler
 func (z item) MarshalMsg(b []byte) (o []byte, err error) {
 	o = msgp.Require(b, z.Msgsize())

middleware/csrf/manager_msgp_test.go

@@ -0,0 +1,67 @@
+package csrf
+
+// Code generated by github.com/tinylib/msgp DO NOT EDIT.
+
+import (
+	"testing"
+
+	"github.com/tinylib/msgp/msgp"
+)
+
+func TestMarshalUnmarshalitem(t *testing.T) {
+	v := item{}
+	bts, err := v.MarshalMsg(nil)
+	if err != nil {
+		t.Fatal(err)
+	}
+	left, err := v.UnmarshalMsg(bts)
+	if err != nil {
+		t.Fatal(err)
+	}
+	if len(left) > 0 {
+		t.Errorf("%d bytes left over after UnmarshalMsg(): %q", len(left), left)
+	}
+
+	left, err = msgp.Skip(bts)
+	if err != nil {
+		t.Fatal(err)
+	}
+	if len(left) > 0 {
+		t.Errorf("%d bytes left over after Skip(): %q", len(left), left)
+	}
+}
+
+func BenchmarkMarshalMsgitem(b *testing.B) {
+	v := item{}
+	b.ReportAllocs()
+	b.ResetTimer()
+	for i := 0; i < b.N; i++ {
+		v.MarshalMsg(nil)
+	}
+}
+
+func BenchmarkAppendMsgitem(b *testing.B) {
+	v := item{}
+	bts := make([]byte, 0, v.Msgsize())
+	bts, _ = v.MarshalMsg(bts[0:0])
+	b.SetBytes(int64(len(bts)))
+	b.ReportAllocs()
+	b.ResetTimer()
+	for i := 0; i < b.N; i++ {
+		bts, _ = v.MarshalMsg(bts[0:0])
+	}
+}
+
+func BenchmarkUnmarshalitem(b *testing.B) {
+	v := item{}
+	bts, _ := v.MarshalMsg(nil)
+	b.ReportAllocs()
+	b.SetBytes(int64(len(bts)))
+	b.ResetTimer()
+	for i := 0; i < b.N; i++ {
+		_, err := v.UnmarshalMsg(bts)
+		if err != nil {
+			b.Fatal(err)
+		}
+	}
+}

middleware/limiter/manager.go

@@ -8,10 +8,7 @@ import (
 	"github.com/gofiber/fiber/v3/internal/memory"
 )
 
-// go:generate msgp
-// msgp -file="manager.go" -o="manager_msgp.go" -tests=false -unexported
-// don't forget to replace the msgp import path to:
-// "github.com/gofiber/fiber/v2/internal/msgp"
+//go:generate msgp -o=manager_msgp.go -io=false -unexported
 type item struct {
 	currHits int
 	prevHits int

middleware/limiter/manager_msgp.go

@@ -6,89 +6,6 @@ import (
 	"github.com/tinylib/msgp/msgp"
 )
 
-// DecodeMsg implements msgp.Decodable
-func (z *item) DecodeMsg(dc *msgp.Reader) (err error) {
-	var field []byte
-	_ = field
-	var zb0001 uint32
-	zb0001, err = dc.ReadMapHeader()
-	if err != nil {
-		err = msgp.WrapError(err)
-		return
-	}
-	for zb0001 > 0 {
-		zb0001--
-		field, err = dc.ReadMapKeyPtr()
-		if err != nil {
-			err = msgp.WrapError(err)
-			return
-		}
-		switch msgp.UnsafeString(field) {
-		case "currHits":
-			z.currHits, err = dc.ReadInt()
-			if err != nil {
-				err = msgp.WrapError(err, "currHits")
-				return
-			}
-		case "prevHits":
-			z.prevHits, err = dc.ReadInt()
-			if err != nil {
-				err = msgp.WrapError(err, "prevHits")
-				return
-			}
-		case "exp":
-			z.exp, err = dc.ReadUint64()
-			if err != nil {
-				err = msgp.WrapError(err, "exp")
-				return
-			}
-		default:
-			err = dc.Skip()
-			if err != nil {
-				err = msgp.WrapError(err)
-				return
-			}
-		}
-	}
-	return
-}
-
-// EncodeMsg implements msgp.Encodable
-func (z item) EncodeMsg(en *msgp.Writer) (err error) {
-	// map header, size 3
-	// write "currHits"
-	err = en.Append(0x83, 0xa8, 0x63, 0x75, 0x72, 0x72, 0x48, 0x69, 0x74, 0x73)
-	if err != nil {
-		return
-	}
-	err = en.WriteInt(z.currHits)
-	if err != nil {
-		err = msgp.WrapError(err, "currHits")
-		return
-	}
-	// write "prevHits"
-	err = en.Append(0xa8, 0x70, 0x72, 0x65, 0x76, 0x48, 0x69, 0x74, 0x73)
-	if err != nil {
-		return
-	}
-	err = en.WriteInt(z.prevHits)
-	if err != nil {
-		err = msgp.WrapError(err, "prevHits")
-		return
-	}
-	// write "exp"
-	err = en.Append(0xa3, 0x65, 0x78, 0x70)
-	if err != nil {
-		return
-	}
-	err = en.WriteUint64(z.exp)
-	if err != nil {
-		err = msgp.WrapError(err, "exp")
-		return
-	}
-	return
-}
-
 // MarshalMsg implements msgp.Marshaler
 func (z item) MarshalMsg(b []byte) (o []byte, err error) {
 	o = msgp.Require(b, z.Msgsize())

middleware/limiter/manager_msgp_test.go

@@ -0,0 +1,67 @@
+package limiter
+
+// Code generated by github.com/tinylib/msgp DO NOT EDIT.
+
+import (
+	"testing"
+
+	"github.com/tinylib/msgp/msgp"
+)
+
+func TestMarshalUnmarshalitem(t *testing.T) {
+	v := item{}
+	bts, err := v.MarshalMsg(nil)
+	if err != nil {
+		t.Fatal(err)
+	}
+	left, err := v.UnmarshalMsg(bts)
+	if err != nil {
+		t.Fatal(err)
+	}
+	if len(left) > 0 {
+		t.Errorf("%d bytes left over after UnmarshalMsg(): %q", len(left), left)
+	}
+
+	left, err = msgp.Skip(bts)
+	if err != nil {
+		t.Fatal(err)
+	}
+	if len(left) > 0 {
+		t.Errorf("%d bytes left over after Skip(): %q", len(left), left)
+	}
+}
+
+func BenchmarkMarshalMsgitem(b *testing.B) {
+	v := item{}
+	b.ReportAllocs()
+	b.ResetTimer()
+	for i := 0; i < b.N; i++ {
+		v.MarshalMsg(nil)
+	}
+}
+
+func BenchmarkAppendMsgitem(b *testing.B) {
+	v := item{}
+	bts := make([]byte, 0, v.Msgsize())
+	bts, _ = v.MarshalMsg(bts[0:0])
+	b.SetBytes(int64(len(bts)))
+	b.ReportAllocs()
+	b.ResetTimer()
+	for i := 0; i < b.N; i++ {
+		bts, _ = v.MarshalMsg(bts[0:0])
+	}
+}
+
+func BenchmarkUnmarshalitem(b *testing.B) {
+	v := item{}
+	bts, _ := v.MarshalMsg(nil)
+	b.ReportAllocs()
+	b.SetBytes(int64(len(bts)))
+	b.ResetTimer()
+	for i := 0; i < b.N; i++ {
+		_, err := v.UnmarshalMsg(bts)
+		if err != nil {
+			b.Fatal(err)
+		}
+	}
+}

middleware/session/data.go

@@ -4,10 +4,6 @@ import (
 	"sync"
 )
 
-// go:generate msgp
-// msgp -file="data.go" -o="data_msgp.go" -tests=false -unexported
-// don't forget to replace the msgp import path to:
-// "github.com/gofiber/fiber/v3/internal/msgp"
 type data struct {
 	sync.RWMutex
 	Data map[string]any