Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork5.3k
[Messenger] document reset_on_message transport option#15796
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
+63 −0
Merged
Changes fromall commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
63 changes: 63 additions & 0 deletionsmessenger.rst
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -696,6 +696,69 @@ of the desired grace period in seconds) in order to perform a graceful shutdown: | ||
| [program:x] | ||
| stopwaitsecs=20 | ||
| Stateless Worker | ||
| ~~~~~~~~~~~~~~~~ | ||
| PHP was designed to be stateless: everything is lost after processing an HTTP | ||
lyrixx marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| request. When you run your application in an HTTP context, you may not take care | ||
| of services states that may leak services since PHP clean everything after | ||
| sending the response. | ||
| Since worker run in a CLI context, you need to be careful about services state. | ||
| You should avoid to put a state in a service to avoid leaking some information | ||
lyrixx marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| and/or memory from one message to another message. | ||
| Some symfony services leak by nature. For example the monolog fingers crossed | ||
| handler. To avoid such situations, you can configure a transport to | ||
| automatically reset the container between two messages: | ||
| .. configuration-block:: | ||
| .. code-block:: yaml | ||
| # config/packages/messenger.yaml | ||
| framework: | ||
| messenger: | ||
| transports: | ||
| async: | ||
| dsn: '%env(MESSENGER_TRANSPORT_DSN)%' | ||
| reset_on_message: true | ||
| .. code-block:: xml | ||
| <!-- config/packages/messenger.xml --> | ||
| <?xml version="1.0" encoding="UTF-8" ?> | ||
| <container xmlns="http://symfony.com/schema/dic/services" | ||
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
| xmlns:framework="http://symfony.com/schema/dic/symfony" | ||
| xsi:schemaLocation="http://symfony.com/schema/dic/services | ||
| https://symfony.com/schema/dic/services/services-1.0.xsd | ||
| http://symfony.com/schema/dic/symfony | ||
| https://symfony.com/schema/dic/symfony/symfony-1.0.xsd"> | ||
| <framework:config> | ||
| <framework:messenger> | ||
| <framework:transport name="async" dsn="%env(MESSENGER_TRANSPORT_DSN)%" reset-on-message="true"> | ||
| </framework:transport> | ||
| </framework:messenger> | ||
| </framework:config> | ||
| </container> | ||
| .. code-block:: php | ||
| // config/packages/messenger.php | ||
| use Symfony\Config\FrameworkConfig; | ||
| return static function (FrameworkConfig $framework) { | ||
| $messenger = $framework->messenger(); | ||
| $messenger->transport('async') | ||
| ->dsn('%env(MESSENGER_TRANSPORT_DSN)%') | ||
| ->resetOnMessage(true) | ||
| ; | ||
| }; | ||
| .. _messenger-retries-failures: | ||
| Retries & Failures | ||
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.