Add CompatForm::logAndShowError() - #393
Merged
Merged
Conversation
Subclasses that catch an exception or otherwise fail during processing previously had to repeat the same three steps by hand: 1. log the error 2. add it as a form message 3. call `onError()` to mark the form as failed `logAndShowError()` bundles this into one call. Exceptions are logged with their confidential stack trace (argument values redacted, types only) via `IcingaException::getConfidentialTraceAsString()`, so call sites don't need to worry about leaking sensitive data into the log. Plain strings and `Stringable` messages are logged as-is.
jrauh01
force-pushed
the
feature/log-form-errors
branch
from
July 1, 2026 08:20
7d66ee2 to
b4011e1
Compare
Contributor
Author
|
Tests for this are currently not possible due to our test structure. I've added them in #394 so we can add them later. I verified locally that the tests were successful. |
`logAndShowError()` now replaces `{error}` in the template itself and forwards
any extra `$args` to `Form::addMessage()` for the remaining formatting.
lippserd
approved these changes
Jul 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Subclasses that catch an exception or otherwise fail during processing previously had to repeat the same three steps by hand:
onError()to mark the form as failedlogAndShowError()bundles this into one call.Exceptions are logged with their confidential stack trace (argument values redacted, types only) via
IcingaException::getConfidentialTraceAsString(), so call sites don't need to worry about leaking sensitive data into the log. Plain strings andStringablemessages are logged as-is.