mirror of
https://github.com/go-gitea/gitea
synced 2024-11-18 16:14:26 +00:00
1a4f693f9f
Fixes: https://github.com/go-gitea/gitea/issues/29956. This error exposed a existing bug in the code, it was just never noticed because the jQuery expression evaluated without error before while the new one doesn't. Also improves error message styles: Before: <img width="1338" alt="Screenshot 2024-03-21 at 09 16 07" src="https://github.com/go-gitea/gitea/assets/115237/1cc1ef89-ad94-491e-bbca-75387f7547a0"> After: <img width="1335" alt="Screenshot 2024-03-21 at 09 15 44" src="https://github.com/go-gitea/gitea/assets/115237/312efc79-5353-4e2a-a703-1bccd3c01736">
96 lines
4.4 KiB
JavaScript
96 lines
4.4 KiB
JavaScript
// 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.
|
|
|
|
// This sets up the URL prefix used in webpack's chunk loading.
|
|
// This file must be imported before any lazy-loading is being attempted.
|
|
__webpack_public_path__ = `${window.config?.assetUrlPrefix ?? '/assets'}/`;
|
|
|
|
const filteredErrors = new Set([
|
|
'getModifierState is not a function', // https://github.com/microsoft/monaco-editor/issues/4325
|
|
]);
|
|
|
|
export function showGlobalErrorMessage(msg) {
|
|
const pageContent = document.querySelector('.page-content');
|
|
if (!pageContent) return;
|
|
|
|
for (const filteredError of filteredErrors) {
|
|
if (msg.includes(filteredError)) return;
|
|
}
|
|
|
|
// compact the message to a data attribute to avoid too many duplicated messages
|
|
const msgCompact = msg.replace(/\W/g, '').trim();
|
|
let msgDiv = pageContent.querySelector(`.js-global-error[data-global-error-msg-compact="${msgCompact}"]`);
|
|
if (!msgDiv) {
|
|
const el = document.createElement('div');
|
|
el.innerHTML = `<div class="ui container negative message center aligned js-global-error tw-mt-[15px] tw-whitespace-pre-line"></div>`;
|
|
msgDiv = el.childNodes[0];
|
|
}
|
|
// merge duplicated messages into "the message (count)" format
|
|
const msgCount = Number(msgDiv.getAttribute(`data-global-error-msg-count`)) + 1;
|
|
msgDiv.setAttribute(`data-global-error-msg-compact`, msgCompact);
|
|
msgDiv.setAttribute(`data-global-error-msg-count`, msgCount.toString());
|
|
msgDiv.textContent = msg + (msgCount > 1 ? ` (${msgCount})` : '');
|
|
pageContent.prepend(msgDiv);
|
|
}
|
|
|
|
/**
|
|
* @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({error, reason, message, type, filename, lineno, colno}) {
|
|
const err = error ?? reason;
|
|
const assetBaseUrl = String(new URL(__webpack_public_path__, window.location.origin));
|
|
const {runModeIsProd} = window.config ?? {};
|
|
|
|
// `error` and `reason` are not guaranteed to be errors. If the value is falsy, it is likly a
|
|
// 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
|
|
// - https://github.com/mozilla-mobile/firefox-ios/issues/10817
|
|
// - https://github.com/go-gitea/gitea/issues/20240
|
|
if (!err) {
|
|
if (message) console.error(new Error(message));
|
|
if (runModeIsProd) return;
|
|
}
|
|
|
|
// If the error stack trace does not include the base URL of our script assets, it likely came
|
|
// from a browser extension or inline script. Do not show such errors in production.
|
|
if (err instanceof Error && !err.stack?.includes(assetBaseUrl) && runModeIsProd) {
|
|
return;
|
|
}
|
|
|
|
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() {
|
|
if (window._globalHandlerErrors?._inited) {
|
|
showGlobalErrorMessage(`The global error handler has been initialized, do not initialize it again`);
|
|
return;
|
|
}
|
|
if (!window.config) {
|
|
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 the
|
|
// handler calls `_globalHandlerErrors.push` (array method) to record all errors occur before
|
|
// this init then in this init, we can collect all error events and show them.
|
|
for (const e of window._globalHandlerErrors || []) {
|
|
processWindowErrorEvent(e);
|
|
}
|
|
// then, change _globalHandlerErrors to an object with push method, to process further error
|
|
// events directly
|
|
window._globalHandlerErrors = {_inited: true, push: (e) => processWindowErrorEvent(e)};
|
|
}
|
|
|
|
initGlobalErrorHandler();
|