Skip to content

Commit fcb8d09

Browse files
authored
Merge pull request #113 from php-enqueue/client-envets-and-commands
[RFC][client] Add ability to send events or commands.
2 parents 0a3b34c + 7791211 commit fcb8d09

22 files changed

Lines changed: 774 additions & 19 deletions

‎pkg/enqueue-bundle/DependencyInjection/Compiler/ExtractProcessorTagSubscriptionsTrait.php‎

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
namespace Enqueue\Bundle\DependencyInjection\Compiler;
44

5+
use Enqueue\Client\CommandSubscriberInterface;
6+
use Enqueue\Client\Config;
57
use Enqueue\Client\TopicSubscriberInterface;
68
use Symfony\Component\DependencyInjection\ContainerBuilder;
79
use Symfony\Component\DependencyInjection\Exception\ParameterNotFoundException;
@@ -43,7 +45,42 @@ protected function extractSubscriptions(ContainerBuilder $container, $processorS
4345
];
4446

4547
$data = [];
48+
if (is_subclass_of($processorClass, CommandSubscriberInterface::class)) {
49+
/** @var CommandSubscriberInterface $processorClass */
50+
$params = $processorClass::getSubscribedCommand();
51+
if (is_string($params)) {
52+
if (empty($params)) {
53+
throw new \LogicException('The processor name (it is also the command name) must not be empty.');
54+
}
55+
56+
$data[] = [
57+
'topicName' => Config::COMMAND_TOPIC,
58+
'queueName' => $defaultQueueName,
59+
'queueNameHardcoded' => false,
60+
'processorName' => $params,
61+
];
62+
} elseif (is_array($params)) {
63+
$params = array_replace($subscriptionPrototype, $params);
64+
if (false == $processorName = $resolve($params['processorName'])) {
65+
throw new \LogicException('The processor name (it is also the command name) must not be empty.');
66+
}
67+
68+
$data[] = [
69+
'topicName' => Config::COMMAND_TOPIC,
70+
'queueName' => $resolve($params['queueName']) ?: $defaultQueueName,
71+
'queueNameHardcoded' => $resolve($params['queueNameHardcoded']),
72+
'processorName' => $processorName,
73+
];
74+
} else {
75+
throw new \LogicException(sprintf(
76+
'Command subscriber configuration is invalid. "%s"',
77+
json_encode($processorClass::getSubscribedCommand())
78+
));
79+
}
80+
}
81+
4682
if (is_subclass_of($processorClass, TopicSubscriberInterface::class)) {
83+
/** @var TopicSubscriberInterface $processorClass */
4784
foreach ($processorClass::getSubscribedTopics() as $topicName => $params) {
4885
if (is_string($params)) {
4986
$data[] = [
@@ -68,7 +105,12 @@ protected function extractSubscriptions(ContainerBuilder $container, $processorS
68105
));
69106
}
70107
}
71-
} else {
108+
}
109+
110+
if (false == (
111+
is_subclass_of($processorClass, CommandSubscriberInterface::class) ||
112+
is_subclass_of($processorClass, TopicSubscriberInterface::class)
113+
)) {
72114
foreach ($tagAttributes as $tagAttribute) {
73115
$tagAttribute = array_replace($subscriptionPrototype, $tagAttribute);
74116

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,12 @@ services:
2323
enqueue.producer:
2424
alias: 'enqueue.client.producer'
2525

26+
enqueue.client.producer_v2:
27+
class: 'Enqueue\Client\ProducerV2'
28+
arguments:
29+
- '@enqueue.client.producer'
30+
- '@enqueue.client.rpc_client'
31+
2632
enqueue.spool_producer:
2733
alias: 'enqueue.client.spool_producer'
2834

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
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 TestCommandSubscriberProcessor 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::reply(
20+
$context->createMessage($message->getBody().'Reply')
21+
);
22+
}
23+
24+
public static function getSubscribedCommand()
25+
{
26+
return 'test_command_subscriber';
27+
}
28+
}

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,11 @@ services:
4747
tags:
4848
- { name: 'kernel.event_listener', async: true, event: 'test_async', method: 'onEvent' }
4949

