Skip to content

Commit 4ec22b6

Browse files
authored
Merge pull request #127 from php-enqueue/send-exclusive-commands-to-their-queues-bypassing-router
[client] Send exclusive commands to their queues directly, by passing…
2 parents de1bb8a + 1287b1b commit 4ec22b6

10 files changed

Lines changed: 163 additions & 23 deletions

File tree

‎pkg/enqueue-bundle/Resources/config/extensions/exclusive_command_extension.yml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,5 @@ services:
55
arguments:
66
- []
77
tags:
8-
- { name: 'enqueue.consumption.extension', priority: 100 }
8+
- { name: 'enqueue.consumption.extension', priority: 100 }
9+
- { name: 'enqueue.client.extension', priority: 100 }
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<?php
2+
3+
namespace Enqueue\Bundle\Tests\Functional\App;
4+
5+
use Enqueue\Client\CommandSubscriberInterface;
6+
use Enqueue\Consumption\Result;
7+
use Enqueue\Psr\PsrContext;
8+
use Enqueue\Psr\PsrMessage;
9+
use Enqueue\Psr\PsrProcessor;
10+
11+
class TestExclusiveCommandSubscriberProcessor implements PsrProcessor, CommandSubscriberInterface
12+
{
13+
public $calls = [];
14+
15+
public function process(PsrMessage $message, PsrContext $context)
16+
{
17+
$this->calls[] = $message;
18+
19+
return Result::ACK;
20+
}
21+
22+
public static function getSubscribedCommand()
23+
{
24+
return [
25+
'processorName' => 'theExclusiveCommandName',
26+
'queueName' => 'the_exclusive_command_queue',
27+
'queueNameHardcoded' => true,
28+
'exclusive' => true,
29+
];
30+
}
31+
}

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,11 @@ services:
5252
tags:
5353
- { name: 'enqueue.client.processor' }
5454

55+
test_exclusive_command_subscriber_processor:
56+
class: 'Enqueue\Bundle\Tests\Functional\App\TestExclusiveCommandSubscriberProcessor'
57+
tags:
58+
- { name: 'enqueue.client.processor' }
59+
5560
test_async_subscriber:
5661
class: 'Enqueue\Bundle\Tests\Functional\App\TestAsyncSubscriber'
5762
tags:

‎pkg/enqueue-bundle/Tests/Functional/Client/ProducerTest.php‎

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -88,24 +88,33 @@ public function testShouldSendMessageInstanceAsCommandWithoutNeedForReply()
8888
$this->assertEquals('theMessage', $traces[0]['body']);
8989
$this->assertEquals([
9090
'enqueue.topic_name' => Config::COMMAND_TOPIC,
91-
'enqueue.processor_name' => 'theCommand',
91+
'enqueue.processor_name' => 'enqueue.client.router_processor',
92+
'enqueue.command_name' => 'theCommand',
9293
'enqueue.processor_queue_name' => 'default',
9394
], $traces[0]['properties']);
9495
}
9596

96-
public function testShouldSendCommandWithNeedForReply()
97+
public function testShouldSendExclusiveCommandWithNeedForReply()
9798
{
9899
/** @var ProducerInterface $producer */
99100
$producer = $this->container->get('enqueue.client.producer');
100101

101-
$result = $producer->sendCommand('theCommand', 'theMessage', true);
102+
$message = new Message('theMessage');
102103

103-
$this->assertInstanceOf(Promise::class, $result);
104+
$result = $producer->sendCommand('theExclusiveCommandName', $message, false);
104105

105-
$traces = $this->getTraceableProducer()->getCommandTraces('theCommand');
106+
$this->assertNull($result);
107+
108+
$traces = $this->getTraceableProducer()->getCommandTraces('theExclusiveCommandName');
106109

107110
$this->assertCount(1, $traces);
108111
$this->assertEquals('theMessage', $traces[0]['body']);
112+
$this->assertEquals([
113+
'enqueue.topic_name' => Config::COMMAND_TOPIC,
114+
'enqueue.processor_name' => 'theExclusiveCommandName',
115+
'enqueue.command_name' => 'theExclusiveCommandName',
116+
'enqueue.processor_queue_name' => 'the_exclusive_command_queue',
117+
], $traces[0]['properties']);
109118
}
110119

