Skip to content

Commit

Permalink
minor #27129 [Messenger] Rename Adapters to Transports (sroze)
Browse files Browse the repository at this point in the history
This PR was squashed before being merged into the 4.1-dev branch (closes #27129).

Discussion
----------

[Messenger] Rename Adapters to Transports

| Q             | A
| ------------- | ---
| Branch?       | master
| Bug fix?      | no
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | ø
| License       | MIT
| Doc PR        | ø

Last of our tasks on the "plan to beta", renaming "adapters" to "transports". This is a term that makes more sense and is commonly used within the "queue community".

Commits
-------

13b7475 [Messenger] Rename Adapters to Transports
  • Loading branch information
nicolas-grekas committed May 4, 2018
2 parents 926f240 + 13b7475 commit 47da23c
Show file tree
Hide file tree
Showing 42 changed files with 82 additions and 89 deletions.
Expand Up @@ -13,7 +13,7 @@

use Doctrine\Common\Persistence\ManagerRegistry;
use Doctrine\ORM\EntityManagerInterface;
use Symfony\Component\Messenger\MiddlewareInterface;
use Symfony\Component\Messenger\Middleware\MiddlewareInterface;

/**
* Wraps all handlers in a single doctrine transaction.
Expand Down
Expand Up @@ -971,7 +971,7 @@ private function addMessengerSection(ArrayNodeDefinition $rootNode)
->arrayNode('messenger')
->info('Messenger configuration')
->{!class_exists(FullStack::class) && interface_exists(MessageBusInterface::class) ? 'canBeDisabled' : 'canBeEnabled'}()
->fixXmlConfig('adapter')
->fixXmlConfig('transport')
->fixXmlConfig('bus', 'buses')
->children()
->arrayNode('routing')
Expand Down Expand Up @@ -1024,7 +1024,7 @@ function ($a) {
->end()
->scalarNode('encoder')->defaultValue('messenger.transport.serializer')->end()
->scalarNode('decoder')->defaultValue('messenger.transport.serializer')->end()
->arrayNode('adapters')
->arrayNode('transports')
->useAttributeAsKey('name')
->arrayPrototype()
->beforeNormalization()
Expand Down
Expand Up @@ -1449,7 +1449,7 @@ private function registerMessengerConfiguration(array $config, ContainerBuilder
$loader->load('messenger.xml');

if ($this->isConfigEnabled($container, $config['serializer'])) {
if (\count($config['adapters']) > 0 && !$this->isConfigEnabled($container, $serializerConfig)) {
if (\count($config['transports']) > 0 && !$this->isConfigEnabled($container, $serializerConfig)) {
throw new LogicException('Using the default encoder/decoder, Symfony Messenger requires the Serializer. Enable it or install it by running "composer require symfony/serializer-pack".');
}

Expand Down Expand Up @@ -1505,17 +1505,17 @@ private function registerMessengerConfiguration(array $config, ContainerBuilder

$container->getDefinition('messenger.asynchronous.routing.sender_locator')->replaceArgument(1, $messageToSenderIdsMapping);

foreach ($config['adapters'] as $name => $adapter) {
foreach ($config['transports'] as $name => $transport) {
$senderDefinition = (new Definition(SenderInterface::class))
->setFactory(array(new Reference('messenger.adapter_factory'), 'createSender'))
->setArguments(array($adapter['dsn'], $adapter['options']))
->setFactory(array(new Reference('messenger.transport_factory'), 'createSender'))
->setArguments(array($transport['dsn'], $transport['options']))
->addTag('messenger.sender', array('name' => $name))
;
$container->setDefinition('messenger.sender.'.$name, $senderDefinition);

$receiverDefinition = (new Definition(ReceiverInterface::class))
->setFactory(array(new Reference('messenger.adapter_factory'), 'createReceiver'))
->setArguments(array($adapter['dsn'], $adapter['options']))
->setFactory(array(new Reference('messenger.transport_factory'), 'createReceiver'))
->setArguments(array($transport['dsn'], $transport['options']))
->addTag('messenger.receiver', array('name' => $name))
;
$container->setDefinition('messenger.receiver.'.$name, $receiverDefinition);
Expand Down
Expand Up @@ -8,7 +8,7 @@
<defaults public="false" />

<!-- Handlers -->
<service id="messenger.handler_resolver" class="Symfony\Component\Messenger\ContainerHandlerLocator">
<service id="messenger.handler_resolver" class="Symfony\Component\Messenger\Handler\Locator\ContainerHandlerLocator">
<argument type="service" id="service_container"/>
</service>

Expand Down Expand Up @@ -60,16 +60,16 @@
</service>

<!-- Adapters -->
<service id="messenger.adapter_factory" class="Symfony\Component\Messenger\Adapter\Factory\ChainAdapterFactory">
<argument type="tagged" tag="messenger.adapter_factory" />
<service id="messenger.transport_factory" class="Symfony\Component\Messenger\Transport\Factory\ChainTransportFactory">
<argument type="tagged" tag="messenger.transport_factory" />
</service>

<service id="messenger.adapter.amqp.factory" class="Symfony\Component\Messenger\Adapter\AmqpExt\AmqpAdapterFactory">
<service id="messenger.adapter.amqp.factory" class="Symfony\Component\Messenger\Transport\AmqpExt\AmqpTransportFactory">
<argument type="service" id="messenger.transport.encoder" />
<argument type="service" id="messenger.transport.decoder" />
<argument>%kernel.debug%</argument>

<tag name="messenger.adapter_factory" />
<tag name="messenger.transport_factory" />
</service>
</services>
</container>
Expand Up @@ -356,7 +356,7 @@
<xsd:element name="encoder" type="xsd:string" minOccurs="0" />
<xsd:element name="decoder" type="xsd:string" minOccurs="0" />
<xsd:element name="routing" type="messenger_routing" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="adapter" type="messenger_adapter" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="transport" type="messenger_transport" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="bus" type="messenger_bus" minOccurs="0" maxOccurs="unbounded" />
</xsd:sequence>
<xsd:attribute name="default-bus" type="xsd:string" />
Expand All @@ -381,19 +381,14 @@
<xsd:attribute name="service" type="xsd:string" use="required"/>
</xsd:complexType>

<xsd:complexType name="messenger_adapter">
<xsd:complexType name="messenger_transport">
<xsd:sequence>
<xsd:element name="options" type="metadata" minOccurs="0" maxOccurs="unbounded" />
</xsd:sequence>
<xsd:attribute name="name" type="xsd:string" />
<xsd:attribute name="dsn" type="xsd:string" />
</xsd:complexType>

<xsd:complexType name="messenger_adapter_option">
<xsd:attribute name="name" type="xsd:string" />
<xsd:attribute name="value" type="xsd:string" />
</xsd:complexType>

<xsd:complexType name="messenger_bus">
<xsd:sequence>
<xsd:element name="middleware" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />
Expand Down
Expand Up @@ -254,7 +254,7 @@ class_exists(SemaphoreStore::class) && SemaphoreStore::isSupported() ? 'semaphor
'messenger' => array(
'enabled' => !class_exists(FullStack::class) && interface_exists(MessageBusInterface::class),
'routing' => array(),
'adapters' => array(),
'transports' => array(),
'serializer' => array(
'enabled' => true,
'format' => 'json',
Expand Down
Expand Up @@ -8,7 +8,7 @@
'serializer' => array(
'enabled' => true,
),
'adapters' => array(
'transports' => array(
'default' => 'amqp://localhost/%2f/messages',
),
),
Expand Down
Expand Up @@ -3,7 +3,7 @@
$container->loadFromExtension('framework', array(
'serializer' => true,
'messenger' => array(
'adapters' => array(
'transports' => array(
'default' => 'amqp://localhost/%2f/messages',
'customised' => array(
'dsn' => 'amqp://localhost/%2f/messages?exchange_name=exchange_name',
Expand Down
Expand Up @@ -9,7 +9,7 @@
<framework:serializer enabled="false" />
<framework:messenger>
<framework:serializer enabled="true" />
<framework:adapter name="default" dsn="amqp://localhost/%2f/messages" />
<framework:transport name="default" dsn="amqp://localhost/%2f/messages" />
</framework:messenger>
</framework:config>
</container>
Expand Up @@ -8,14 +8,14 @@
<framework:config>
<framework:serializer enabled="true" />
<framework:messenger>
<framework:adapter name="default" dsn="amqp://localhost/%2f/messages" />
<framework:adapter name="customised" dsn="amqp://localhost/%2f/messages?exchange_name=exchange_name">
<framework:transport name="default" dsn="amqp://localhost/%2f/messages" />
<framework:transport name="customised" dsn="amqp://localhost/%2f/messages?exchange_name=exchange_name">
<framework:options>
<framework:queue>
<framework:name>Queue</framework:name>
</framework:queue>
</framework:options>
</framework:adapter>
</framework:transport>
</framework:messenger>
</framework:config>
</container>
Expand Up @@ -4,5 +4,5 @@ framework:
messenger:
serializer:
enabled: true
adapters:
transports:
default: 'amqp://localhost/%2f/messages'
@@ -1,7 +1,7 @@
framework:
serializer: true
messenger:
adapters:
transports:
default: 'amqp://localhost/%2f/messages'
customised:
dsn: 'amqp://localhost/%2f/messages?exchange_name=exchange_name'
Expand Down
Expand Up @@ -529,9 +529,9 @@ public function testMessenger()
$this->assertTrue($container->has('message_bus'));
}

public function testMessengerAdapter()
public function testMessengerTransports()
{
$container = $this->createContainerFromFile('messenger_adapter');
$container = $this->createContainerFromFile('messenger_transports');
$this->assertTrue($container->hasDefinition('messenger.sender.default'));
$this->assertTrue($container->getDefinition('messenger.sender.default')->hasTag('messenger.sender'));
$this->assertEquals(array(array('name' => 'default')), $container->getDefinition('messenger.sender.default')->getTag('messenger.sender'));
Expand All @@ -543,7 +543,7 @@ public function testMessengerAdapter()
$senderFactory = $container->getDefinition('messenger.sender.customised')->getFactory();
$senderArguments = $container->getDefinition('messenger.sender.customised')->getArguments();

$this->assertEquals(array(new Reference('messenger.adapter_factory'), 'createSender'), $senderFactory);
$this->assertEquals(array(new Reference('messenger.transport_factory'), 'createSender'), $senderFactory);
$this->assertCount(2, $senderArguments);
$this->assertSame('amqp://localhost/%2f/messages?exchange_name=exchange_name', $senderArguments[0]);
$this->assertSame(array('queue' => array('name' => 'Queue')), $senderArguments[1]);
Expand All @@ -552,7 +552,7 @@ public function testMessengerAdapter()
$receiverFactory = $container->getDefinition('messenger.receiver.customised')->getFactory();
$receiverArguments = $container->getDefinition('messenger.receiver.customised')->getArguments();

$this->assertEquals(array(new Reference('messenger.adapter_factory'), 'createReceiver'), $receiverFactory);
$this->assertEquals(array(new Reference('messenger.transport_factory'), 'createReceiver'), $receiverFactory);
$this->assertCount(2, $receiverArguments);
$this->assertSame('amqp://localhost/%2f/messages?exchange_name=exchange_name', $receiverArguments[0]);
$this->assertSame(array('queue' => array('name' => 'Queue')), $receiverArguments[1]);
Expand Down
Expand Up @@ -13,7 +13,7 @@

use Symfony\Component\Messenger\Asynchronous\Routing\SenderLocatorInterface;
use Symfony\Component\Messenger\Asynchronous\Transport\ReceivedMessage;
use Symfony\Component\Messenger\MiddlewareInterface;
use Symfony\Component\Messenger\Middleware\MiddlewareInterface;

/**
* @author Samuel Roze <samuel.roze@gmail.com>
Expand Down
Expand Up @@ -9,7 +9,7 @@
* file that was distributed with this source code.
*/

namespace Symfony\Component\Messenger;
namespace Symfony\Component\Messenger\Handler\Locator;

use Psr\Container\ContainerInterface;
use Symfony\Component\Messenger\Exception\NoHandlerForMessageException;
Expand Down
Expand Up @@ -9,7 +9,7 @@
* file that was distributed with this source code.
*/

namespace Symfony\Component\Messenger;
namespace Symfony\Component\Messenger\Handler\Locator;

use Symfony\Component\Messenger\Exception\NoHandlerForMessageException;

Expand Down
Expand Up @@ -9,7 +9,7 @@
* file that was distributed with this source code.
*/

namespace Symfony\Component\Messenger;
namespace Symfony\Component\Messenger\Handler\Locator;

use Symfony\Component\Messenger\Exception\NoHandlerForMessageException;

Expand Down
2 changes: 2 additions & 0 deletions src/Symfony/Component/Messenger/MessageBus.php
Expand Up @@ -11,6 +11,8 @@

namespace Symfony\Component\Messenger;

use Symfony\Component\Messenger\Middleware\MiddlewareInterface;

/**
* @author Samuel Roze <samuel.roze@gmail.com>
* @author Matthias Noback <matthiasnoback@gmail.com>
Expand Down
Expand Up @@ -11,8 +11,7 @@

namespace Symfony\Component\Messenger\Middleware;

use Symfony\Component\Messenger\MiddlewareInterface;
use Symfony\Component\Messenger\HandlerLocatorInterface;
use Symfony\Component\Messenger\Handler\Locator\HandlerLocatorInterface;

/**
* @author Samuel Roze <samuel.roze@gmail.com>
Expand Down
Expand Up @@ -12,7 +12,6 @@
namespace Symfony\Component\Messenger\Middleware;

use Symfony\Component\Messenger\Asynchronous\Transport\ReceivedMessage;
use Symfony\Component\Messenger\MiddlewareInterface;
use Psr\Log\LoggerInterface;

/**
Expand Down
Expand Up @@ -9,7 +9,7 @@
* file that was distributed with this source code.
*/

namespace Symfony\Component\Messenger;
namespace Symfony\Component\Messenger\Middleware;

/**
* @author Samuel Roze <samuel.roze@gmail.com>
Expand Down
Expand Up @@ -12,7 +12,6 @@
namespace Symfony\Component\Messenger\Middleware;

use Symfony\Component\Messenger\Exception\NoHandlerForMessageException;
use Symfony\Component\Messenger\MiddlewareInterface;

/**
* @author Samuel Roze <samuel.roze@gmail.com>
Expand Down
Expand Up @@ -12,7 +12,6 @@
namespace Symfony\Component\Messenger\Middleware;

use Symfony\Component\Messenger\Exception\ValidationFailedException;
use Symfony\Component\Messenger\MiddlewareInterface;
use Symfony\Component\Validator\Validator\ValidatorInterface;

/**
Expand Down
Expand Up @@ -16,16 +16,16 @@
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Reference;
use Symfony\Component\DependencyInjection\ServiceLocator;
use Symfony\Component\Messenger\Adapter\AmqpExt\AmqpReceiver;
use Symfony\Component\Messenger\Adapter\AmqpExt\AmqpSender;
use Symfony\Component\Messenger\ContainerHandlerLocator;
use Symfony\Component\Messenger\Transport\AmqpExt\AmqpReceiver;
use Symfony\Component\Messenger\Transport\AmqpExt\AmqpSender;
use Symfony\Component\Messenger\Handler\Locator\ContainerHandlerLocator;
use Symfony\Component\Messenger\DataCollector\MessengerDataCollector;
use Symfony\Component\Messenger\DependencyInjection\MessengerPass;
use Symfony\Component\Messenger\Handler\ChainHandler;
use Symfony\Component\Messenger\Handler\MessageSubscriberInterface;
use Symfony\Component\Messenger\MessageBusInterface;
use Symfony\Component\Messenger\Middleware\TolerateNoHandler;
use Symfony\Component\Messenger\MiddlewareInterface;
use Symfony\Component\Messenger\Middleware\MiddlewareInterface;
use Symfony\Component\Messenger\Tests\Fixtures\DummyMessage;
use Symfony\Component\Messenger\Tests\Fixtures\SecondMessage;
use Symfony\Component\Messenger\Transport\ReceiverInterface;
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Component/Messenger/Tests/MessageBusTest.php
Expand Up @@ -14,7 +14,7 @@
use PHPUnit\Framework\TestCase;
use Symfony\Component\Messenger\MessageBus;
use Symfony\Component\Messenger\MessageBusInterface;
use Symfony\Component\Messenger\MiddlewareInterface;
use Symfony\Component\Messenger\Middleware\MiddlewareInterface;
use Symfony\Component\Messenger\Tests\Fixtures\DummyMessage;

class MessageBusTest extends TestCase
Expand Down
Expand Up @@ -12,7 +12,7 @@
namespace Symfony\Component\Messenger\Tests\Middleware;

use PHPUnit\Framework\TestCase;
use Symfony\Component\Messenger\HandlerLocator;
use Symfony\Component\Messenger\Handler\Locator\HandlerLocator;
use Symfony\Component\Messenger\Middleware\HandleMessageMiddleware;
use Symfony\Component\Messenger\Tests\Fixtures\DummyMessage;

Expand Down
Expand Up @@ -9,12 +9,12 @@
* file that was distributed with this source code.
*/

namespace Symfony\Component\Messenger\Tests\Adapter\AmqpExt;
namespace Symfony\Component\Messenger\Tests\Transport\AmqpExt;

use PHPUnit\Framework\TestCase;
use Symfony\Component\Messenger\Adapter\AmqpExt\AmqpReceiver;
use Symfony\Component\Messenger\Adapter\AmqpExt\AmqpSender;
use Symfony\Component\Messenger\Adapter\AmqpExt\Connection;
use Symfony\Component\Messenger\Transport\AmqpExt\AmqpReceiver;
use Symfony\Component\Messenger\Transport\AmqpExt\AmqpSender;
use Symfony\Component\Messenger\Transport\AmqpExt\Connection;
use Symfony\Component\Messenger\Tests\Fixtures\DummyMessage;
use Symfony\Component\Messenger\Transport\Serialization\Serializer;
use Symfony\Component\Process\PhpProcess;
Expand Down
Expand Up @@ -9,12 +9,12 @@
* file that was distributed with this source code.
*/

namespace Symfony\Component\Messenger\Tests\Adapter\AmqpExt;
namespace Symfony\Component\Messenger\Tests\Transport\AmqpExt;

use PHPUnit\Framework\TestCase;
use Symfony\Component\Messenger\Adapter\AmqpExt\AmqpReceiver;
use Symfony\Component\Messenger\Adapter\AmqpExt\Connection;
use Symfony\Component\Messenger\Adapter\AmqpExt\Exception\RejectMessageExceptionInterface;
use Symfony\Component\Messenger\Transport\AmqpExt\AmqpReceiver;
use Symfony\Component\Messenger\Transport\AmqpExt\Connection;
use Symfony\Component\Messenger\Transport\AmqpExt\Exception\RejectMessageExceptionInterface;
use Symfony\Component\Messenger\Tests\Fixtures\DummyMessage;
use Symfony\Component\Messenger\Transport\Serialization\Serializer;
use Symfony\Component\Serializer as SerializerComponent;
Expand Down Expand Up @@ -51,7 +51,7 @@ public function testItSendTheDecodedMessageToTheHandlerAndAcknowledgeIt()
}

/**
* @expectedException \Symfony\Component\Messenger\Tests\Adapter\AmqpExt\InterruptException
* @expectedException \Symfony\Component\Messenger\Tests\Transport\AmqpExt\InterruptException
*/
public function testItNonAcknowledgeTheMessageIfAnExceptionHappened()
{
Expand All @@ -77,7 +77,7 @@ public function testItNonAcknowledgeTheMessageIfAnExceptionHappened()
}

/**
* @expectedException \Symfony\Component\Messenger\Tests\Adapter\AmqpExt\WillNeverWorkException
* @expectedException \Symfony\Component\Messenger\Tests\Transport\AmqpExt\WillNeverWorkException
*/
public function testItRejectsTheMessageIfTheExceptionIsARejectMessageExceptionInterface()
{
Expand Down

0 comments on commit 47da23c

Please sign in to comment.