50+
test_command_subscriber_processor:
51+
class: 'Enqueue\Bundle\Tests\Functional\App\TestCommandSubscriberProcessor'
52+
tags:
53+
- { name: 'enqueue.client.processor' }
54+
5055
test_async_subscriber:
5156
class: 'Enqueue\Bundle\Tests\Functional\App\TestAsyncSubscriber'
5257
tags:
Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
<?php
2+
3+
namespace Enqueue\Bundle\Tests\Functional\Client;
4+
5+
use Enqueue\Bundle\Tests\Functional\WebTestCase;
6+
use Enqueue\Client\Config;
7+
use Enqueue\Client\ProducerV2Interface;
8+
use Enqueue\Client\TraceableProducer;
9+
use Enqueue\Rpc\Promise;
10+
11+
/**
12+
* @group functional
13+
*/
14+
class ProducerV2Test extends WebTestCase
15+
{
16+
public function setUp()
17+
{
18+
parent::setUp();
19+
20+
$this->container->get('enqueue.client.producer')->clearTraces();
21+
}
22+
23+
public function tearDown()
24+
{
25+
parent::tearDown();
26+
27+
$this->container->get('enqueue.client.producer')->clearTraces();
28+
}
29+
30+
public function testCouldBeGetFromContainerAsService()
31+
{
32+
$producer = $this->container->get('enqueue.client.producer_v2');
33+
34+
$this->assertInstanceOf(ProducerV2Interface::class, $producer);
35+
}
36+
37+
public function testShouldSendEvent()
38+
{
39+
/** @var ProducerV2Interface $producer */
40+
$producer = $this->container->get('enqueue.client.producer_v2');
41+
42+
$producer->sendEvent('theTopic', 'theMessage');
43+
44+
$traces = $this->getTraceableProducer()->getTopicTraces('theTopic');
45+
46+
$this->assertCount(1, $traces);
47+
$this->assertEquals('theMessage', $traces[0]['body']);
48+
}
49+
50+
public function testShouldSendCommandWithoutNeedForReply()
51+
{
52+
/** @var ProducerV2Interface $producer */
53+
$producer = $this->container->get('enqueue.client.producer_v2');
54+
55+
$result = $producer->sendCommand('theCommand', 'theMessage', false);
56+
57+
$this->assertNull($result);
58+
59+
$traces = $this->getTraceableProducer()->getTopicTraces(Config::COMMAND_TOPIC);
60+
61+
$this->assertCount(1, $traces);
62+
$this->assertEquals('theMessage', $traces[0]['body']);
63+
$this->assertEquals([
64+
'enqueue.topic_name' => Config::COMMAND_TOPIC,
65+
'enqueue.processor_name' => 'theCommand',
66+
'enqueue.processor_queue_name' => 'default',
67+
], $traces[0]['properties']);
68+
}
69+
70+
public function testShouldSendCommandWithNeedForReply()
71+
{
72+
/** @var ProducerV2Interface $producer */
73+
$producer = $this->container->get('enqueue.client.producer_v2');
74+
75+
$result = $producer->sendCommand('theCommand', 'theMessage', true);
76+
77+
$this->assertInstanceOf(Promise::class, $result);
78+
79+
$traces = $this->getTraceableProducer()->getTopicTraces(Config::COMMAND_TOPIC);
80+
81+
$this->assertCount(1, $traces);
82+
$this->assertEquals('theMessage', $traces[0]['body']);
83+
$this->assertEquals([
84+
'enqueue.topic_name' => Config::COMMAND_TOPIC,
85+
'enqueue.processor_name' => 'theCommand',
86+
'enqueue.processor_queue_name' => 'default',
87+
], $traces[0]['properties']);
88+
}
89+
90+
/**
91+
* @return TraceableProducer|object
92+
*/
93+
private function getTraceableProducer()
94+
{
95+
return $this->container->get('enqueue.client.producer');
96+
}
97+
}

‎pkg/enqueue-bundle/Tests/Functional/QueuesCommandTest.php‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,16 @@ public function testShouldDisplayRegisteredQueues()
3030
$this->assertContains('enqueue.app.default', $display);
3131
$this->assertContains('enqueue.client.router_processor', $display);
3232
}
33+
34+
public function testShouldDisplayRegisteredCommand()
35+
{
36+
$command = $this->container->get('enqueue.client.meta.queues_command');
37+
38+
$tester = new CommandTester($command);
39+
$tester->execute([]);
40+
41+
$display = $tester->getDisplay();
42+
43+
$this->assertContains('test_command_subscriber', $display);
44+
}
3345
}

‎pkg/enqueue-bundle/Tests/Functional/TopicsCommandTest.php‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
namespace Enqueue\Bundle\Tests\Functional;
44

5+
use Enqueue\Client\Config;
56
use Enqueue\Symfony\Client\Meta\TopicsCommand;
67
use Symfony\Component\Console\Tester\CommandTester;
78

