[FrameworkBundle] Make the messenger.reset_on_message config option default to true

upyx · upyx · commit b07c0f5b701c · 2021-11-05T22:47:32.000+03:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -21,6 +21,7 @@ CHANGELOG
  * Remove support for passing a `RouteCollectionBuilder` to `MicroKernelTrait::configureRoutes()`, type-hint `RoutingConfigurator` instead
  * Remove the `cache.adapter.doctrine` service
  * Remove the `framework.translator.enabled_locales` config option, use `framework.enabled_locales` instead
+ * Make the `framework.messenger.reset_on_message` configuration option default to `true`
 
 5.4
 ---
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -1422,8 +1422,12 @@ function ($a) {
                             ->info('Transport name to send failed messages to (after all retries have failed).')
                         ->end()
                         ->booleanNode('reset_on_message')
-                            ->defaultNull()
+                            ->defaultTrue()
                             ->info('Reset container services after each message.')
+                            ->validate()
+                                ->ifTrue(static fn ($v) => true !== $v)
+                                ->thenInvalid('The "framework.messenger.reset_on_message" configuration option can be set to "true" only. To prevent services resetting after each message you can set the "--no-reset" option in "messenger:consume" command.')
+                            ->end()
                         ->end()
                         ->scalarNode('default_bus')->defaultNull()->end()
                         ->arrayNode('buses')
diff --git a/DependencyInjection/FrameworkExtension.php b/DependencyInjection/FrameworkExtension.php
@@ -2067,17 +2067,8 @@ private function registerMessengerConfiguration(array $config, ContainerBuilder
             $container->removeDefinition('console.command.messenger_failed_messages_remove');
         }
 
-        if (false === $config['reset_on_message']) {
-            throw new LogicException('The "framework.messenger.reset_on_message" configuration option can be set to "true" only. To prevent services resetting after each message you can set the "--no-reset" option in "messenger:consume" command.');
-        }
-
         if (!$container->hasDefinition('console.command.messenger_consume_messages')) {
             $container->removeDefinition('messenger.listener.reset_services');
-        } elseif (null === $config['reset_on_message']) {
-            trigger_deprecation('symfony/framework-bundle', '5.4', 'Not setting the "framework.messenger.reset_on_message" configuration option is deprecated, it will default to "true" in version 6.0.');
-
-            $container->getDefinition('console.command.messenger_consume_messages')->replaceArgument(5, null);
-            $container->removeDefinition('messenger.listener.reset_services');
         }
     }
 
diff --git a/Tests/DependencyInjection/ConfigurationTest.php b/Tests/DependencyInjection/ConfigurationTest.php
@@ -536,7 +536,7 @@ class_exists(SemaphoreStore::class) && SemaphoreStore::isSupported() ? 'semaphor
                 ],
                 'default_bus' => null,
                 'buses' => ['messenger.bus.default' => ['default_middleware' => true, 'middleware' => []]],