111120
public function testShouldSendMessageInstanceCommandWithNeedForReply()
@@ -125,7 +134,8 @@ public function testShouldSendMessageInstanceCommandWithNeedForReply()
125134
$this->assertEquals('theMessage', $traces[0]['body']);
126135
$this->assertEquals([
127136
'enqueue.topic_name' => Config::COMMAND_TOPIC,
128-
'enqueue.processor_name' => 'theCommand',
137+
'enqueue.processor_name' => 'enqueue.client.router_processor',
138+
'enqueue.command_name' => 'theCommand',
129139
'enqueue.processor_queue_name' => 'default',
130140
], $traces[0]['properties']);
131141
}

‎pkg/enqueue/Client/Config.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
class Config
66
{
77
const PARAMETER_TOPIC_NAME = 'enqueue.topic_name';
8+
const PARAMETER_COMMAND_NAME = 'enqueue.command_name';
89
const PARAMETER_PROCESSOR_NAME = 'enqueue.processor_name';
910
const PARAMETER_PROCESSOR_QUEUE_NAME = 'enqueue.processor_queue_name';
1011
const DEFAULT_PROCESSOR_QUEUE_NAME = 'default';

‎pkg/enqueue/Client/ConsumptionExtension/ExclusiveCommandExtension.php‎

Lines changed: 39 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,33 @@
33
namespace Enqueue\Client\ConsumptionExtension;
44

55
use Enqueue\Client\Config;
6+
use Enqueue\Client\ExtensionInterface as ClientExtensionInterface;
7+
use Enqueue\Client\Message;
68
use Enqueue\Consumption\Context;
79
use Enqueue\Consumption\EmptyExtensionTrait;
8-
use Enqueue\Consumption\ExtensionInterface;
10+
use Enqueue\Consumption\ExtensionInterface as ConsumptionExtensionInterface;
911

10-
class ExclusiveCommandExtension implements ExtensionInterface
12+
class ExclusiveCommandExtension implements ConsumptionExtensionInterface, ClientExtensionInterface
1113
{
1214
use EmptyExtensionTrait;
1315

1416
/**
15-
* @var array
17+
* @var string[]
1618
*/
1719
private $queueNameToProcessorNameMap;
1820

1921
/**
20-
* @param array $queueNameToProcessorNameMap
22+
* @var string[]
23+
*/
24+
private $processorNameToQueueNameMap;
25+
26+
/**
27+
* @param string[] $queueNameToProcessorNameMap
2128
*/
2229
public function __construct(array $queueNameToProcessorNameMap)
2330
{
2431
$this->queueNameToProcessorNameMap = $queueNameToProcessorNameMap;
32+
$this->processorNameToQueueNameMap = array_flip($queueNameToProcessorNameMap);
2533
}
2634

2735
public function onPreReceived(Context $context)
@@ -38,13 +46,40 @@ public function onPreReceived(Context $context)
3846
if ($message->getProperty(Config::PARAMETER_PROCESSOR_NAME)) {
3947
return;
4048
}
49+
if ($message->getProperty(Config::PARAMETER_COMMAND_NAME)) {
50+
return;
51+
}
4152

4253
if (array_key_exists($queue->getQueueName(), $this->queueNameToProcessorNameMap)) {
4354
$context->getLogger()->debug('[ExclusiveCommandExtension] This is a exclusive command queue and client\'s properties are not set. Setting them');
4455

4556
$message->setProperty(Config::PARAMETER_TOPIC_NAME, Config::COMMAND_TOPIC);
4657
$message->setProperty(Config::PARAMETER_PROCESSOR_QUEUE_NAME, $queue->getQueueName());
4758
$message->setProperty(Config::PARAMETER_PROCESSOR_NAME, $this->queueNameToProcessorNameMap[$queue->getQueueName()]);
59+
$message->setProperty(Config::PARAMETER_COMMAND_NAME, $this->queueNameToProcessorNameMap[$queue->getQueueName()]);
4860
}
4961
}
62+
63+
/**
64+
* {@inheritdoc}
65+
*/
66+
public function onPreSend($topic, Message $message)
67+
{
68+
if (Config::COMMAND_TOPIC != $topic) {
69+
return;
70+
}
71+
72+
$commandName = $message->getProperty(Config::PARAMETER_COMMAND_NAME);
73+
if (array_key_exists($commandName, $this->processorNameToQueueNameMap)) {
74+
$message->setProperty(Config::PARAMETER_PROCESSOR_NAME, $commandName);
75+
$message->setProperty(Config::PARAMETER_PROCESSOR_QUEUE_NAME, $this->processorNameToQueueNameMap[$commandName]);
76+
}
77+
}
78+
79+
/**
80+
* {@inheritdoc}
81+
*/
82+
public function onPostSend($topic, Message $message)
83+
{
84+
}
5085
}

