v3: Use Named Fields Instead of Positional and Align Structures to Re…

…duce Memory Usage (gofiber#3079)

* Use composites for internal structures. Fix alignment of structures across Fiber

* Update struct alignment in test files

* Enable alignment check with govet

* Fix ctx autoformat unit-test

* Revert app Config struct. Add betteralign to Makefile

* Disable comment on alert since it wont work for forks

* Update benchmark.yml

* Update benchmark.yml

* Remove warning from using positional fields

* Update router.go

.github/workflows/benchmark.yml

@@ -14,6 +14,8 @@ permissions:
   deployments: write
   # contents permission to update benchmark contents in gh-pages branch
   contents: write
+  # allow posting comments to pull request
+  pull-requests: write
 
 name: Benchmark
 jobs:

.golangci.yml

@@ -101,7 +101,6 @@ linters-settings:
   govet:
     enable-all: true
     disable:
-      - fieldalignment
       - shadow
 
   grouper:

Makefile

@@ -51,3 +51,8 @@ longtest:
 .PHONY: tidy
 tidy:
 	go mod tidy -v
+
+## betteralign: 📐 Optimize alignment of fields in structs
+.PHONY: betteralign
+betteralign:
+	go run github.com/dkorunic/betteralign/cmd/betteralign@latest -test_files -generated_files -apply ./...

addon/retry/exponential_backoff_test.go

@@ -11,10 +11,10 @@ import (
 func Test_ExponentialBackoff_Retry(t *testing.T) {
 	t.Parallel()
 	tests := []struct {
-		name       string
+		expErr     error
 		expBackoff *ExponentialBackoff
 		f          func() error
-		expErr     error
+		name       string
 	}{
 		{
 			name:       "With default values - successful",

app.go

@@ -80,29 +80,16 @@ type ErrorHandler = func(Ctx, error) error
 
 // Error represents an error that occurred while handling a request.
 type Error struct {
-	Code    int    `json:"code"`
 	Message string `json:"message"`
+	Code    int    `json:"code"`
 }
 
 // App denotes the Fiber application.
 type App struct {
-	mutex sync.Mutex
-	// Route stack divided by HTTP methods
-	stack [][]*Route
-	// Route stack divided by HTTP methods and route prefixes
-	treeStack []map[string][]*Route
-	// contains the information if the route stack has been changed to build the optimized tree
-	routesRefreshed bool
-	// Amount of registered routes
-	routesCount uint32
-	// Amount of registered handlers
-	handlersCount uint32
 	// Ctx pool
 	pool sync.Pool
 	// Fasthttp server
 	server *fasthttp.Server
-	// App config
-	config Config
 	// Converts string to a byte slice
 	getBytes func(s string) (b []byte)
 	// Converts byte slice to a string
@@ -113,24 +100,37 @@ type App struct {
 	latestRoute *Route
 	// newCtxFunc
 	newCtxFunc func(app *App) CustomCtx
-	// custom binders
-	customBinders []CustomBinder
 	// TLS handler
 	tlsHandler *TLSHandler
 	// Mount fields
 	mountFields *mountFields
-	// Indicates if the value was explicitly configured
-	configured Config
+	// Route stack divided by HTTP methods
+	stack [][]*Route
+	// Route stack divided by HTTP methods and route prefixes
+	treeStack []map[string][]*Route
+	// custom binders
+	customBinders []CustomBinder
 	// customConstraints is a list of external constraints
 	customConstraints []CustomConstraint
 	// sendfiles stores configurations for handling ctx.SendFile operations
 	sendfiles []*sendFileStore
+	// App config
+	config Config
+	// Indicates if the value was explicitly configured
+	configured Config
 	// sendfilesMutex is a mutex used for sendfile operations
 	sendfilesMutex sync.RWMutex
+	mutex          sync.Mutex
+	// Amount of registered routes
+	routesCount uint32
+	// Amount of registered handlers
+	handlersCount uint32
+	// contains the information if the route stack has been changed to build the optimized tree
+	routesRefreshed bool
 }
 
 // Config is a struct holding the server settings.
-type Config struct {
+type Config struct { //nolint:govet // Aligning the struct fields is not necessary. betteralign:ignore
 	// Enables the "Server: value" HTTP header.
 	//
 	// Default: ""

bind_test.go

@@ -26,9 +26,9 @@ func Test_Bind_Query(t *testing.T) {
 	c := app.AcquireCtx(&fasthttp.RequestCtx{})
 
 	type Query struct {
-		ID    int
 		Name  string
 		Hobby []string
+		ID    int
 	}
 	c.Request().SetBody([]byte(``))
 	c.Request().Header.SetContentType("")
@@ -53,14 +53,14 @@ func Test_Bind_Query(t *testing.T) {
 	require.Empty(t, empty.Hobby)
 
 	type Query2 struct {
-		Bool            bool
-		ID              int
 		Name            string
 		Hobby           string
 		FavouriteDrinks []string
 		Empty           []string
 		Alloc           []string
 		No              []int64
+		ID              int
+		Bool            bool
 	}
 
 	c.Request().URI().SetQueryString("id=1&name=tom&hobby=basketball,football&favouriteDrinks=milo,coke,pepsi&alloc=&no=1")
@@ -237,8 +237,8 @@ func Test_Bind_Query_Schema(t *testing.T) {
 	require.Equal(t, "nested.age is empty", c.Bind().Query(q2).Error())
 
 	type Node struct {
-		Value int   `query:"val,required"`
 		Next  *Node `query:"next,required"`
+		Value int   `query:"val,required"`
 	}
 	c.Request().URI().SetQueryString("val=1&next.val=3")
 	n := new(Node)
@@ -292,9 +292,9 @@ func Test_Bind_Header(t *testing.T) {
 	c := app.AcquireCtx(&fasthttp.RequestCtx{})
 
 	type Header struct {
-		ID    int
 		Name  string
 		Hobby []string
+		ID    int
 	}
 	c.Request().SetBody([]byte(``))
 	c.Request().Header.SetContentType("")
@@ -318,14 +318,14 @@ func Test_Bind_Header(t *testing.T) {
 	require.Empty(t, empty.Hobby)
 
 	type Header2 struct {
-		Bool            bool
-		ID              int
 		Name            string
 		Hobby           string
 		FavouriteDrinks []string
 		Empty           []string
 		Alloc           []string
 		No              []int64
+		ID              int
+		Bool            bool
 	}
 
 	c.Request().Header.Add("id", "2")
@@ -502,8 +502,8 @@ func Test_Bind_Header_Schema(t *testing.T) {
 	require.Equal(t, "Nested.age is empty", c.Bind().Header(h2).Error())
 
 	type Node struct {
-		Value int   `header:"Val,required"`
 		Next  *Node `header:"Next,required"`
+		Value int   `header:"Val,required"`
 	}
 	c.Request().Header.Add("Val", "1")
 	c.Request().Header.Add("Next.Val", "3")
@@ -533,9 +533,9 @@ func Test_Bind_RespHeader(t *testing.T) {
 	c := app.AcquireCtx(&fasthttp.RequestCtx{})
 
 	type Header struct {
-		ID    int
 		Name  string
 		Hobby []string
+		ID    int
 	}
 	c.Request().SetBody([]byte(``))
 	c.Request().Header.SetContentType("")
@@ -559,14 +559,14 @@ func Test_Bind_RespHeader(t *testing.T) {
 	require.Empty(t, empty.Hobby)
 
 	type Header2 struct {
-		Bool            bool
-		ID              int
 		Name            string
 		Hobby           string
 		FavouriteDrinks []string
 		Empty           []string
 		Alloc           []string
 		No              []int64
+		ID              int
+		Bool            bool
 	}
 
 	c.Response().Header.Add("id", "2")
@@ -635,9 +635,9 @@ func Benchmark_Bind_Query(b *testing.B) {
 	c := app.AcquireCtx(&fasthttp.RequestCtx{})
 
 	type Query struct {
-		ID    int
 		Name  string
 		Hobby []string
+		ID    int
 	}
 	c.Request().SetBody([]byte(``))
 	c.Request().Header.SetContentType("")
@@ -708,9 +708,9 @@ func Benchmark_Bind_Query_Comma(b *testing.B) {
 	c := app.AcquireCtx(&fasthttp.RequestCtx{})
 
 	type Query struct {
-		ID    int
 		Name  string
 		Hobby []string
+		ID    int
 	}
 	c.Request().SetBody([]byte(``))
 	c.Request().Header.SetContentType("")
@@ -732,9 +732,9 @@ func Benchmark_Bind_Header(b *testing.B) {
 	c := app.AcquireCtx(&fasthttp.RequestCtx{})
 
 	type ReqHeader struct {
-		ID    int
 		Name  string
 		Hobby []string
+		ID    int
 	}
 	c.Request().SetBody([]byte(``))
 	c.Request().Header.SetContentType("")
@@ -782,9 +782,9 @@ func Benchmark_Bind_RespHeader(b *testing.B) {
 	c := app.AcquireCtx(&fasthttp.RequestCtx{})
 
 	type ReqHeader struct {
-		ID    int
 		Name  string
 		Hobby []string
+		ID    int
 	}
 	c.Request().SetBody([]byte(``))
 	c.Request().Header.SetContentType("")
@@ -1252,9 +1252,9 @@ func Test_Bind_Cookie(t *testing.T) {
 	c := app.AcquireCtx(&fasthttp.RequestCtx{})
 
 	type Cookie struct {
-		ID    int
 		Name  string
 		Hobby []string
+		ID    int
 	}
 	c.Request().SetBody([]byte(``))
 	c.Request().Header.SetContentType("")
@@ -1278,14 +1278,14 @@ func Test_Bind_Cookie(t *testing.T) {
 	require.Empty(t, empty.Hobby)
 
 	type Cookie2 struct {
-		Bool            bool
-		ID              int
 		Name            string
 		Hobby           string
 		FavouriteDrinks []string
 		Empty           []string
 		Alloc           []string
 		No              []int64
+		ID              int
+		Bool            bool
 	}
 
 	c.Request().Header.SetCookie("id", "2")
@@ -1463,8 +1463,8 @@ func Test_Bind_Cookie_Schema(t *testing.T) {
 	require.Equal(t, "Nested.Age is empty", c.Bind().Cookie(h2).Error())
 
 	type Node struct {
-		Value int   `cookie:"Val,required"`
 		Next  *Node `cookie:"Next,required"`
+		Value int   `cookie:"Val,required"`
 	}
 	c.Request().Header.SetCookie("Val", "1")
 	c.Request().Header.SetCookie("Next.Val", "3")
@@ -1495,9 +1495,9 @@ func Benchmark_Bind_Cookie(b *testing.B) {
 	c := app.AcquireCtx(&fasthttp.RequestCtx{})
 
 	type Cookie struct {
-		ID    int
 		Name  string
 		Hobby []string
+		ID    int
 	}
 	c.Request().SetBody([]byte(``))
 	c.Request().Header.SetContentType("")

binder/mapping.go

@@ -12,9 +12,9 @@ import (
 
 // ParserConfig form decoder config for SetParserDecoder
 type ParserConfig struct {
-	IgnoreUnknownKeys bool
 	SetAliasTag       string
 	ParserType        []ParserType
+	IgnoreUnknownKeys bool
 	ZeroEmpty         bool
 }