From eb61460da06ac725f69dc9092d9752e25fcc16ff Mon Sep 17 00:00:00 2001 From: Maksim Kotlyar Date: Mon, 1 Oct 2018 18:33:11 +0300 Subject: [PATCH] [client] Rename config options. --- pkg/enqueue/Client/Config.php | 79 ++++++++++--------- .../SetRouterPropertiesExtension.php | 6 +- pkg/enqueue/Client/Driver/AmqpDriver.php | 4 +- pkg/enqueue/Client/Driver/FsDriver.php | 2 +- pkg/enqueue/Client/Driver/GenericDriver.php | 10 +-- pkg/enqueue/Client/Driver/GpsDriver.php | 4 +- .../Client/Driver/RabbitMqStompDriver.php | 4 +- pkg/enqueue/Client/Driver/RdKafkaDriver.php | 4 +- pkg/enqueue/Client/Driver/SqsDriver.php | 2 +- pkg/enqueue/Client/Driver/StompDriver.php | 2 +- .../Symfony/Client/ConsumeMessagesCommand.php | 4 +- pkg/enqueue/Symfony/Client/RoutesCommand.php | 2 +- pkg/enqueue/Tests/Client/ConfigTest.php | 20 ++--- pkg/simple-client/SimpleClient.php | 4 +- .../Tests/Functional/SimpleClientTest.php | 2 +- 15 files changed, 78 insertions(+), 71 deletions(-) diff --git a/pkg/enqueue/Client/Config.php b/pkg/enqueue/Client/Config.php index 0dc4ee5f8..ef68fb632 100644 --- a/pkg/enqueue/Client/Config.php +++ b/pkg/enqueue/Client/Config.php @@ -20,59 +20,66 @@ class Config /** * @var string */ - private $appName; + private $separator; /** * @var string */ - private $routerTopicName; + private $app; /** * @var string */ - private $routerQueueName; + private $routerTopic; /** * @var string */ - private $defaultProcessorQueueName; + private $routerQueue; /** * @var string */ - private $routerProcessorName; + private $defaultQueue; + + /** + * @var string + */ + private $routerProcessor; /** * @var array */ private $transportConfig; - public function __construct(string $prefix, string $appName, string $routerTopicName, string $routerQueueName, string $defaultProcessorQueueName, string $routerProcessorName, array $transportConfig = []) + public function __construct(string $prefix, string $app, string $routerTopic, string $routerQueue, string $defaultQueue, string $routerProcessor, array $transportConfig = []) { $this->prefix = trim($prefix); - $this->appName = trim($appName); + $this->app = trim($app); - $this->routerTopicName = trim($routerTopicName); - if (empty($this->routerTopicName)) { + $this->routerTopic = trim($routerTopic); + if (empty($this->routerTopic)) { throw new \InvalidArgumentException('Router topic is empty.'); } - $this->routerQueueName = trim($routerQueueName); - if (empty($this->routerQueueName)) { + $this->routerQueue = trim($routerQueue); + if (empty($this->routerQueue)) { throw new \InvalidArgumentException('Router queue is empty.'); } - $this->defaultProcessorQueueName = trim($defaultProcessorQueueName); - if (empty($this->defaultProcessorQueueName)) { + $this->defaultQueue = trim($defaultQueue); + if (empty($this->defaultQueue)) { throw new \InvalidArgumentException('Default processor queue name is empty.'); } - $this->routerProcessorName = trim($routerProcessorName); - if (empty($this->routerProcessorName)) { + $this->routerProcessor = trim($routerProcessor); + if (empty($this->routerProcessor)) { throw new \InvalidArgumentException('Router processor name is empty.'); } $this->transportConfig = $transportConfig; + + $this->separator = '.'; } public function getPrefix(): string @@ -82,32 +89,32 @@ public function getPrefix(): string public function getSeparator(): string { - return '.'; + return $this->separator; } - public function getAppName(): string + public function getApp(): string { - return $this->appName; + return $this->app; } - public function getRouterTopicName(): string + public function getRouterTopic(): string { - return $this->routerTopicName; + return $this->routerTopic; } - public function getRouterQueueName(): string + public function getRouterQueue(): string { - return $this->routerQueueName; + return $this->routerQueue; } - public function getDefaultProcessorQueueName(): string + public function getDefaultQueue(): string { - return $this->defaultProcessorQueueName; + return $this->defaultQueue; } - public function getRouterProcessorName(): string + public function getRouterProcessor(): string { - return $this->routerProcessorName; + return $this->routerProcessor; } /** @@ -122,20 +129,20 @@ public function getTransportOption(string $name, $default = null) public static function create( string $prefix = null, - string $appName = null, - string $routerTopicName = null, - string $routerQueueName = null, - string $defaultProcessorQueueName = null, - string $routerProcessorName = null, + string $app = null, + string $routerTopic = null, + string $routerQueue = null, + string $defaultQueue = null, + string $routerProcessor = null, array $transportConfig = [] ): self { return new static( $prefix ?: '', - $appName ?: '', - $routerTopicName ?: 'router', - $routerQueueName ?: 'default', - $defaultProcessorQueueName ?: 'default', - $routerProcessorName ?: 'router', + $app ?: '', + $routerTopic ?: 'router', + $routerQueue ?: 'default', + $defaultQueue ?: 'default', + $routerProcessor ?: 'router', $transportConfig ); } diff --git a/pkg/enqueue/Client/ConsumptionExtension/SetRouterPropertiesExtension.php b/pkg/enqueue/Client/ConsumptionExtension/SetRouterPropertiesExtension.php index 2ecc1dded..ca6a32bf1 100644 --- a/pkg/enqueue/Client/ConsumptionExtension/SetRouterPropertiesExtension.php +++ b/pkg/enqueue/Client/ConsumptionExtension/SetRouterPropertiesExtension.php @@ -33,17 +33,17 @@ public function onPreReceived(Context $context) } $config = $this->driver->getConfig(); - $queue = $this->driver->createQueue($config->getRouterQueueName()); + $queue = $this->driver->createQueue($config->getRouterQueue()); if ($context->getInteropQueue()->getQueueName() != $queue->getQueueName()) { return; } // RouterProcessor is our default message processor when that header is not set - $message->setProperty(Config::PROCESSOR, $config->getRouterProcessorName()); + $message->setProperty(Config::PROCESSOR, $config->getRouterProcessor()); $context->getLogger()->debug( '[SetRouterPropertiesExtension] '. - sprintf('Set router processor "%s"', $config->getRouterProcessorName()) + sprintf('Set router processor "%s"', $config->getRouterProcessor()) ); } } diff --git a/pkg/enqueue/Client/Driver/AmqpDriver.php b/pkg/enqueue/Client/Driver/AmqpDriver.php index 6d36fc4c1..be62753bf 100644 --- a/pkg/enqueue/Client/Driver/AmqpDriver.php +++ b/pkg/enqueue/Client/Driver/AmqpDriver.php @@ -70,7 +70,7 @@ public function setupBroker(LoggerInterface $logger = null): void $log('Declare router exchange: %s', $routerTopic->getTopicName()); $this->getContext()->declareTopic($routerTopic); - $routerQueue = $this->createQueue($this->getConfig()->getRouterQueueName()); + $routerQueue = $this->createQueue($this->getConfig()->getRouterQueue()); $log('Declare router queue: %s', $routerQueue->getQueueName()); $this->getContext()->declareQueue($routerQueue); @@ -99,7 +99,7 @@ public function setupBroker(LoggerInterface $logger = null): void protected function createRouterTopic(): Destination { $topic = $this->doCreateTopic( - $this->createTransportRouterTopicName($this->getConfig()->getRouterTopicName(), true) + $this->createTransportRouterTopicName($this->getConfig()->getRouterTopic(), true) ); $topic->setType(AmqpTopic::TYPE_FANOUT); $topic->addFlag(AmqpTopic::FLAG_DURABLE); diff --git a/pkg/enqueue/Client/Driver/FsDriver.php b/pkg/enqueue/Client/Driver/FsDriver.php index 7931ea3a1..9de59c23b 100644 --- a/pkg/enqueue/Client/Driver/FsDriver.php +++ b/pkg/enqueue/Client/Driver/FsDriver.php @@ -26,7 +26,7 @@ public function setupBroker(LoggerInterface $logger = null): void }; // setup router - $routerQueue = $this->createQueue($this->getConfig()->getRouterQueueName()); + $routerQueue = $this->createQueue($this->getConfig()->getRouterQueue()); $log('Declare router queue "%s" file: %s', $routerQueue->getQueueName(), $routerQueue->getFileInfo()); $this->getContext()->declareDestination($routerQueue); diff --git a/pkg/enqueue/Client/Driver/GenericDriver.php b/pkg/enqueue/Client/Driver/GenericDriver.php index 2da6b7dcb..740bbafe8 100644 --- a/pkg/enqueue/Client/Driver/GenericDriver.php +++ b/pkg/enqueue/Client/Driver/GenericDriver.php @@ -77,9 +77,9 @@ public function sendToProcessor(Message $message): void $message->setProperty(Config::PROCESSOR, $route->getProcessor()); $queue = $this->createRouteQueue($route); } elseif ($topic && false == $message->getProperty(Config::PROCESSOR)) { - $message->setProperty(Config::PROCESSOR, $this->config->getRouterProcessorName()); + $message->setProperty(Config::PROCESSOR, $this->config->getRouterProcessor()); - $queue = $this->createQueue($this->config->getRouterQueueName()); + $queue = $this->createQueue($this->config->getRouterQueue()); } elseif ($command) { $route = $this->routeCollection->command($command); if (false == $route) { @@ -127,7 +127,7 @@ public function createQueue(string $clientQueueName, bool $prefix = true): Inter public function createRouteQueue(Route $route): InteropQueue { $transportName = $this->createTransportQueueName( - $route->getQueue() ?: $this->config->getDefaultProcessorQueueName(), + $route->getQueue() ?: $this->config->getDefaultQueue(), $route->isPrefixQueue() ); @@ -225,7 +225,7 @@ protected function doSendToProcessor(InteropProducer $producer, InteropQueue $qu protected function createRouterTopic(): Destination { - return $this->createQueue($this->getConfig()->getRouterQueueName()); + return $this->createQueue($this->getConfig()->getRouterQueue()); } protected function createTransportRouterTopicName(string $name, bool $prefix): string @@ -238,7 +238,7 @@ protected function createTransportRouterTopicName(string $name, bool $prefix): s protected function createTransportQueueName(string $name, bool $prefix): string { $clientPrefix = $prefix ? $this->config->getPrefix() : ''; - $clientAppName = $prefix ? $this->config->getAppName() : ''; + $clientAppName = $prefix ? $this->config->getApp() : ''; return strtolower(implode($this->config->getSeparator(), array_filter([$clientPrefix, $clientAppName, $name]))); } diff --git a/pkg/enqueue/Client/Driver/GpsDriver.php b/pkg/enqueue/Client/Driver/GpsDriver.php index 2a37b7244..37a7110c1 100644 --- a/pkg/enqueue/Client/Driver/GpsDriver.php +++ b/pkg/enqueue/Client/Driver/GpsDriver.php @@ -29,7 +29,7 @@ public function setupBroker(LoggerInterface $logger = null): void // setup router $routerTopic = $this->createRouterTopic(); - $routerQueue = $this->createQueue($this->getConfig()->getRouterQueueName()); + $routerQueue = $this->createQueue($this->getConfig()->getRouterQueue()); $log('Subscribe router topic to queue: %s -> %s', $routerTopic->getTopicName(), $routerQueue->getQueueName()); $this->getContext()->subscribe($routerTopic, $routerQueue); @@ -58,7 +58,7 @@ public function setupBroker(LoggerInterface $logger = null): void protected function createRouterTopic(): Destination { return $this->doCreateTopic( - $this->createTransportRouterTopicName($this->getConfig()->getRouterTopicName(), true) + $this->createTransportRouterTopicName($this->getConfig()->getRouterTopic(), true) ); } } diff --git a/pkg/enqueue/Client/Driver/RabbitMqStompDriver.php b/pkg/enqueue/Client/Driver/RabbitMqStompDriver.php index c2ca768ab..36bdd86cf 100644 --- a/pkg/enqueue/Client/Driver/RabbitMqStompDriver.php +++ b/pkg/enqueue/Client/Driver/RabbitMqStompDriver.php @@ -76,7 +76,7 @@ public function setupBroker(LoggerInterface $logger = null): void } // setup router - $routerExchange = $this->createTransportRouterTopicName($this->getConfig()->getRouterTopicName(), true); + $routerExchange = $this->createTransportRouterTopicName($this->getConfig()->getRouterTopic(), true); $log('Declare router exchange: %s', $routerExchange); $this->management->declareExchange($routerExchange, [ 'type' => 'fanout', @@ -84,7 +84,7 @@ public function setupBroker(LoggerInterface $logger = null): void 'auto_delete' => false, ]); - $routerQueue = $this->createTransportQueueName($this->getConfig()->getRouterQueueName(), true); + $routerQueue = $this->createTransportQueueName($this->getConfig()->getRouterQueue(), true); $log('Declare router queue: %s', $routerQueue); $this->management->declareQueue($routerQueue, [ 'auto_delete' => false, diff --git a/pkg/enqueue/Client/Driver/RdKafkaDriver.php b/pkg/enqueue/Client/Driver/RdKafkaDriver.php index 1a10b228e..ecb711c97 100644 --- a/pkg/enqueue/Client/Driver/RdKafkaDriver.php +++ b/pkg/enqueue/Client/Driver/RdKafkaDriver.php @@ -27,7 +27,7 @@ public function setupBroker(LoggerInterface $logger = null): void }; // setup router - $routerQueue = $this->createQueue($this->getConfig()->getRouterQueueName()); + $routerQueue = $this->createQueue($this->getConfig()->getRouterQueue()); $log('Create router queue: %s', $routerQueue->getQueueName()); $this->getContext()->createConsumer($routerQueue); @@ -51,7 +51,7 @@ public function setupBroker(LoggerInterface $logger = null): void protected function createRouterTopic(): Destination { return $this->doCreateTopic( - $this->createTransportRouterTopicName($this->getConfig()->getRouterTopicName(), true) + $this->createTransportRouterTopicName($this->getConfig()->getRouterTopic(), true) ); } } diff --git a/pkg/enqueue/Client/Driver/SqsDriver.php b/pkg/enqueue/Client/Driver/SqsDriver.php index 9672d3955..bf66c050c 100644 --- a/pkg/enqueue/Client/Driver/SqsDriver.php +++ b/pkg/enqueue/Client/Driver/SqsDriver.php @@ -26,7 +26,7 @@ public function setupBroker(LoggerInterface $logger = null): void }; // setup router - $routerQueue = $this->createQueue($this->getConfig()->getRouterQueueName()); + $routerQueue = $this->createQueue($this->getConfig()->getRouterQueue()); $log('Declare router queue: %s', $routerQueue->getQueueName()); $this->getContext()->declareQueue($routerQueue); diff --git a/pkg/enqueue/Client/Driver/StompDriver.php b/pkg/enqueue/Client/Driver/StompDriver.php index 7236505e2..7040c71dd 100644 --- a/pkg/enqueue/Client/Driver/StompDriver.php +++ b/pkg/enqueue/Client/Driver/StompDriver.php @@ -61,7 +61,7 @@ protected function createRouterTopic(): Destination { /** @var StompDestination $topic */ $topic = $this->doCreateTopic( - $this->createTransportRouterTopicName($this->getConfig()->getRouterTopicName(), true) + $this->createTransportRouterTopicName($this->getConfig()->getRouterTopic(), true) ); $topic->setDurable(true); $topic->setAutoDelete(false); diff --git a/pkg/enqueue/Symfony/Client/ConsumeMessagesCommand.php b/pkg/enqueue/Symfony/Client/ConsumeMessagesCommand.php index f38fc86cb..727893799 100644 --- a/pkg/enqueue/Symfony/Client/ConsumeMessagesCommand.php +++ b/pkg/enqueue/Symfony/Client/ConsumeMessagesCommand.php @@ -74,8 +74,8 @@ protected function execute(InputInterface $input, OutputInterface $output): ?int $clientQueueNames = $input->getArgument('client-queue-names'); if (empty($clientQueueNames)) { - $clientQueueNames[$this->driver->getConfig()->getDefaultProcessorQueueName()] = true; - $clientQueueNames[$this->driver->getConfig()->getRouterQueueName()] = true; + $clientQueueNames[$this->driver->getConfig()->getDefaultQueue()] = true; + $clientQueueNames[$this->driver->getConfig()->getRouterQueue()] = true; foreach ($this->driver->getRouteCollection()->all() as $route) { if ($route->getQueue()) { diff --git a/pkg/enqueue/Symfony/Client/RoutesCommand.php b/pkg/enqueue/Symfony/Client/RoutesCommand.php index e4abc20a3..132fd1be1 100644 --- a/pkg/enqueue/Symfony/Client/RoutesCommand.php +++ b/pkg/enqueue/Symfony/Client/RoutesCommand.php @@ -119,7 +119,7 @@ private function formatProcessor(Route $route): string private function formatQueue(Route $route): string { - $queue = $route->getQueue() ?: $this->config->getDefaultProcessorQueueName(); + $queue = $route->getQueue() ?: $this->config->getDefaultQueue(); return $route->isPrefixQueue() ? $queue.' (prefixed)' : $queue.' (as is)'; } diff --git a/pkg/enqueue/Tests/Client/ConfigTest.php b/pkg/enqueue/Tests/Client/ConfigTest.php index e130319de..8e54508cf 100644 --- a/pkg/enqueue/Tests/Client/ConfigTest.php +++ b/pkg/enqueue/Tests/Client/ConfigTest.php @@ -49,7 +49,7 @@ public function testShouldReturnAppNameSetInConstructor() 'aRouterProcessorName' ); - $this->assertEquals('theApp', $config->getAppName()); + $this->assertEquals('theApp', $config->getApp()); } /** @@ -66,7 +66,7 @@ public function testShouldTrimReturnAppNameSetInConstructor(string $empty) 'aRouterProcessorName' ); - $this->assertSame('', $config->getAppName()); + $this->assertSame('', $config->getApp()); } public function testShouldReturnRouterProcessorNameSetInConstructor() @@ -80,7 +80,7 @@ public function testShouldReturnRouterProcessorNameSetInConstructor() 'aRouterProcessorName' ); - $this->assertEquals('aRouterProcessorName', $config->getRouterProcessorName()); + $this->assertEquals('aRouterProcessorName', $config->getRouterProcessor()); } public function testShouldReturnRouterTopicNameSetInConstructor() @@ -94,7 +94,7 @@ public function testShouldReturnRouterTopicNameSetInConstructor() 'aRouterProcessorName' ); - $this->assertEquals('aRouterTopicName', $config->getRouterTopicName()); + $this->assertEquals('aRouterTopicName', $config->getRouterTopic()); } public function testShouldReturnRouterQueueNameSetInConstructor() @@ -108,7 +108,7 @@ public function testShouldReturnRouterQueueNameSetInConstructor() 'aRouterProcessorName' ); - $this->assertEquals('aRouterQueueName', $config->getRouterQueueName()); + $this->assertEquals('aRouterQueueName', $config->getRouterQueue()); } public function testShouldReturnDefaultQueueNameSetInConstructor() @@ -122,17 +122,17 @@ public function testShouldReturnDefaultQueueNameSetInConstructor() 'aRouterProcessorName' ); - $this->assertEquals('aDefaultQueueName', $config->getDefaultProcessorQueueName()); + $this->assertEquals('aDefaultQueueName', $config->getDefaultQueue()); } public function testShouldCreateDefaultConfig() { $config = Config::create(); - $this->assertSame('default', $config->getDefaultProcessorQueueName()); - $this->assertSame('router', $config->getRouterProcessorName()); - $this->assertSame('default', $config->getRouterQueueName()); - $this->assertSame('router', $config->getRouterTopicName()); + $this->assertSame('default', $config->getDefaultQueue()); + $this->assertSame('router', $config->getRouterProcessor()); + $this->assertSame('default', $config->getRouterQueue()); + $this->assertSame('router', $config->getRouterTopic()); } /** diff --git a/pkg/simple-client/SimpleClient.php b/pkg/simple-client/SimpleClient.php index 7a4cff3ca..1f0d1c12a 100644 --- a/pkg/simple-client/SimpleClient.php +++ b/pkg/simple-client/SimpleClient.php @@ -169,7 +169,7 @@ public function consume(ExtensionInterface $runtimeExtension = null): void $boundQueues = []; - $routerQueue = $this->getDriver()->createQueue($this->getDriver()->getConfig()->getRouterQueueName()); + $routerQueue = $this->getDriver()->createQueue($this->getDriver()->getConfig()->getRouterQueue()); $this->queueConsumer->bind($routerQueue, $this->delegateProcessor); $boundQueues[$routerQueue->getQueueName()] = true; @@ -268,7 +268,7 @@ public function build(array $configs): void $routerProcessor = new RouterProcessor($driver); - $processorRegistry->add($config->getRouterProcessorName(), $routerProcessor); + $processorRegistry->add($config->getRouterProcessor(), $routerProcessor); $this->driver = $driver; $this->producer = $producer; diff --git a/pkg/simple-client/Tests/Functional/SimpleClientTest.php b/pkg/simple-client/Tests/Functional/SimpleClientTest.php index 61e061811..63699c23b 100644 --- a/pkg/simple-client/Tests/Functional/SimpleClientTest.php +++ b/pkg/simple-client/Tests/Functional/SimpleClientTest.php @@ -181,7 +181,7 @@ protected function purgeQueue(SimpleClient $client): void { $driver = $client->getDriver(); - $queue = $driver->createQueue($driver->getConfig()->getDefaultProcessorQueueName()); + $queue = $driver->createQueue($driver->getConfig()->getDefaultQueue()); try { $client->getDriver()->getContext()->purgeQueue($queue);