Skip to content

fix(loader): Avoid setting/resetting window.onerror #47311

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 13, 2023
Merged

fix(loader): Avoid setting/resetting window.onerror #47311

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
50ae68e
fix(loader): Avoid setting/resetting `window.onerror`
mydea Apr 13, 2023
db6c72c
fix
mydea Apr 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 19 additions & 36 deletions src/sentry/templates/sentry/js-sdk-loader.js.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,21 @@
queue.data.push(content);
};
queue.data = [];
function onError() {
// Use keys as "data type" to save some characters"
queue({
e: [].slice.call(arguments),
});
}
function onUnhandledRejection(e) {
queue({
p: 'reason' in e
? e.reason
: 'detail' in e && 'reason' in e.detail
? e.detail.reason
: e,
});
}
function injectSdk(callbacks) {
if (injected) {
return;
Expand All @@ -50,14 +65,8 @@
// Once our SDK is loaded
_newScriptTag.addEventListener('load', function () {
try {
// Restore onerror/onunhandledrejection handlers - only if not mutated in the meanwhile
if (_window[_onerror] && _window[_onerror].__SENTRY_LOADER__) {
_window[_onerror] = _oldOnerror;
}
if (_window[_onunhandledrejection] &&
_window[_onunhandledrejection].__SENTRY_LOADER__) {
_window[_onunhandledrejection] = _oldOnunhandledrejection;
}
_window.removeEventListener('error', onError);
_window.removeEventListener('unhandledrejection', onUnhandledRejection);
// Add loader as SDK source
_window.SENTRY_SDK_SOURCE = 'loader';
var SDK_1 = _window[_namespace];
Expand Down Expand Up @@ -186,34 +195,8 @@
queue({ f: f, a: arguments });
};
});
// Store reference to the old `onerror` handler and override it with our own function
// that will just push exceptions to the queue and call through old handler if we found one
var _oldOnerror = _window[_onerror];
_window[_onerror] = function () {
// Use keys as "data type" to save some characters"
queue({
e: [].slice.call(arguments),
});
if (_oldOnerror) {
_oldOnerror.apply(_window, arguments);
}
};
_window[_onerror].__SENTRY_LOADER__ = true;
// Do the same store/queue/call operations for `onunhandledrejection` event
var _oldOnunhandledrejection = _window[_onunhandledrejection];
_window[_onunhandledrejection] = function (e) {
queue({
p: 'reason' in e
? e.reason
: 'detail' in e && 'reason' in e.detail
? e.detail.reason
: e,
});
if (_oldOnunhandledrejection) {
_oldOnunhandledrejection.apply(_window, arguments);
}
};
_window[_onunhandledrejection].__SENTRY_LOADER__ = true;
_window.addEventListener('error', onError);
_window.addEventListener('unhandledrejection', onUnhandledRejection);
if (!lazy) {
setTimeout(function () {
injectSdk(onLoadCallbacks);
Expand Down
2 changes: 1 addition & 1 deletion src/sentry/templates/sentry/js-sdk-loader.min.js.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{% load sentry_helpers %}!function(n,e,r,t,a,i,o,c,_,f){for(var p=f,forceLoad=!1,s=0;s<document.scripts.length;s++)if(document.scripts[s].src.indexOf(o)>-1){p&&"no"===document.scripts[s].getAttribute("data-lazy")&&(p=!1);break}var u=!1,l=[],d=function(n){("e"in n||"p"in n||n.f&&n.f.indexOf("capture")>-1||n.f&&n.f.indexOf("showReportDialog")>-1)&&p&&R(l),d.data.push(n)};function R(o){if(!u){u=!0;var f=e.scripts[0],p=e.createElement(r);p.src=c,p.crossOrigin="anonymous",p.addEventListener("load",(function(){try{n[t]&&n[t].__SENTRY_LOADER__&&(n[t]=E),n[a]&&n[a].__SENTRY_LOADER__&&(n[a]=v),n.SENTRY_SDK_SOURCE="loader";var e=n[i],r=e.init;e.init=function(n){var t=_;for(var a in n)Object.prototype.hasOwnProperty.call(n,a)&&(t[a]=n[a]);!function(n,e){var r=n.integrations||[];if(!Array.isArray(r))return;var t=r.map((function(n){return n.name}));n.tracesSampleRate&&-1===t.indexOf("BrowserTracing")&&r.push(new e.BrowserTracing);(n.replaysSessionSampleRate||n.replaysOnErrorSampleRate)&&-1===t.indexOf("Replay")&&r.push(new e.Replay);n.integrations=r}(t,e),r(t)},function(e,r){try{for(var i=0;i<e.length;i++)"function"==typeof e[i]&&e[i]();var o=d.data,c=!(void 0===(u=n.__SENTRY__)||!u.hub||!u.hub.getClient());o.sort((function(n){return"init"===n.f?-1:0}));var _=!1;for(i=0;i<o.length;i++)if(o[i].f){_=!0;var f=o[i];!1===c&&"init"!==f.f&&r.init(),c=!0,r[f.f].apply(r,f.a)}!1===c&&!1===_&&r.init();var p=n[t],s=n[a];for(i=0;i<o.length;i++)"e"in o[i]&&p?p.apply(n,o[i].e):"p"in o[i]&&s&&s.apply(n,[o[i].p])}catch(n){console.error(n)}var u}(o,e)}catch(n){console.error(n)}})),f.parentNode.insertBefore(p,f)}}d.data=[],n[i]=n[i]||{},n[i].onLoad=function(n){l.push(n),p&&!forceLoad||R(l)},n[i].forceLoad=function(){forceLoad=!0,p&&setTimeout((function(){R(l)}))},["init","addBreadcrumb","captureMessage","captureException","captureEvent","configureScope","withScope","showReportDialog"].forEach((function(e){n[i][e]=function(){d({f:e,a:arguments})}}));var E=n[t];n[t]=function(){d({e:[].slice.call(arguments)}),E&&E.apply(n,arguments)},n[t].__SENTRY_LOADER__=!0;var v=n[a];n[a]=function(e){d({p:"reason"in e?e.reason:"detail"in e&&"reason"in e.detail?e.detail.reason:e}),v&&v.apply(n,arguments)},n[a].__SENTRY_LOADER__=!0,p||setTimeout((function(){R(l)}))}(window,document,"script","onerror","onunhandledrejection","Sentry",'{{ publicKey|safe }}','{{ jsSdkUrl|safe }}',{{ config|to_json|safe }},{{ isLazy|safe|lower }});
{% load sentry_helpers %}!function(e,n,r,t,i,o,a,c,s,f){for(var u=f,forceLoad=!1,p=0;p<document.scripts.length;p++)if(document.scripts[p].src.indexOf(a)>-1){u&&"no"===document.scripts[p].getAttribute("data-lazy")&&(u=!1);break}var d=!1,l=[],_=function(e){("e"in e||"p"in e||e.f&&e.f.indexOf("capture")>-1||e.f&&e.f.indexOf("showReportDialog")>-1)&&u&&E(l),_.data.push(e)};function v(){_({e:[].slice.call(arguments)})}function h(e){_({p:"reason"in e?e.reason:"detail"in e&&"reason"in e.detail?e.detail.reason:e})}function E(a){if(!d){d=!0;var f=n.scripts[0],u=n.createElement(r);u.src=c,u.crossOrigin="anonymous",u.addEventListener("load",(function(){try{e.removeEventListener("error",v),e.removeEventListener("unhandledrejection",h),e.SENTRY_SDK_SOURCE="loader";var n=e[o],r=n.init;n.init=function(e){var t=s;for(var i in e)Object.prototype.hasOwnProperty.call(e,i)&&(t[i]=e[i]);!function(e,n){var r=e.integrations||[];if(!Array.isArray(r))return;var t=r.map((function(e){return e.name}));e.tracesSampleRate&&-1===t.indexOf("BrowserTracing")&&r.push(new n.BrowserTracing);(e.replaysSessionSampleRate||e.replaysOnErrorSampleRate)&&-1===t.indexOf("Replay")&&r.push(new n.Replay);e.integrations=r}(t,n),r(t)},function(n,r){try{for(var o=0;o<n.length;o++)"function"==typeof n[o]&&n[o]();var a=_.data,c=!(void 0===(d=e.__SENTRY__)||!d.hub||!d.hub.getClient());a.sort((function(e){return"init"===e.f?-1:0}));var s=!1;for(o=0;o<a.length;o++)if(a[o].f){s=!0;var f=a[o];!1===c&&"init"!==f.f&&r.init(),c=!0,r[f.f].apply(r,f.a)}!1===c&&!1===s&&r.init();var u=e[t],p=e[i];for(o=0;o<a.length;o++)"e"in a[o]&&u?u.apply(e,a[o].e):"p"in a[o]&&p&&p.apply(e,[a[o].p])}catch(e){console.error(e)}var d}(a,n)}catch(e){console.error(e)}})),f.parentNode.insertBefore(u,f)}}_.data=[],e[o]=e[o]||{},e[o].onLoad=function(e){l.push(e),u&&!forceLoad||E(l)},e[o].forceLoad=function(){forceLoad=!0,u&&setTimeout((function(){E(l)}))},["init","addBreadcrumb","captureMessage","captureException","captureEvent","configureScope","withScope","showReportDialog"].forEach((function(n){e[o][n]=function(){_({f:n,a:arguments})}})),e.addEventListener("error",v),e.addEventListener("unhandledrejection",h),u||setTimeout((function(){E(l)}))}(window,document,"script","onerror","onunhandledrejection","Sentry",'{{ publicKey|safe }}','{{ jsSdkUrl|safe }}',{{ config|to_json|safe }},{{ isLazy|safe|lower }});
63 changes: 22 additions & 41 deletions src/sentry/templates/sentry/js-sdk-loader.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,24 @@ declare const __LOADER__IS_LAZY__: any;
};
queue.data = [];

function onError() {
// Use keys as "data type" to save some characters"
queue({
e: [].slice.call(arguments),
});
}

function onUnhandledRejection(e) {
queue({
p:
'reason' in e
? e.reason
: 'detail' in e && 'reason' in e.detail
? e.detail.reason
: e,
});
}

function injectSdk(callbacks) {
if (injected) {
return;
Expand All @@ -74,16 +92,8 @@ declare const __LOADER__IS_LAZY__: any;
// Once our SDK is loaded
_newScriptTag.addEventListener('load', function () {
try {
// Restore onerror/onunhandledrejection handlers - only if not mutated in the meanwhile
if (_window[_onerror] && _window[_onerror].__SENTRY_LOADER__) {
_window[_onerror] = _oldOnerror;
}
if (
_window[_onunhandledrejection] &&
_window[_onunhandledrejection].__SENTRY_LOADER__
) {
_window[_onunhandledrejection] = _oldOnunhandledrejection;
}
_window.removeEventListener('error', onError);
_window.removeEventListener('unhandledrejection', onUnhandledRejection);

// Add loader as SDK source
_window.SENTRY_SDK_SOURCE = 'loader';
Expand Down Expand Up @@ -239,37 +249,8 @@ declare const __LOADER__IS_LAZY__: any;
};
});

// Store reference to the old `onerror` handler and override it with our own function
// that will just push exceptions to the queue and call through old handler if we found one
const _oldOnerror = _window[_onerror];
_window[_onerror] = function () {
// Use keys as "data type" to save some characters"
queue({
e: [].slice.call(arguments),
});

if (_oldOnerror) {
_oldOnerror.apply(_window, arguments);
}
};
_window[_onerror].__SENTRY_LOADER__ = true;

// Do the same store/queue/call operations for `onunhandledrejection` event
const _oldOnunhandledrejection = _window[_onunhandledrejection];
_window[_onunhandledrejection] = function (e) {
queue({
p:
'reason' in e
? e.reason
: 'detail' in e && 'reason' in e.detail
? e.detail.reason
: e,
});
if (_oldOnunhandledrejection) {
_oldOnunhandledrejection.apply(_window, arguments);
}
};
_window[_onunhandledrejection].__SENTRY_LOADER__ = true;
_window.addEventListener('error', onError);
_window.addEventListener('unhandledrejection', onUnhandledRejection);

if (!lazy) {
setTimeout(function () {
Expand Down