summaryrefslogtreecommitdiffstats
path: root/web_src/js/bootstrap.js
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--web_src/js/bootstrap.js109
1 files changed, 109 insertions, 0 deletions
diff --git a/web_src/js/bootstrap.js b/web_src/js/bootstrap.js
new file mode 100644
index 00000000..c707979c
--- /dev/null
+++ b/web_src/js/bootstrap.js
@@ -0,0 +1,109 @@
+// 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'}/`;
+
+// Ignore external and some known internal errors that we are unable to currently fix.
+function shouldIgnoreError(err) {
+ const assetBaseUrl = String(new URL(__webpack_public_path__, window.location.origin));
+
+ if (!(err instanceof Error)) return false;
+ // 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. Ignore these errors.
+ if (!err.stack?.includes(assetBaseUrl)) return true;
+ // Ignore some known internal errors that we are unable to currently fix (eg via Monaco).
+ const ignorePatterns = [
+ '/assets/js/monaco.', // https://codeberg.org/forgejo/forgejo/issues/3638 , https://github.com/go-gitea/gitea/issues/30861 , https://github.com/microsoft/monaco-editor/issues/4496
+ ];
+ for (const pattern of ignorePatterns) {
+ if (err.stack?.includes(pattern)) return true;
+ }
+ return false;
+}
+
+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 {runModeIsProd} = window.config ?? {};
+
+ // `error` and `reason` are not guaranteed to be errors. If the value is falsy, it is likely 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;
+ }
+
+ // In production do not display errors that should be ignored.
+ if (runModeIsProd && shouldIgnoreError(err)) 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();