services
data_display
error
Odoo 19 services — error (core)
Live preview
Interactive
Source excerpt
web/static/src/core/errors/error_service.js
import { browser } from "../browser/browser";
import { registry } from "../registry";
import { completeUncaughtError, getErrorTechnicalName } from "./error_utils";
import { isBrowserFirefox, isBrowserChrome } from "@web/core/browser/feature_detection";
export class HTMLElementLoadingError extends Error {
static message = "Error loading an HTML Element";
constructor(message = HTMLElementLoadingError.message, event) {
super(message);
this.event = event;
}
}
/**
* Uncaught Errors have 4 properties:
* - name: technical name of the error (UncaughtError, ...)
* - message: short user visible description of the issue ("Uncaught Cors Error")
* - traceback: long description, possibly technical of the issue (such as a traceback)
* - originalError: the error that was actually being caught. Note that it is not
* necessarily an error (for ex, if some code does throw "boom")
*/
export class UncaughtError extends Error {
constructor(message) {
super(message);
this.name = getErrorTechnicalName(this);
this.traceback = null;
}
}
export class UncaughtClientError extends UncaughtError {
constructor(message = "Uncaught Javascript Error") {
super(message);
}
}
export class UncaughtPromiseError extends UncaughtError {
constructor(message = "Uncaught Promise") {
super(message);
this.unhandledRejectionEvent = null;
}
}
export class ThirdPartyScriptError extends UncaughtError {
constructor(message = "Third-Party Script Error") {
super(message);
}
}
export const errorService = {
start(env) {
function handleError(uncaughtError, retry = true) {
function shouldLogError() {
// Only log errors that are relevant business-wise, following the heuristics:
// Error.event and Error.traceback have been assigned
// in one of the two error event listeners below.
// If preventDefault was already executed on the event, don't log it.
return (
uncaughtError.event &&
!uncaughtError.event.defaultPrevented &&
uncaughtError.traceback
);
}
let originalError = uncaughtError;
while (originalError instanceof Error && "cause" in originalError) {
originalError = originalError.cause;
}
for (const [name, handler] of registry.category("error_handlers").getEntries()) {
try {
if (handler(env, uncaughtError, originalError)) {
break;
}
} catch (e) {
if (shouldLogError()) {
uncaughtError.event.preventDefault();
console.error(
`@web/core/error_service: handler "${name}" failed with "${
e.cause || e
}" while trying to handle:\n` + uncaughtError.traceback
);
}
return;
}
}
if (shouldLogError()) {
// Log the full traceback instead of letting the browser log the incomplete one
uncaughtError.event.preventDefault();
console.error(uncaughtError.traceback);
}
}
browser.addEventListener("error", async (ev) => {
const { colno, error, filename, lineno, message } = ev;
// We never want to display the following ResizeObserver error to the end-user. It
// simply indicates that the browser delayed notifications to the next frame to prevent
// infinite loop, which is how he's supposed to behave. However, it would be interesting
// to track places from where this error could be thrown, and try to fix them.
// https://trackjs.com/javascript-errors/resizeobserver-loop-completed-with-undelivered-notifications/
const resizeObserverError =
"ResizeObserver loop completed with undelivered notifications.";
if (!(error instanceof Error) && message === resizeObserverError) {
ev.preventDefault();
return;
}
const isRedactedError = !filename && !lineno && !colno;
const isThirdPartyScriptError =
isRedactedError ||
// Firefox doesn't hide details of errors occuring in third-party scripts, check origin explicitly
(isBrowserFirefox() && new URL(filename).origin !== window.location.origin);
// Don't display error dialogs for third party script errors unless we are in debug mode
if (isThirdPartyScriptError && !odoo.debug) {
return;
}
let uncaughtError;
if (isRedactedError) {
uncaughtError = new ThirdPartyScriptError();
uncaughtError.traceback =
`An error whose details cannot be accessed by the Odoo framework has occurred.\n` +
`The error probably originates from a JavaScript file served from a different origin.\n` +
`The full error is available in the browser console.`;
} else {
Registry / API
- Registry name
error- Category
services- Module
web- Slug
error- Nav group
data_display