Skip to content

Commit a25506e

Browse files
makasimmakasim
authored
Merge pull request #636 from php-enqueue/multi-client-configuration
Enable job-queue for default configuration
2 parents 8bdc8df + 1db3a2e commit a25506e

17 files changed

Lines changed: 169 additions & 114 deletions

File tree

‎docs/bundle/config_reference.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ enqueue:
5757

5858
# The factory service should be a class that implements "Enqueue\Monitoring\StatsStorageFactory" interface
5959
storage_factory_class: ~
60+
job: false
6061
async_commands:
6162
enabled: false
6263
extensions:

‎pkg/enqueue-bundle/DependencyInjection/Configuration.php‎

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
namespace Enqueue\Bundle\DependencyInjection;
44

55
use Enqueue\AsyncCommand\RunCommandProcessor;
6+
use Enqueue\AsyncEventDispatcher\DependencyInjection\AsyncEventDispatcherExtension;
7+
use Enqueue\JobQueue\Job;
68
use Enqueue\Monitoring\Symfony\DependencyInjection\MonitoringFactory;
79
use Enqueue\Symfony\Client\DependencyInjection\ClientFactory;
810
use Enqueue\Symfony\DependencyInjection\TransportFactory;
@@ -35,6 +37,8 @@ public function getConfigTreeBuilder(): TreeBuilder
3537
->append(ClientFactory::getConfiguration($this->debug))
3638
->append($this->getMonitoringConfiguration())
3739
->append($this->getAsyncCommandsConfiguration())
40+
->append($this->getJobConfiguration())
41+
->append($this->getAsyncEventsConfiguration())
3842
->arrayNode('extensions')->addDefaultsIfNotSet()->children()
3943
->booleanNode('doctrine_ping_connection_extension')->defaultFalse()->end()
4044
->booleanNode('doctrine_clear_identity_map_extension')->defaultFalse()->end()
@@ -45,14 +49,6 @@ public function getConfigTreeBuilder(): TreeBuilder
4549
->end()
4650
;
4751

48-
// $rootNode->children()
49-
// ->booleanNode('job')->defaultFalse()->end()
50-
// ->arrayNode('async_events')
51-
// ->addDefaultsIfNotSet()
52-
// ->canBeEnabled()
53-
// ->end()
54-
// ;
55-
5652
return $tb;
5753
}
5854

@@ -76,4 +72,28 @@ private function getAsyncCommandsConfiguration(): ArrayNodeDefinition
7672
->canBeEnabled()
7773
;
7874
}
75+
76+
private function getJobConfiguration(): ArrayNodeDefinition
77+
{
78+
if (false === class_exists(Job::class)) {
79+
return MissingComponentFactory::getConfiguration('job', ['enqueue/job-queue']);
80+
}
81+
82+
return (new ArrayNodeDefinition('job'))
83+
->addDefaultsIfNotSet()
84+
->canBeEnabled()
85+
;
86+
}
87+
88+
private function getAsyncEventsConfiguration(): ArrayNodeDefinition
89+
{
90+
if (false == class_exists(AsyncEventDispatcherExtension::class)) {
91+
return MissingComponentFactory::getConfiguration('async_events', ['enqueue/async-event-dispatcher']);
92+
}
93+
94+
return (new ArrayNodeDefinition('async_events'))
95+
->addDefaultsIfNotSet()
96+
->canBeEnabled()
97+
;
98+
}
7999
}

‎pkg/enqueue-bundle/DependencyInjection/EnqueueExtension.php‎

Lines changed: 43 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
use Enqueue\Symfony\Client\DependencyInjection\ClientFactory;
1717
use Enqueue\Symfony\DependencyInjection\TransportFactory;
1818
use Enqueue\Symfony\DiUtils;
19+
use Interop\Queue\Context;
1920
use Symfony\Component\Config\FileLocator;
2021
use Symfony\Component\Config\Resource\FileResource;
2122
use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -35,7 +36,7 @@ public function load(array $configs, ContainerBuilder $container): void
3536

3637
// find default configuration
3738
$defaultName = null;
38-
foreach ($config as $name => $configs) {
39+
foreach ($config as $name => $modules) {
3940
// set first as default
4041
if (null === $defaultName) {
4142
$defaultName = $name;
@@ -49,40 +50,65 @@ public function load(array $configs, ContainerBuilder $container): void
4950

5051
$transportNames = [];
5152
$clientNames = [];
52-
foreach ($config as $name => $configs) {
53+
foreach ($config as $name => $modules) {
5354
// transport & consumption
5455
$transportNames[] = $name;
5556

56-
$transportFactory = (new TransportFactory($name));
57-
$transportFactory->buildConnectionFactory($container, $configs['transport']);
57+
$transportFactory = (new TransportFactory($name, $defaultName === $name));
58+
$transportFactory->buildConnectionFactory($container, $modules['transport']);
5859
$transportFactory->buildContext($container, []);
59-
$transportFactory->buildQueueConsumer($container, $configs['consumption']);
60+
$transportFactory->buildQueueConsumer($container, $modules['consumption']);
6061
$transportFactory->buildRpcClient($container, []);
6162

6263
// client
63-
if (isset($configs['client'])) {
64+
if (isset($modules['client'])) {
6465
$clientNames[] = $name;
6566

66-
$clientConfig = $configs['client'];
67+
$clientConfig = $modules['client'];
6768
// todo
68-
$clientConfig['transport'] = $configs['transport'];
69-
$clientConfig['consumption'] = $configs['consumption'];
69+
$clientConfig['transport'] = $modules['transport'];
70+
$clientConfig['consumption'] = $modules['consumption'];
7071

71-
$clientFactory = new ClientFactory($name);
72-
$clientFactory->build($container, $clientConfig, $defaultName === $name);
73-
$clientFactory->createDriver($container, $configs['transport']);
72+
$clientFactory = new ClientFactory($name, $defaultName === $name);
73+
$clientFactory->build($container, $clientConfig);
74+
$clientFactory->createDriver($container, $modules['transport']);
7475
$clientFactory->createFlushSpoolProducerListener($container);
7576
}
7677

7778
// monitoring
78-
if (isset($configs['monitoring'])) {
79+
if (isset($modules['monitoring'])) {
7980
$monitoringFactory = new MonitoringFactory($name);
80-
$monitoringFactory->buildStorage($container, $configs['monitoring']);
81-
$monitoringFactory->buildConsumerExtension($container, $configs['monitoring']);
81+
$monitoringFactory->buildStorage($container, $modules['monitoring']);
82+
$monitoringFactory->buildConsumerExtension($container, $modules['monitoring']);
83+
84+
if (isset($modules['client'])) {
85+
$monitoringFactory->buildClientExtension($container, $modules['monitoring']);
86+
}
87+
}
88+
89+
// job-queue
90+
if (false == empty($modules['job']['enabled'])) {
91+
if (false === isset($modules['client'])) {
92+
throw new \LogicException('Client is required for job-queue.');
93+
}
8294

83-
if (isset($configs['client'])) {
84-
$monitoringFactory->buildClientExtension($container, $configs['monitoring']);
95+
if ($name !== $defaultName) {
96+
throw new \LogicException('Job-queue supports only default configuration.');
8597
}
98+
99+
$loader->load('job.yml');
100+
}
101+
102+
// async events
103+
if (false == empty($modules['async_events']['enabled'])) {
104+
if ($name !== $defaultName) {
105+
throw new \LogicException('Async events supports only default configuration.');
106+
}
107+
108+
$extension = new AsyncEventDispatcherExtension();
109+
$extension->load([[
110+
'context_service' => Context::class,
111+
]], $container);
86112
}
87113
}
88114

@@ -112,25 +138,6 @@ public function load(array $configs, ContainerBuilder $container): void
112138
$this->loadDoctrineClearIdentityMapExtension($config, $container);
113139
$this->loadSignalExtension($config, $container);
114140
$this->loadReplyExtension($config, $container);
115-
116-
// if ($config['job']) {
117-
// if (!class_exists(Job::class)) {
118-
// throw new \LogicException('Seems "enqueue/job-queue" is not installed. Please fix this issue.');
119-
// }
120-
//
121-
// $loader->load('job.yml');
122-
// }
123-
//
124-
// if ($config['async_events']['enabled']) {
125-
// if (false == class_exists(AsyncEventDispatcherExtension::class)) {
126-
// throw new \LogicException('The "enqueue/async-event-dispatcher" package has to be installed.');
127-
// }
128-
//
129-
// $extension = new AsyncEventDispatcherExtension();
130-
// $extension->load([[
131-
// 'context_service' => 'enqueue.transport.default.context',
132-
// ]], $container);
133-
// }
134141
}
135142

136143
public function getConfiguration(array $config, ContainerBuilder $container): Configuration

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ services:
2020
public: true
2121
arguments:
2222
- '@Enqueue\JobQueue\Doctrine\JobStorage'
23-
- '@enqueue.client.default.producer'
23+
- '@Enqueue\Client\ProducerInterface'
2424

2525
# Deprecated. To be removed in 0.10.
2626
enqueue.job.processor:
@@ -55,7 +55,7 @@ services:
5555
arguments:
5656
- '@Enqueue\JobQueue\Doctrine\JobStorage'
5757
- '@Enqueue\JobQueue\CalculateRootJobStatusService'
58-
- '@enqueue.client.default.producer'
58+
- '@Enqueue\Client\ProducerInterface'
5959
- '@logger'
6060
tags:
6161
- { name: 'enqueue.command_subscriber', client: 'default' }
@@ -70,7 +70,7 @@ services:
7070
public: true
7171
arguments:
7272
- '@Enqueue\JobQueue\Doctrine\JobStorage'
73-
- '@enqueue.client.default.producer'
73+
- '@Enqueue\Client\ProducerInterface'
7474
- '@logger'
7575
tags:
7676
- { name: 'enqueue.topic_subscriber', client: 'default' }

‎pkg/enqueue-bundle/Tests/Functional/App/config/config.yml‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ enqueue:
2626
transport: 'null:'
2727
client:
2828
traceable_producer: true
29+
job: true
30+
async_events: true
2931
async_commands: true
30-
# job: true
31-
# async_commands: true
3232

3333
services:
3434
test_enqueue.client.default.traceable_producer:
@@ -115,7 +115,7 @@ services:
115115
- {name: 'enqueue.event_transformer', eventName: 'test_async_subscriber', transformerName: 'test_async' }
116116

117117
# overwrite async listener with one based on client producer. so we can use traceable producer.
118-
# enqueue.events.async_listener:
119-
# class: 'Enqueue\Bundle\Tests\Functional\App\AsyncListener'
120-
# public: true
121-
# arguments: ['@enqueue.client.default.producer', '@enqueue.events.registry']
118+
enqueue.events.async_listener:
119+
class: 'Enqueue\Bundle\Tests\Functional\App\AsyncListener'
120+
public: true
121+
arguments: ['@enqueue.client.default.producer', '@enqueue.events.registry']

‎pkg/enqueue-bundle/Tests/Functional/Events/AsyncListenerTest.php‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,6 @@ class AsyncListenerTest extends WebTestCase
1818
{
1919
public function setUp()
2020
{
21-
$this->markTestSkipped('Configuration for async_events is not yet ready');
22-
2321
parent::setUp();
2422

2523
/** @var AsyncListener $asyncListener */

‎pkg/enqueue-bundle/Tests/Functional/Events/AsyncProcessorTest.php‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,6 @@ class AsyncProcessorTest extends WebTestCase
2020
{
2121
public function setUp()
2222
{
23-
$this->markTestSkipped('Configuration for async_events is not yet ready');
24-
2523
parent::setUp();
2624

2725
/** @var AsyncListener $asyncListener */

‎pkg/enqueue-bundle/Tests/Functional/Events/AsyncSubscriberTest.php‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,6 @@ class AsyncSubscriberTest extends WebTestCase
1818
{
1919
public function setUp()
2020
{
21-
$this->markTestSkipped('Configuration for async_events is not yet ready');
22-
2321
parent::setUp();
2422

2523
/** @var AsyncListener $asyncListener */

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ class CalculateRootJobStatusProcessorTest extends WebTestCase
1212
{
1313
public function testCouldBeConstructedByContainer()
1414
{
15-
$this->markTestSkipped('Configuration for jobs is not yet ready');
16-
1715
$instance = static::$container->get(CalculateRootJobStatusProcessor::class);
1816

1917
$this->assertInstanceOf(CalculateRootJobStatusProcessor::class, $instance);

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ class DependentJobServiceTest extends WebTestCase
1212
{
1313
public function testCouldBeConstructedByContainer()
1414
{
15-
$this->markTestSkipped('Configuration for jobs is not yet ready');
16-
1715
$instance = static::$container->get(DependentJobService::class);
1816

1917
$this->assertInstanceOf(DependentJobService::class, $instance);

0 commit comments

Comments
 (0)