multi client configuration

Author: ASKozienko

docs/bundle/config_reference.md

@@ -43,6 +43,7 @@ enqueue:
 
             # the time in milliseconds queue consumer waits for a message (100 ms by default)
             receive_timeout:      100
+        job:                      false
         async_commands:
             enabled:              false
         extensions:

pkg/enqueue-bundle/DependencyInjection/Configuration.php

@@ -3,6 +3,7 @@
 namespace Enqueue\Bundle\DependencyInjection;
 
 use Enqueue\AsyncCommand\RunCommandProcessor;
+use Enqueue\JobQueue\Job;
 use Enqueue\Monitoring\Symfony\DependencyInjection\MonitoringFactory;
 use Enqueue\Symfony\Client\DependencyInjection\ClientFactory;
 use Enqueue\Symfony\DependencyInjection\TransportFactory;
@@ -35,6 +36,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                     ->append(ClientFactory::getConfiguration($this->debug))
                     ->append($this->getMonitoringConfiguration())
                     ->append($this->getAsyncCommandsConfiguration())
+                    ->append($this->getJobConfiguration())
                     ->arrayNode('extensions')->addDefaultsIfNotSet()->children()
                         ->booleanNode('doctrine_ping_connection_extension')->defaultFalse()->end()
                         ->booleanNode('doctrine_clear_identity_map_extension')->defaultFalse()->end()
@@ -46,7 +48,6 @@ public function getConfigTreeBuilder(): TreeBuilder
         ;
 
 //        $rootNode->children()
-//            ->booleanNode('job')->defaultFalse()->end()
 //            ->arrayNode('async_events')
 //                ->addDefaultsIfNotSet()
 //                ->canBeEnabled()
@@ -76,4 +77,16 @@ private function getAsyncCommandsConfiguration(): ArrayNodeDefinition
             ->canBeEnabled()
         ;
     }
+
+    private function getJobConfiguration(): ArrayNodeDefinition
+    {
+        if (false === class_exists(Job::class)) {
+            return MissingComponentFactory::getConfiguration('job', ['enqueue/job-queue']);
+        }
+
+        return (new ArrayNodeDefinition('job'))
+            ->addDefaultsIfNotSet()
+            ->canBeEnabled()
+        ;
+    }
 }

pkg/enqueue-bundle/DependencyInjection/EnqueueExtension.php

@@ -84,6 +84,19 @@ public function load(array $configs, ContainerBuilder $container): void
                     $monitoringFactory->buildClientExtension($container, $configs['monitoring']);
                 }
             }
+
+            // job-queue
+            if (false == empty($configs['job']['enabled'])) {
+                if (false === isset($configs['client'])) {
+                    throw new \LogicException('Client is required for job-queue.');
+                }
+
+                if ($name !== $defaultName) {
+                    throw new \LogicException('Job-queue supports only default configuration.');
+                }
+
+                $loader->load('job.yml');
+            }
         }
 
         $defaultClient = null;
@@ -113,14 +126,6 @@ public function load(array $configs, ContainerBuilder $container): void
         $this->loadSignalExtension($config, $container);
         $this->loadReplyExtension($config, $container);
 
-//        if ($config['job']) {
-//            if (!class_exists(Job::class)) {
-//                throw new \LogicException('Seems "enqueue/job-queue" is not installed. Please fix this issue.');
-//            }
-//
-//            $loader->load('job.yml');
-//        }
-//
 //        if ($config['async_events']['enabled']) {
 //            if (false == class_exists(AsyncEventDispatcherExtension::class)) {
 //                throw new \LogicException('The "enqueue/async-event-dispatcher" package has to be installed.');

pkg/enqueue-bundle/Resources/config/job.yml

@@ -20,7 +20,7 @@ services:
         public: true
         arguments:
             - '@Enqueue\JobQueue\Doctrine\JobStorage'
-            - '@enqueue.client.default.producer'
+            - '@Enqueue\Client\ProducerInterface'
 
     # Deprecated. To be removed in 0.10.
     enqueue.job.processor:
@@ -55,7 +55,7 @@ services:
         arguments:
             - '@Enqueue\JobQueue\Doctrine\JobStorage'
             - '@Enqueue\JobQueue\CalculateRootJobStatusService'
-            - '@enqueue.client.default.producer'
+            - '@Enqueue\Client\ProducerInterface'
             - '@logger'
         tags:
             - { name: 'enqueue.command_subscriber', client: 'default' }
@@ -70,7 +70,7 @@ services:
         public: true
         arguments:
             - '@Enqueue\JobQueue\Doctrine\JobStorage'
-            - '@enqueue.client.default.producer'
+            - '@Enqueue\Client\ProducerInterface'
             - '@logger'
         tags:
             - { name: 'enqueue.topic_subscriber', client: 'default' }

pkg/enqueue-bundle/Tests/Functional/Job/CalculateRootJobStatusProcessorTest.php

