feat(browser): Document unregisterOriginalCallbacks option in browserApiErrors integration page
#13859
Conversation
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
…serApiErrors` integration page
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
2 Skipped Deployments
|
Lms24
requested review from
a team,
stephanie-anderson,
s1gr1d,
AbhiPrasad and
RulaKhaled
and removed request for
a team,
stephanie-anderson and
s1gr1d
Bundle ReportChanges will decrease total bundle size by 15 bytes (-0.0%) ⬇️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-server-cjsAssets Changed:
view changes for bundle: sentry-docs-client-array-pushAssets Changed:
|
Lms24
added a commit
to getsentry/sentry-javascript
that referenced
this pull request
May 28, 2025
…iErrorsIntegration` (#16412) This patch adds an option to fix a very unfortunate, effective double invocation of callbacks on objects inheriting from our `EventTarget.addEventListener` instrumentation (to be found in `browserApiErrorsIntegration`. Affected users can switch on the new option and doing so will make our instrumentation of `addEventListener` also call `removeEventListener` on for the original callback. Applied to the example above, it will essentially restore the idempotency of `addEventListener`. At the same time, it feels very risky to do this so for the time being, we'll keep this (and document it as) opt-in. Usage: ```js Sentry.init({ // ... integrations: [ Sentry.browserApiErrorsIntegration({ unregisterOriginalCallbacks: true, }), ], }); ``` Docs PR: getsentry/sentry-docs#13859 fixes #16398
AbhiPrasad
approved these changes
May 28, 2025
coolguyzone
reviewed
May 29, 2025
docs/platforms/javascript/common/configuration/integrations/browserapierrors.mdx
Outdated
Show resolved
Hide resolved
coolguyzone
reviewed
May 29, 2025
coolguyzone
reviewed
May 29, 2025
coolguyzone
approved these changes
May 29, 2025
Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io>
|
Thanks for the suggestions @coolguyzone! 🫡 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 a new option added via getsentry/sentry-javascript#16412. Also added a troubleshooting section as adding this option was the result of investigating a user-reported SDK issue (getsentry/sentry-javascript#16398)
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:
LEGAL BOILERPLATE
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.
EXTRA RESOURCES