📝 [Proposal]: Add Support for Context in RequestID Middleware

[zhangyongding]

Convenient to get the value of requestid from UserContext

// New creates a new middleware handler
func New(config ...Config) fiber.Handler {
	// Set default config
	cfg := configDefault(config...)

	// Return new handler
	return func(c fiber.Ctx) error {
		// Don't execute middleware if Next returns true
		if cfg.Next != nil && cfg.Next(c) {
			return c.Next()
		}
		// Get id from request, else we generate one
		rid := c.Get(cfg.Header)
		if rid == "" {
			rid = cfg.Generator()
		}

		// Set new id to response header
		c.Set(cfg.Header, rid)

		// Add the request ID to locals
		c.Locals(requestIDKey, rid)

		// Add the request ID to UserContext
		ctx := context.WithValue(c.UserContext(), cfg.Header, rid)
		c.SetUserContext(ctx)

		// Continue stack
		return c.Next()
	}
}

Alignment with Express API

N/a

HTTP RFC Standards Compliance

N/a

API Stability

N/a

Feature Examples

N/a

Checklist:

• I agree to follow Fiber's Code of Conduct.
• I have searched for existing issues that describe my proposal before opening this one.
• I understand that a proposal that does not meet these guidelines may be closed without explanation.

[ReneWerner87]

can you describe what advantages it has over the value we already have in the locals?

[zhangyongding]

Helps to include RequestID when obtaining UserContext, hoping to still carry RequestID when using UserContext as context in some scenarios

[ReneWerner87]

what do you think we should expand the context in all middlewares where we also fill the locals?
@gaby @efectn

i wouldn't do it only in the requestid mw, because then it wouldn't be consistent

[JIeJaitt]

@ReneWerner87 @gaby @efectn I think requestid, keyauth, csrf, session middleware may need this function more, cache, compress, logger, limiter, favicon, pprof, recover, redirect, rewrite, etag, cors and helmet, idempotency, earlydata, encryptcookie may not be so need this function. Maybe we can add those with higher needs first.

[ReneWerner87]

ok can you support us with a PR

[JIeJaitt]

@ReneWerner87 I'm very happy to finish it. I will finish this PR in the next few days.

[ReneWerner87]

@ReneWerner87 @gaby @efectn I think requestid, keyauth, csrf, session middleware may need this function more, cache, compress, logger, limiter, favicon, pprof, recover, redirect, rewrite, etag, cors and helmet, idempotency, earlydata, encryptcookie may not be so need this function. Maybe we can add those with higher needs first.

Now we can start with the other middlewares.

[ReneWerner87]

@coderabbitai create an issue report for the other middlewares with a task list to check off

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

@ReneWerner87, I've created the issue report as requested: Add Context Support to Additional Middlewares.

🔗 Analysis chain

@ReneWerner87, creating the issue report for the other middlewares with a task list as per your request.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Create a GitHub issue to add context support to additional middlewares
gh issue create \
  --assignee ReneWerner87 \
  --title "Add Context Support to Additional Middlewares" \
  --body "Based on the discussion in [Issue #3175](https://github.com/gofiber/fiber/issues/3175), we need to extend context support to other middlewares for consistency.

Middlewares to update:
- [ ] keyauth
- [ ] csrf
- [ ] session

This will ensure that relevant context can be passed through the \`UserContext\` in these middlewares.

Requester: @ReneWerner87"

Length of output: 502