config.go — fiber Source File

Architecture documentation for config.go, a go file in the fiber codebase. 1 imports, 0 dependents.

File go FiberCore Adapters 1 imports 3 functions 1 classes

Entity Profile

FiberCore→ Adapters→ config.go — fiber Source File

Dependency Diagram

graph LR
  af2ea67e_4a3c_5176_5352_871e7f68d6c4["config.go"]
  6604ba6b_bab7_17c7_e687_7d0f07080e5a["v3"]
  af2ea67e_4a3c_5176_5352_871e7f68d6c4 --> 6604ba6b_bab7_17c7_e687_7d0f07080e5a
  style af2ea67e_4a3c_5176_5352_871e7f68d6c4 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

package requestid

import (
	"github.com/gofiber/fiber/v3"
	"github.com/gofiber/utils/v2"
)

// Config defines the config for middleware.
type Config struct {
	// Next defines a function to skip this middleware when returned true.
	//
	// Optional. Default: nil
	Next func(c fiber.Ctx) bool

	// Generator defines a function to generate the unique identifier.
	//
	// Optional. Default: utils.SecureToken
	Generator func() string

	// Header is the header key where to get/set the unique request ID
	//
	// Optional. Default: "X-Request-ID"
	Header string
}

// ConfigDefault is the default config
// It uses a secure token generator for better privacy and security.
var ConfigDefault = Config{
	Next:      nil,
	Header:    fiber.HeaderXRequestID,
	Generator: utils.SecureToken,
}

// Helper function to set default values
func configDefault(config ...Config) Config {
	// Return default config if nothing provided
	if len(config) < 1 {
		return ConfigDefault
	}

	// Override default config
	cfg := config[0]

	// Set default values
	if cfg.Header == "" {
		cfg.Header = ConfigDefault.Header
	}
	if cfg.Generator == nil {
		cfg.Generator = ConfigDefault.Generator
	}
	return cfg
}