-
Notifications
You must be signed in to change notification settings - Fork 29.9k
fix: trace context propagation from middleware → server #85900
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
kakadiadarpan
wants to merge
2
commits into
vercel:canary
Choose a base branch
from
kakadiadarpan:darpan/propogate-opentelemetry-context-in-middleware-response-headers
base: canary
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+48
−26
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When setting the
x-middleware-override-headersheader at line 510, the code concatenatesmiddlewareOverrideHeaders(which can benull) with a string, resulting in the literal string "null" being prepended to the header value. This corrupts the header when trace context is captured but no previous override headers exist.View Details
Analysis
Null concatenation in x-middleware-override-headers header when trace context is captured without existing overrides
What fails: In
packages/next/src/server/web/adapter.tslines 507-512, when middleware captures trace context but no previous override headers exist, the code concatenatesnullwith string values, resulting in the literal string"null"being prepended to the header value.How to reproduce:
middlewareTraceContext.length > 0)middlewareOverrideHeadersis null fromfinalResponse.headers.get())middlewareOverrideHeaders + ',' + overwrittenHeaders.join(',')null + ',' + 'traceparent,tracestate'="null,traceparent,tracestate"Result: The
x-middleware-override-headersheader contains the literal string"null"as the first element, which corrupts header propagation and may break trace propagation in the server-side code.Expected: When
middlewareOverrideHeadersis null, the header should be set to only the overwritten headers list without the "null" prefix, i.e.,"traceparent,tracestate".Root cause: The refactoring in commit a711b1c ("propagate context in middleware response headers") moved the header update outside the
if (middlewareOverrideHeaders)conditional block, but did not add a null check when concatenating the values.