feat: Allow to define the serializer from connection DSN (#8)

Author: vincent4vx

ConnectionFactory/Configuration.php

@@ -66,6 +66,11 @@ public static function createConfiguration(string $name, array $options): self
 
         if (isset($options['url'])) {
             $preparedConfig = ResolverConnectionDriverFactory::parseDsn($options['url']);
+
+            if (isset($preparedConfig['serializer'])) {
+                $preparedConfig['url_serializer'] = $preparedConfig['serializer'];
+                unset($preparedConfig['serializer']);
+            }
         }
         if (!empty($options['options'])) {
             $options = array_merge($options, $options['options']);

ConnectionFactory/ConnectionDriverFactory.php

@@ -106,6 +106,26 @@ public function createDriver(Configuration $config, SerializerInterface $seriali
         return $this->configureKnownDriver($config, $serializer);
     }
 
+    /**
+     * Create the connection driver instance, and resolve the serializer from the URL option "serializer".
+     *
+     * @param Configuration                  $config                    The driver configuration
+     * @param \Closure():SerializerInterface $defaultSerializerResolver The default serializer resolver. Used when the serializer is not set in the configuration.
+     *
+     * @return ConnectionDriverInterface
+     *
+     * @internal
+     */
+    public function createDriverAndResolveSerializerFromUrl(Configuration $config, \Closure $defaultSerializerResolver)
+    {
+        $serializer = $config->has('url_serializer')
+            ? $this->container->get('bdf_queue.serializer.'.$config->get('url_serializer'))
+            : $defaultSerializerResolver()
+        ;
+
+        return $this->createDriver($config, $serializer);
+    }
+
     /**
      * Create the known driver instance.
      *

DependencyInjection/BdfQueueExtension.php

@@ -19,6 +19,7 @@
 use Bdf\QueueBundle\DependencyInjection\Compiler\RegisterReceiverFactoryPass;
 use Bdf\QueueBundle\DependencyInjection\Failer\FailerDriverConfiguratorInterface;
 use Symfony\Component\Config\FileLocator;
+use Symfony\Component\DependencyInjection\Argument\ServiceClosureArgument;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Extension\Extension;
 use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
@@ -56,13 +57,22 @@ public function configureConnections(array $config, ContainerBuilder $container)
                 ->setFactory([DriverConfiguration::class, 'createConfiguration'])
                 ->setArguments([$name, $options]);
 
-            $container->register('bdf_queue.connection_definition.'.$name, ConnectionDriverInterface::class)
+            $driverDefinition = $container->register('bdf_queue.connection_definition.'.$name, ConnectionDriverInterface::class)
                 ->setPublic(true)
-                ->setFactory($options['connection_factory'] ?? [new Reference(ConnectionDriverFactory::class), 'createDriver'])
-                ->setArguments([
-                    new Reference('bdf_queue.config_definition.'.$name),
-                    new Reference($this->configureSerializer($options['serializer'], $config['default_serializer'])),
-                ]);
+                ->setArgument(0, new Reference('bdf_queue.config_definition.'.$name))
+            ;
+
+            if (empty($options['serializer']['from_url'])) {
+                $driverDefinition
+                    ->setFactory($options['connection_factory'] ?? [new Reference(ConnectionDriverFactory::class), 'createDriver'])
+                    ->setArgument(1, new Reference($this->configureSerializer($options['serializer'], $config['default_serializer'])))
+                ;
+            } else {
+                $driverDefinition
+                    ->setFactory($options['connection_factory'] ?? [new Reference(ConnectionDriverFactory::class), 'createDriverAndResolveSerializerFromUrl'])
+                    ->setArgument(1, new ServiceClosureArgument(new Reference($this->configureSerializer($options['serializer'], $config['default_serializer']))))
+                ;
+            }
         }
 
         $container->registerForAutoconfiguration(ConnectionDriverConfiguratorInterface::class)

DependencyInjection/Configuration.php

@@ -88,6 +88,10 @@ private function getConnectionsNode()
                         ->scalarNode('service')
                             ->info('The serializer service ID.')
                         ->end()
+                        ->booleanNode('from_url')
+                            ->info('Use the URL option "serializer=" to configure the serializer. The value should be the serializer ID.')
+                            ->defaultFalse()
+                        ->end()
                     ->end()
                 ->end()
                 ->arrayNode('options')

Resources/config/queue.yaml

@@ -65,16 +65,20 @@ services:
   #Serializer
   bdf_queue.serializer.native:
     class: 'Bdf\Queue\Serializer\Serializer'
+    public: true
 
   bdf_queue.serializer.bdf:
     class: 'Bdf\Queue\Serializer\BdfSerializer'
+    public: true
     arguments: ['@?bdf_serializer']
 
   bdf_queue.serializer.json:
     class: 'Bdf\Queue\Serializer\JsonSerializer'
+    public: true
 
   bdf_queue.serializer.bdf_json:
     class: 'Bdf\Queue\Serializer\BdfSerializer'
+    public: true
     arguments:
       - '@?bdf_serializer'
       - 'json'

Tests/BdfQueueBundleTest.php

@@ -4,6 +4,7 @@
 
 require_once __DIR__.'/TestKernel.php';
 
+use Bdf\Queue\Connection\ConnectionDriverInterface;
 use Bdf\Queue\Connection\Prime\PrimeConnection;
 use Bdf\Queue\Console\Command\BindCommand;
 use Bdf\Queue\Console\Command\ConsumeCommand;
@@ -25,11 +26,14 @@
 use Bdf\Queue\Failer\MemoryFailedJobRepository;
 use Bdf\Queue\Message\Message;
 use Bdf\Queue\Message\QueuedMessage;
+use Bdf\Queue\Serializer\JsonSerializer;
+use Bdf\Queue\Serializer\Serializer;
 use Bdf\Queue\Testing\QueueHelper;
 use Bdf\QueueBundle\BdfQueueBundle;
 use Bdf\QueueBundle\Consumption\ReceiverLoader;
 use Bdf\QueueBundle\Tests\Fixtures\Bar;
 use Bdf\QueueBundle\Tests\Fixtures\Foo;
+use Bdf\QueueBundle\Tests\Fixtures\GetConnection;
 use Bdf\QueueBundle\Tests\Fixtures\GetDestinationFactory;
 use Bdf\QueueBundle\Tests\Fixtures\TestHandler;
 use PHPUnit\Framework\TestCase;
@@ -154,7 +158,7 @@ public function testConnectionOptions()
             'gearman' => [
                 'driver' => null,
                 'host' => null,
-                'serializer' => ['id' => 'native'],
+                'serializer' => ['id' => 'native', 'from_url' => false],
                 'queue' => null,
                 'url' => 'gearman://127.0.0.1',
                 'options' => ['client_timeout' => 1],
@@ -254,6 +258,20 @@ public function testPrimeConnection()
         $destinations->queue('prime', 'queue_name');
     }
 
+    public function testWithSerializerFromUrl()
+    {
+        $kernel = new \TestKernel(__DIR__.'/Fixtures/conf_with_serializer_from_dsn.yaml');
+        $kernel->boot();
+
+        /** @var ConnectionDriverInterface $connection */
+        $connection = $kernel->getContainer()->get(GetConnection::class)->get('queue');
+        $this->assertInstanceOf(JsonSerializer::class, $connection->serializer());
+
+        /** @var ConnectionDriverInterface $connection */
+        $connection = $kernel->getContainer()->get(GetConnection::class)->get('no_defined');
+        $this->assertInstanceOf(Serializer::class, $connection->serializer());
+    }
+
     public function testDestinationFactoryInstance()
     {
         $kernel = new \TestKernel();

Tests/Fixtures/GetConnection.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Bdf\QueueBundle\Tests\Fixtures;
+
+use Bdf\Queue\Connection\ConnectionDriverInterface;
+use Bdf\Queue\Connection\Factory\ConnectionDriverFactoryInterface;
+
+class GetConnection
+{
+    private ConnectionDriverFactoryInterface $factory;
+
+    public function __construct(ConnectionDriverFactoryInterface $factory)
+    {
+        $this->factory = $factory;
+    }
+
+    public function get(string $name): ConnectionDriverInterface
+    {
+        return $this->factory->create($name);
+    }
+}

Tests/Fixtures/conf_with_serializer_from_dsn.yaml

@@ -0,0 +1,30 @@
+bdf_queue:
+  default_connection: 'gearman'
+  default_serializer: 'native'
+  connections:
+    queue:
+      url: 'gearman://127.0.0.1?serializer=json'
+      serializer:
+        from_url: true
+      options:
+        client-timeout: 1
+
+    no_defined:
+      url: 'gearman://127.0.0.1'
+      serializer:
+        from_url: true
+
+prime:
+  default_connection: 'my_connection'
+  connections:
+    my_connection: 'sqlite::memory:'
+
+  migration:
+    connection: 'my_connection'
+    path: '%kernel.project_dir%/src/Migration'
+
+services:
+  Bdf\QueueBundle\Tests\Fixtures\GetConnection:
+    class: Bdf\QueueBundle\Tests\Fixtures\GetConnection
+    public: true
+    autowire: true

Tests/Fixtures/conf_with_service_middleware.yaml

@@ -0,0 +1,38 @@
+bdf_queue:
+  default_connection: 'gearman'
+  default_serializer: 'native'
+  connections:
+    memory:
+      url: 'memory:'
+      serializer:
+        id: 'native'
+  destinations:
+    b2p_bus:
+      url: 'queue://memory/b2p_bus'
+      consumer:
+        handler: 'var_dump'
+        middlewares:
+          - 'test_receiver'
+
+prime:
+  default_connection: 'my_connection'
+  connections:
+    my_connection: 'sqlite::memory:'
+
+  migration:
+    connection: 'my_connection'
+    path: '%kernel.project_dir%/src/Migration'
+
+services:
+  _defaults:
+    autowire: true
+    autoconfigure: true
+
+  Bdf\QueueBundle\Tests\Fixtures\GetDestinationFactory:
+    public: true
+    class: Bdf\QueueBundle\Tests\Fixtures\GetDestinationFactory
+
+  test_receiver:
+    class: Bdf\QueueBundle\Tests\Fixtures\FooReceiver
+    arguments:
+      - {'foo': 'bar'}