Making the serializer configurable by transport

weaverryan · weaverryan · commit 1fc3ef311801 · 2019-03-21T10:47:28.000-04:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -1095,6 +1095,7 @@ function ($a) {
                                 ->fixXmlConfig('option')
                                 ->children()
                                     ->scalarNode('dsn')->end()
+                                    ->scalarNode('serializer')->defaultNull()->info('Service id of a custom serializer to use.')->end()
                                     ->arrayNode('options')
                                         ->normalizeKeys(false)
                                         ->defaultValue([])
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -1587,22 +1587,10 @@ private function registerMessengerConfiguration(array $config, ContainerBuilder
             $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 Messenger serializer cannot be enabled as the Serializer support is not available. Try enabling it or running "composer require symfony/serializer-pack".');
-                }
-
-                $container->getDefinition('messenger.transport.symfony_serializer')
-                    ->replaceArgument(1, $config['serializer']['format'])
-                    ->replaceArgument(2, $config['serializer']['context']);
-            }
-
-            if ($config['serializer']['id']) {
-                $container->setAlias('messenger.transport.serializer', $config['serializer']['id']);
-            } else {
-                $container->removeDefinition('messenger.transport.amqp.factory');
-                $container->removeDefinition(SerializerInterface::class);
-            }
+            $container->getDefinition('messenger.transport.symfony_serializer')
+                ->replaceArgument(1, $config['serializer']['format'])
+                ->replaceArgument(2, $config['serializer']['context']);
+            $container->setAlias('messenger.transport.serializer', $config['serializer']['id']);
         }
 
         if (null === $config['default_bus'] && 1 === \count($config['buses'])) {
@@ -1648,8 +1636,8 @@ private function registerMessengerConfiguration(array $config, ContainerBuilder
 
         $senderAliases = [];
         foreach ($config['transports'] as $name => $transport) {
-            if (0 === strpos($transport['dsn'], 'amqp://') && !$container->hasDefinition('messenger.transport.amqp.factory')) {
-                throw new LogicException('The default AMQP transport is not available. Make sure you have installed and enabled the Serializer component. Try enabling it or running "composer require symfony/serializer-pack".');
+            if (null !== $transport['serializer']) {
+                $transport['options']['serializer'] = new Reference($transport['serializer']);
             }
 
             $transportDefinition = (new Definition(TransportInterface::class))
diff --git a/src/Symfony/Component/Messenger/Tests/Transport/AmqpExt/AmqpTransportFactoryTest.php b/src/Symfony/Component/Messenger/Tests/Transport/AmqpExt/AmqpTransportFactoryTest.php
@@ -15,6 +15,7 @@
 use Symfony\Component\Messenger\Transport\AmqpExt\AmqpTransport;
 use Symfony\Component\Messenger\Transport\AmqpExt\AmqpTransportFactory;
 use Symfony\Component\Messenger\Transport\AmqpExt\Connection;
+use Symfony\Component\Messenger\Transport\Serialization\PhpSerializer;
 use Symfony\Component\Messenger\Transport\Serialization\SerializerInterface;
 
 class AmqpTransportFactoryTest extends TestCase
@@ -40,4 +41,19 @@ public function testItCreatesTheTransport()
 
         $this->assertEquals($expectedTransport, $factory->createTransport('amqp://localhost', ['foo' => 'bar']));
     }
+
+    public function testItCreatesTheTransportWithACustomSerializer()
+    {
+        $factory = new AmqpTransportFactory(
+            $this->createMock(SerializerInterface::class)
+        );
+
+        // make a different serializer than the one above
+        $serializer = $this->createMock(PhpSerializer::class);
+
+        $expectedTransport = new AmqpTransport(Connection::fromDsn('amqp://localhost', ['foo' => 'bar']), $serializer);
+
+
+        $this->assertEquals($expectedTransport, $factory->createTransport('amqp://localhost', ['foo' => 'bar', 'serializer' => $serializer]));
+    }
 }
diff --git a/src/Symfony/Component/Messenger/Transport/AmqpExt/AmqpTransportFactory.php b/src/Symfony/Component/Messenger/Transport/AmqpExt/AmqpTransportFactory.php
@@ -32,7 +32,10 @@ public function __construct(SerializerInterface $serializer = null)
 
     public function createTransport(string $dsn, array $options): TransportInterface
     {
-        return new AmqpTransport(Connection::fromDsn($dsn, $options), $this->serializer);
+        $serializer = $options['serializer'] ?? $this->serializer;
+        unset($options['serializer']);
+
+        return new AmqpTransport(Connection::fromDsn($dsn, $options), $serializer);
     }
 
     public function supports(string $dsn, array $options): bool
diff --git a/src/Symfony/Component/Messenger/Transport/TransportFactoryInterface.php b/src/Symfony/Component/Messenger/Transport/TransportFactoryInterface.php
@@ -20,6 +20,13 @@
  */
 interface TransportFactoryInterface
 {
+    /**
+     * Creates a new transport using the dsn & options.
+     *
+     * Options can include anything that's understood by the transport.
+     * A "serializer" key may be passed to indicate a customer serializer
+     * object that the transport should use.
+     */
     public function createTransport(string $dsn, array $options): TransportInterface;
 
     public function supports(string $dsn, array $options): bool;

Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,10 @@ public function __construct(SerializerInterface $serializer = null)`
`32`	`32`
`33`	`33`	`public function createTransport(string $dsn, array $options): TransportInterface`
`34`	`34`	`{`
`35`		`- return new AmqpTransport(Connection::fromDsn($dsn, $options), $this->serializer);`
	`35`	`+ $serializer = $options['serializer'] ?? $this->serializer;`
	`36`	`+ unset($options['serializer']);`
	`37`	`+`
	`38`	`+ return new AmqpTransport(Connection::fromDsn($dsn, $options), $serializer);`
`36`	`39`	`}`
`37`	`40`
`38`	`41`	`public function supports(string $dsn, array $options): bool`