‎pkg/enqueue/Client/Producer.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ public function sendCommand($command, $message, $needReply = false)
118118
}
119119

120120
$message->setProperty(Config::PARAMETER_TOPIC_NAME, Config::COMMAND_TOPIC);
121-
$message->setProperty(Config::PARAMETER_PROCESSOR_NAME, $command);
121+
$message->setProperty(Config::PARAMETER_COMMAND_NAME, $command);
122122
$message->setScope(Message::SCOPE_APP);
123123

124124
$this->sendEvent(Config::COMMAND_TOPIC, $message);

‎pkg/enqueue/Client/RouterProcessor.php‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -100,17 +100,18 @@ private function routeEvent(PsrMessage $message)
100100
*/
101101
private function routeCommand(PsrMessage $message)
102102
{
103-
$processorName = $message->getProperty(Config::PARAMETER_PROCESSOR_NAME);
104-
if (false == $processorName) {
103+
$commandName = $message->getProperty(Config::PARAMETER_COMMAND_NAME);
104+
if (false == $commandName) {
105105
return Result::reject(sprintf(
106106
'Got message without required parameter: "%s"',
107-
Config::PARAMETER_PROCESSOR_NAME
107+
Config::PARAMETER_COMMAND_NAME
108108
));
109109
}
110110

111-
if (isset($this->commandRoutes[$processorName])) {
111+
if (isset($this->commandRoutes[$commandName])) {
112112
$processorMessage = clone $message;
113-
$processorMessage->setProperty(Config::PARAMETER_PROCESSOR_QUEUE_NAME, $this->commandRoutes[$processorName]);
113+
$processorMessage->setProperty(Config::PARAMETER_PROCESSOR_QUEUE_NAME, $this->commandRoutes[$commandName]);
114+
$processorMessage->setProperty(Config::PARAMETER_PROCESSOR_NAME, $commandName);
114115

115116
$this->driver->sendToProcessor($this->driver->createClientMessage($processorMessage));
116117
}

‎pkg/enqueue/Tests/Client/ConsumptionExtension/ExclusiveCommandExtensionTest.php‎

Lines changed: 58 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,10 @@
44

55
use Enqueue\Client\Config;
66
use Enqueue\Client\ConsumptionExtension\ExclusiveCommandExtension;
7+
use Enqueue\Client\ExtensionInterface as ClientExtensionInterface;
8+
use Enqueue\Client\Message;
79
use Enqueue\Consumption\Context;
8-
use Enqueue\Consumption\ExtensionInterface;
10+
use Enqueue\Consumption\ExtensionInterface as ConsumptionExtensionInterface;
911
use Enqueue\Null\NullContext;
1012
use Enqueue\Null\NullMessage;
1113
use Enqueue\Null\NullQueue;
@@ -17,9 +19,14 @@ class ExclusiveCommandExtensionTest extends TestCase
1719
{
1820
use ClassExtensionTrait;
1921

20-
public function testShouldImplementExtensionInterface()
22+
public function testShouldImplementConsumptionExtensionInterface()
2123
{
22-
$this->assertClassImplements(ExtensionInterface::class, ExclusiveCommandExtension::class);
24+
$this->assertClassImplements(ConsumptionExtensionInterface::class, ExclusiveCommandExtension::class);
25+
}
26+
27+
public function testShouldImplementClientExtensionInterface()
28+
{
29+
$this->assertClassImplements(ClientExtensionInterface::class, ExclusiveCommandExtension::class);
2330
}
2431

2532
public function testCouldBeConstructedWithQueueNameToProcessorNameMap()
@@ -134,6 +141,54 @@ public function testShouldSetCommandPropertiesIfCurrentQueueInTheMap()
134141
'enqueue.topic_name' => '__command__',
135142
'enqueue.processor_queue_name' => 'aFooQueueName',
136143
'enqueue.processor_name' => 'aFooProcessorName',
144+
'enqueue.command_name' => 'aFooProcessorName',
145+
], $message->getProperties());
146+
}
147+
148+
public function testShouldDoNothingOnPreSendIfTopicNotCommandOne()
149+
{
150+
$message = new Message();
151+
152+
$extension = new ExclusiveCommandExtension([
153+
'aFooQueueName' => 'aFooProcessorName',
154+
]);
155+
156+
$extension->onPreSend('aTopic', $message);
157+
158+
$this->assertEquals([], $message->getProperties());
159+
}
160+
161+
public function testShouldDoNothingIfCommandNotExclusive()
162+
{
163+
$message = new Message();
164+
$message->setProperty(Config::PARAMETER_COMMAND_NAME, 'theBarProcessorName');
165+
166+
$extension = new ExclusiveCommandExtension([
167+
'aFooQueueName' => 'aFooProcessorName',
168+
]);
169+
170+
$extension->onPreSend(Config::COMMAND_TOPIC, $message);
171+
172+
$this->assertEquals([
173+
'enqueue.command_name' => 'theBarProcessorName',
174+
], $message->getProperties());
175+
}
176+
177+
public function testShouldForceExclusiveCommandQueue()
178+
{
179+
$message = new Message();
180+
$message->setProperty(Config::PARAMETER_COMMAND_NAME, 'aFooProcessorName');
181+
182+
$extension = new ExclusiveCommandExtension([
183+
'aFooQueueName' => 'aFooProcessorName',
184+
]);
185+
186+
$extension->onPreSend(Config::COMMAND_TOPIC, $message);
187+
188+
$this->assertEquals([
189+
'enqueue.command_name' => 'aFooProcessorName',
190+
'enqueue.processor_name' => 'aFooProcessorName',
191+
'enqueue.processor_queue_name' => 'aFooQueueName',
137192
], $message->getProperties());
138193
}
139194
}

