getsentry / getsentry/sentry-javascript

GlobalHandlers: Use event handlers instead of monkey-patching `window.onerror`

Open
#17,217 1 comment 0 reactions 0 assignees View on GitHub
Improvement
Dominant language
TypeScript
Stars
8.7k
Forks
1.8k
Avg merge
1d 17h
Merged PRs (30d)
515

Description

### Description

Today, our `globalHandlersIntegration` monkey-patches `window.onerror` and `window.onunhandledrejection` directly. While this worked generally fine, it has the disadvantage that any party could come in with an improper monkey patch and remove Sentry form the listener chain.

Instead, we could use `window.addEventListener('error')` (same for unhanded rejection).

While we get the same data, this has the advantage that the SDK can't be removed by accident.

Compatibility-wise, using event handlers [should be fine](https://caniuse.com/?search=addeventlistener).

Which leaves us with the thing we need to investigate carefully: Compatibility with our loader script.
This is the reason why we currently still use `onerror`:

https://github.com/getsentry/sentry-javascript/blob/faada7ca942403bba2627208a7e5a4516606dbeb/packages/core/src/instrument/globalError.ts#L22-L23

However, we're not (yet) sure if this is actually a concern. Whatever we do here, we need to ensure that behaviour for the loader doesn't change and vice versa.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.