ref(node): Streamline amqplib instrumentation#21753
Open
s1gr1d wants to merge 2 commits into
Open
Conversation
s1gr1d
requested review from
JPeer264,
andreiborza,
mydea and
nicohrubec
and removed request for
a team
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
Comment on lines
+171
to
+172
| const modifiedOptions = options ?? {}; | ||
| modifiedOptions.headers = modifiedOptions.headers ?? {}; |
Contributor
There was a problem hiding this comment.
Bug: The startPublishSpan function mutates the caller's options object by reference, adding tracing headers. This can cause unexpected side effects when the options object is reused.
Severity: MEDIUM
Suggested Fix
Defensively clone the incoming options object and its headers property to avoid mutating the original object. For example: const modifiedOptions = { ...(options ?? {}), headers: { ...(options?.headers ?? {}) } };.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.
Location: packages/node/src/integrations/tracing/amqplib/vendored/utils.ts#L171-L172
Potential issue: The `startPublishSpan` function mutates the `options` object passed by
the caller. When a non-null `options` object is provided, it is assigned by reference to
`modifiedOptions`. Subsequent modifications to `modifiedOptions.headers` to add tracing
information (`sentry-trace`, `baggage`) directly alter the original user-provided
object. This is problematic as the `amqplib` library documentation encourages reusing
the `options` object for multiple publish calls. This undocumented side effect can lead
to unexpected behavior and data pollution in the user's application logic.
Did we get this right? 👍 / 👎 to inform future reviews.
Contributor
size-limit report 📦
|
JPeer264
approved these changes
Jun 24, 2026
JPeer264
left a comment
JPeer264
left a comment
Member
There was a problem hiding this comment.
LGTM overall just one kinda nit
| return module; | ||
| } | ||
|
|
||
| private patchConnect(moduleExports: any): any { |
Member
There was a problem hiding this comment.
l/m: There are a lot of any in this code, but linting doesn't fail - we should include this file again by removing it from the oxlintrc base.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Streamlines the amqplib instrumentation:
startSpanAPIs from@sentry/coreinstead of the OTel tracer./* eslint-disable */from the vendored files so they pass the linter.Closes #20723
Linear: https://linear.app/getsentry/issue/JS-2375/streamline-opentelemetryinstrumentation-amqplib