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.
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
Add section for Messenger integration #637
Conversation
Resources/doc/messenger.rst
Outdated
@@ -0,0 +1,11 @@ | |||
Messenger integration |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Capitalize "Integration" since this is a title.
Resources/doc/messenger.rst
Outdated
|
||
.. note:: | ||
|
||
The middleware is available when using Symfony 4.4 or newer |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's work this into the previous paragraph.
When using Symfony 4.4 or later, the bundle automatically registers...
Resources/doc/messenger.rst
Outdated
===================== | ||
|
||
The bundle automatically registers a `Messenger`_ middleware that clears | ||
document managers between messages being handled to avoid outdated data. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion:
...that clears all document managers after handling messages, which helps to isolate each handler and guard against reading out-of-date document data.
I summarized that from @weaverryan's explanation in symfony/symfony#34156. You could also considering adding a link to the issue for more context, since there isn't much else to say on this page, but I don't feel strongly either way about that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Dang, now I see it's not even a middleware but rather a event subscriber 👀 I'll go with your summary
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking at the Symfony PR, I think the design changed somewhere along the way. In any event, current text LGTM.
Closes #634