-                'reset_on_message' => null,
+                'reset_on_message' => true,
             ],
             'disallow_search_engine_index' => true,
             'http_client' => [
diff --git a/Tests/DependencyInjection/Fixtures/php/messenger.php b/Tests/DependencyInjection/Fixtures/php/messenger.php
@@ -5,7 +5,6 @@
 
 $container->loadFromExtension('framework', [
     'messenger' => [
-        'reset_on_message' =>  true,
         'routing' => [
             FooMessage::class => ['sender.bar', 'sender.biz'],
             BarMessage::class => 'sender.foo',
diff --git a/Tests/DependencyInjection/Fixtures/php/messenger_middleware_factory_erroneous_format.php b/Tests/DependencyInjection/Fixtures/php/messenger_middleware_factory_erroneous_format.php
@@ -2,7 +2,6 @@
 
 $container->loadFromExtension('framework', [
     'messenger' => [
-        'reset_on_message' =>  true,
         'buses' => [
             'command_bus' => [
                 'middleware' => [
diff --git a/Tests/DependencyInjection/Fixtures/php/messenger_multiple_buses.php b/Tests/DependencyInjection/Fixtures/php/messenger_multiple_buses.php
@@ -2,7 +2,6 @@
 
 $container->loadFromExtension('framework', [
     'messenger' => [
-        'reset_on_message' =>  true,
         'default_bus' => 'messenger.bus.commands',
         'buses' => [
             'messenger.bus.commands' => null,
diff --git a/Tests/DependencyInjection/Fixtures/php/messenger_multiple_failure_transports.php b/Tests/DependencyInjection/Fixtures/php/messenger_multiple_failure_transports.php
@@ -2,7 +2,6 @@
 
 $container->loadFromExtension('framework', [
     'messenger' => [
-        'reset_on_message' =>  true,
         'transports' => [
             'transport_1' => [
                 'dsn' => 'null://',
diff --git a/Tests/DependencyInjection/Fixtures/php/messenger_multiple_failure_transports_global.php b/Tests/DependencyInjection/Fixtures/php/messenger_multiple_failure_transports_global.php
@@ -3,7 +3,6 @@
 $container->loadFromExtension('framework', [
     'messenger' => [
         'failure_transport' => 'failure_transport_global',
-        'reset_on_message' =>  true,
         'transports' => [
             'transport_1' => [
                 'dsn' => 'null://',
diff --git a/Tests/DependencyInjection/Fixtures/php/messenger_routing.php b/Tests/DependencyInjection/Fixtures/php/messenger_routing.php
@@ -3,7 +3,6 @@
 $container->loadFromExtension('framework', [
     'serializer' => true,
     'messenger' => [
-        'reset_on_message' =>  true,
         'serializer' => [
             'default_serializer' => 'messenger.transport.symfony_serializer',
         ],
diff --git a/Tests/DependencyInjection/Fixtures/php/messenger_routing_invalid_transport.php b/Tests/DependencyInjection/Fixtures/php/messenger_routing_invalid_transport.php
@@ -3,7 +3,6 @@
 $container->loadFromExtension('framework', [
     'serializer' => true,
     'messenger' => [
-        'reset_on_message' =>  true,
         'serializer' => [
             'default_serializer' => 'messenger.transport.symfony_serializer',
         ],
diff --git a/Tests/DependencyInjection/Fixtures/php/messenger_routing_single.php b/Tests/DependencyInjection/Fixtures/php/messenger_routing_single.php
@@ -2,7 +2,6 @@
 
 $container->loadFromExtension('framework', [
     'messenger' => [
-        'reset_on_message' =>  true,
         'routing' => [
             'Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Messenger\DummyMessage' => ['amqp'],
         ],
diff --git a/Tests/DependencyInjection/Fixtures/php/messenger_transport.php b/Tests/DependencyInjection/Fixtures/php/messenger_transport.php
@@ -3,7 +3,6 @@
 $container->loadFromExtension('framework', [
     'serializer' => true,
     'messenger' => [
-        'reset_on_message' =>  true,
         'serializer' => [
             'default_serializer' => 'messenger.transport.symfony_serializer',
             'symfony_serializer' => [
diff --git a/Tests/DependencyInjection/Fixtures/php/messenger_transports.php b/Tests/DependencyInjection/Fixtures/php/messenger_transports.php
@@ -4,7 +4,6 @@
     'serializer' => true,
     'messenger' => [
         'failure_transport' => 'failed',
-        'reset_on_message' =>  true,
         'serializer' => [
             'default_serializer' => 'messenger.transport.symfony_serializer',
         ],
diff --git a/Tests/DependencyInjection/Fixtures/php/messenger_with_explict_reset_on_message_legacy.php b/Tests/DependencyInjection/Fixtures/php/messenger_with_explict_reset_on_message_legacy.php
@@ -5,6 +5,7 @@
 
 $container->loadFromExtension('framework', [
     'messenger' => [
+        'reset_on_message' =>  true,
         'routing' => [
             FooMessage::class => ['sender.bar', 'sender.biz'],
             BarMessage::class => 'sender.foo',
diff --git a/Tests/DependencyInjection/Fixtures/php/notifier.php b/Tests/DependencyInjection/Fixtures/php/notifier.php
@@ -5,8 +5,7 @@
 
 $container->loadFromExtension('framework', [
     'messenger' => [
-        'enabled' => true,
-        'reset_on_message' =>  true,
+        'enabled' => true
     ],
     'mailer' => [
         'dsn' => 'smtp://example.com',
diff --git a/Tests/DependencyInjection/Fixtures/php/notifier_without_mailer.php b/Tests/DependencyInjection/Fixtures/php/notifier_without_mailer.php
@@ -9,7 +9,6 @@
     ],
     'messenger' => [
         'enabled' => true,
-        'reset_on_message' =>  true,
     ],
     'notifier' => [
         'enabled' => true,
diff --git a/Tests/DependencyInjection/Fixtures/xml/messenger.xml b/Tests/DependencyInjection/Fixtures/xml/messenger.xml
@@ -6,7 +6,7 @@
         http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
 
     <framework:config>
-        <framework:messenger reset-on-message="true">
+        <framework:messenger>
             <framework:routing message-class="Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Messenger\FooMessage">
                 <framework:sender service="sender.bar" />
                 <framework:sender service="sender.biz" />
diff --git a/Tests/DependencyInjection/Fixtures/xml/messenger_multiple_buses.xml b/Tests/DependencyInjection/Fixtures/xml/messenger_multiple_buses.xml
@@ -6,7 +6,7 @@
         http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
 
     <framework:config>
-        <framework:messenger default-bus="messenger.bus.commands" reset-on-message="true">
+        <framework:messenger default-bus="messenger.bus.commands">
             <framework:bus name="messenger.bus.commands" />
             <framework:bus name="messenger.bus.events">
                 <framework:middleware id="with_factory">
diff --git a/Tests/DependencyInjection/Fixtures/xml/messenger_multiple_failure_transports.xml b/Tests/DependencyInjection/Fixtures/xml/messenger_multiple_failure_transports.xml
@@ -6,7 +6,7 @@
         http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
 
     <framework:config>
-        <framework:messenger reset-on-message="true">
+        <framework:messenger>
             <framework:transport name="transport_1" dsn="null://" failure-transport="failure_transport_1" />
             <framework:transport name="transport_2" dsn="null://" />
             <framework:transport name="transport_3" dsn="null://" failure-transport="failure_transport_3" />
diff --git a/Tests/DependencyInjection/Fixtures/xml/messenger_multiple_failure_transports_global.xml b/Tests/DependencyInjection/Fixtures/xml/messenger_multiple_failure_transports_global.xml
@@ -6,7 +6,7 @@
         http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
 
     <framework:config>
-        <framework:messenger failure-transport="failure_transport_global" reset-on-message="true">
+        <framework:messenger failure-transport="failure_transport_global">
             <framework:transport name="transport_1" dsn="null://" failure-transport="failure_transport_1" />
             <framework:transport name="transport_2" dsn="null://" />
             <framework:transport name="transport_3" dsn="null://" failure-transport="failure_transport_3" />
diff --git a/Tests/DependencyInjection/Fixtures/xml/messenger_routing.xml b/Tests/DependencyInjection/Fixtures/xml/messenger_routing.xml
@@ -7,7 +7,7 @@
 
     <framework:config>
         <framework:serializer enabled="true" />
-        <framework:messenger reset-on-message="true">
+        <framework:messenger>
             <framework:serializer default-serializer="messenger.transport.symfony_serializer" />
             <framework:routing message-class="Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Messenger\DummyMessage">
                 <framework:sender service="amqp" />
diff --git a/Tests/DependencyInjection/Fixtures/xml/messenger_routing_invalid_transport.xml b/Tests/DependencyInjection/Fixtures/xml/messenger_routing_invalid_transport.xml
@@ -7,7 +7,7 @@
 
     <framework:config>
         <framework:serializer enabled="true" />
-        <framework:messenger reset-on-message="true">
+        <framework:messenger>
             <framework:serializer default-serializer="messenger.transport.symfony_serializer" />
             <framework:routing message-class="Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Messenger\DummyMessage">
                 <framework:sender service="invalid" />
diff --git a/Tests/DependencyInjection/Fixtures/xml/messenger_routing_single.xml b/Tests/DependencyInjection/Fixtures/xml/messenger_routing_single.xml
@@ -6,7 +6,7 @@
         http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
 
     <framework:config>
-        <framework:messenger reset-on-message="true">
+        <framework:messenger>
             <framework:routing message-class="Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Messenger\DummyMessage">
                 <framework:sender service="amqp" />
             </framework:routing>
diff --git a/Tests/DependencyInjection/Fixtures/xml/messenger_transport.xml b/Tests/DependencyInjection/Fixtures/xml/messenger_transport.xml
@@ -7,7 +7,7 @@
 
     <framework:config>
         <framework:serializer enabled="true" />
-        <framework:messenger reset-on-message="true">
+        <framework:messenger>
             <framework:serializer default-serializer="messenger.transport.symfony_serializer">
                 <framework:symfony-serializer format="csv">
                     <framework:context>
diff --git a/Tests/DependencyInjection/Fixtures/xml/messenger_transports.xml b/Tests/DependencyInjection/Fixtures/xml/messenger_transports.xml
@@ -7,7 +7,7 @@
 
     <framework:config>
         <framework:serializer enabled="true" />
-        <framework:messenger failure-transport="failed" reset-on-message="true">
+        <framework:messenger failure-transport="failed">
             <framework:serializer default-serializer="messenger.transport.symfony_serializer" />
             <framework:transport name="default" dsn="amqp://localhost/%2f/messages" />
             <framework:transport name="customised" dsn="amqp://localhost/%2f/messages?exchange_name=exchange_name" serializer="messenger.transport.native_php_serializer">
diff --git a/Tests/DependencyInjection/Fixtures/xml/messenger_with_explict_reset_on_message_legacy.xml b/Tests/DependencyInjection/Fixtures/xml/messenger_with_explict_reset_on_message_legacy.xml
@@ -6,7 +6,7 @@
         http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
 
     <framework:config>
-        <framework:messenger>
+        <framework:messenger reset-on-message="true">
             <framework:routing message-class="Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Messenger\FooMessage">
                 <framework:sender service="sender.bar" />
                 <framework:sender service="sender.biz" />
diff --git a/Tests/DependencyInjection/Fixtures/xml/notifier.xml b/Tests/DependencyInjection/Fixtures/xml/notifier.xml
@@ -6,7 +6,7 @@
         http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
 
     <framework:config>
-        <framework:messenger enabled="true" reset-on-message="true" />
+        <framework:messenger enabled="true" />
         <framework:mailer dsn="smtp://example.com" />
         <framework:notifier enabled="true" notification-on-failed-messages="true">
             <framework:chatter-transport name="slack">null</framework:chatter-transport>
diff --git a/Tests/DependencyInjection/Fixtures/xml/notifier_without_mailer.xml b/Tests/DependencyInjection/Fixtures/xml/notifier_without_mailer.xml
@@ -7,7 +7,7 @@
 
     <framework:config>
         <framework:mailer enabled="false" />
-        <framework:messenger enabled="true" reset-on-message="true" />
+        <framework:messenger enabled="true" />
         <framework:notifier enabled="true" notification-on-failed-messages="true">
             <framework:chatter-transport name="slack">null</framework:chatter-transport>
             <framework:texter-transport name="twilio">null</framework:texter-transport>
diff --git a/Tests/DependencyInjection/Fixtures/yml/messenger.yml b/Tests/DependencyInjection/Fixtures/yml/messenger.yml
@@ -1,6 +1,5 @@
 framework:
     messenger:
-        reset_on_message: true
         routing:
             'Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Messenger\FooMessage': ['sender.bar', 'sender.biz']
             'Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Messenger\BarMessage': 'sender.foo'
diff --git a/Tests/DependencyInjection/Fixtures/yml/messenger_middleware_factory_erroneous_format.yml b/Tests/DependencyInjection/Fixtures/yml/messenger_middleware_factory_erroneous_format.yml
@@ -1,6 +1,5 @@
 framework:
     messenger:
-        reset_on_message: true
         buses:
             command_bus:
                 middleware:
diff --git a/Tests/DependencyInjection/Fixtures/yml/messenger_multiple_buses.yml b/Tests/DependencyInjection/Fixtures/yml/messenger_multiple_buses.yml
@@ -1,6 +1,5 @@
 framework:
     messenger:
-        reset_on_message: true
         default_bus: messenger.bus.commands
         buses:
             messenger.bus.commands: ~
diff --git a/Tests/DependencyInjection/Fixtures/yml/messenger_multiple_failure_transports.yml b/Tests/DependencyInjection/Fixtures/yml/messenger_multiple_failure_transports.yml
@@ -1,6 +1,5 @@
 framework:
     messenger:
-        reset_on_message: true
         transports:
             transport_1:
                 dsn: 'null://'
diff --git a/Tests/DependencyInjection/Fixtures/yml/messenger_multiple_failure_transports_global.yml b/Tests/DependencyInjection/Fixtures/yml/messenger_multiple_failure_transports_global.yml
@@ -1,6 +1,5 @@
 framework:
     messenger:
-        reset_on_message: true
         failure_transport: failure_transport_global
         transports:
             transport_1:
diff --git a/Tests/DependencyInjection/Fixtures/yml/messenger_routing.yml b/Tests/DependencyInjection/Fixtures/yml/messenger_routing.yml
@@ -1,7 +1,6 @@
 framework:
     serializer: true
     messenger:
-        reset_on_message: true
         serializer:
             default_serializer: messenger.transport.symfony_serializer
         routing:
diff --git a/Tests/DependencyInjection/Fixtures/yml/messenger_routing_invalid_transport.yml b/Tests/DependencyInjection/Fixtures/yml/messenger_routing_invalid_transport.yml
@@ -1,7 +1,6 @@
 framework:
     serializer: true
     messenger:
-        reset_on_message: true
         serializer:
             default_serializer: messenger.transport.symfony_serializer
         routing:
diff --git a/Tests/DependencyInjection/Fixtures/yml/messenger_routing_single.yml b/Tests/DependencyInjection/Fixtures/yml/messenger_routing_single.yml
@@ -1,6 +1,5 @@
 framework:
     messenger:
-        reset_on_message: true
         routing:
             'Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Messenger\DummyMessage': [amqp]
 
diff --git a/Tests/DependencyInjection/Fixtures/yml/messenger_transport.yml b/Tests/DependencyInjection/Fixtures/yml/messenger_transport.yml
@@ -1,7 +1,6 @@
 framework:
     serializer: true
     messenger:
-        reset_on_message: true
         serializer:
             default_serializer: messenger.transport.symfony_serializer
             symfony_serializer:
diff --git a/Tests/DependencyInjection/Fixtures/yml/messenger_transports.yml b/Tests/DependencyInjection/Fixtures/yml/messenger_transports.yml
@@ -2,7 +2,6 @@ framework:
     serializer: true
     messenger:
         failure_transport: failed
-        reset_on_message: true
         serializer:
             default_serializer: messenger.transport.symfony_serializer
         transports:
diff --git a/Tests/DependencyInjection/Fixtures/yml/messenger_with_explict_reset_on_message_legacy.yml b/Tests/DependencyInjection/Fixtures/yml/messenger_with_explict_reset_on_message_legacy.yml
@@ -1,5 +1,6 @@
 framework:
     messenger:
+        reset_on_message: true
         routing:
             'Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Messenger\FooMessage': ['sender.bar', 'sender.biz']
             'Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Messenger\BarMessage': 'sender.foo'
diff --git a/Tests/DependencyInjection/Fixtures/yml/notifier.yml b/Tests/DependencyInjection/Fixtures/yml/notifier.yml
@@ -1,7 +1,6 @@
 framework:
     messenger:
         enabled: true
-        reset_on_message: true
     mailer:
         dsn: 'smtp://example.com'
     notifier:
diff --git a/Tests/DependencyInjection/Fixtures/yml/notifier_without_mailer.yml b/Tests/DependencyInjection/Fixtures/yml/notifier_without_mailer.yml
@@ -3,7 +3,6 @@ framework:
         enabled: false
     messenger:
         enabled: true
-        reset_on_message: true
     notifier:
         enabled: true
         notification_on_failed_messages: true
diff --git a/Tests/DependencyInjection/FrameworkExtensionTest.php b/Tests/DependencyInjection/FrameworkExtensionTest.php
diff --git a/composer.json b/composer.json

Original file line number	Diff line number	Diff line change
`@@ -2067,17 +2067,8 @@ private function registerMessengerConfiguration(array $config, ContainerBuilder`
`2067`	`2067`	`$container->removeDefinition('console.command.messenger_failed_messages_remove');`
`2068`	`2068`	`}`
`2069`	`2069`
`2070`		`- if (false === $config['reset_on_message']) {`
`2071`		`- throw new LogicException('The "framework.messenger.reset_on_message" configuration option can be set to "true" only. To prevent services resetting after each message you can set the "--no-reset" option in "messenger:consume" command.');`
`2072`		`- }`
`2073`		`-`
`2074`	`2070`	`if (!$container->hasDefinition('console.command.messenger_consume_messages')) {`
`2075`	`2071`	`$container->removeDefinition('messenger.listener.reset_services');`
`2076`		`- } elseif (null === $config['reset_on_message']) {`
`2077`		`- trigger_deprecation('symfony/framework-bundle', '5.4', 'Not setting the "framework.messenger.reset_on_message" configuration option is deprecated, it will default to "true" in version 6.0.');`
`2078`		`-`
`2079`		`- $container->getDefinition('console.command.messenger_consume_messages')->replaceArgument(5, null);`
`2080`		`- $container->removeDefinition('messenger.listener.reset_services');`
`2081`	`2072`	`}`
`2082`	`2073`	`}`
`2083`	`2074`