fix(loader): Avoid setting/resetting window.onerror#47311
Merged
Conversation
Contributor
|
🚨 Warning: This pull request contains Frontend and Backend changes! It's discouraged to make changes to Sentry's Frontend and Backend in a single pull request. The Frontend and Backend are not atomically deployed. If the changes are interdependent of each other, they must be separated into two pull requests and be made forward or backwards compatible, such that the Backend or Frontend can be safely deployed independently. Have questions? Please ask in the |
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #47311 +/- ##
==========================================
- Coverage 80.65% 72.85% -7.80%
==========================================
Files 4752 4723 -29
Lines 201025 200640 -385
Branches 11648 11648
==========================================
- Hits 162127 146177 -15950
- Misses 38640 54205 +15565
Partials 258 258 |
AbhiPrasad
approved these changes
Apr 13, 2023
3 tasks
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This uses
addEventListenerinstead ofwindow.onerrorto set the handler for the loader.This way, we avoid infinite recursion when users also do that, e.g. right after loading the loader:
Rundown of the problem:
The root cause for this issue was this new check we added:
https://github.com/getsentry/sentry/pull/47311/files#diff-02afb4c480e9e9c8bcc2f5fd8096291fd71d113cc2d50139624c6d890fed6e88L54
So where did this cause issues?
Imagine following setup and order of users' Website
-> Loader script
-> Other script that overwrites
window.onError-> throw an unhandled Error
What was happening is that because of the
ifthis is invoked whenever we the full SDK was loaded but not initialized yet.
Previously it was this:
Since initially
window.onErrorisnullwe caused an endless loop of re-calling the LoaderonErroron the other, the external
onErrorhandler, caused the site to slowly run out of memory.Now we use event listeners instead to not have to deal with overwriting
onError.In the old version where we still dealt with
onErrorcallback - we also caused a bug where we set the handler back tonullregardless if a second one was registered in the meantime.