@@ -12,8 +12,6 @@ class CalculateRootJobStatusProcessorTest extends WebTestCase
 {
     public function testCouldBeConstructedByContainer()
     {
-        $this->markTestSkipped('Configuration for jobs is not yet ready');
-
         $instance = static::$container->get(CalculateRootJobStatusProcessor::class);
 
         $this->assertInstanceOf(CalculateRootJobStatusProcessor::class, $instance);

pkg/enqueue-bundle/Tests/Functional/Job/DependentJobServiceTest.php

@@ -12,8 +12,6 @@ class DependentJobServiceTest extends WebTestCase
 {
     public function testCouldBeConstructedByContainer()
     {
-        $this->markTestSkipped('Configuration for jobs is not yet ready');
-
         $instance = static::$container->get(DependentJobService::class);
 
         $this->assertInstanceOf(DependentJobService::class, $instance);

pkg/enqueue-bundle/Tests/Functional/Job/JobRunnerTest.php

@@ -12,8 +12,6 @@ class JobRunnerTest extends WebTestCase
 {
     public function testCouldBeConstructedByContainer()
     {
-        $this->markTestSkipped('Configuration for jobs is not yet ready');
-
         $instance = static::$container->get(JobRunner::class);
 
         $this->assertInstanceOf(JobRunner::class, $instance);

pkg/enqueue-bundle/Tests/Functional/Job/JobStorageTest.php

@@ -12,8 +12,6 @@ class JobStorageTest extends WebTestCase
 {
     public function testCouldGetJobStorageAsServiceFromContainer()
     {
-        $this->markTestSkipped('Configuration for jobs is not yet ready');
-
         $instance = static::$container->get(JobStorage::class);
 
         $this->assertInstanceOf(JobStorage::class, $instance);

pkg/enqueue-bundle/Tests/Unit/DependencyInjection/ConfigurationTest.php

@@ -160,34 +160,38 @@ public function testShouldThrowExceptionIfDefaultProcessorQueueIsEmpty()
 
     public function testJobShouldBeDisabledByDefault()
     {
-        $this->markTestSkipped('Configuration for jobs is not yet ready');
-
         $configuration = new Configuration(true);
 
         $processor = new Processor();
         $config = $processor->processConfiguration($configuration, [[
-            'transport' => [],
+            'default' => [
+                'transport' => [],
+            ],
         ]]);
 
         $this->assertArraySubset([
-            'job' => false,
+            'default' => [
+                'job' => false,
+            ],
         ], $config);
     }
 
     public function testCouldEnableJob()
     {
-        $this->markTestSkipped('Configuration for jobs is not yet ready');
-
         $configuration = new Configuration(true);
 
         $processor = new Processor();
         $config = $processor->processConfiguration($configuration, [[
-            'transport' => [],
-            'job' => true,
+            'default' => [
+                'transport' => [],
+                'job' => true,
+            ],
         ]]);
 
         $this->assertArraySubset([
-            'job' => true,
+            'default' => [
+                'job' => true,
+            ],
         ], $config);
     }
 

pkg/enqueue-bundle/Tests/Unit/DependencyInjection/EnqueueExtensionTest.php

@@ -255,31 +255,49 @@ public function testShouldNotLoadDelayRedeliveredMessageExtensionIfRedeliveredDe
 
     public function testShouldLoadJobServicesIfEnabled()
     {
-        $this->markTestSkipped('Configuration for jobs is not yet ready');
-
         $container = $this->getContainerBuilder(true);
 
         $extension = new EnqueueExtension();
 
         $extension->load([[
-            'transport' => [],
-            'job' => true,
+            'default' => [
+                'transport' => [],
+                'client' => null,
+                'job' => true,
+            ],
         ]], $container);
 
         self::assertTrue($container->hasDefinition(JobRunner::class));
     }
 
-    public function testShouldNotLoadJobServicesIfDisabled()
+    public function testShouldThrowExceptionIfClientIsNotEnabledOnJobLoad()
     {
-        $this->markTestSkipped('Configuration for jobs is not yet ready');
+        $this->expectException(\LogicException::class);
+        $this->expectExceptionMessage('Client is required for job-queue.');
+
+        $container = $this->getContainerBuilder(true);
+
+        $extension = new EnqueueExtension();
+
+        $extension->load([[
+            'default' => [
+                'transport' => [],
+                'job' => true,
+            ],
+        ]], $container);
+    }
 
+    public function testShouldNotLoadJobServicesIfDisabled()
+    {
         $container = $this->getContainerBuilder(true);
 
         $extension = new EnqueueExtension();
 
         $extension->load([[
-            'transport' => [],
-            'job' => false,
+            'default' => [
+                'transport' => [],
+                'job' => false,
+            ],
         ]], $container);
 
         self::assertFalse($container->hasDefinition(JobRunner::class));