mirror of
https://github.com/zap-proto/fiber.git
synced 2026-10-30 15:06:23 +00:00
Benjamin GrosseandGitHub
0c4df7176a
* Revert "Revert "🐛 requestid.Config.ContextKey is interface{} (#2369)" (#2742)"
This reverts commit 21ea005b07.
* fix: request ContextKey default value condition
Should check for `nil` since it is `any`.
* fix: don't constrain middlewares' context-keys to strings
`context` recommends using "unexported type" as context keys to avoid
collisions https://pkg.go.dev/github.com/gofiber/fiber/v2#Ctx.Locals.
The official go blog also recommends this https://go.dev/blog/context.
`fiber.Ctx.Locals(key any, value any)` correctly allows consumers to
use unexported types or e.g. strings.
But some fiber middlewares constrain their context-keys to `string` in
their "default config structs", making it impossible to use unexported
types.
This PR removes the `string` _constraint_ from all middlewares, allowing
to now use unexported types as per the official guidelines. However
the default value is still a string, so it's not a breaking change, and
anyone still using strings as context keys is not affected.
67 lines
1.6 KiB
Go
67 lines
1.6 KiB
Go
package requestid
|
|
|
|
import (
|
|
"github.com/gofiber/fiber/v2"
|
|
"github.com/gofiber/fiber/v2/utils"
|
|
)
|
|
|
|
// 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
|
|
|
|
// Header is the header key where to get/set the unique request ID
|
|
//
|
|
// Optional. Default: "X-Request-ID"
|
|
Header string
|
|
|
|
// Generator defines a function to generate the unique identifier.
|
|
//
|
|
// Optional. Default: utils.UUID
|
|
Generator func() string
|
|
|
|
// ContextKey defines the key used when storing the request ID in
|
|
// the locals for a specific request.
|
|
// Should be a private type instead of string, but too many apps probably
|
|
// rely on this exact value.
|
|
//
|
|
// Optional. Default: "requestid"
|
|
ContextKey interface{}
|
|
}
|
|
|
|
// ConfigDefault is the default config
|
|
// It uses a fast UUID generator which will expose the number of
|
|
// requests made to the server. To conceal this value for better
|
|
// privacy, use the "utils.UUIDv4" generator.
|
|
var ConfigDefault = Config{
|
|
Next: nil,
|
|
Header: fiber.HeaderXRequestID,
|
|
Generator: utils.UUID,
|
|
ContextKey: "requestid",
|
|
}
|
|
|
|
// 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
|
|
}
|
|
if cfg.ContextKey == nil {
|
|
cfg.ContextKey = ConfigDefault.ContextKey
|
|
}
|
|
return cfg
|
|
}
|