Small code refactor

Author: Sergio Andres Virviescas Santana

path.go

@@ -6,6 +6,7 @@
 package router
 
 import (
+	"strings"
 	"sync"
 
 	"github.com/savsgio/gotils"
@@ -142,3 +143,33 @@ func cleanPathWithBuffer(cpb *cleanPathBuffer, path string) {
 
 	cpb.buf = cpb.buf[:cpb.w]
 }
+
+// returns all possible paths when the original path has optional arguments
+func getOptionalPaths(path string) []string {
+	paths := make([]string, 0)
+
+	index := 0
+	newParam := false
+	for i := 0; i < len(path); i++ {
+		c := path[i]
+
+		if c == ':' {
+			index = i
+			newParam = true
+		} else if i > 0 && newParam && c == '?' {
+			p := strings.Replace(path[:index], "?", "", -1)
+			if !gotils.StringSliceInclude(paths, p) {
+				paths = append(paths, p)
+			}
+
+			p = strings.Replace(path[:i], "?", "", -1) + "/"
+			if !gotils.StringSliceInclude(paths, p) {
+				paths = append(paths, p)
+			}
+
+			newParam = false
+		}
+	}
+
+	return paths
+}

path_test.go

@@ -8,6 +8,8 @@ package router
 import (
 	"runtime"
 	"testing"
+
+	"github.com/valyala/fasthttp"
 )
 
 var cleanTests = []struct {
@@ -91,6 +93,33 @@ func TestPathCleanMallocs(t *testing.T) {
 	}
 }
 
+func TestGetOptionalPath(t *testing.T) {
+	handler := func(ctx *fasthttp.RequestCtx) {
+		ctx.SetStatusCode(fasthttp.StatusOK)
+	}
+
+	expectedPaths := []string{
+		"/show/:name/",
+		"/show/:name/:surname/",
+		"/show/:name/:surname/at/",
+		"/show/:name/:surname/at/:address/",
+		"/show/:name/:surname/at/:address/:id/",
+		"/show/:name/:surname/at/:address/:id/:phone/",
+	}
+	r := New()
+	r.GET("/show/:name/:surname?/at/:address?/:id/:phone?", handler)
+
+	for _, path := range expectedPaths {
+		ctx := new(fasthttp.RequestCtx)
+
+		h, _ := r.Lookup("GET", path, ctx)
+
+		if h == nil {
+			t.Errorf("Expected optional path '%s' is not registered", path)
+		}
+	}
+}
+
 func BenchmarkCleanPathWithBuffer(b *testing.B) {
 	path := "/../bench/"
 	cpb := acquireCleanPathBuffer()

router.go

@@ -159,14 +159,10 @@ func New() *Router {
 // Group returns a new grouped Router.
 // Path auto-correction, including trailing slashes, is enabled by default.
 func (r *Router) Group(path string) *Router {
-	g := &Router{
-		parent:                 r,
-		beginPath:              path,
-		RedirectTrailingSlash:  true,
-		RedirectFixedPath:      true,
-		HandleMethodNotAllowed: true,
-		HandleOPTIONS:          true,
-	}
+	g := New()
+	g.parent = r
+	g.beginPath = path
+
 	return g
 }
 
@@ -205,36 +201,6 @@ func (r *Router) DELETE(path string, handle fasthttp.RequestHandler) {
 	r.Handle("DELETE", path, handle)
 }
 
-// returns all possible paths when the original path has optional arguments
-func getOptionalPaths(path string) []string {
-	paths := make([]string, 0)
-
-	index := 0
-	newParam := false
-	for i := 0; i < len(path); i++ {
-		c := path[i]
-
-		if c == ':' {
-			index = i
-			newParam = true
-		} else if i > 0 && newParam && c == '?' {
-			p := strings.Replace(path[:index], "?", "", -1)
-			if !gotils.StringSliceInclude(paths, p) {
-				paths = append(paths, p)
-			}
-
-			p = strings.Replace(path[:i], "?", "", -1) + "/"
-			if !gotils.StringSliceInclude(paths, p) {
-				paths = append(paths, p)
-			}
-
-			newParam = false
-		}
-	}
-
-	return paths
-}
-
 // Handle registers a new request handle with the given path and method.
 //
 // For GET, POST, PUT, PATCH and DELETE requests the respective shortcut
@@ -344,12 +310,6 @@ func (r *Router) ServeFilesCustom(path string, fs *fasthttp.FS) {
 	})
 }
 
-func (r *Router) recv(ctx *fasthttp.RequestCtx) {
-	if rcv := recover(); rcv != nil {
-		r.PanicHandler(ctx, rcv)
-	}
-}
-
 // Lookup allows the manual lookup of a method + path combo.
 // This is e.g. useful to build a framework around this router.
 // If the path was found, it returns the handle function and the path parameter
@@ -362,44 +322,6 @@ func (r *Router) Lookup(method, path string, ctx *fasthttp.RequestCtx) (fasthttp
 	return nil, false
 }
 
-func (r *Router) allowed(path, reqMethod string) (allow string) {
-	if path == "*" || path == "/*" { // server-wide
-		for method := range r.trees {
-			if method == "OPTIONS" {
-				continue
-			}
-
-			// add request method to list of allowed methods
-			if len(allow) == 0 {
-				allow = method
-			} else {
-				allow += ", " + method
-			}
-		}
-	} else { // specific path
-		for method := range r.trees {
-			// Skip the requested method - we already tried this one
-			if method == reqMethod || method == "OPTIONS" {
-				continue
-			}
-
-			handle, _ := r.trees[method].getValue(path, nil)
-			if handle != nil {
-				// add request method to list of allowed methods
-				if len(allow) == 0 {
-					allow = method
-				} else {
-					allow += ", " + method
-				}
-			}
-		}
-	}
-	if len(allow) > 0 {
-		allow += ", OPTIONS"
-	}
-	return
-}
-
 // Handler makes the router implement the fasthttp.ListenAndServe interface.
 func (r *Router) Handler(ctx *fasthttp.RequestCtx) {
 	if r.PanicHandler != nil {
@@ -495,3 +417,47 @@ func (r *Router) Handler(ctx *fasthttp.RequestCtx) {
 		ctx.Error(fasthttp.StatusMessage(fasthttp.StatusNotFound), fasthttp.StatusNotFound)
 	}
 }
+
+func (r *Router) allowed(path, reqMethod string) (allow string) {
+	if path == "*" || path == "/*" { // server-wide
+		for method := range r.trees {
+			if method == "OPTIONS" {
+				continue
+			}
+
+			// add request method to list of allowed methods
+			if len(allow) == 0 {
+				allow = method
+			} else {
+				allow += ", " + method
+			}
+		}
+	} else { // specific path
+		for method := range r.trees {
+			// Skip the requested method - we already tried this one
+			if method == reqMethod || method == "OPTIONS" {
+				continue
+			}
+
+			handle, _ := r.trees[method].getValue(path, nil)
+			if handle != nil {
+				// add request method to list of allowed methods
+				if len(allow) == 0 {
+					allow = method
+				} else {
+					allow += ", " + method
+				}
+			}
+		}
+	}
+	if len(allow) > 0 {
+		allow += ", OPTIONS"
+	}
+	return
+}
+
+func (r *Router) recv(ctx *fasthttp.RequestCtx) {
+	if rcv := recover(); rcv != nil {
+		r.PanicHandler(ctx, rcv)
+	}
+}

router_test.go

@@ -223,33 +223,6 @@ func TestRouterRoot(t *testing.T) {
 	}
 }
 
-func TestRouterOptionalPathArgs(t *testing.T) {
-	handler := func(ctx *fasthttp.RequestCtx) {
-		ctx.SetStatusCode(fasthttp.StatusOK)
-	}
-
-	expectedPaths := []string{
-		"/show/:name/",
-		"/show/:name/:surname/",
-		"/show/:name/:surname/at/",
-		"/show/:name/:surname/at/:address/",
-		"/show/:name/:surname/at/:address/:id/",
-		"/show/:name/:surname/at/:address/:id/:phone/",
-	}
-	r := New()
-	r.GET("/show/:name/:surname?/at/:address?/:id/:phone?", handler)
-
-	for _, path := range expectedPaths {
-		ctx := new(fasthttp.RequestCtx)
-
-		h, _ := r.Lookup("GET", path, ctx)
-
-		if h == nil {
-			t.Errorf("Expected optional path '%s' is not registered", path)
-		}
-	}
-}
-
 func TestRouterChaining(t *testing.T) {
 	r1 := New()
 	r2 := New()

tree.go

@@ -14,10 +14,30 @@ import (
 	"github.com/valyala/fasthttp"
 )
 
+const (
+	static nodeType = iota // default
+	root
+	param
+	catchAll
+)
+
+type nodeType uint8
+
 type buffer struct {
 	b []byte
 }
 
+type node struct {
+	path      string
+	wildChild bool
+	nType     nodeType
+	maxParams uint8
+	indices   string
+	children  []*node
+	handle    fasthttp.RequestHandler
+	priority  uint32
+}
+
 var bufferPool = sync.Pool{
 	New: func() interface{} {
 		return &buffer{
@@ -55,24 +75,20 @@ func countParams(path string) uint8 {
 	return uint8(n)
 }
 
-type nodeType uint8
-
-const (
-	static nodeType = iota // default
-	root
-	param
-	catchAll
-)
-
-type node struct {
-	path      string
-	wildChild bool
-	nType     nodeType
-	maxParams uint8
-	indices   string
-	children  []*node
-	handle    fasthttp.RequestHandler
-	priority  uint32
+// shift bytes in array by n bytes left
+func shiftNRuneBytes(rb [4]byte, n int) [4]byte {
+	switch n {
+	case 0:
+		return rb
+	case 1:
+		return [4]byte{rb[1], rb[2], rb[3], 0}
+	case 2:
+		return [4]byte{rb[2], rb[3]}
+	case 3:
+		return [4]byte{rb[3]}
+	default:
+		return [4]byte{}
+	}
 }
 
 // increments priority of the given child and reorders if necessary
@@ -482,22 +498,6 @@ func (n *node) findCaseInsensitivePath(path string, fixTrailingSlash bool) ([]by
 	return fixedPath, found
 }
 
-// shift bytes in array by n bytes left
-func shiftNRuneBytes(rb [4]byte, n int) [4]byte {
-	switch n {
-	case 0:
-		return rb
-	case 1:
-		return [4]byte{rb[1], rb[2], rb[3], 0}
-	case 2:
-		return [4]byte{rb[2], rb[3]}
-	case 3:
-		return [4]byte{rb[3]}
-	default:
-		return [4]byte{}
-	}
-}
-
 // recursive case-insensitive lookup function used by n.findCaseInsensitivePath
 func (n *node) findCaseInsensitivePathRec(path, loPath string, ciPath []byte, rb [4]byte, fixTrailingSlash bool) ([]byte, bool) {
 	loNPath := toLower(n.path)