Merge pull request #1702 from deguif/fix-messenger-integration

Fix messenger integration

Author: XWB

CHANGELOG-6.0.md

@@ -6,6 +6,8 @@ in 6.0 versions.
 
 ### 6.0.0-BETA3 (2020-xx-xx)
 
+* Fixed `symfony/messenger` integration.
+
 ### 6.0.0-BETA2 (2020-09-24)
 
 * Added support for queued messages via Symfony Messenger.

composer.json

@@ -37,7 +37,6 @@
         "symfony/console": "^4.4 || ^5.1",
         "symfony/dependency-injection": "^4.4 || ^5.1",
         "symfony/framework-bundle": "^4.4 || ^5.1",
-        "symfony/messenger": "^4.4 || ^5.1",
         "symfony/property-access": "^4.4 || ^5.1"
     },
     "require-dev": {
@@ -53,6 +52,7 @@
         "knplabs/knp-components": "^2.3",
         "phpunit/phpunit": "^8.5",
         "symfony/expression-language": "^4.4 || ^5.1",
+        "symfony/messenger": "^4.4 || ^5.1",
         "symfony/serializer": "^4.4 || ^5.1",
         "symfony/twig-bundle": "^4.4 || ^5.1",
         "symfony/web-profiler-bundle": "^4.4 || ^5.1",

src/DependencyInjection/Configuration.php

@@ -54,6 +54,12 @@ public function getConfigTreeBuilder()
                     ->info('Defaults to the first index defined')
                 ->end()
                 ->scalarNode('default_manager')->defaultValue('orm')->end()
+                ->arrayNode('messenger')
+                    ->canBeEnabled()
+                    ->children()
+                        ->scalarNode('message_bus')->defaultNull()->end()
+                    ->end()
+                ->end()
                 ->arrayNode('serializer')
                     ->treatNullLike([])
                     ->children()

src/DependencyInjection/FOSElasticaExtension.php

@@ -19,9 +19,11 @@
 use Symfony\Component\DependencyInjection\ChildDefinition;
 use Symfony\Component\DependencyInjection\ContainerAwareInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Exception\LogicException;
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
 use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
+use Symfony\Component\Messenger\MessageBusInterface;
 
 class FOSElasticaExtension extends Extension
 {
@@ -80,6 +82,10 @@ public function load(array $configs, ContainerBuilder $container)
             $config['default_index'] = reset($keys);
         }
 
+        if ($this->isConfigEnabled($container, $config['messenger'])) {
+            $this->registerMessengerConfiguration($config['messenger'], $container, $loader);
+        }
+
         if (isset($config['serializer'])) {
             $loader->load('serializer.xml');
 
@@ -739,4 +745,17 @@ private function getClient(string $clientName): Reference
 
         return $this->clients[$clientName]['reference'];
     }
+
+    private function registerMessengerConfiguration(array $config, ContainerBuilder $container, XmlFileLoader $loader): void
+    {
+        if (!interface_exists(MessageBusInterface::class)) {
+            throw new LogicException('Messenger support cannot be enabled as the Messenger component is not installed. Try running "composer require symfony/messenger".');
+        }
+
+        $loader->load('messenger.xml');
+
+        $container->getDefinition('fos_elastica.async_pager_persister')
+            ->replaceArgument(2, $config['message_bus'] ? new Reference($config['message_bus']) : new Reference('messenger.default_bus'))
+        ;
+    }
 }

src/Resources/config/messenger.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<container xmlns="http://symfony.com/schema/dic/services"
+           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+           xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+
+    <services>
+        <service id="fos_elastica.async_pager_persister" class="FOS\ElasticaBundle\Persister\AsyncPagerPersister">
+            <argument type="service" id="fos_elastica.pager_persister_registry" />
+            <argument type="service" id="fos_elastica.pager_provider_registry" />
+            <argument /> <!-- message bus-->
+
+            <tag name="fos_elastica.pager_persister" persisterName="async" />
+        </service>
+    </services>
+</container>

src/Resources/config/persister.xml

@@ -12,14 +12,6 @@
             <tag name="fos_elastica.pager_persister" persisterName="in_place" />
         </service>
 
-        <service id="fos_elastica.async_pager_persister" class="FOS\ElasticaBundle\Persister\AsyncPagerPersister">
-            <argument type="service" id="fos_elastica.pager_persister_registry" />
-            <argument type="service" id="fos_elastica.pager_provider_registry" />
-            <argument type="service" id="messenger.default_bus" />
-
-            <tag name="fos_elastica.pager_persister" persisterName="async" />
-        </service>
-
         <service id="fos_elastica.pager_persister_registry" class="FOS\ElasticaBundle\Persister\PagerPersisterRegistry">
             <argument type="tagged_locator" tag="fos_elastica.pager_persister" index-by="persisterName" />
         </service>

tests/Unit/DependencyInjection/ConfigurationTest.php

@@ -36,6 +36,10 @@ public function testUnconfiguredConfiguration()
             'indexes' => [],
             'index_templates' => [],
             'default_manager' => 'orm',
+            'messenger' => [
+                'enabled' => false,
+                'message_bus' => null,
+            ],
         ], $configuration);
     }