linden123/githaven-fork
1
1
Fork 0
forked from Shiloh/githaven
Code Pull Requests Activity

Fix/Improve processWindowErrorEvent (#29407)

Browse Source 
- `e.error` can be undefined in some cases which would raise an error
inside this error handler, fixed that.
- The displayed message mentions looking into the console, but in my
case of error from `ResizeObserver` there was nothing there, so add this
logging. I think this logging was once there but got lost during
refactoring.
This commit is contained in:
silverwind 2024-02-28 23:20:53 +01:00 committed by GitHub
parent 850fc2516e
commit 6d9b7253a2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 36 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
web_src/js/bootstrap.js vendored
View File

@ -1,5 +1,6 @@
// DO NOT IMPORT window.config HERE! // DO NOT IMPORT window.config HERE!
// to make sure the error handler always works, we should never import `window.config`, because some user's custom template breaks it. // to make sure the error handler always works, we should never import `window.config`, because
// some user's custom template breaks it.
// This sets up the URL prefix used in webpack's chunk loading. // This sets up the URL prefix used in webpack's chunk loading.
// This file must be imported before any lazy-loading is being attempted. // This file must be imported before any lazy-loading is being attempted.
@ -26,29 +27,42 @@ export function showGlobalErrorMessage(msg) {
} }
/** /**
* @param {ErrorEvent} e * @param {ErrorEvent|PromiseRejectionEvent} event - Event
* @param {string} event.message - Only present on ErrorEvent
* @param {string} event.error - Only present on ErrorEvent
* @param {string} event.type - Only present on ErrorEvent
* @param {string} event.filename - Only present on ErrorEvent
* @param {number} event.lineno - Only present on ErrorEvent
* @param {number} event.colno - Only present on ErrorEvent
* @param {string} event.reason - Only present on PromiseRejectionEvent
* @param {number} event.promise - Only present on PromiseRejectionEvent
*/ */
function processWindowErrorEvent(e) { function processWindowErrorEvent({error, reason, message, type, filename, lineno, colno}) {
const err = e.error ?? e.reason; const err = error ?? reason;
const assetBaseUrl = String(new URL(__webpack_public_path__, window.location.origin)); const assetBaseUrl = String(new URL(__webpack_public_path__, window.location.origin));
const {runModeIsProd} = window.config ?? {};
// error is likely from browser extension or inline script. Do not show these in production builds. // `error` and `reason` are not guaranteed to be errors. If the value is falsy, it is likly a
if (!err.stack?.includes(assetBaseUrl) && window.config?.runModeIsProd) return; // non-critical event from the browser. We log them but don't show them to users. Examples:
// - https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver#observation_errors
let message; // - https://github.com/mozilla-mobile/firefox-ios/issues/10817
if (e.type === 'unhandledrejection') { // - https://github.com/go-gitea/gitea/issues/20240
message = `JavaScript promise rejection: ${err.message}.`; if (!err) {
} else { if (message) console.error(new Error(message));
message = `JavaScript error: ${e.message} (${e.filename} @ ${e.lineno}:${e.colno}).`; if (runModeIsProd) return;
} }
if (!e.error && e.lineno === 0 && e.colno === 0 && e.filename === '' && window.navigator.userAgent.includes('FxiOS/')) { // If the error stack trace does not include the base URL of our script assets, it likely came
// At the moment, Firefox (iOS) (10x) has an engine bug. See https://github.com/go-gitea/gitea/issues/20240 // from a browser extension or inline script. Do not show such errors in production.
// If a script inserts a newly created (and content changed) element into DOM, there will be a nonsense error event reporting: Script error: line 0, col 0. if (err instanceof Error && !err.stack?.includes(assetBaseUrl) && runModeIsProd) {
return; // ignore such nonsense error event return;
} }
showGlobalErrorMessage(`${message} Open browser console to see more details.`); let msg = err?.message ?? message;
if (lineno) msg += ` (${filename} @ ${lineno}:${colno})`;
const dot = msg.endsWith('.') ? '' : '.';
const renderedType = type === 'unhandledrejection' ? 'promise rejection' : type;
showGlobalErrorMessage(`JavaScript ${renderedType}: ${msg}${dot} Open browser console to see more details.`);
} }
function initGlobalErrorHandler() { function initGlobalErrorHandler() {
@ -59,13 +73,14 @@ function initGlobalErrorHandler() {
if (!window.config) { if (!window.config) {
showGlobalErrorMessage(`Gitea JavaScript code couldn't run correctly, please check your custom templates`); showGlobalErrorMessage(`Gitea JavaScript code couldn't run correctly, please check your custom templates`);
} }
// we added an event handler for window error at the very beginning of <script> of page head // we added an event handler for window error at the very beginning of <script> of page head the
// the handler calls `_globalHandlerErrors.push` (array method) to record all errors occur before this init // handler calls `_globalHandlerErrors.push` (array method) to record all errors occur before
// then in this init, we can collect all error events and show them // this init then in this init, we can collect all error events and show them.
for (const e of window._globalHandlerErrors || []) { for (const e of window._globalHandlerErrors || []) {
processWindowErrorEvent(e); processWindowErrorEvent(e);
} }
// then, change _globalHandlerErrors to an object with push method, to process further error events directly // then, change _globalHandlerErrors to an object with push method, to process further error
// events directly
window._globalHandlerErrors = {_inited: true, push: (e) => processWindowErrorEvent(e)}; window._globalHandlerErrors = {_inited: true, push: (e) => processWindowErrorEvent(e)};
} }