Skip to content

[Messenger] Add FlattenExceptionNormalizer #18805

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 1, 2023
Merged

[Messenger] Add FlattenExceptionNormalizer #18805

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion components/messenger.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,9 +161,21 @@ Here are some important envelope stamps that are shipped with the Symfony Messen
#. :class:`Symfony\\Component\\Messenger\\Stamp\\ErrorDetailsStamp`,
an internal stamp when a message fails due to an exception in the handler.

.. note::

The :class:`Symfony\\Component\\Messenger\\Stamp\\ErrorDetailsStamp` stamp
contains a :class:`Symfony\\Component\\ErrorHandler\\Exception\\FlattenException`,
which is a representation of the exception that made the message failed. This
exception can be retrieved with the
:method:`Symfony\\Component\\Messenger\\Stamp\\ErrorDetailsStamp::getFlattenException`
method. This exception is normalized thanks to the
:class:`Symfony\\Component\\Messenger\\Transport\\Serialization\\Normalizer\\FlattenExceptionNormalizer`
which helps error reporting in the Messenger context.

.. versionadded:: 5.2

The ``ErrorDetailsStamp`` stamp was introduced in Symfony 5.2.
The ``ErrorDetailsStamp`` stamp and the ``FlattenExceptionNormalizer``
were introduced in Symfony 5.2.

Instead of dealing directly with the messages in the middleware you receive the envelope.
Hence you can inspect the envelope content and its stamps, or add any::
Expand Down