mirror of
https://codeberg.org/forgejo/forgejo
synced 2024-11-30 05:46:09 +01:00
6aa5554161
Backport #28873 by wxiaoguang
Gitea treat JS errors seriously, so sometimes the JS errors caused by
3rdparty code (eg: browser extensions) would also be reported on Gitea
UI: TypeError: WeakMap key undefined (caused by extension DarkReader's
bug) #28861
To avoid fill the user's screen with a lot of error messages, this PR
merges the same error messages into one.
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
(cherry picked from commit b7e32b2382)
64 lines
3.1 KiB
JavaScript
64 lines
3.1 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'}/`;
|
|
|
|
export function showGlobalErrorMessage(msg) {
|
|
const pageContent = document.querySelector('.page-content');
|
|
if (!pageContent) 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" style="white-space: 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} e
|
|
*/
|
|
function processWindowErrorEvent(e) {
|
|
if (e.type === 'unhandledrejection') {
|
|
showGlobalErrorMessage(`JavaScript promise rejection: ${e.reason}. Open browser console to see more details.`);
|
|
return;
|
|
}
|
|
if (!e.error && e.lineno === 0 && e.colno === 0 && e.filename === '' && window.navigator.userAgent.includes('FxiOS/')) {
|
|
// At the moment, Firefox (iOS) (10x) has an engine bug. See https://github.com/go-gitea/gitea/issues/20240
|
|
// 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.
|
|
return; // ignore such nonsense error event
|
|
}
|
|
|
|
showGlobalErrorMessage(`JavaScript error: ${e.message} (${e.filename} @ ${e.lineno}:${e.colno}). 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();
|