‎pkg/enqueue/Tests/Client/RouterProcessorTest.php‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ public function testShouldRouteOriginalMessageToCommandRecipient()
9393
$message->setProperties([
9494
'aProp' => 'aPropVal',
9595
Config::PARAMETER_TOPIC_NAME => Config::COMMAND_TOPIC,
96-
Config::PARAMETER_PROCESSOR_NAME => 'theCommandName',
96+
Config::PARAMETER_COMMAND_NAME => 'theCommandName',
9797
]);
9898

9999
$clientMessage = new Message();
@@ -129,11 +129,12 @@ public function testShouldRouteOriginalMessageToCommandRecipient()
129129
'aProp' => 'aPropVal',
130130
'enqueue.topic_name' => Config::COMMAND_TOPIC,
131131
'enqueue.processor_name' => 'theCommandName',
132+
'enqueue.command_name' => 'theCommandName',
132133
'enqueue.processor_queue_name' => 'aQueueName',
133134
], $routedMessage->getProperties());
134135
}
135136

136-
public function testShouldRejectCommandMessageIfProcessorNamePropertyMissing()
137+
public function testShouldRejectCommandMessageIfCommandNamePropertyMissing()
137138
{
138139
$message = new NullMessage();
139140
$message->setBody('theBody');
@@ -163,7 +164,7 @@ public function testShouldRejectCommandMessageIfProcessorNamePropertyMissing()
163164

164165
$this->assertInstanceOf(Result::class, $result);
165166
$this->assertEquals(Result::REJECT, $result->getStatus());
166-
$this->assertEquals('Got message without required parameter: "enqueue.processor_name"', $result->getReason());
167+
$this->assertEquals('Got message without required parameter: "enqueue.command_name"', $result->getReason());
167168
}
168169

169170
public function testShouldAddEventRoute()

0 commit comments

Comments
 (0)