✨feature: print all routes message when server starts (#1677)

* ✨feature: print all routes message when server starts

* ✨feature: print all routes message when server starts

* ✨feature:  print all routes message when server starts

* 🐛fix: errors unhandled

* 🐛fix: ignore child process and add some "-" to the table head

* 🐛fix: add printRoutesMessage for listener and listenTLS

app.go

@@ -20,10 +20,12 @@ import (
 	"os"
 	"reflect"
 	"runtime"
+	"sort"
 	"strconv"
 	"strings"
 	"sync"
 	"sync/atomic"
+	"text/tabwriter"
 	"time"
 
 	"github.com/gofiber/fiber/v2/internal/colorable"
@@ -350,6 +352,10 @@ type Config struct {
 	// Default: []string
 	TrustedProxies    []string `json:"trusted_proxies"`
 	trustedProxiesMap map[string]struct{}
+
+	//If set to true, will print all routes with their method, path and handler.
+	// Default: false
+	EnablePrintRoutes bool `json:"print_routes"`
 }
 
 // Static defines configuration options when defining static assets.
@@ -389,6 +395,14 @@ type Static struct {
 	Next func(c *Ctx) bool
 }
 
+// RouteMessage is some message need to be print when server starts
+type RouteMessage struct {
+	name     string
+	method   string
+	path     string
+	handlers string
+}
+
 // Default Config values
 const (
 	DefaultBodyLimit            = 4 * 1024 * 1024
@@ -713,6 +727,10 @@ func (app *App) Listener(ln net.Listener) error {
 	if !app.config.DisableStartupMessage {
 		app.startupMessage(ln.Addr().String(), getTlsConfig(ln) != nil, "")
 	}
+	// Print routes
+	if app.config.EnablePrintRoutes {
+		app.printRoutesMessage()
+	}
 	// Start listening
 	return app.server.Serve(ln)
 }
@@ -737,6 +755,10 @@ func (app *App) Listen(addr string) error {
 	if !app.config.DisableStartupMessage {
 		app.startupMessage(ln.Addr().String(), false, "")
 	}
+	// Print routes
+	if app.config.EnablePrintRoutes {
+		app.printRoutesMessage()
+	}
 	// Start listening
 	return app.server.Serve(ln)
 }
@@ -777,6 +799,10 @@ func (app *App) ListenTLS(addr, certFile, keyFile string) error {
 	if !app.config.DisableStartupMessage {
 		app.startupMessage(ln.Addr().String(), true, "")
 	}
+	// Print routes
+	if app.config.EnablePrintRoutes {
+		app.printRoutesMessage()
+	}
 	// Start listening
 	return app.server.ServeTLS(ln, certFile, keyFile)
 }
@@ -1198,3 +1224,51 @@ func (app *App) startupMessage(addr string, tls bool, pids string) {
 
 	_, _ = fmt.Fprintln(out, output)
 }
+
+// printRoutesMessage print all routes with method, path, name and handlers
+// in a format of table, like this:
+// method | path | name      | handlers
+// GET    | /    | routeName | github.com/gofiber/fiber/v2.emptyHandler
+// HEAD   | /    |           | github.com/gofiber/fiber/v2.emptyHandler
+func (app *App) printRoutesMessage() {
+	// ignore child processes
+	if IsChild() {
+		return
+	}
+
+	const (
+		// cBlack = "\u001b[90m"
+		// cRed   = "\u001b[91m"
+		cCyan   = "\u001b[96m"
+		cGreen  = "\u001b[92m"
+		cYellow = "\u001b[93m"
+		cBlue   = "\u001b[94m"
+		// cMagenta = "\u001b[95m"
+		cWhite = "\u001b[97m"
+		// cReset = "\u001b[0m"
+	)
+	var routes []RouteMessage
+	for _, routeStack := range app.stack {
+		for _, route := range routeStack {
+			var newRoute = RouteMessage{}
+			newRoute.name = route.Name
+			newRoute.method = route.Method
+			newRoute.path = route.Path
+			for _, handler := range route.Handlers {
+				newRoute.handlers += runtime.FuncForPC(reflect.ValueOf(handler).Pointer()).Name() + " "
+			}
+			routes = append(routes, newRoute)
+		}
+	}
+	w := tabwriter.NewWriter(os.Stdout, 1, 1, 1, ' ', 0)
+	// Sort routes by path
+	sort.Slice(routes, func(i, j int) bool {
+		return routes[i].path < routes[j].path
+	})
+	_, _ = fmt.Fprintf(w, "%smethod\t%s| %spath\t%s| %sname\t%s| %shandlers\n", cBlue, cWhite, cGreen, cWhite, cCyan, cWhite, cYellow)
+	_, _ = fmt.Fprintf(w, "%s------\t%s| %s----\t%s| %s----\t%s| %s--------\n", cBlue, cWhite, cGreen, cWhite, cCyan, cWhite, cYellow)
+	for _, route := range routes {
+		_, _ = fmt.Fprintf(w, "%s%s\t%s| %s%s\t%s| %s%s\t%s| %s%s\n", cBlue, route.method, cWhite, cGreen, route.path, cWhite, cCyan, route.name, cWhite, cYellow, route.handlers)
+	}
+	_ = w.Flush()
+}

app_test.go

@@ -1576,3 +1576,40 @@ func Test_App_UseMountedErrorHandlerForBestPrefixMatch(t *testing.T) {
 	utils.AssertEqual(t, nil, err, "iotuil.ReadAll()")
 	utils.AssertEqual(t, "hi, i'm a custom sub sub fiber error", string(b), "Third fiber Response body")
 }
+
+func emptyHandler(c *Ctx) error {
+	return nil
+}
+func Test_App_print_Route(t *testing.T) {
+	app := New(Config{EnablePrintRoutes: true})
+	app.Get("/", emptyHandler).Name("routeName")
+	printRoutesMessage := captureOutput(func() {
+		app.printRoutesMessage()
+	})
+	fmt.Println(printRoutesMessage)
+	utils.AssertEqual(t, true, strings.Contains(printRoutesMessage, "GET"))
+	utils.AssertEqual(t, true, strings.Contains(printRoutesMessage, "/"))
+	utils.AssertEqual(t, true, strings.Contains(printRoutesMessage, "emptyHandler"))
+	utils.AssertEqual(t, true, strings.Contains(printRoutesMessage, "routeName"))
+}
+
+func Test_App_print_Route_with_group(t *testing.T) {
+	app := New(Config{EnablePrintRoutes: true})
+	app.Get("/", emptyHandler)
+	v1 := app.Group("v1")
+	v1.Get("/test", emptyHandler).Name("v1")
+	v1.Post("/test/fiber", emptyHandler)
+	v1.Put("/test/fiber/*", emptyHandler)
+	printRoutesMessage := captureOutput(func() {
+		app.printRoutesMessage()
+	})
+	fmt.Println(printRoutesMessage)
+	utils.AssertEqual(t, true, strings.Contains(printRoutesMessage, "GET"))
+	utils.AssertEqual(t, true, strings.Contains(printRoutesMessage, "/"))
+	utils.AssertEqual(t, true, strings.Contains(printRoutesMessage, "emptyHandler"))
+	utils.AssertEqual(t, true, strings.Contains(printRoutesMessage, "/v1/test"))
+	utils.AssertEqual(t, true, strings.Contains(printRoutesMessage, "POST"))
+	utils.AssertEqual(t, true, strings.Contains(printRoutesMessage, "/v1/test/fiber"))
+	utils.AssertEqual(t, true, strings.Contains(printRoutesMessage, "PUT"))
+	utils.AssertEqual(t, true, strings.Contains(printRoutesMessage, "/v1/test/fiber/*"))
+}

internal/colorable/colorable_appengine.go

@@ -1,3 +1,4 @@
+//go:build appengine
 // +build appengine
 
 package colorable

internal/colorable/colorable_others.go

@@ -1,5 +1,5 @@
-// +build !windows
+//go:build !windows && !appengine
-// +build !appengine
+// +build !windows,!appengine
 
 package colorable
 

internal/colorable/colorable_windows.go

@@ -1,5 +1,5 @@
-// +build windows
+//go:build windows && !appengine
-// +build !appengine
+// +build windows,!appengine
 
 package colorable
 

internal/fasttemplate/unsafe.go

@@ -1,3 +1,4 @@
+//go:build !appengine
 // +build !appengine
 
 package fasttemplate

internal/fasttemplate/unsafe_gae.go

@@ -1,3 +1,4 @@
+//go:build appengine
 // +build appengine
 
 package fasttemplate

internal/fwd/writer_appengine.go

@@ -1,3 +1,4 @@
+//go:build appengine
 // +build appengine
 
 package fwd

internal/fwd/writer_unsafe.go

@@ -1,3 +1,4 @@
+//go:build !appengine
 // +build !appengine
 
 package fwd

internal/go-ole/com.go

@@ -1,3 +1,4 @@
+//go:build windows
 // +build windows
 
 package ole

internal/go-ole/com_func.go

@@ -1,3 +1,4 @@
+//go:build !windows
 // +build !windows
 
 package ole

internal/go-ole/error_func.go

@@ -1,3 +1,4 @@
+//go:build !windows
 // +build !windows
 
 package ole

internal/go-ole/error_windows.go

@@ -1,3 +1,4 @@
+//go:build windows
 // +build windows
 
 package ole

internal/go-ole/iconnectionpoint_func.go

@@ -1,3 +1,4 @@
+//go:build !windows
 // +build !windows
 
 package ole

internal/go-ole/iconnectionpoint_windows.go

@@ -1,3 +1,4 @@
+//go:build windows
 // +build windows
 
 package ole

internal/go-ole/iconnectionpointcontainer_func.go

@@ -1,3 +1,4 @@
+//go:build !windows
 // +build !windows
 
 package ole

internal/go-ole/iconnectionpointcontainer_windows.go

@@ -1,3 +1,4 @@
+//go:build windows
 // +build windows
 
 package ole

internal/go-ole/idispatch_func.go

@@ -1,3 +1,4 @@
+//go:build !windows
 // +build !windows
 
 package ole

internal/go-ole/idispatch_windows.go

@@ -1,3 +1,4 @@
+//go:build windows
 // +build windows
 
 package ole

internal/go-ole/ienumvariant_func.go

@@ -1,3 +1,4 @@
+//go:build !windows
 // +build !windows
 
 package ole

internal/go-ole/ienumvariant_windows.go

@@ -1,3 +1,4 @@
+//go:build windows
 // +build windows
 
 package ole

internal/go-ole/iinspectable_func.go

@@ -1,3 +1,4 @@
+//go:build !windows
 // +build !windows
 
 package ole

internal/go-ole/iinspectable_windows.go

@@ -1,3 +1,4 @@
+//go:build windows
 // +build windows
 
 package ole

internal/go-ole/iprovideclassinfo_func.go

@@ -1,3 +1,4 @@
+//go:build !windows
 // +build !windows
 
 package ole

internal/go-ole/iprovideclassinfo_windows.go

@@ -1,3 +1,4 @@
+//go:build windows
 // +build windows
 
 package ole

internal/go-ole/itypeinfo_func.go

@@ -1,3 +1,4 @@
+//go:build !windows
 // +build !windows
 
 package ole

internal/go-ole/itypeinfo_windows.go

@@ -1,3 +1,4 @@
+//go:build windows
 // +build windows
 
 package ole

internal/go-ole/iunknown_func.go

@@ -1,3 +1,4 @@
+//go:build !windows
 // +build !windows
 
 package ole

internal/go-ole/iunknown_windows.go

@@ -1,3 +1,4 @@
+//go:build windows
 // +build windows
 
 package ole

internal/go-ole/oleutil/connection.go

@@ -1,3 +1,4 @@
+//go:build windows
 // +build windows
 
 package oleutil

internal/go-ole/oleutil/connection_func.go

@@ -1,3 +1,4 @@
+//go:build !windows
 // +build !windows
 
 package oleutil

internal/go-ole/oleutil/connection_windows.go

@@ -1,3 +1,4 @@
+//go:build windows
 // +build windows
 
 package oleutil

internal/go-ole/oleutil/go-get.go

@@ -1,6 +1,7 @@
 // This file is here so go get succeeds as without it errors with:
 // no buildable Go source files in ...
 //
+//go:build !windows
 // +build !windows
 
 package oleutil

internal/go-ole/safearray_func.go

@@ -1,3 +1,4 @@
+//go:build !windows
 // +build !windows
 
 package ole

internal/go-ole/safearray_windows.go

@@ -1,3 +1,4 @@
+//go:build windows
 // +build windows
 
 package ole

internal/go-ole/safearrayslices.go

@@ -1,3 +1,4 @@
+//go:build windows
 // +build windows
 
 package ole

internal/go-ole/variables.go

@@ -1,3 +1,4 @@
+//go:build windows
 // +build windows
 
 package ole

internal/go-ole/variant_386.go

@@ -1,3 +1,4 @@
+//go:build 386
 // +build 386
 
 package ole

internal/go-ole/variant_amd64.go

@@ -1,3 +1,4 @@
+//go:build amd64
 // +build amd64
 
 package ole

internal/go-ole/variant_date_386.go

@@ -1,3 +1,4 @@
+//go:build windows && 386
 // +build windows,386
 
 package ole

internal/go-ole/variant_date_amd64.go

@@ -1,3 +1,4 @@
+//go:build windows && amd64
 // +build windows,amd64
 
 package ole

internal/go-ole/variant_ppc64le.go

@@ -1,3 +1,4 @@
+//go:build ppc64le
 // +build ppc64le
 
 package ole

internal/go-ole/variant_s390x.go

@@ -1,3 +1,4 @@
+//go:build s390x
 // +build s390x
 
 package ole

internal/go-ole/winrt.go

@@ -1,3 +1,4 @@
+//go:build windows
 // +build windows
 
 package ole

internal/go-ole/winrt_doc.go

@@ -1,3 +1,4 @@
+//go:build !windows
 // +build !windows
 
 package ole

internal/gopsutil/common/common_darwin.go

@@ -1,3 +1,4 @@
+//go:build darwin
 // +build darwin
 
 package common

internal/gopsutil/common/common_freebsd.go

@@ -1,3 +1,4 @@
+//go:build freebsd || openbsd
 // +build freebsd openbsd
 
 package common

internal/gopsutil/common/common_linux.go

@@ -1,3 +1,4 @@
+//go:build linux
 // +build linux
 
 package common

internal/gopsutil/common/common_openbsd.go

@@ -1,3 +1,4 @@
+//go:build openbsd
 // +build openbsd
 
 package common

internal/gopsutil/common/common_unix.go

@@ -1,3 +1,4 @@
+//go:build linux || freebsd || darwin || openbsd
 // +build linux freebsd darwin openbsd
 
 package common

internal/gopsutil/cpu/cpu_darwin.go

@@ -1,3 +1,4 @@
+//go:build darwin
 // +build darwin
 
 package cpu

internal/gopsutil/cpu/cpu_darwin_cgo.go

@@ -1,5 +1,5 @@
-// +build darwin
+//go:build darwin && cgo
-// +build cgo
+// +build darwin,cgo
 
 package cpu
 

internal/gopsutil/cpu/cpu_darwin_nocgo.go

@@ -1,5 +1,5 @@
-// +build darwin
+//go:build darwin && !cgo
-// +build !cgo
+// +build darwin,!cgo
 
 package cpu
 

internal/gopsutil/cpu/cpu_fallback.go

@@ -1,3 +1,4 @@
+//go:build !darwin && !linux && !freebsd && !openbsd && !solaris && !windows && !dragonfly
 // +build !darwin,!linux,!freebsd,!openbsd,!solaris,!windows,!dragonfly
 
 package cpu

internal/gopsutil/cpu/cpu_linux.go

@@ -1,3 +1,4 @@
+//go:build linux
 // +build linux
 
 package cpu

internal/gopsutil/cpu/cpu_openbsd.go

@@ -1,3 +1,4 @@
+//go:build openbsd
 // +build openbsd
 
 package cpu

internal/gopsutil/cpu/cpu_windows.go

@@ -1,3 +1,4 @@
+//go:build windows
 // +build windows
 
 package cpu

internal/gopsutil/load/load_bsd.go

@@ -1,3 +1,4 @@
+//go:build freebsd || openbsd
 // +build freebsd openbsd
 
 package load

internal/gopsutil/load/load_freebsd.go

@@ -1,3 +1,4 @@
+//go:build freebsd
 // +build freebsd
 
 package load

internal/gopsutil/load/load_openbsd.go

@@ -1,3 +1,4 @@
+//go:build openbsd
 // +build openbsd
 
 package load

internal/gopsutil/mem/mem_darwin.go

@@ -1,3 +1,4 @@
+//go:build darwin
 // +build darwin
 
 package mem

internal/gopsutil/mem/mem_darwin_cgo.go

@@ -1,5 +1,5 @@
-// +build darwin
+//go:build darwin && cgo
-// +build cgo
+// +build darwin,cgo
 
 package mem
 

internal/gopsutil/mem/mem_darwin_nocgo.go

@@ -1,5 +1,5 @@
-// +build darwin
+//go:build darwin && !cgo
-// +build !cgo
+// +build darwin,!cgo
 
 package mem
 

internal/gopsutil/mem/mem_fallback.go

@@ -1,3 +1,4 @@
+//go:build !darwin && !linux && !freebsd && !openbsd && !solaris && !windows
 // +build !darwin,!linux,!freebsd,!openbsd,!solaris,!windows
 
 package mem

internal/gopsutil/mem/mem_freebsd.go

@@ -1,3 +1,4 @@
+//go:build freebsd
 // +build freebsd
 
 package mem

internal/gopsutil/mem/mem_linux.go

@@ -1,3 +1,4 @@
+//go:build linux
 // +build linux
 
 package mem

internal/gopsutil/mem/mem_openbsd.go

@@ -1,3 +1,4 @@
+//go:build openbsd
 // +build openbsd
 
 package mem

internal/gopsutil/mem/mem_openbsd_386.go

@@ -1,5 +1,6 @@
-// +build openbsd
+//go:build openbsd && 386
-// +build 386
+// +build openbsd,386
+
 // Code generated by cmd/cgo -godefs; DO NOT EDIT.
 // cgo -godefs mem/types_openbsd.go
 

internal/gopsutil/mem/mem_windows.go

@@ -1,3 +1,4 @@
+//go:build windows
 // +build windows
 
 package mem

internal/gopsutil/mem/types_openbsd.go

@@ -1,3 +1,4 @@
+//go:build ignore
 // +build ignore
 
 /*

internal/gopsutil/net/net_aix.go

@@ -1,3 +1,4 @@
+//go:build aix
 // +build aix
 
 package net

internal/gopsutil/net/net_darwin.go

@@ -1,3 +1,4 @@
+//go:build darwin
 // +build darwin
 
 package net

internal/gopsutil/net/net_fallback.go

@@ -1,3 +1,4 @@
+//go:build !aix && !darwin && !linux && !freebsd && !openbsd && !windows
 // +build !aix,!darwin,!linux,!freebsd,!openbsd,!windows
 
 package net

internal/gopsutil/net/net_freebsd.go

@@ -1,3 +1,4 @@
+//go:build freebsd
 // +build freebsd
 
 package net

internal/gopsutil/net/net_linux.go

@@ -1,3 +1,4 @@
+//go:build linux
 // +build linux
 
 package net

internal/gopsutil/net/net_openbsd.go

@@ -1,3 +1,4 @@
+//go:build openbsd
 // +build openbsd
 
 package net

internal/gopsutil/net/net_unix.go

@@ -1,3 +1,4 @@
+//go:build freebsd || darwin
 // +build freebsd darwin
 
 package net

internal/gopsutil/net/net_windows.go

@@ -1,3 +1,4 @@
+//go:build windows
 // +build windows
 
 package net

internal/gopsutil/process/process_darwin.go

@@ -1,3 +1,4 @@
+//go:build darwin
 // +build darwin
 
 package process

internal/gopsutil/process/process_darwin_arm64.go

@@ -1,5 +1,6 @@
-// +build darwin
+//go:build darwin && arm64
-// +build arm64
+// +build darwin,arm64
+
 // Code generated by cmd/cgo -godefs; DO NOT EDIT.
 // cgo -godefs process/types_darwin.go
 

internal/gopsutil/process/process_darwin_cgo.go

@@ -1,5 +1,5 @@
-// +build darwin
+//go:build darwin && cgo
-// +build cgo
+// +build darwin,cgo
 
 package process
 

internal/gopsutil/process/process_darwin_nocgo.go

@@ -1,5 +1,5 @@
-// +build darwin
+//go:build darwin && !cgo
-// +build !cgo
+// +build darwin,!cgo
 
 package process
 

internal/gopsutil/process/process_fallback.go

@@ -1,3 +1,4 @@
+//go:build !darwin && !linux && !freebsd && !openbsd && !windows
 // +build !darwin,!linux,!freebsd,!openbsd,!windows
 
 package process

internal/gopsutil/process/process_freebsd.go

@@ -1,3 +1,4 @@
+//go:build freebsd
 // +build freebsd
 
 package process

internal/gopsutil/process/process_freebsd_arm64.go

@@ -1,5 +1,6 @@
-// +build freebsd
+//go:build freebsd && arm64
-// +build arm64
+// +build freebsd,arm64
+
 // Code generated by cmd/cgo -godefs; DO NOT EDIT.
 // cgo -godefs process/types_freebsd.go
 

internal/gopsutil/process/process_linux.go

@@ -1,3 +1,4 @@
+//go:build linux
 // +build linux
 
 package process

internal/gopsutil/process/process_openbsd.go

@@ -1,3 +1,4 @@
+//go:build openbsd
 // +build openbsd
 
 package process

internal/gopsutil/process/process_openbsd_386.go

@@ -1,5 +1,6 @@
-// +build openbsd
+//go:build openbsd && 386
-// +build 386
+// +build openbsd,386
+
 // Code generated by cmd/cgo -godefs; DO NOT EDIT.
 // cgo -godefs process/types_openbsd.go
 

internal/gopsutil/process/process_posix.go

@@ -1,3 +1,4 @@
+//go:build linux || freebsd || openbsd || darwin
 // +build linux freebsd openbsd darwin
 
 package process

internal/gopsutil/process/process_windows.go

@@ -1,3 +1,4 @@
+//go:build windows
 // +build windows
 
 package process

internal/gopsutil/process/process_windows_386.go

@@ -1,3 +1,4 @@
+//go:build windows
 // +build windows
 
 package process

internal/gopsutil/process/process_windows_amd64.go

@@ -1,3 +1,4 @@
+//go:build windows
 // +build windows
 
 package process

internal/gopsutil/process/types_darwin.go

@@ -5,6 +5,7 @@
 // Hand Writing
 // - all pointer in ExternProc to uint64
 
+//go:build ignore
 // +build ignore
 
 /*

internal/gopsutil/process/types_freebsd.go

@@ -1,3 +1,4 @@
+//go:build ignore
 // +build ignore
 
 // We still need editing by hands.

internal/gopsutil/process/types_openbsd.go

@@ -1,3 +1,4 @@
+//go:build ignore
 // +build ignore
 
 // We still need editing by hands.

internal/isatty/isatty_bsd.go

@@ -1,3 +1,4 @@
+//go:build (darwin || freebsd || openbsd || netbsd || dragonfly) && !appengine
 // +build darwin freebsd openbsd netbsd dragonfly
 // +build !appengine
 

internal/isatty/isatty_others.go

@@ -1,3 +1,4 @@
+//go:build appengine || js || nacl || wasm
 // +build appengine js nacl wasm
 
 package isatty

internal/isatty/isatty_plan9.go

@@ -1,3 +1,4 @@
+//go:build plan9
 // +build plan9
 
 package isatty

internal/isatty/isatty_solaris.go

@@ -1,5 +1,5 @@
-// +build solaris
+//go:build solaris && !appengine
-// +build !appengine
+// +build solaris,!appengine
 
 package isatty
 

internal/isatty/isatty_tcgets.go

@@ -1,3 +1,4 @@
+//go:build (linux || aix) && !appengine
 // +build linux aix
 // +build !appengine