Skip to content

Commit bb98a46

Browse files
committed
[client] Add ability to send events or commands.
* Events 1 to many * Commands 1 to 1 with possibility to get result (optionally)
1 parent 0a3b34c commit bb98a46

6 files changed

Lines changed: 174 additions & 4 deletions

File tree

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

Lines changed: 44 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,43 @@ 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 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+
65+
if ($processorName = $resolve($params['processorName'])) {
66+
throw new \LogicException('The processor name (it is also the command name) must not be empty.');
67+
}
68+
69+
$data[] = [
70+
'topicName' => Config::COMMAND_TOPIC,
71+
'queueName' => $resolve($params['queueName']) ?: $defaultQueueName,
72+
'queueNameHardcoded' => $resolve($params['queueNameHardcoded']),
73+
'processorName' => $processorName,
74+
];
75+
} else {
76+
throw new \LogicException(sprintf(
77+
'Command subscriber configuration is invalid. "%s"',
78+
json_encode($processorClass::getSubscribedCommand())
79+
));
80+
}
81+
}
82+
4683
if (is_subclass_of($processorClass, TopicSubscriberInterface::class)) {
84+
/** @var TopicSubscriberInterface $processorClass */
4785
foreach ($processorClass::getSubscribedTopics() as $topicName => $params) {
4886
if (is_string($params)) {
4987
$data[] = [
@@ -68,7 +106,12 @@ protected function extractSubscriptions(ContainerBuilder $container, $processorS
68106
));
69107
}
70108
}
71-
} else {
109+
}
110+
111+
if (false == (
112+
is_subclass_of($processorClass, CommandSubscriberInterface::class) ||
113+
is_subclass_of($processorClass, TopicSubscriberInterface::class)
114+
)) {
72115
foreach ($tagAttributes as $tagAttribute) {
73116
$tagAttribute = array_replace($subscriptionPrototype, $tagAttribute);
74117

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<?php
2+
3+
namespace Enqueue\Client;
4+
5+
interface CommandSubscriberInterface
6+
{
7+
/**
8+
* The result maybe either:.
9+
*
10+
* 'aCommandName'
11+
*
12+
* or
13+
*
14+
* [
15+
* 'processorName' => 'aCommandName',
16+
* 'queueName' => 'a_client_queue_name',
17+
* 'queueNameHardcoded' => true,
18+
* ]
19+
*
20+
* queueName and queueNameHardcoded are optional.
21+
*
22+
* Note: If you set queueNameHardcoded to true then the queueName is used as is and therefor the driver is not used to create a transport queue name.
23+
*
24+
* @return string|array
25+
*/
26+
public static function getSubscribedCommand();
27+
}

‎pkg/enqueue/Client/Config.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ class Config
88
const PARAMETER_PROCESSOR_NAME = 'enqueue.processor_name';
99
const PARAMETER_PROCESSOR_QUEUE_NAME = 'enqueue.processor_queue_name';
1010
const DEFAULT_PROCESSOR_QUEUE_NAME = 'default';
11+
const COMMAND_TOPIC = '__command__';
1112

1213
/**
1314
* @var string

‎pkg/enqueue/Client/Producer.php‎

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
use Enqueue\Util\JSON;
66
use Enqueue\Util\UUID;
77

8-
class Producer implements ProducerInterface
8+
class Producer implements ProducerInterface, ProducerV2Interface
99
{
1010
/**
1111
* @var DriverInterface
@@ -18,7 +18,8 @@ class Producer implements ProducerInterface
1818
private $extension;
1919

2020
/**
21-
* @param DriverInterface $driver
21+
* @param DriverInterface $driver
22+
* @param ExtensionInterface|null $extension
2223
*/
2324
public function __construct(DriverInterface $driver, ExtensionInterface $extension = null)
2425
{
@@ -80,6 +81,32 @@ public function send($topic, $message)
8081
}
8182
}
8283

84+
/**
85+
* {@inheritdoc}
86+
*/
87+
public function sendEvent($topic, $message)
88+
{
89+
$this->send($topic, $message);
90+
}
91+
92+
/**
93+
* {@inheritdoc}
94+
*/
95+
public function sendCommand($command, $message)
96+
{
97+
if (false == $message instanceof Message) {
98+
$message = new Message($message);
99+
}
100+
101+
$message->setProperty(Config::PARAMETER_TOPIC_NAME, Config::COMMAND_TOPIC);
102+
$message->setProperty(Config::PARAMETER_PROCESSOR_NAME, $command);
103+
$message->setScope(Message::SCOPE_APP);
104+
105+
$this->send('__command__', $message);
106+
107+
// TODO add support of replies
108+
}
109+
83110
/**
84111
* @param Message $message
85112
*/
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<?php
2+
3+
namespace Enqueue\Client;
4+
5+
interface ProducerV2Interface
6+
{
7+
/**
8+
* @experimental
9+
*
10+
* @param string $topic
11+
* @param string|array|Message $message
12+
*/
13+
public function sendEvent($topic, $message);
14+
15+
/**
16+
* @experimental
17+
*
18+
* @param string $command
19+
* @param string|array|Message $message
20+
*/
21+
public function sendCommand($command, $message);
22+
}

‎pkg/enqueue/Client/RouterProcessor.php‎

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,11 @@ class RouterProcessor implements PsrProcessor
1919
*/
2020
private $routes;
2121

22+
/**
23+
* @var array
24+
*/
25+
private $commands;
26+
2227
/**
2328
* @param DriverInterface $driver
2429
* @param array $routes
@@ -36,7 +41,11 @@ public function __construct(DriverInterface $driver, array $routes = [])
3641
*/
3742
public function add($topicName, $queueName, $processorName)
3843
{
39-
$this->routes[$topicName][] = [$processorName, $queueName];
44+
if (Config::COMMAND_TOPIC === $topicName) {
45+
$this->commands[$processorName] = $queueName;
46+
} else {
47+
$this->routes[$topicName][] = [$processorName, $queueName];
48+
}
4049
}
4150

4251
/**
@@ -52,6 +61,22 @@ public function process(PsrMessage $message, PsrContext $context)
5261
));
5362
}
5463

64+
if (Config::COMMAND_TOPIC === $topicName) {
65+
return $this->routeCommand($message);
66+
}
67+
68+
return $this->routeEvent($message);
69+
}
70+
71+
/**
72+
* @param PsrMessage $message
73+
*
74+
* @return string|Result
75+
*/
76+
private function routeEvent(PsrMessage $message)
77+
{
78+
$topicName = $message->getProperty(Config::PARAMETER_TOPIC_NAME);
79+
5580
if (array_key_exists($topicName, $this->routes)) {
5681
foreach ($this->routes[$topicName] as $route) {
5782
$processorMessage = clone $message;
@@ -64,4 +89,29 @@ public function process(PsrMessage $message, PsrContext $context)
6489

6590
return self::ACK;
6691
}
92+
93+
/**
94+
* @param PsrMessage $message
95+
*
96+
* @return string|Result
97+
*/
98+
private function routeCommand(PsrMessage $message)
99+
{
100+
$processorName = $message->getProperty(Config::PARAMETER_PROCESSOR_NAME);
101+
if (false == $processorName) {
102+
return Result::reject(sprintf(
103+
'Got message without required parameter: "%s"',
104+
Config::PARAMETER_PROCESSOR_NAME
105+
));
106+
}
107+
108+
if (isset($this->commands[$processorName])) {
109+
$processorMessage = clone $message;
110+
$processorMessage->setProperty(Config::PARAMETER_PROCESSOR_QUEUE_NAME, $this->commands[$processorName]);
111+
112+
$this->driver->sendToProcessor($this->driver->createClientMessage($processorMessage));
113+
}
114+
115+
return self::ACK;
116+
}
67117
}

0 commit comments

Comments
 (0)