producers and consumers autowiring arguments

Eloar · Eloar · commit 87b6cbc22649 · 2021-07-21T14:34:10.000+02:00
registering aliases for autowiring arguments when loading producers and
consumers from configuration.
diff --git a/DependencyInjection/OldSoundRabbitMqExtension.php b/DependencyInjection/OldSoundRabbitMqExtension.php
@@ -3,13 +3,13 @@
 namespace OldSound\RabbitMqBundle\DependencyInjection;
 
 use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
-use Symfony\Component\DependencyInjection\ContainerInterface;
-use Symfony\Component\DependencyInjection\Extension\Extension;
+use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\DependencyInjection\Definition;
-use Symfony\Component\DependencyInjection\Reference;
+use Symfony\Component\DependencyInjection\Extension\Extension;
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
-use Symfony\Component\Config\FileLocator;
+use Symfony\Component\DependencyInjection\Reference;
 
 /**
  * OldSoundRabbitMqExtension.
@@ -171,11 +171,32 @@ protected function loadProducers()
                 if (null !== $producer['service_alias']) {
                     $this->container->setAlias($producer['service_alias'], $producerServiceName);
                 }
+
+                // register alias for argument auto wiring
+                if (method_exists($this->container, 'registerAliasForArgument')) {
+                    $argName = !str_ends_with(strtolower($key), 'producer') ? sprintf('%sProducer', $key) : $key;
+                    $this->container
+                        ->registerAliasForArgument($producerServiceName,  'OldSound\RabbitMqBundle\RabbitMq\ProducerInterface', $argName)
+                        ->setPublic(false);
+
+                    $this->container
+                        ->registerAliasForArgument($producerServiceName, $producer['class'], $argName)
+                        ->setPublic(false);
+                }
             }
         } else {
             foreach ($this->config['producers'] as $key => $producer) {
                 $definition = new Definition('%old_sound_rabbit_mq.fallback.class%');
-                $this->container->setDefinition(sprintf('old_sound_rabbit_mq.%s_producer', $key), $definition);
+                $producerServiceName = sprintf('old_sound_rabbit_mq.%s_producer', $key);
+                $this->container->setDefinition($producerServiceName, $definition);
+
+                // register alias for argumen auto wiring
+                if (method_exists($this->container, 'registerAliasForArgument')) {
+                    $argName = !str_ends_with(strtolower($key), 'producer') ? sprintf('%sProducer', $key) : $key;
+                    $this->container
+                        ->registerAliasForArgument($producerServiceName, 'OldSound\RabbitMqBundle\RabbitMq\ProducerInterface', $argName)
+                        ->setPublic(false);
+                }
             }
         }
     }
@@ -242,6 +263,18 @@ protected function loadConsumers()
             $name = sprintf('old_sound_rabbit_mq.%s_consumer', $key);
             $this->container->setDefinition($name, $definition);
             $this->addDequeuerAwareCall($consumer['callback'], $name);
+
+            // register alias for argument auto wiring
+            if (method_exists($this->container, 'registerAliasForArgument')) {
+                $argName = !str_ends_with(strtolower($key), 'consumer') ? sprintf('%sConsumer', $key) : $key;
+                $this->container
+                    ->registerAliasForArgument($name, 'OldSound\RabbitMqBundle\RabbitMq\ConsumerInterface', $argName)
+                    ->setPublic(false);
+
+                $this->container
+                    ->registerAliasForArgument($name, '%old_sound_rabbit_mq.consumer.class%', $argName)
+                    ->setPublic(false);
+                }
         }
     }
 
diff --git a/README.md b/README.md
@@ -534,6 +534,35 @@ consumers:
         qos_options:      {prefetch_size: 0, prefetch_count: 1, global: false}
 ```
 
+### Autowiring producers and consumers ###
+
+If used with **Symfony 4.2+** bundle declares in container set of aliases for producers and regular consumers. Those are 
+used for arguments autowiring based on declared type and argument name. This allows you to change previous producer 
+example to:
+
+```php
+public function indexAction($name, ProducerInteface $uploadPictureProducer)
+{
+    $msg = array('user_id' => 1235, 'image_path' => '/path/to/new/pic.png');
+    $uploadPictureProducer->publish(serialize($msg));
+}
+```
+
+Name of argument is constructed from producer or consumer name from configuration and suffixed with producer or consumer
+word according to type. In contrast to container items naming convention word suffix (producer or consumer) will not be
+duplicated if name is already suffixed. `upload_picture` producer key will be changed to `$uploadPictureProducer`
+argument name. `upload_picture_producer` producer key would also be aliased to `$uploadPictureProducer` argument name.
+It is best to avoid names similar in such manner.
+
+All producers are aliased to `OldSound\RabbitMqBundle\RabbitMq\ProducerInterface` and producer class option from 
+configuration. In sandbox mode only ProducerInterface aliases are made. It is highly recommended to use ProducerInterface
+class when type hinting arguments for producer injection.
+
+All consumers are aliased to 'OldSound\RabbitMqBundle\RabbitMq\ConsumerInterface' and '%old_sound_rabbit_mq.consumer.class%'
+configuration option value. There is no difference between regular and sandbox mode. It is highly recommended to use
+ConsumerInterface when type hinting arguments for client injection.
+
+
 ### Callbacks ###
 
 Here's an example callback:
@@ -807,7 +836,7 @@ binding scenarios might include exchange to exchange bindings via `destination_i
 ```yaml
 bindings:
     - {exchange: foo, destination: bar, routing_key: 'baz.*' }
-    - {exchange: foo1, destination: foo, routing_key: 'baz.*' destination_is_exchange: true}
+    - {exchange: foo1, destination: foo, routing_key: 'baz.*', destination_is_exchange: true}
 ```
 
 The rabbitmq:setup-fabric command will declare exchanges and queues as defined in your producer, consumer
diff --git a/Tests/DependencyInjection/OldSoundRabbitMqExtensionTest.php b/Tests/DependencyInjection/OldSoundRabbitMqExtensionTest.php
@@ -3,6 +3,7 @@
 namespace OldSound\RabbitMqBundle\Tests\DependencyInjection;
 
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
 use Symfony\Component\Config\FileLocator;
@@ -318,6 +319,36 @@ public function testFooProducerDefinition()
         $this->assertEquals('My\Foo\Producer', $definition->getClass());
     }
 
+    public function testProducerArgumentAliases()
+    {
+        /** @var ContainerInterface $container */
+        $container = $this->getContainer('test.yml');
+
+        if (!method_exists($container, 'registerAliasForArgument')) {
+            // don't test if autowiring arguments functionality is not available
+            return;
+        }
+
+        // test expected aliases
+        $producerInterface = 'OldSound\RabbitMqBundle\RabbitMq\ProducerInterface';
+        $expectedAliases = array(
+            $producerInterface . ' $fooProducer' => 'old_sound_rabbit_mq.foo_producer_producer',
+            'My\Foo\Producer $fooProducer' => 'old_sound_rabbit_mq.foo_producer_producer',
+            $producerInterface . ' $fooProducerAliasedProducer' => 'old_sound_rabbit_mq.foo_producer_aliased_producer',
+            'My\Foo\Producer $fooProducerAliasedProducer' => 'old_sound_rabbit_mq.foo_producer_aliased_producer',
+            $producerInterface . ' $defaultProducer' => 'old_sound_rabbit_mq.default_producer_producer',
+            '%old_sound_rabbit_mq.producer.class% $defaultProducer' => 'old_sound_rabbit_mq.default_producer_producer',
+        );
+
+        foreach($expectedAliases as $id => $target) {
+            $this->assertTrue($container->hasAlias($id), sprintf('Container should have %s alias for autowiring support.', $id));
+
+            $alias = $container->getAlias($id);
+            $this->assertEquals($target, (string)$alias, sprintf('Autowiring for %s should use %s.', $id, $target));
+            $this->assertFalse($alias->isPublic(), sprintf('Autowiring alias for %s should be private', $id));
+        }
+    }
+
     /**
      * @group alias
      */