@@ -29,4 +30,17 @@ public function testShouldDisplayRegisteredTopics()
2930
$this->assertContains('__router__', $display);
3031
$this->assertContains('enqueue.client.router_processor', $display);
3132
}
33+
34+
public function testShouldDisplayCommands()
35+
{
36+
$command = $this->container->get('enqueue.client.meta.topics_command');
37+
38+
$tester = new CommandTester($command);
39+
$tester->execute([]);
40+
41+
$display = $tester->getDisplay();
42+
43+
$this->assertContains(Config::COMMAND_TOPIC, $display);
44+
$this->assertContains('test_command_subscriber', $display);
45+
}
3246
}

‎pkg/enqueue-bundle/Tests/Unit/DependencyInjection/Compiler/BuildClientRoutingPassTest.php‎

Lines changed: 55 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,12 @@
44

55
use Enqueue\Bundle\DependencyInjection\Compiler\BuildClientRoutingPass;
66
use Enqueue\Bundle\Tests\Unit\DependencyInjection\Compiler\Mock\InvalidTopicSubscriber;
7+
use Enqueue\Bundle\Tests\Unit\DependencyInjection\Compiler\Mock\OnlyCommandNameSubscriber;
78
use Enqueue\Bundle\Tests\Unit\DependencyInjection\Compiler\Mock\OnlyTopicNameTopicSubscriber;
9+
use Enqueue\Bundle\Tests\Unit\DependencyInjection\Compiler\Mock\ProcessorNameCommandSubscriber;
810
use Enqueue\Bundle\Tests\Unit\DependencyInjection\Compiler\Mock\ProcessorNameTopicSubscriber;
911
use Enqueue\Bundle\Tests\Unit\DependencyInjection\Compiler\Mock\QueueNameTopicSubscriber;
12+
use Enqueue\Client\Config;
1013
use PHPUnit\Framework\TestCase;
1114
use Symfony\Component\DependencyInjection\ContainerBuilder;
1215
use Symfony\Component\DependencyInjection\Definition;
@@ -213,8 +216,6 @@ public function testShouldBuildRouteFromSubscriberIfQueueNameSpecified()
213216

214217
public function testShouldThrowExceptionWhenTopicSubscriberConfigurationIsInvalid()
215218
{
216-
$this->setExpectedException(\LogicException::class, 'Topic subscriber configuration is invalid. "[12345]"');
217-
218219
$container = $this->createContainerBuilder();
219220

220221
$processor = new Definition(InvalidTopicSubscriber::class);
@@ -225,8 +226,60 @@ public function testShouldThrowExceptionWhenTopicSubscriberConfigurationIsInvali
225226
$router->setArguments(['', '']);
226227
$container->setDefinition('enqueue.client.router_processor', $router);
227228

229+
$pass = new BuildClientRoutingPass();
230+
231+
$this->expectException(\LogicException::class);
232+
$this->expectExceptionMessage('Topic subscriber configuration is invalid. "[12345]"');
233+
234+
$pass->process($container);
235+
}
236+
237+
public function testShouldBuildRouteFromCommandSubscriberIfOnlyCommandNameSpecified()
238+
{
239+
$container = $this->createContainerBuilder();
240+
241+
$processor = new Definition(OnlyCommandNameSubscriber::class);
242+
$processor->addTag('enqueue.client.processor');
243+
$container->setDefinition('processor-service-id', $processor);
244+
245+
$router = new Definition();
246+
$router->setArguments([null, null, null]);
247+
$container->setDefinition('enqueue.client.router_processor', $router);
248+
249+
$pass = new BuildClientRoutingPass();
250+
$pass->process($container);
251+
252+
$expectedRoutes = [
253+
Config::COMMAND_TOPIC => [
254+
['the-command-name', 'aDefaultQueueName'],
255+
],
256+
];
257+
258+
$this->assertEquals($expectedRoutes, $router->getArgument(1));
259+
}
260+
261+
public function testShouldBuildRouteFromCommandSubscriberIfProcessorNameSpecified()
262+
{
263+
$container = $this->createContainerBuilder();
264+
265+
$processor = new Definition(ProcessorNameCommandSubscriber::class);
266+
$processor->addTag('enqueue.client.processor');
267+
$container->setDefinition('processor-service-id', $processor);
268+
269+
$router = new Definition();
270+
$router->setArguments([null, null, null]);
271+
$container->setDefinition('enqueue.client.router_processor', $router);
272+
228273
$pass = new BuildClientRoutingPass();
229274
$pass->process($container);
275+
276+
$expectedRoutes = [
277+
Config::COMMAND_TOPIC => [
278+
['the-command-name', 'the-command-queue-name'],
279+
],
280+
];
281+
282+
$this->assertEquals($expectedRoutes, $router->getArgument(1));
230283
}
231284

232285
/**

0 commit comments

Comments
 (0)