Use utils Trim functions instead of the strings/bytes functions (#3087)

ReneWerner87 · web-flow · commit fadedcb5be83 · 2024-07-24T16:25:35.000+02:00
* Use utils Trim functions instead of the strings/bytes functions

* rename Test and Benchmark functions with same name
diff --git a/client/response.go b/client/response.go
@@ -8,7 +8,6 @@ import (
 	"io/fs"
 	"os"
 	"path/filepath"
-	"strings"
 	"sync"
 
 	"github.com/gofiber/utils/v2"
@@ -68,7 +67,7 @@ func (r *Response) Body() []byte {
 
 // String method returns the body of the server response as String.
 func (r *Response) String() string {
-	return strings.TrimSpace(string(r.Body()))
+	return utils.Trim(string(r.Body()), ' ')
 }
 
 // JSON method will unmarshal body to json.
diff --git a/ctx.go b/ctx.go
@@ -778,7 +778,7 @@ iploop:
 			i++
 		}
 
-		s := strings.TrimRight(headerValue[i:j], " ")
+		s := utils.TrimRight(headerValue[i:j], ' ')
 
 		if c.app.config.EnableIPValidation {
 			// Skip validation if IP is clearly not IPv4/IPv6, otherwise validate without allocations
@@ -828,7 +828,7 @@ func (c *DefaultCtx) extractIPFromHeader(header string) string {
 				i++
 			}
 
-			s := strings.TrimRight(headerValue[i:j], " ")
+			s := utils.TrimRight(headerValue[i:j], ' ')
 
 			if c.app.config.EnableIPValidation {
 				if (!v6 && !v4) || (v6 && !utils.IsIPv6(s)) || (v4 && !utils.IsIPv4(s)) {
@@ -862,7 +862,7 @@ func (c *DefaultCtx) Is(extension string) bool {
 	}
 
 	return strings.HasPrefix(
-		strings.TrimLeft(utils.UnsafeString(c.fasthttp.Request.Header.ContentType()), " "),
+		utils.TrimLeft(utils.UnsafeString(c.fasthttp.Request.Header.ContentType()), ' '),
 		extensionHeader,
 	)
 }
@@ -939,7 +939,7 @@ func (c *DefaultCtx) Links(link ...string) {
 			bb.WriteString(`; rel="` + link[i] + `",`)
 		}
 	}
-	c.setCanonical(HeaderLink, strings.TrimRight(c.app.getString(bb.Bytes()), ","))
+	c.setCanonical(HeaderLink, utils.TrimRight(c.app.getString(bb.Bytes()), ','))
 	bytebufferpool.Put(bb)
 }
 
@@ -1810,7 +1810,7 @@ func (c *DefaultCtx) configDependentPaths() {
 	}
 	// If StrictRouting is disabled, we strip all trailing slashes
 	if !c.app.config.StrictRouting && len(c.detectionPathBuffer) > 1 && c.detectionPathBuffer[len(c.detectionPathBuffer)-1] == '/' {
-		c.detectionPathBuffer = bytes.TrimRight(c.detectionPathBuffer, "/")
+		c.detectionPathBuffer = utils.TrimRight(c.detectionPathBuffer, '/')
 	}
 	c.detectionPath = c.app.getString(c.detectionPathBuffer)
 
diff --git a/go.mod b/go.mod
@@ -3,7 +3,7 @@ module github.com/gofiber/fiber/v3
 go 1.21
 
 require (
-	github.com/gofiber/utils/v2 v2.0.0-beta.5
+	github.com/gofiber/utils/v2 v2.0.0-beta.6
 	github.com/google/uuid v1.6.0
 	github.com/mattn/go-colorable v0.1.13
 	github.com/mattn/go-isatty v0.0.20
diff --git a/go.sum b/go.sum
@@ -2,8 +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/utils/v2 v2.0.0-beta.5 h1:zbDIU8gVAlZ2Ak9Fk8APlis4S7wUiQFbcvv6UASkm6A=
-github.com/gofiber/utils/v2 v2.0.0-beta.5/go.mod h1:3Kz8Px3jInKFvqxDzDeoSygwEOO+3uyubTmUa6PqY+0=
+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=
 github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/klauspost/compress v1.17.9 h1:6KIumPrER1LHsvBVuDa0r5xaG0Es51mhhB9BQB2qeMA=
diff --git a/helpers.go b/helpers.go
@@ -222,7 +222,7 @@ func getGroupPath(prefix, path string) string {
 		path = "/" + path
 	}
 
-	return strings.TrimRight(prefix, "/") + path
+	return utils.TrimRight(prefix, '/') + path
 }
 
 // acceptsOffer This function determines if an offer matches a given specification.
@@ -336,7 +336,7 @@ func getSplicedStrList(headerValue string, dst []string) []string {
 				dst = make([]string, len(dst)+(len(dst)>>1)+2)
 				copy(dst, oldSlice)
 			}
-			dst[insertIndex] = strings.TrimLeft(headerValue[lastElementEndsAt:index], " ")
+			dst[insertIndex] = utils.TrimLeft(headerValue[lastElementEndsAt:index], ' ')
 			lastElementEndsAt = uint8(index + 1)
 			insertIndex++
 		}
@@ -356,7 +356,7 @@ func forEachMediaRange(header []byte, functor func([]byte)) {
 
 	for len(header) > 0 {
 		n := 0
-		header = bytes.TrimLeft(header, " ")
+		header = utils.TrimLeft(header, ' ')
 		quotes := 0
 		escaping := false
 
@@ -459,7 +459,7 @@ func getOffer(header []byte, isAccepted func(spec, offer string, specParams head
 			}
 		}
 
-		spec = bytes.TrimSpace(spec)
+		spec = utils.Trim(spec, ' ')
 
 		// Determine specificity
 		var specificity int
diff --git a/middleware/cache/manager_msgp_test.go b/middleware/cache/manager_msgp_test.go
diff --git a/middleware/cors/cors.go b/middleware/cors/cors.go
@@ -6,6 +6,7 @@ import (
 
 	"github.com/gofiber/fiber/v3"
 	"github.com/gofiber/fiber/v3/log"
+	"github.com/gofiber/utils/v2"
 )
 
 // New creates a new middleware handler
@@ -44,15 +45,15 @@ func New(config ...Config) fiber.Handler {
 			break
 		}
 		if i := strings.Index(origin, "://*."); i != -1 {
-			trimmedOrigin := strings.TrimSpace(origin[:i+3] + origin[i+4:])
+			trimmedOrigin := utils.Trim(origin[:i+3]+origin[i+4:], ' ')
 			isValid, normalizedOrigin := normalizeOrigin(trimmedOrigin)
 			if !isValid {
 				panic("[CORS] Invalid origin format in configuration: " + trimmedOrigin)
 			}
 			sd := subdomain{prefix: normalizedOrigin[:i+3], suffix: normalizedOrigin[i+3:]}
 			allowSOrigins = append(allowSOrigins, sd)
 		} else {
-			trimmedOrigin := strings.TrimSpace(origin)
+			trimmedOrigin := utils.Trim(origin, ' ')
 			isValid, normalizedOrigin := normalizeOrigin(trimmedOrigin)
 			if !isValid {
 				panic("[CORS] Invalid origin format in configuration: " + trimmedOrigin)
diff --git a/middleware/csrf/csrf.go b/middleware/csrf/csrf.go
@@ -8,6 +8,7 @@ import (
 	"time"
 
 	"github.com/gofiber/fiber/v3"
+	"github.com/gofiber/utils/v2"
 )
 
 var (
@@ -62,15 +63,15 @@ func New(config ...Config) fiber.Handler {
 
 	for _, origin := range cfg.TrustedOrigins {
 		if i := strings.Index(origin, "://*."); i != -1 {
-			trimmedOrigin := strings.TrimSpace(origin[:i+3] + origin[i+4:])
+			trimmedOrigin := utils.Trim(origin[:i+3]+origin[i+4:], ' ')
 			isValid, normalizedOrigin := normalizeOrigin(trimmedOrigin)
 			if !isValid {
 				panic("[CSRF] Invalid origin format in configuration:" + origin)
 			}
 			sd := subdomain{prefix: normalizedOrigin[:i+3], suffix: normalizedOrigin[i+3:]}
 			trustedSubOrigins = append(trustedSubOrigins, sd)
 		} else {
-			trimmedOrigin := strings.TrimSpace(origin)
+			trimmedOrigin := utils.Trim(origin, ' ')
 			isValid, normalizedOrigin := normalizeOrigin(trimmedOrigin)
 			if !isValid {
 				panic("[CSRF] Invalid origin format in configuration:" + origin)
diff --git a/middleware/csrf/csrf_test.go b/middleware/csrf/csrf_test.go
@@ -139,7 +139,7 @@ func Test_CSRF_WithSession(t *testing.T) {
 		h(ctx)
 		token := string(ctx.Response.Header.Peek(fiber.HeaderSetCookie))
 		for _, header := range strings.Split(token, ";") {
-			if strings.Split(strings.TrimSpace(header), "=")[0] == ConfigDefault.CookieName {
+			if strings.Split(utils.Trim(header, ' '), "=")[0] == ConfigDefault.CookieName {
 				token = strings.Split(header, "=")[1]
 				break
 			}
@@ -248,7 +248,7 @@ func Test_CSRF_ExpiredToken_WithSession(t *testing.T) {
 	h(ctx)
 	token := string(ctx.Response.Header.Peek(fiber.HeaderSetCookie))
 	for _, header := range strings.Split(token, ";") {
-		if strings.Split(strings.TrimSpace(header), "=")[0] == ConfigDefault.CookieName {
+		if strings.Split(utils.Trim(header, ' '), "=")[0] == ConfigDefault.CookieName {
 			token = strings.Split(header, "=")[1]
 			break
 		}
diff --git a/middleware/csrf/manager_msgp_test.go b/middleware/csrf/manager_msgp_test.go
diff --git a/middleware/limiter/manager_msgp_test.go b/middleware/limiter/manager_msgp_test.go
diff --git a/middleware/pprof/pprof.go b/middleware/pprof/pprof.go
@@ -5,6 +5,7 @@ import (
 	"strings"
 
 	"github.com/gofiber/fiber/v3"
+	"github.com/gofiber/utils/v2"
 	"github.com/valyala/fasthttp/fasthttpadaptor"
 )
 
@@ -71,7 +72,7 @@ func New(config ...Config) fiber.Handler {
 		default:
 			// pprof index only works with trailing slash
 			if strings.HasSuffix(path, "/") {
-				path = strings.TrimRight(path, "/")
+				path = utils.TrimRight(path, '/')
 			} else {
 				path = prefix + "/"
 			}
diff --git a/mount.go b/mount.go
@@ -6,9 +6,10 @@ package fiber
 
 import (
 	"sort"
-	"strings"
 	"sync"
 	"sync/atomic"
+
+	"github.com/gofiber/utils/v2"
 )
 
 // Put fields related to mounting.
@@ -39,7 +40,7 @@ func newMountFields(app *App) *mountFields {
 // any of the fiber's sub apps are added to the application's error handlers
 // to be invoked on errors that happen within the prefix route.
 func (app *App) mount(prefix string, subApp *App) Router {
-	prefix = strings.TrimRight(prefix, "/")
+	prefix = utils.TrimRight(prefix, '/')
 	if prefix == "" {
 		prefix = "/"
 	}
@@ -69,7 +70,7 @@ func (app *App) mount(prefix string, subApp *App) Router {
 // compose them as a single service using Mount.
 func (grp *Group) mount(prefix string, subApp *App) Router {
 	groupPath := getGroupPath(grp.Prefix, prefix)
-	groupPath = strings.TrimRight(groupPath, "/")
+	groupPath = utils.TrimRight(groupPath, '/')
 	if groupPath == "" {
 		groupPath = "/"
 	}
diff --git a/path.go b/path.go
@@ -51,7 +51,7 @@ const (
 	optionalParam                byte = '?'  // concludes a parameter by name and makes it optional
 	paramStarterChar             byte = ':'  // start character for a parameter with name
 	slashDelimiter               byte = '/'  // separator for the route, unlike the other delimiters this character at the end can be optional
-	slashDelimiterStr                 = "/"  // separator for the route, unlike the other delimiters this character at the end can be optional
+	slashDelimiterStr            byte = '/'  // separator for the route, unlike the other delimiters this character at the end can be optional
 	escapeChar                   byte = '\\' // escape character
 	paramConstraintStart         byte = '<'  // start of type constraint for a parameter
 	paramConstraintEnd           byte = '>'  // end of type constraint for a parameter
@@ -161,7 +161,7 @@ func RoutePatternMatch(path, pattern string, cfg ...Config) bool {
 	}
 	// Strict routing, remove trailing slashes
 	if !config.StrictRouting && len(patternPretty) > 1 {
-		patternPretty = strings.TrimRight(patternPretty, "/")
+		patternPretty = utils.TrimRight(patternPretty, '/')
 	}
 
 	parser := parseRoute(patternPretty)
@@ -233,7 +233,7 @@ func addParameterMetaInfo(segs []*routeSegment) []*routeSegment {
 		} else {
 			comparePart = segs[i].Const
 			if len(comparePart) > 1 {
-				comparePart = strings.TrimRight(comparePart, slashDelimiterStr)
+				comparePart = utils.TrimRight(comparePart, slashDelimiterStr)
 			}
 		}
 	}
diff --git a/redirect.go b/redirect.go
@@ -249,10 +249,10 @@ func (r *Redirect) parseAndClearFlashMessages() {
 	for {
 		commaPos = findNextNonEscapedCharsetPosition(cookieValue, []byte(CookieDataSeparator))
 		if commaPos == -1 {
-			r.c.redirectionMessages = append(r.c.redirectionMessages, strings.Trim(cookieValue, " "))
+			r.c.redirectionMessages = append(r.c.redirectionMessages, utils.Trim(cookieValue, ' '))
 			break
 		}
-		r.c.redirectionMessages = append(r.c.redirectionMessages, strings.Trim(cookieValue[:commaPos], " "))
+		r.c.redirectionMessages = append(r.c.redirectionMessages, utils.Trim(cookieValue[:commaPos], ' '))
 		cookieValue = cookieValue[commaPos+1:]
 	}
 
diff --git a/router.go b/router.go

Original file line number	Diff line number	Diff line change
`@@ -778,7 +778,7 @@ iploop:`
`778`	`778`	`i++`
`779`	`779`	`}`
`780`	`780`
`781`		`- s := strings.TrimRight(headerValue[i:j], " ")`
	`781`	`+ s := utils.TrimRight(headerValue[i:j], ' ')`
`782`	`782`
`783`	`783`	`if c.app.config.EnableIPValidation {`
`784`	`784`	`// Skip validation if IP is clearly not IPv4/IPv6, otherwise validate without allocations`
`@@ -828,7 +828,7 @@ func (c *DefaultCtx) extractIPFromHeader(header string) string {`
`828`	`828`	`i++`
`829`	`829`	`}`
`830`	`830`
`831`		`- s := strings.TrimRight(headerValue[i:j], " ")`
	`831`	`+ s := utils.TrimRight(headerValue[i:j], ' ')`
`832`	`832`
`833`	`833`	`if c.app.config.EnableIPValidation {`
`834`	`834`	`if (!v6 && !v4) \|\| (v6 && !utils.IsIPv6(s)) \|\| (v4 && !utils.IsIPv4(s)) {`
`@@ -862,7 +862,7 @@ func (c *DefaultCtx) Is(extension string) bool {`
`862`	`862`	`}`
`863`	`863`
`864`	`864`	`return strings.HasPrefix(`
`865`		`- strings.TrimLeft(utils.UnsafeString(c.fasthttp.Request.Header.ContentType()), " "),`
	`865`	`+ utils.TrimLeft(utils.UnsafeString(c.fasthttp.Request.Header.ContentType()), ' '),`
`866`	`866`	`extensionHeader,`
`867`	`867`	`)`
`868`	`868`	`}`
`@@ -939,7 +939,7 @@ func (c *DefaultCtx) Links(link ...string) {`
`939`	`939`	bb.WriteString(`; rel="` + link[i] + `",`)
`940`	`940`	`}`
`941`	`941`	`}`
`942`		`- c.setCanonical(HeaderLink, strings.TrimRight(c.app.getString(bb.Bytes()), ","))`
	`942`	`+ c.setCanonical(HeaderLink, utils.TrimRight(c.app.getString(bb.Bytes()), ','))`
`943`	`943`	`bytebufferpool.Put(bb)`
`944`	`944`	`}`
`945`	`945`
`@@ -1810,7 +1810,7 @@ func (c *DefaultCtx) configDependentPaths() {`
`1810`	`1810`	`}`
`1811`	`1811`	`// If StrictRouting is disabled, we strip all trailing slashes`
`1812`	`1812`	`if !c.app.config.StrictRouting && len(c.detectionPathBuffer) > 1 && c.detectionPathBuffer[len(c.detectionPathBuffer)-1] == '/' {`
`1813`		`- c.detectionPathBuffer = bytes.TrimRight(c.detectionPathBuffer, "/")`
	`1813`	`+ c.detectionPathBuffer = utils.TrimRight(c.detectionPathBuffer, '/')`
`1814`	`1814`	`}`
`1815`	`1815`	`c.detectionPath = c.app.getString(c.detectionPathBuffer)`
`1816`	`1816`
Original file line number	Diff line number	Diff line change
`@@ -222,7 +222,7 @@ func getGroupPath(prefix, path string) string {`
`222`	`222`	`path = "/" + path`
`223`	`223`	`}`
`224`	`224`
`225`		`- return strings.TrimRight(prefix, "/") + path`
	`225`	`+ return utils.TrimRight(prefix, '/') + path`
`226`	`226`	`}`
`227`	`227`
`228`	`228`	`// acceptsOffer This function determines if an offer matches a given specification.`
`@@ -336,7 +336,7 @@ func getSplicedStrList(headerValue string, dst []string) []string {`
`336`	`336`	`dst = make([]string, len(dst)+(len(dst)>>1)+2)`
`337`	`337`	`copy(dst, oldSlice)`
`338`	`338`	`}`
`339`		`- dst[insertIndex] = strings.TrimLeft(headerValue[lastElementEndsAt:index], " ")`
	`339`	`+ dst[insertIndex] = utils.TrimLeft(headerValue[lastElementEndsAt:index], ' ')`
`340`	`340`	`lastElementEndsAt = uint8(index + 1)`
`341`	`341`	`insertIndex++`
`342`	`342`	`}`
`@@ -356,7 +356,7 @@ func forEachMediaRange(header []byte, functor func([]byte)) {`
`356`	`356`
`357`	`357`	`for len(header) > 0 {`
`358`	`358`	`n := 0`
`359`		`- header = bytes.TrimLeft(header, " ")`
	`359`	`+ header = utils.TrimLeft(header, ' ')`
`360`	`360`	`quotes := 0`
`361`	`361`	`escaping := false`
`362`	`362`
`@@ -459,7 +459,7 @@ func getOffer(header []byte, isAccepted func(spec, offer string, specParams head`
`459`	`459`	`}`
`460`	`460`	`}`
`461`	`461`
`462`		`- spec = bytes.TrimSpace(spec)`
	`462`	`+ spec = utils.Trim(spec, ' ')`
`463`	`463`
`464`	`464`	`// Determine specificity`
`465`	`465`	`var specificity int`