docs(javascript): Add list of integrations that use globals#16384
Open
docs(javascript): Add list of integrations that use globals#16384
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
| // filter integrations that use the global variable | ||
| const integrations = getDefaultIntegrations({}).filter((defaultIntegration) => { | ||
| return !["BrowserApiErrors", "Breadcrumbs", "GlobalHandlers"].includes( | ||
| return !["BrowserApiErrors", "BrowserSession", "Breadcrumbs", "ConversationId", "GlobalHandlers", "FunctionToString"].includes( |
There was a problem hiding this comment.
Bug: The documentation adds the integration name "ConversationId" to a filter list, but this integration does not exist in the Sentry JavaScript SDK.
Severity: MEDIUM
Suggested Fix
Remove "ConversationId" from the filter list in the documentation file. If it was intended to be a different integration, replace it with the correct, existing integration name.
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: docs/platforms/javascript/common/best-practices/shared-environments.mdx#L67
Potential issue: The documentation update adds `"ConversationId"` to a list of
integrations to be filtered out in shared environments. However, `"ConversationId"` is
not a valid integration in the Sentry JavaScript SDK. As a result, when users copy and
use this code, the filter will silently fail to match and remove this non-existent
integration. This misleads developers into believing they have correctly configured
their environment to disable certain global-state-using integrations when they have not.
The other added integrations, `"BrowserSession"` and `"FunctionToString"`, are valid.
Did we get this right? 👍 / 👎 to inform future reviews.
Member
Author
There was a problem hiding this comment.
No this is a correct integration name
https://github.com/getsentry/sentry-javascript/blob/c5e3249496de6cb23c79a1d4a6d1dbf7f00f3f5a/packages/core/src/integrations/conversationId.ts#L8
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.
DESCRIBE YOUR PR
Documents missing integrations to filter.
Ref: getsentry/sentry-javascript#19324
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes: