Skip to content

[bundle] Add BC for topic\command subscribers. #641

New issue

Have a question about this project? No Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

No Sign up for GitHub

By clicking “No Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? No Sign in to your account

Merged
merged 2 commits into from
Nov 16, 2018
Merged

[bundle] Add BC for topic\command subscribers. #641

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b617dea
[bundle] Add BC for topic\command subscribers.
makasim Nov 16, 2018
53962b9
fix tests.
makasim Nov 16, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions pkg/enqueue/Client/TopicSubscriberInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,22 @@ interface TopicSubscriberInterface
*
* or
*
* ['aTopicName' => [
* 'processor' => 'processor',
* [
* [
* 'topic' => 'aTopicName',
* 'processor' => 'fooProcessor',
* 'queue' => 'a_client_queue_name',
* ]]
*
* 'aCustomOption' => 'aVal',
* ],
* [
* 'topic' => 'anotherTopicName',
* 'processor' => 'barProcessor',
* 'queue' => 'a_client_queue_name',
*
* 'aCustomOption' => 'aVal',
* ],
* ]
*
* Note: If you set prefix_queue to true then the queue is used as is and therefor the driver is not used to prepare a transport queue name.
* It is possible to pass other options, they could be accessible on a route instance through options.
Expand Down
35 changes: 35 additions & 0 deletions pkg/enqueue/Symfony/Client/DependencyInjection/BuildCommandSubscriberRoutesPass.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,41 @@ public function process(ContainerBuilder $container): void
throw new \LogicException('Command subscriber configuration is invalid. Should be an array or string.');
}

// 0.8 command subscriber
if (isset($commands['processorName'])) {
@trigger_error('The command subscriber 0.8 syntax is deprecated since Enqueue 0.9.', E_USER_DEPRECATED);

$source = $commands['processorName'];
$processor = $params['processorName'] ?? $serviceId;

$options = $commands;
unset(
$options['processorName'],
$options['queueName'],
$options['queueNameHardcoded'],
$options['exclusive'],
$options['topic'],
$options['source'],
$options['source_type'],
$options['processor'],
$options['options']
);

$options['processor_service_id'] = $serviceId;

if (isset($commands['queueName'])) {
$options['queue'] = $commands['queueName'];
}

if (isset($commands['queueNameHardcoded']) && $commands['queueNameHardcoded']) {
$options['prefix_queue'] = false;
}

$routeCollection->add(new Route($source, Route::COMMAND, $processor, $options));

continue;
}

if (isset($commands['command'])) {
$commands = [$commands];
}
Expand Down
31 changes: 31 additions & 0 deletions pkg/enqueue/Symfony/Client/DependencyInjection/BuildTopicSubscriberRoutesPass.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,37 @@ public function process(ContainerBuilder $container): void
foreach ($topics as $key => $params) {
if (is_string($params)) {
$routeCollection->add(new Route($params, Route::TOPIC, $serviceId, ['processor_service_id' => $serviceId]));

// 0.8 topic subscriber
} elseif (is_array($params) && is_string($key)) {
@trigger_error('The topic subscriber 0.8 syntax is deprecated since Enqueue 0.9.', E_USER_DEPRECATED);

$source = $key;
$processor = $params['processorName'] ?? $serviceId;

$options = $params;
unset(
$options['processorName'],
$options['queueName'],
$options['queueNameHardcoded'],
$options['topic'],
$options['source'],
$options['source_type'],
$options['processor'],
$options['options']
);

$options['processor_service_id'] = $serviceId;

if (isset($params['queueName'])) {
$options['queue'] = $params['queueName'];
}

if (isset($params['queueNameHardcoded']) && $params['queueNameHardcoded']) {
$options['prefix_queue'] = false;
}

$routeCollection->add(new Route($source, Route::TOPIC, $processor, $options));
} elseif (is_array($params)) {
$source = $params['topic'] ?? null;
$processor = $params['processor'] ?? $serviceId;
Expand Down
43 changes: 43 additions & 0 deletions ...enqueue/Tests/Symfony/Client/DependencyInjection/BuildCommandSubscriberRoutesPassTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -398,6 +398,49 @@ public function testShouldMergeExtractedRoutesWithAlreadySetInCollection()
);
}

public function testShouldRegister08CommandProcessor()
{
$routeCollection = new Definition(RouteCollection::class);
$routeCollection->addArgument([]);

$processor = $this->createCommandSubscriberProcessor([
'processorName' => 'fooCommand',
'queueName' => 'a_client_queue_name',
'queueNameHardcoded' => true,
'exclusive' => true,
'anOption' => 'aFooVal',
]);

$container = new ContainerBuilder();
$container->setParameter('enqueue.clients', ['default']);
$container->setParameter('enqueue.default_client', 'default');
$container->setDefinition('enqueue.client.default.route_collection', $routeCollection);
$container->register('aFooProcessor', get_class($processor))
->addTag('enqueue.command_subscriber')
;

$pass = new BuildCommandSubscriberRoutesPass();
$pass->process($container);

$this->assertInternalType('array', $routeCollection->getArgument(0));
$this->assertCount(1, $routeCollection->getArgument(0));

$this->assertEquals(
[
[
'source' => 'fooCommand',
'source_type' => 'enqueue.client.command_route',
'processor' => 'aFooProcessor',
'processor_service_id' => 'aFooProcessor',
'anOption' => 'aFooVal',
'queue' => 'a_client_queue_name',
'prefix_queue' => false,
],
],
$routeCollection->getArgument(0)
);
}

private function createCommandSubscriberProcessor($commandSubscriberReturns = ['aCommand'])
{
$processor = new class() implements Processor, CommandSubscriberInterface {
Expand Down
47 changes: 47 additions & 0 deletions pkg/enqueue/Tests/Symfony/Client/DependencyInjection/BuildTopicSubscriberRoutesPassTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -358,6 +358,53 @@ public function testShouldMergeExtractedRoutesWithAlreadySetInCollection()
);
}

public function testShouldRegister08TopicSubscriber()
{
$routeCollection = new Definition(RouteCollection::class);
$routeCollection->addArgument([]);

$processor = $this->createTopicSubscriberProcessor([
'fooTopic' => ['processorName' => 'aCustomFooProcessorName', 'queueName' => 'fooQueue', 'queueNameHardcoded' => true, 'anOption' => 'aFooVal'],
'barTopic' => ['processorName' => 'aCustomBarProcessorName', 'anOption' => 'aBarVal'],
]);

$container = new ContainerBuilder();
$container->setParameter('enqueue.clients', ['default']);
$container->setParameter('enqueue.default_client', 'default');
$container->setDefinition('enqueue.client.default.route_collection', $routeCollection);
$container->register('aFooProcessor', get_class($processor))
->addTag('enqueue.topic_subscriber')
;

$pass = new BuildTopicSubscriberRoutesPass();
$pass->process($container);

$this->assertInternalType('array', $routeCollection->getArgument(0));
$this->assertCount(2, $routeCollection->getArgument(0));

$this->assertEquals(
[
[
'source' => 'fooTopic',
'source_type' => 'enqueue.client.topic_route',
'processor' => 'aCustomFooProcessorName',
'processor_service_id' => 'aFooProcessor',
'anOption' => 'aFooVal',
'queue' => 'fooQueue',
'prefix_queue' => false,
],
[
'source' => 'barTopic',
'source_type' => 'enqueue.client.topic_route',
'processor' => 'aCustomBarProcessorName',
'processor_service_id' => 'aFooProcessor',
'anOption' => 'aBarVal',
],
],
$routeCollection->getArgument(0)
);
}

private function createTopicSubscriberProcessor($topicSubscriberReturns = ['aTopic'])
{
$processor = new class() implements Processor, TopicSubscriberInterface {
Expand Down