// ⚑️ Fiber is an Express inspired web framework written in Go with β˜•οΈ // πŸ€– Github Repository: https://github.com/gofiber/fiber // πŸ“Œ API Documentation: https://docs.gofiber.io package fiber import ( "context" "crypto/tls" "crypto/x509" "fmt" "log" "net" "os" "path/filepath" "reflect" "runtime" "sort" "strconv" "strings" "text/tabwriter" "github.com/mattn/go-colorable" "github.com/mattn/go-isatty" ) // ListenConfig is a struct to customize startup of Fiber. // // TODO: Add timeout for graceful shutdown. type ListenConfig struct { // Known networks are "tcp", "tcp4" (IPv4-only), "tcp6" (IPv6-only) // WARNING: When prefork is set to true, only "tcp4" and "tcp6" can be chose. // // Default: NetworkTCP4 ListenerNetwork string `json:"listener_network"` // CertFile is a path of certficate file. // If you want to use TLS, you have to enter this field. // // Default : "" CertFile string `json:"cert_file"` // KeyFile is a path of certficate's private key. // If you want to use TLS, you have to enter this field. // // Default : "" CertKeyFile string `json:"cert_key_file"` // CertClientFile is a path of client certficate. // If you want to use mTLS, you have to enter this field. // // Default : "" CertClientFile string `json:"cert_client_file"` // GracefulContext is a field to shutdown Fiber by given context gracefully. // // Default: nil GracefulContext context.Context `json:"graceful_context"` // TLSConfigFunc allows customizing tls.Config as you want. // // Default: nil TLSConfigFunc func(tlsConfig *tls.Config) `json:"tls_config_func"` // ListenerFunc allows accessing and customizing net.Listener. // // Default: nil ListenerAddrFunc func(addr net.Addr) `json:"listener_addr_func"` // BeforeServeFunc allows customizing and accessing fiber app before serving the app. // // Default: nil BeforeServeFunc func(app *App) error `json:"before_serve_func"` // When set to true, it will not print out the Β«FiberΒ» ASCII art and listening address. // // Default: false DisableStartupMessage bool `json:"disable_startup_message"` // When set to true, this will spawn multiple Go processes listening on the same port. // // Default: false EnablePrefork bool `json:"enable_prefork"` // If set to true, will print all routes with their method, path and handler. // // Default: false EnablePrintRoutes bool `json:"enable_print_routes"` // OnShutdownError allows to customize error behavior when to graceful shutdown server by given signal. // // Default: Print error with log.Fatalf() OnShutdownError func(err error) // OnShutdownSuccess allows to customize success behavior when to graceful shutdown server by given signal. // // Default: nil OnShutdownSuccess func() } // listenConfigDefault is a function to set default values of ListenConfig. func listenConfigDefault(config ...ListenConfig) ListenConfig { if len(config) < 1 { return ListenConfig{ ListenerNetwork: NetworkTCP4, OnShutdownError: func(err error) { log.Fatalf("shutdown: %v", err) }, } } cfg := config[0] if cfg.ListenerNetwork == "" { cfg.ListenerNetwork = NetworkTCP4 } if cfg.OnShutdownError == nil { cfg.OnShutdownError = func(err error) { log.Fatalf("shutdown: %v", err) } } return cfg } // Listen serves HTTP requests from the given addr. // You should enter custom ListenConfig to customize startup. (TLS, mTLS, prefork...) // // app.Listen(":8080") // app.Listen("127.0.0.1:8080") // app.Listen(":8080", ListenConfig{EnablePrefork: true}) func (app *App) Listen(addr string, config ...ListenConfig) error { cfg := listenConfigDefault(config...) // Configure TLS var tlsConfig *tls.Config = nil if cfg.CertFile != "" && cfg.CertKeyFile != "" { cert, err := tls.LoadX509KeyPair(cfg.CertFile, cfg.CertKeyFile) if err != nil { return fmt.Errorf("tls: cannot load TLS key pair from certFile=%q and keyFile=%q: %s", cfg.CertFile, cfg.CertKeyFile, err) } tlsHandler := &TLSHandler{} tlsConfig = &tls.Config{ MinVersion: tls.VersionTLS12, Certificates: []tls.Certificate{ cert, }, GetCertificate: tlsHandler.GetClientInfo, } if cfg.CertClientFile != "" { clientCACert, err := os.ReadFile(filepath.Clean(cfg.CertClientFile)) if err != nil { return err } clientCertPool := x509.NewCertPool() clientCertPool.AppendCertsFromPEM(clientCACert) tlsConfig.ClientAuth = tls.RequireAndVerifyClientCert tlsConfig.ClientCAs = clientCertPool } // Attach the tlsHandler to the config app.SetTLSHandler(tlsHandler) } if cfg.TLSConfigFunc != nil { cfg.TLSConfigFunc(tlsConfig) } // Graceful shutdown if cfg.GracefulContext != nil { ctx, cancel := context.WithCancel(cfg.GracefulContext) defer cancel() go app.gracefulShutdown(ctx, cfg) } // Start prefork if cfg.EnablePrefork { return app.prefork(addr, tlsConfig, cfg) } // Configure Listener ln, err := app.createListener(addr, tlsConfig, cfg) if err != nil { return err } // prepare the server for the start app.startupProcess() // Print startup message & routes app.printMessages(cfg, ln) // Serve if cfg.BeforeServeFunc != nil { if err := cfg.BeforeServeFunc(app); err != nil { return err } } return app.server.Serve(ln) } // Listener serves HTTP requests from the given listener. // You should enter custom ListenConfig to customize startup. (prefork, startup message, graceful shutdown...) func (app *App) Listener(ln net.Listener, config ...ListenConfig) error { cfg := listenConfigDefault(config...) // Graceful shutdown if cfg.GracefulContext != nil { ctx, cancel := context.WithCancel(cfg.GracefulContext) defer cancel() go app.gracefulShutdown(ctx, cfg) } // prepare the server for the start app.startupProcess() // Print startup message & routes app.printMessages(cfg, ln) // Serve if cfg.BeforeServeFunc != nil { if err := cfg.BeforeServeFunc(app); err != nil { return err } } // Prefork is not supported for custom listeners if cfg.EnablePrefork { fmt.Println("[Warning] Prefork isn't supported for custom listeners.") } return app.server.Serve(ln) } // Create listener function. func (app *App) createListener(addr string, tlsConfig *tls.Config, cfg ListenConfig) (net.Listener, error) { var listener net.Listener var err error if tlsConfig != nil { listener, err = tls.Listen(cfg.ListenerNetwork, addr, tlsConfig) } else { listener, err = net.Listen(cfg.ListenerNetwork, addr) } if cfg.ListenerAddrFunc != nil { cfg.ListenerAddrFunc(listener.Addr()) } return listener, err } func (app *App) printMessages(cfg ListenConfig, ln net.Listener) { // Print startup message if !cfg.DisableStartupMessage { app.startupMessage(ln.Addr().String(), getTlsConfig(ln) != nil, "", cfg) } // Print routes if cfg.EnablePrintRoutes { app.printRoutesMessage() } } // startupMessage prepares the startup message with the handler number, port, address and other information func (app *App) startupMessage(addr string, tls bool, pids string, cfg ListenConfig) { // ignore child processes if IsChild() { return } // Alias colors colors := app.config.ColorScheme value := func(s string, width int) string { pad := width - len(s) str := "" for i := 0; i < pad; i++ { str += "." } if s == "Disabled" { str += " " + s } else { str += fmt.Sprintf(" %s%s%s", colors.Cyan, s, colors.Black) } return str } center := func(s string, width int) string { pad := strconv.Itoa((width - len(s)) / 2) str := fmt.Sprintf("%"+pad+"s", " ") str += s str += fmt.Sprintf("%"+pad+"s", " ") if len(str) < width { str += " " } return str } centerValue := func(s string, width int) string { pad := strconv.Itoa((width - len([]rune(s))) / 2) str := fmt.Sprintf("%"+pad+"s", " ") str += fmt.Sprintf("%s%s%s", colors.Cyan, s, colors.Black) str += fmt.Sprintf("%"+pad+"s", " ") if len([]rune(s))-10 < width && len([]rune(s))%2 == 0 { // add an ending space if the length of str is even and str is not too long str += " " } return str } pad := func(s string, width int) (str string) { toAdd := width - len(s) str += s for i := 0; i < toAdd; i++ { str += " " } return } host, port := parseAddr(addr) if host == "" { if cfg.ListenerNetwork == NetworkTCP6 { host = "[::1]" } else { host = "0.0.0.0" } } scheme := "http" if tls { scheme = "https" } isPrefork := "Disabled" if cfg.EnablePrefork { isPrefork = "Enabled" } procs := strconv.Itoa(runtime.GOMAXPROCS(0)) if !cfg.EnablePrefork { procs = "1" } mainLogo := colors.Black + " β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”\n" if app.config.AppName != "" { mainLogo += " β”‚ " + centerValue(app.config.AppName, 49) + " β”‚\n" } mainLogo += " β”‚ " + centerValue("Fiber v"+Version, 49) + " β”‚\n" if host == "0.0.0.0" { mainLogo += " β”‚ " + center(fmt.Sprintf("%s://127.0.0.1:%s", scheme, port), 49) + " β”‚\n" + " β”‚ " + center(fmt.Sprintf("(bound on host 0.0.0.0 and port %s)", port), 49) + " β”‚\n" } else { mainLogo += " β”‚ " + center(fmt.Sprintf("%s://%s:%s", scheme, host, port), 49) + " β”‚\n" } mainLogo += fmt.Sprintf( " β”‚ β”‚\n"+ " β”‚ Handlers %s Processes %s β”‚\n"+ " β”‚ Prefork .%s PID ....%s β”‚\n"+ " β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜"+ colors.Reset, value(strconv.Itoa(int(app.handlersCount)), 14), value(procs, 12), value(isPrefork, 14), value(strconv.Itoa(os.Getpid()), 14), ) var childPidsLogo string if cfg.EnablePrefork { var childPidsTemplate string childPidsTemplate += "%s" childPidsTemplate += " β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”\n%s" childPidsTemplate += " β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜" childPidsTemplate += "%s" newLine := " β”‚ %s%s%s β”‚" // Turn the `pids` variable (in the form ",a,b,c,d,e,f,etc") into a slice of PIDs var pidSlice []string for _, v := range strings.Split(pids, ",") { if v != "" { pidSlice = append(pidSlice, v) } } var lines []string thisLine := "Child PIDs ... " var itemsOnThisLine []string addLine := func() { lines = append(lines, fmt.Sprintf( newLine, colors.Black, thisLine+colors.Cyan+pad(strings.Join(itemsOnThisLine, ", "), 49-len(thisLine)), colors.Black, ), ) } for _, pid := range pidSlice { if len(thisLine+strings.Join(append(itemsOnThisLine, pid), ", ")) > 49 { addLine() thisLine = "" itemsOnThisLine = []string{pid} } else { itemsOnThisLine = append(itemsOnThisLine, pid) } } // Add left over items to their own line if len(itemsOnThisLine) != 0 { addLine() } // Form logo childPidsLogo = fmt.Sprintf(childPidsTemplate, colors.Black, strings.Join(lines, "\n")+"\n", colors.Reset, ) } // Combine both the child PID logo and the main Fiber logo // Pad the shorter logo to the length of the longer one splitMainLogo := strings.Split(mainLogo, "\n") splitChildPidsLogo := strings.Split(childPidsLogo, "\n") mainLen := len(splitMainLogo) childLen := len(splitChildPidsLogo) if mainLen > childLen { diff := mainLen - childLen for i := 0; i < diff; i++ { splitChildPidsLogo = append(splitChildPidsLogo, "") } } else { diff := childLen - mainLen for i := 0; i < diff; i++ { splitMainLogo = append(splitMainLogo, "") } } // Combine the two logos, line by line output := "\n" for i := range splitMainLogo { output += colors.Black + splitMainLogo[i] + " " + splitChildPidsLogo[i] + "\n" } out := colorable.NewColorableStdout() if os.Getenv("TERM") == "dumb" || os.Getenv("NO_COLOR") == "1" || (!isatty.IsTerminal(os.Stdout.Fd()) && !isatty.IsCygwinTerminal(os.Stdout.Fd())) { out = colorable.NewNonColorable(os.Stdout) } _, _ = 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/v3.emptyHandler // HEAD | / | | github.com/gofiber/fiber/v3.emptyHandler func (app *App) printRoutesMessage() { // ignore child processes if IsChild() { return } // Alias colors colors := app.config.ColorScheme 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) } } out := colorable.NewColorableStdout() if os.Getenv("TERM") == "dumb" || os.Getenv("NO_COLOR") == "1" || (!isatty.IsTerminal(os.Stdout.Fd()) && !isatty.IsCygwinTerminal(os.Stdout.Fd())) { out = colorable.NewNonColorable(os.Stdout) } w := tabwriter.NewWriter(out, 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", colors.Blue, colors.White, colors.Green, colors.White, colors.Cyan, colors.White, colors.Yellow) _, _ = fmt.Fprintf(w, "%s------\t%s| %s----\t%s| %s----\t%s| %s--------\n", colors.Blue, colors.White, colors.Green, colors.White, colors.Cyan, colors.White, colors.Yellow) for _, route := range routes { _, _ = fmt.Fprintf(w, "%s%s\t%s| %s%s\t%s| %s%s\t%s| %s%s\n", colors.Blue, route.method, colors.White, colors.Green, route.path, colors.White, colors.Cyan, route.name, colors.White, colors.Yellow, route.handlers) } _ = w.Flush() } // shutdown goroutine func (app *App) gracefulShutdown(ctx context.Context, cfg ListenConfig) { <-ctx.Done() if err := app.Shutdown(); err != nil { cfg.OnShutdownError(err) } if success := cfg.OnShutdownSuccess; success != nil { success() } }