@@ -427,6 +458,33 @@ public function testFooConsumerDefinition()
         $this->assertEquals('%old_sound_rabbit_mq.consumer.class%', $definition->getClass());
     }
 
+    public function testConsumerArgumentAliases()
+    {
+        $container = $this->getContainer('test.yml');
+
+        if (!method_exists($container, 'registerAliasForArgument')) {
+            // don't test if autowiring arguments functionality is not available
+            return;
+        }
+
+        $consumerInterface = 'OldSound\RabbitMqBundle\RabbitMq\ConsumerInterface';
+        $expectedAliases = array(
+            $consumerInterface . ' $fooConsumer' => 'old_sound_rabbit_mq.foo_consumer_consumer',
+            '%old_sound_rabbit_mq.consumer.class% $fooConsumer' => 'old_sound_rabbit_mq.foo_consumer_consumer',
+            $consumerInterface . ' $defaultConsumer' => 'old_sound_rabbit_mq.default_consumer_consumer',
+            '%old_sound_rabbit_mq.consumer.class% $defaultConsumer' => 'old_sound_rabbit_mq.default_consumer_consumer',
+            $consumerInterface . ' $qosTestConsumer' => 'old_sound_rabbit_mq.qos_test_consumer_consumer',
+            '%old_sound_rabbit_mq.consumer.class% $qosTestConsumer' => 'old_sound_rabbit_mq.qos_test_consumer_consumer'
+        );
+        foreach($expectedAliases as $id => $target) {
+            $this->assertTrue($container->hasAlias($id), sprintf('Container should have %s alias for autowiring support.', $id));
+
+            $alias = $container->getAlias($id);
+            $this->assertEquals($target, (string)$alias, sprintf('Autowiring for %s should use %s.', $id, $target));
+            $this->assertFalse($alias->isPublic(), sprintf('Autowiring alias for %s should be private', $id));
+        }
+    }
+
     public function testDefaultConsumerDefinition()
     {
         $container = $this->getContainer('test.yml');
