Custom message not shown on Production mode

[FedericoQuarin]

Describe the bug

On production mode, the error window is not showing the custom message that was set, just the error code.

Expected behavior

No response

Minimal reproducible example

On the demo, setting production mode and clicking Throw Error with custom message

Add-on Version

4.0.1

Vaadin Version

24

Additional information

No response

[javier-godoy]

In worked that way until 3.7.0

ErrorWindowAddon/src/main/java/com/flowingcode/vaadin/addons/errorwindow/ErrorWindow.java

Lines 304 to 316 in 3502b48

	protected Html createErrorLabel() {
	String label = errorMessage == null ? i18n.getDefaultErrorMessage() : errorMessage;
	if (productionMode) {
	label =
	label.concat(
	String.format(
	"<br />%s<br /><span class='uuid'>%s</span>",
	i18n.getInstructions(), uuid));
	}
	final Html errorLabel = new Html("<span>" + label + "</span>");
	errorLabel.getElement().getClassList().add("errorlabel");
	return errorLabel;
	}

In version 4.0.0 the method was refactored as

ErrorWindowAddon/src/main/java/com/flowingcode/vaadin/addons/errorwindow/ErrorWindow.java

Lines 306 to 318 in 16fd293

	protected Component createErrorLabel() {
	Div errorLabel = new Div();
	errorLabel.setClassName("errorlabel");
	if (productionMode) {
	Div instructions = new Div(new Text(i18n.getInstructions()));
	Span uuidSpan = new Span(uuid);
	uuidSpan.setClassName("uuid");
	errorLabel.add(instructions, uuidSpan);
	} else {
	String label = errorMessage == null ? i18n.getDefaultErrorMessage() : errorMessage;
	errorLabel.setText(label);
	}

[javier-godoy]

The default error handler initializes errorMessage from the throwable.getLocalizedMessage() (which, regardless of its name, is almost never localized). For unexpected exceptions, it does not make sense to display that information to final users.

You can configure a custom ErrorWindowFactory for a given exception class (and initialize the error window there as you see fit)

ErrorWindowAddon/src/main/java/com/flowingcode/vaadin/addons/errorwindow/ErrorManager.java

Lines 79 to 82 in 24aae5a

	public static void setErrorWindowFactory(Class<? extends Throwable> clazz,
	ErrorWindowFactory errorWindowFactory) {
	factories.put(clazz.asSubclass(Throwable.class), errorWindowFactory);
	}

Alternatively, you can provide custom "instructions" and open ErrorWindow explicitly:

ErrorWindowAddon/src/test/java/com/flowingcode/vaadin/addons/errorwindow/ErrorwindowDemo.java

Lines 75 to 92 in 24aae5a

	Button throwErrorWithCustomMessageAndCustomTexts =
	new Button(
	"Throw Error with custom message (custom labels)",
	ev -> {
	try {
	Integer.parseInt("asdf");
	} catch (NumberFormatException e) {
	ErrorWindowI18n i18n = ErrorWindowI18n.createDefault();
	i18n.setCaption("Uh oh... that's embarrassing");
	i18n.setInstructions(
	"Please pass this unique error identifier to your administrator");
	i18n.setClose("Ok");
	i18n.setDetails("Show me technical details");
	i18n.setDefaultErrorMessage("Something really strange happened");
	ErrorWindow w = new ErrorWindow(e, "CUSTOM ERROR MESSAGE", i18n);
	w.open();
	}
	});

[javier-godoy]

The constructor (Throwable, String) seems to suggest that the string will be displayed as "instructions" (in production mode) and that it will override the exception message (in development mode). As explained above, this is not the current intention of the API, but we acknowledge that it's not good DX.

[mlopezFC]

Maybe we could deprecate that constructor to emphasize that.