Uses a messenger serializer, not an individual encoder/decoder

sroze · sroze · commit 8ec5532ff026 · 2018-09-09T11:28:13.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,7 +11,8 @@ CHANGELOG
  * Deprecated the `Symfony\Bundle\FrameworkBundle\Controller\Controller` class in favor of `Symfony\Bundle\FrameworkBundle\Controller\AbstractController`.
  * Enabled autoconfiguration for `Psr\Log\LoggerAwareInterface`
  * Added new "auto" mode for `framework.session.cookie_secure` to turn it on when HTTPS is used
-
+ * Removed the `framework.messenger.encoder` and `framework.messenger.decoder` options. Use the `framework.messenger.serializer.id` option to replace the Messenger serializer.
+ 
 4.1.0
 -----
 
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -1030,9 +1030,23 @@ function ($a) {
                             ->end()
                         ->end()
                         ->arrayNode('serializer')
-                            ->{!class_exists(FullStack::class) && class_exists(Serializer::class) ? 'canBeDisabled' : 'canBeEnabled'}()
                             ->addDefaultsIfNotSet()
+                            ->beforeNormalization()
+                                ->always()
+                                ->then(function ($config) {
+                                    if (false === $config) {
+                                        return array('id' => null);
+                                    }
+
+                                    if (\is_string($config)) {
+                                        return array('id' => $config);
+                                    }
+
+                                    return $config;
+                                })
+                            ->end()
                             ->children()
+                                ->scalarNode('id')->defaultValue('messenger.transport.symfony_serializer')->end()
                                 ->scalarNode('format')->defaultValue('json')->end()
                                 ->arrayNode('context')
                                     ->normalizeKeys(false)
@@ -1042,8 +1056,6 @@ function ($a) {
                                 ->end()
                             ->end()
                         ->end()
-                        ->scalarNode('encoder')->defaultValue('messenger.transport.serializer')->end()
-                        ->scalarNode('decoder')->defaultValue('messenger.transport.serializer')->end()
                         ->arrayNode('transports')
                             ->useAttributeAsKey('name')
                             ->arrayPrototype()
diff --git a/DependencyInjection/FrameworkExtension.php b/DependencyInjection/FrameworkExtension.php
@@ -1490,24 +1490,27 @@ private function registerMessengerConfiguration(array $config, ContainerBuilder
 
         $loader->load('messenger.xml');
 
-        if ($this->isConfigEnabled($container, $config['serializer'])) {
-            if (!$this->isConfigEnabled($container, $serializerConfig)) {
-                throw new LogicException('The default Messenger serializer cannot be enabled as the Serializer support is not available. Try enable it or install it by running "composer require symfony/serializer-pack".');
+        if (empty($config['transports'])) {
+            $container->removeDefinition('messenger.transport.symfony_serializer');
+            $container->removeDefinition('messenger.transport.amqp.factory');
+        } else {
+            if ('messenger.transport.symfony_serializer' === $config['serializer']['id']) {
+                if (!$this->isConfigEnabled($container, $serializerConfig)) {
+                    throw new LogicException('The default Messenger serializer cannot be enabled as the Serializer support is not available. Try enable it or install it by running "composer require symfony/serializer-pack".');
+                }
+
+                $container->getDefinition('messenger.transport.symfony_serializer')
+                    ->replaceArgument(1, $config['serializer']['format'])
+                    ->replaceArgument(2, $config['serializer']['context']);
             }
 
-            $container->getDefinition('messenger.transport.serializer')
-                ->replaceArgument(1, $config['serializer']['format'])
-                ->replaceArgument(2, $config['serializer']['context']);
-        } else {
-            $container->removeDefinition('messenger.transport.serializer');
-            if ('messenger.transport.serializer' === $config['encoder'] || 'messenger.transport.serializer' === $config['decoder']) {
+            if ($config['serializer']['id']) {
+                $container->setAlias('messenger.transport.serializer', $config['serializer']['id']);
+            } else {
                 $container->removeDefinition('messenger.transport.amqp.factory');
             }
         }
 
-        $container->setAlias('messenger.transport.encoder', $config['encoder']);
-        $container->setAlias('messenger.transport.decoder', $config['decoder']);
-
         if (null === $config['default_bus']) {
             if (\count($config['buses']) > 1) {
                 throw new LogicException(sprintf('You need to define a default bus with the "default_bus" configuration. Possible values: %s', implode(', ', array_keys($config['buses']))));
diff --git a/Resources/config/messenger.xml b/Resources/config/messenger.xml
@@ -18,7 +18,7 @@
         </service>
 
         <!-- Message encoding/decoding -->
-        <service id="messenger.transport.serializer" class="Symfony\Component\Messenger\Transport\Serialization\Serializer">
+        <service id="messenger.transport.symfony_serializer" class="Symfony\Component\Messenger\Transport\Serialization\Serializer">
             <argument type="service" id="serializer" />
             <argument /> <!-- Format -->
             <argument type="collection" /> <!-- Context -->
@@ -61,8 +61,7 @@
         </service>
 
         <service id="messenger.transport.amqp.factory" class="Symfony\Component\Messenger\Transport\AmqpExt\AmqpTransportFactory">
-            <argument type="service" id="messenger.transport.encoder" />
-            <argument type="service" id="messenger.transport.decoder" />
+            <argument type="service" id="messenger.transport.serializer" />
             <argument>%kernel.debug%</argument>
 
             <tag name="messenger.transport_factory" />
diff --git a/Resources/config/schema/symfony-1.0.xsd b/Resources/config/schema/symfony-1.0.xsd
@@ -378,7 +378,7 @@
             <xsd:element name="context" type="metadata" minOccurs="0" maxOccurs="unbounded" />
         </xsd:sequence>
         <xsd:attribute name="format" type="xsd:string" />
-        <xsd:attribute name="enabled" type="xsd:boolean" />
+        <xsd:attribute name="id" type="xsd:string" />
     </xsd:complexType>
 
     <xsd:complexType name="messenger_routing">
diff --git a/Tests/DependencyInjection/ConfigurationTest.php b/Tests/DependencyInjection/ConfigurationTest.php
@@ -293,12 +293,10 @@ class_exists(SemaphoreStore::class) && SemaphoreStore::isSupported() ? 'semaphor
                 'routing' => array(),
                 'transports' => array(),
                 'serializer' => array(
-                    'enabled' => !class_exists(FullStack::class),
+                    'id' => 'messenger.transport.symfony_serializer',
                     'format' => 'json',
                     'context' => array(),
                 ),
-                'encoder' => 'messenger.transport.serializer',
-                'decoder' => 'messenger.transport.serializer',
                 'default_bus' => null,
                 'buses' => array('messenger.bus.default' => array('default_middleware' => true, 'middleware' => array())),
             ),
diff --git a/Tests/DependencyInjection/Fixtures/php/messenger_amqp_transport_no_serializer.php b/Tests/DependencyInjection/Fixtures/php/messenger_amqp_transport_no_serializer.php
@@ -2,9 +2,7 @@
 
 $container->loadFromExtension('framework', array(
     'messenger' => array(
-        'serializer' => array(
-            'enabled' => false,
-        ),
+        'serializer' => false,
         'transports' => array(
             'default' => 'amqp://localhost/%2f/messages',
         ),
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', array(
     'serializer' => true,
     'messenger' => array(
-        'serializer' => true,
         'routing' => array(
             'Symfony\Component\Messenger\Tests\Fixtures\DummyMessage' => array('amqp', 'audit'),
             'Symfony\Component\Messenger\Tests\Fixtures\SecondMessage' => array(
diff --git a/Tests/DependencyInjection/Fixtures/php/messenger_transport.php b/Tests/DependencyInjection/Fixtures/php/messenger_transport.php
@@ -7,5 +7,8 @@
             'format' => 'csv',
             'context' => array('enable_max_depth' => true),
         ),
+        'transports' => array(
+            'default' => 'amqp://localhost/%2f/messages',
+        ),
     ),
 ));
diff --git a/Tests/DependencyInjection/Fixtures/php/messenger_transport_no_serializer.php b/Tests/DependencyInjection/Fixtures/php/messenger_transport_no_serializer.php
@@ -5,9 +5,6 @@
         'enabled' => false,
     ),
     'messenger' => array(
-        'serializer' => array(
-            'enabled' => true,
-        ),
         'transports' => array(
             'default' => 'amqp://localhost/%2f/messages',
         ),
diff --git a/Tests/DependencyInjection/Fixtures/php/messenger_transports.php b/Tests/DependencyInjection/Fixtures/php/messenger_transports.php
@@ -3,7 +3,6 @@
 $container->loadFromExtension('framework', array(
     'serializer' => true,
     'messenger' => array(
-        'serializer' => true,
         'transports' => array(
             'default' => 'amqp://localhost/%2f/messages',
             'customised' => array(
diff --git a/Tests/DependencyInjection/Fixtures/php/serializer_disabled.php b/Tests/DependencyInjection/Fixtures/php/serializer_disabled.php
@@ -4,7 +4,4 @@
     'serializer' => array(
         'enabled' => false,
     ),
-    'messenger' => array(
-        'serializer' => false,
-    ),
 ));
diff --git a/Tests/DependencyInjection/Fixtures/xml/messenger.xml b/Tests/DependencyInjection/Fixtures/xml/messenger.xml
@@ -7,7 +7,6 @@
 
     <framework:config>
         <framework:messenger>
-            <framework:serializer enabled="false" />
             <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_amqp_transport_no_serializer.xml b/Tests/DependencyInjection/Fixtures/xml/messenger_amqp_transport_no_serializer.xml
@@ -7,7 +7,7 @@
 
     <framework:config>
         <framework:messenger>
-            <framework:serializer enabled="false" />
+            <framework:serializer id="null" />
             <framework:transport name="default" dsn="amqp://localhost/%2f/messages" />
         </framework:messenger>
     </framework:config>
diff --git a/Tests/DependencyInjection/Fixtures/xml/messenger_routing.xml b/Tests/DependencyInjection/Fixtures/xml/messenger_routing.xml
@@ -8,7 +8,6 @@
     <framework:config>
         <framework:serializer enabled="true" />
         <framework:messenger>
-            <framework:serializer enabled="true" />
             <framework:routing message-class="Symfony\Component\Messenger\Tests\Fixtures\DummyMessage">
                 <framework:sender service="amqp" />
                 <framework:sender service="audit" />
diff --git a/Tests/DependencyInjection/Fixtures/xml/messenger_transport.xml b/Tests/DependencyInjection/Fixtures/xml/messenger_transport.xml
@@ -13,6 +13,7 @@
                     <framework:enable_max_depth>true</framework:enable_max_depth>
                 </framework:context>
             </framework:serializer>
+            <framework:transport name="default" dsn="amqp://localhost/%2f/messages" />
         </framework:messenger>
     </framework:config>
 </container>
diff --git a/Tests/DependencyInjection/Fixtures/xml/messenger_transport_no_serializer.xml b/Tests/DependencyInjection/Fixtures/xml/messenger_transport_no_serializer.xml
@@ -8,7 +8,6 @@
     <framework:config>
         <framework:serializer enabled="false" />
         <framework:messenger>
-            <framework:serializer enabled="true" />
             <framework:transport name="default" dsn="amqp://localhost/%2f/messages" />
         </framework:messenger>
     </framework:config>
diff --git a/Tests/DependencyInjection/Fixtures/xml/messenger_transports.xml b/Tests/DependencyInjection/Fixtures/xml/messenger_transports.xml
@@ -8,7 +8,6 @@
     <framework:config>
         <framework:serializer enabled="true" />
         <framework:messenger>
-            <framework:serializer enabled="true" />
             <framework:transport name="default" dsn="amqp://localhost/%2f/messages" />
             <framework:transport name="customised" dsn="amqp://localhost/%2f/messages?exchange_name=exchange_name">
                 <framework:options>
diff --git a/Tests/DependencyInjection/Fixtures/xml/serializer_disabled.xml b/Tests/DependencyInjection/Fixtures/xml/serializer_disabled.xml
@@ -7,8 +7,5 @@
 
     <framework:config>
         <framework:serializer enabled="false" />
-        <framework:messenger>
-            <framework:serializer enabled="false" />
-        </framework:messenger>
     </framework:config>
 </container>
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:
-        serializer: true
         routing:
             'Symfony\Component\Messenger\Tests\Fixtures\DummyMessage': [amqp, audit]
             'Symfony\Component\Messenger\Tests\Fixtures\SecondMessage':
diff --git a/Tests/DependencyInjection/Fixtures/yml/messenger_transport.yml b/Tests/DependencyInjection/Fixtures/yml/messenger_transport.yml
@@ -5,3 +5,5 @@ framework:
             format: csv
             context:
                 enable_max_depth: true
+        transports:
+            default: 'amqp://localhost/%2f/messages'
diff --git a/Tests/DependencyInjection/Fixtures/yml/messenger_transport_no_serializer.yml b/Tests/DependencyInjection/Fixtures/yml/messenger_transport_no_serializer.yml
@@ -2,7 +2,5 @@ framework:
     serializer:
         enabled: false
     messenger:
-        serializer:
-            enabled: true
         transports:
             default: 'amqp://localhost/%2f/messages'
diff --git a/Tests/DependencyInjection/Fixtures/yml/messenger_transports.yml b/Tests/DependencyInjection/Fixtures/yml/messenger_transports.yml
@@ -1,7 +1,6 @@
 framework:
     serializer: true
     messenger:
-        serializer: true
         transports:
             default: 'amqp://localhost/%2f/messages'
             customised:
diff --git a/Tests/DependencyInjection/Fixtures/yml/serializer_disabled.yml b/Tests/DependencyInjection/Fixtures/yml/serializer_disabled.yml
@@ -1,5 +1,3 @@
 framework:
     serializer:
         enabled: false
-    messenger:
-        serializer: false
diff --git a/Tests/DependencyInjection/FrameworkExtensionTest.php b/Tests/DependencyInjection/FrameworkExtensionTest.php
@@ -604,10 +604,9 @@ public function testMessengerTransportConfiguration()
     {
         $container = $this->createContainerFromFile('messenger_transport');
 
-        $this->assertSame('messenger.transport.serializer', (string) $container->getAlias('messenger.transport.encoder'));
-        $this->assertSame('messenger.transport.serializer', (string) $container->getAlias('messenger.transport.decoder'));
+        $this->assertSame('messenger.transport.symfony_serializer', (string) $container->getAlias('messenger.transport.serializer'));
 
-        $serializerTransportDefinition = $container->getDefinition('messenger.transport.serializer');
+        $serializerTransportDefinition = $container->getDefinition('messenger.transport.symfony_serializer');
         $this->assertSame('csv', $serializerTransportDefinition->getArgument(1));
         $this->assertSame(array('enable_max_depth' => true), $serializerTransportDefinition->getArgument(2));
     }
