@geogirafe/lib-geoportal
Version:
GeoGirafe is a flexible application to build online geoportals.
201 lines (195 loc) • 7.8 kB
JavaScript
import { v4 as uuidv4 } from 'uuid';
import GirafeSingleton from '../../base/GirafeSingleton';
import ConfigManager from '../configuration/configmanager';
import StateManager from '../state/statemanager';
import ErrorStackParser from 'error-stack-parser';
import { SourceMapConsumer } from 'source-map-js';
import ShareManager from '../share/sharemanager';
import I18nManager from '../i18n/i18nmanager';
class ErrorManager extends GirafeSingleton {
constructor(type) {
super(type);
Object.defineProperty(this, "configManager", {
enumerable: true,
configurable: true,
writable: true,
value: void 0
});
Object.defineProperty(this, "stateManager", {
enumerable: true,
configurable: true,
writable: true,
value: void 0
});
Object.defineProperty(this, "i18nManager", {
enumerable: true,
configurable: true,
writable: true,
value: void 0
});
Object.defineProperty(this, "sourceMaps", {
enumerable: true,
configurable: true,
writable: true,
value: {}
});
this.configManager = ConfigManager.getInstance();
this.stateManager = StateManager.getInstance();
this.i18nManager = I18nManager.getInstance();
this.listenToAllErrors();
}
getErrorMessage(title, stack, contextUrl) {
const description = `
## Debug Infos
### Context
${contextUrl}
### Callstack
\`\`\`
${stack}
\`\`\`
/label ~"error report"
`;
const errorMessage = `${title}<br/><a target="_new" href="https://gitlab.com/geogirafe/gg-viewer/-/issues/new?issue[title]=${encodeURIComponent(title)}&issuable_template=bug&issue[description]=${encodeURIComponent(description)}">Report Error</a>`;
return errorMessage;
}
pushMessage(id, text, level) {
// Remove existing message with the same id
this.stateManager.state.infobox.elements.splice(this.stateManager.state.infobox.elements.findIndex((el) => el.id === id), 1);
// Add a new one
this.stateManager.state.infobox.elements.push({
id: id,
text: text,
type: level
});
}
listenToAllErrors() {
// Listen to all uncatched errors
window.onerror = async (_message, file, line, col, error) => {
const title = error?.message ?? `Unknown error in ${file} at line ${line} and column ${col}.`;
const stack = await this.getStackTrace(error);
this.pushErrorMessageWithStack(title, stack);
return false;
};
// Listen to all unhandled HTTPRequest rejections
window.addEventListener('unhandledrejection', async (event) => {
const error = event.reason ?? new Error('Unknown reason');
const title = `Unhandled rejection: ${error.message}`;
const stack = await this.getStackTrace(error);
this.pushErrorMessageWithStack(title, stack);
return false;
});
}
async getStackTrace(error) {
let stack = 'Unknown stack';
if (error?.stack) {
try {
// NOTE REG: Specific to Vite: When running in debug mode, we do not need to calculate the original stacktrace
stack = import.meta.env.DEV ? error.stack : await this.getOriginalStackTrace(error);
}
catch (e) {
// If an error accurs during the calculation of the stacktrace, we just ignore it
// and return the original stacktrace. Otherwise it could lead to an infinite exception loop.
console.warn(e);
stack = error.stack;
}
}
return stack;
}
pushErrorMessageWithStack(title, stack) {
// Add new errormessage only if not already present
const pendingMessages = this.stateManager.state.infobox.elements.map((ele) => ele.text);
const contextUrl = this.getContextUrl();
const errorMessage = this.getErrorMessage(title, stack, contextUrl);
if (!pendingMessages.includes(errorMessage)) {
this.stateManager.state.infobox.elements.push({
id: uuidv4(),
text: errorMessage,
type: 'error'
});
}
}
getContextUrl() {
const base = window.location.href.split('#')[0];
try {
const hash = ShareManager.getInstance().getStateToShare();
return `${base}#${hash}`;
}
catch {
return base;
}
}
async getOriginalStackTrace(error) {
if (Object.keys(this.sourceMaps).length === 0) {
await this.loadAllSourceMaps();
}
// Map the minified stacktrace with the original one
const stackFrames = ErrorStackParser.parse(error);
const originalStackFrames = stackFrames.map((frame) => {
const sourceMap = this.sourceMaps[this.getNormalizedPath(frame.fileName)];
if (sourceMap) {
const originalPosition = sourceMap.originalPositionFor({
line: frame.lineNumber,
column: frame.columnNumber
});
if (originalPosition.source) {
return {
fileName: originalPosition.source,
lineNumber: originalPosition.line,
columnNumber: originalPosition.column,
functionName: frame.functionName
};
}
}
// Default : return the original frame
return frame;
});
return originalStackFrames
.map((frame) => {
return `${frame.functionName || 'anonymous'} (${frame.fileName}:${frame.lineNumber}:${frame.columnNumber})`;
})
.join('\n');
}
async loadAllSourceMaps() {
const scripts = document.getElementsByTagName('script');
for (const script of scripts) {
await this.loadSourceMap(this.getNormalizedPath(script.src));
}
}
async loadSourceMap(jsFilename) {
const response = await fetch(jsFilename);
const content = await response.text();
// Load sourcemap of this specific file
let regex = /\/\/# sourceMappingURL=([^\s]+)/;
let match = RegExp(regex).exec(content);
if (match) {
const sourceMapUrl = this.getNormalizedPath(jsFilename, match[1]);
if (!(jsFilename in this.sourceMaps)) {
const sourceMapResponse = await fetch(sourceMapUrl);
const sourceMapContent = await sourceMapResponse.json();
const sourceMap = new SourceMapConsumer(sourceMapContent);
this.sourceMaps[jsFilename] = sourceMap;
}
}
else {
console.info('No Sourcemap found');
}
// Load sourcemaps of all other dependent bundles
regex = /from *"([^\s]+)"/g;
const matches = content.matchAll(regex);
for (match of matches) {
for (let i = 1; i < match.length; ++i) {
const sourceMapUrl = this.getNormalizedPath(jsFilename, match[1]);
await this.loadSourceMap(sourceMapUrl);
}
}
}
getNormalizedPath(initialUrl, newFilename) {
if (!initialUrl) {
throw new Error('No path to normalize');
}
const path = newFilename ? initialUrl.substring(0, initialUrl.lastIndexOf('/') + 1) + newFilename : initialUrl;
const url = new URL(path);
return url.origin + url.pathname;
}
}
export default ErrorManager;