[ErrorRenderer] Refactor and delegate serializing responsibility to the Serializer component #34288
Conversation
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
4d3c31d to
99f2631
Compare
yceruto
commented
Nov 8, 2019
| @@ -18,7 +18,6 @@ Console | |||
| Debug | |||
| ----- | |||
|
|
|||
| * Deprecated the `Debug` class, use the one from the `ErrorRenderer` component instead | |||
There was a problem hiding this comment.
[duplicated] the whole component is deprecated (mentioned two lines bellow)
| @@ -57,7 +57,6 @@ Console | |||
| Debug | |||
| ----- | |||
|
|
|||
| * Removed the `Debug` class, use the one from the `ErrorRenderer` component instead | |||
| @@ -26,14 +26,14 @@ | |||
| */ | |||
| class FlattenException extends LegacyFlattenException | |||
| { | |||
| private $title; | |||
There was a problem hiding this comment.
minor refactor for better name (it was introduced in 4.4)
1ae38b6 to
a13b9de
Compare
5bfb7b6 to
05f4b08
Compare
|
Ready for review! (Travis dep=high failures is normal) |
fabpot
requested changes
Nov 9, 2019
| public function normalize($exception, $format = null, array $context = []) | ||
| { | ||
| if (!$exception instanceof FlattenException) { | ||
| $exception = FlattenException::createFromThrowable($exception); |
There was a problem hiding this comment.
What if ErrorRenderer is not installed?
chalasr
reviewed
Nov 10, 2019
| } | ||
| } | ||
| ``` | ||
|
|
||
| Configure your rendering service tagging it with `error_renderer.renderer`. |
There was a problem hiding this comment.
Should be removed from:
|
closing in favor of #34312 |
fabpot
added a commit
that referenced
this pull request
Nov 12, 2019
…onent (nicolas-grekas, yceruto) This PR was merged into the 4.4 branch. Discussion ---------- [ErrorHandler] merge and remove the ErrorRenderer component | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | yes | New feature? | yes | Deprecations? | no | Tickets | - | License | MIT | Doc PR | - This PR supersedes #34288. Here is what it does: - Merge the `ErrorRenderer` component into `ErrorHandler` - Add `ErrorRendererInterface::render(\Throwable $e): FlattenException` and refactor error renderers around it. - Add `FlattenException::setAsString()` to make the previous possible. - Add `CliErrorRenderer` to render error on the CLI too. This means `VarDumper` is now a required dependency of `ErrorHandler`. This paves the way to use it also for rendering HTML - the logic there is much more advanced than what `HtmlErrorRenderer` provides and ever should provide. - Make `BufferingLogger` map its collected logs to `error_log()` if they are not emptied before. - Remove some classes that are not needed anymore (`ErrorRenderer`, `ErrorRendererPass`, `HtmlErrorRendererInterface`) - Simplified the logic in `Debug::enable()` - nobody uses its arguments - Fix a few issues found meanwhile. With these changes, the component can be used standalone. One is now able to require only it, register it either with either `ErrorHandler::register()` or `Debug::enable()` and profit. Commits ------- d1bf1ca [ErrorHandler] help finish the PR 6c9157b [ErrorHandler] merge and remove the ErrorRenderer component
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
By default, the ErrorRenderer component will host only the HTML+JS error page, delegating the serialization of other formats to the Serializer component (if installed & serializer config is enabled). This will simplify the usage and integration with other third-party packages like API-Platform and FOSRestBundle.
Main changes:
ProblemNormalizerto the Serializer component (RFC 7807 compliant),<Format>ErrorRendererand registration mechanism in favor of Serializer's normalizers (seeUPGRADE-4.4.mdchanges),debug:error-renderercommand, it's no longer needed, as well as other classes.Related comment:
wdyt?