Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[Messenger] Allow to configure the transport #26941

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 17, 2018
Merged

[Messenger] Allow to configure the transport #26941

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1008,6 +1008,21 @@ function ($a) {
->end()
->end()
->end()
->arrayNode('serializer')
->canBeDisabled()
->addDefaultsIfNotSet()
->children()
->scalarNode('format')->defaultValue('json')->end()
->arrayNode('context')
->normalizeKeys(false)
->useAttributeAsKey('name')
->defaultValue(array())
->prototype('variable')->end()
->end()
->end()
->end()
->scalarNode('encoder')->defaultValue('messenger.transport.serializer')->end()
->scalarNode('decoder')->defaultValue('messenger.transport.serializer')->end()
->arrayNode('middlewares')
->addDefaultsIfNotSet()
->children()
Expand Down
19 changes: 17 additions & 2 deletions src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ public function load(array $configs, ContainerBuilder $container)
}

if ($this->isConfigEnabled($container, $config['messenger'])) {
$this->registerMessengerConfiguration($config['messenger'], $container, $loader);
$this->registerMessengerConfiguration($config['messenger'], $container, $loader, $config['serializer']);
} else {
$container->removeDefinition('console.command.messenger_consume_messages');
}
Expand Down Expand Up @@ -1438,14 +1438,29 @@ private function registerLockConfiguration(array $config, ContainerBuilder $cont
}
}

private function registerMessengerConfiguration(array $config, ContainerBuilder $container, XmlFileLoader $loader)
private function registerMessengerConfiguration(array $config, ContainerBuilder $container, XmlFileLoader $loader, array $serializerConfig)
{
if (!interface_exists(MessageBusInterface::class)) {
throw new LogicException('Messenger support cannot be enabled as the Messenger component is not installed.');
}

$loader->load('messenger.xml');

if ($this->isConfigEnabled($container, $config['serializer'])) {
if (count($config['adapters']) > 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".');
}

$container->getDefinition('messenger.transport.serializer')
->replaceArgument(1, $config['serializer']['format'])
->replaceArgument(2, $config['serializer']['context']);
} else {
$container->removeDefinition('messenger.transport.serializer');
}

$container->setAlias('messenger.transport.encoder', $config['encoder']);
$container->setAlias('messenger.transport.decoder', $config['decoder']);

$messageToSenderIdsMapping = array();
foreach ($config['routing'] as $message => $messageConfiguration) {
$messageToSenderIdsMapping[$message] = $messageConfiguration['senders'];
Expand Down
11 changes: 5 additions & 6 deletions src/Symfony/Bundle/FrameworkBundle/Resources/config/messenger.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,12 @@
</service>

<!-- Message encoding/decoding -->
<service id="messenger.transport.serialize_message_with_type_in_headers" class="Symfony\Component\Messenger\Transport\Serialization\Serializer">
<service id="messenger.transport.serializer" class="Symfony\Component\Messenger\Transport\Serialization\Serializer">
<argument type="service" id="serializer" />
<argument /> <!-- Format -->
<argument type="collection" /> <!-- Context -->
</service>

<service id="messenger.transport.default_encoder" alias="messenger.transport.serialize_message_with_type_in_headers" public="true" />
<service id="messenger.transport.default_decoder" alias="messenger.transport.serialize_message_with_type_in_headers" public="true" />
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason to move to PHP? If not, better keep here, isn't it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a reason: it's now configurable via the framework.messenger.transport configuration.


<!-- Logging & Debug -->
<service id="messenger.middleware.debug.logging" class="Symfony\Component\Messenger\Debug\LoggingMiddleware">
<argument type="service" id="logger" />
Expand Down Expand Up @@ -79,8 +78,8 @@
</service>

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

<tag name="messenger.adapter_factory" />
Expand Down
11 changes: 11 additions & 0 deletions src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,12 +352,23 @@

<xsd:complexType name="messenger">
<xsd:sequence>
<xsd:element name="serializer" type="messenger_serializer" minOccurs="0" />
<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="middlewares" type="messenger_middleware" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="adapter" type="messenger_adapter" minOccurs="0" maxOccurs="unbounded" />
</xsd:sequence>
</xsd:complexType>

<xsd:complexType name="messenger_serializer">
<xsd:sequence>
<xsd:element name="context" type="metadata" minOccurs="0" maxOccurs="unbounded" />
</xsd:sequence>
<xsd:attribute name="format" type="xsd:string" />
<xsd:attribute name="enabled" type="xsd:boolean" />
</xsd:complexType>

<xsd:complexType name="messenger_routing">
<xsd:choice minOccurs="0" maxOccurs="unbounded">
<xsd:element name="sender" type="messenger_routing_sender" />
Expand Down
8 changes: 8 additions & 0 deletions src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
use Symfony\Component\Config\Definition\Processor;
use Symfony\Component\Lock\Store\SemaphoreStore;
use Symfony\Component\Messenger\MessageBusInterface;
use Symfony\Component\Serializer\Serializer;

class ConfigurationTest extends TestCase
{
Expand Down Expand Up @@ -259,6 +260,13 @@ class_exists(SemaphoreStore::class) && SemaphoreStore::isSupported() ? 'semaphor
),
),
'adapters' => array(),
'serializer' => array(
'enabled' => true,
'format' => 'json',
'context' => array(),
),
'encoder' => 'messenger.transport.serializer',
'decoder' => 'messenger.transport.serializer',
),
);
}
Expand Down
1 change: 1 addition & 0 deletions ...mfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/messenger_adapter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<?php

$container->loadFromExtension('framework', array(
'serializer' => true,
'messenger' => array(
'adapters' => array(
'default' => 'amqp://localhost/%2f/messages',
Expand Down
10 changes: 10 additions & 0 deletions ...ony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/messenger_transport.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<?php

$container->loadFromExtension('framework', array(
'messenger' => array(
'serializer' => array(
'format' => 'csv',
'context' => array('enable_max_depth' => true),
),
),
));
15 changes: 15 additions & 0 deletions ...meworkBundle/Tests/DependencyInjection/Fixtures/php/messenger_transport_no_serializer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?php

$container->loadFromExtension('framework', array(
'serializer' => array(
'enabled' => false,
),
'messenger' => array(
'serializer' => array(
'enabled' => true,
),
'adapters' => array(
'default' => 'amqp://localhost/%2f/messages',
),
),
));
1 change: 1 addition & 0 deletions ...mfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/messenger_adapter.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
http://symfony.com/schema/dic/symfony http://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

<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">
Expand Down
17 changes: 17 additions & 0 deletions ...ony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/messenger_transport.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<?xml version="1.0" encoding="utf-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:framework="http://symfony.com/schema/dic/symfony"
xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd
http://symfony.com/schema/dic/symfony http://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

<framework:config>
<framework:messenger>
<framework:serializer format="csv">
<framework:context>
<framework:enable_max_depth>true</framework:enable_max_depth>
</framework:context>
</framework:serializer>
</framework:messenger>
</framework:config>
</container>
15 changes: 15 additions & 0 deletions ...meworkBundle/Tests/DependencyInjection/Fixtures/xml/messenger_transport_no_serializer.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?xml version="1.0" encoding="utf-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:framework="http://symfony.com/schema/dic/symfony"
xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd
http://symfony.com/schema/dic/symfony http://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

<framework:config>
<framework:serializer enabled="false" />
<framework:messenger>
<framework:serializer enabled="true" />
<framework:adapter name="default" dsn="amqp://localhost/%2f/messages" />
</framework:messenger>
</framework:config>
</container>
1 change: 1 addition & 0 deletions ...mfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/messenger_adapter.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
framework:
serializer: true
messenger:
adapters:
default: 'amqp://localhost/%2f/messages'
Expand Down
6 changes: 6 additions & 0 deletions ...ony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/messenger_transport.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
framework:
messenger:
serializer:
format: csv
context:
enable_max_depth: true
8 changes: 8 additions & 0 deletions ...meworkBundle/Tests/DependencyInjection/Fixtures/yml/messenger_transport_no_serializer.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
framework:
serializer:
enabled: false
messenger:
serializer:
enabled: true
adapters:
default: 'amqp://localhost/%2f/messages'
21 changes: 21 additions & 0 deletions src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -569,6 +569,27 @@ public function testMessengerAdapter()
$this->assertSame(array('queue_name' => 'Queue'), $receiverArguments[1]);
}

/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\LogicException
* @expectedExceptionMessage Using the default encoder/decoder, Symfony Messenger requires the Serializer. Enable it or install it by running "composer require symfony/serializer-pack".
*/
public function testMessengerTransportConfigurationWithoutSerializer()
{
$this->createContainerFromFile('messenger_transport_no_serializer');
}

public function testMessengerTransportConfiguration()
{
$container = $this->createContainerFromFile('messenger_transport');

$this->assertSame('messenger.transport.serializer', (string) $container->getAlias('messenger.transport.encoder'));
$this->assertSame('messenger.transport.serializer', (string) $container->getAlias('messenger.transport.decoder'));

$serializerTransportDefinition = $container->getDefinition('messenger.transport.serializer');
$this->assertSame('csv', $serializerTransportDefinition->getArgument(1));
$this->assertSame(array('enable_max_depth' => true), $serializerTransportDefinition->getArgument(2));
}

public function testTranslator()
{
$container = $this->createContainerFromFile('full');
Expand Down
6 changes: 0 additions & 6 deletions src/Symfony/Component/Messenger/DependencyInjection/MessengerPass.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,6 @@ public function process(ContainerBuilder $container)
$container->removeDefinition('messenger.middleware.debug.logging');
}

if (!$container->has('serializer')) {
$container->removeDefinition('messenger.transport.serialize_message_with_type_in_headers');
$container->removeAlias('messenger.transport.default_encoder');
$container->removeAlias('messenger.transport.default_decoder');
}

$this->registerReceivers($container);
$this->registerSenders($container);
$this->registerHandlers($container);
Expand Down
17 changes: 17 additions & 0 deletions src/Symfony/Component/Messenger/Tests/Transport/Serialization/SerializerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,21 @@ public function testEncodedIsHavingTheBodyAndTypeHeader()
$this->assertArrayHasKey('type', $encoded['headers']);
$this->assertEquals(DummyMessage::class, $encoded['headers']['type']);
}

public function testUsesTheCustomFormatAndContext()
{
$message = new DummyMessage('Foo');

$serializer = $this->getMockBuilder(SerializerComponent\SerializerInterface::class)->getMock();
$serializer->expects($this->once())->method('serialize')->with($message, 'csv', array('foo' => 'bar'))->willReturn('Yay');
$serializer->expects($this->once())->method('deserialize')->with('Yay', DummyMessage::class, 'csv', array('foo' => 'bar'))->willReturn($message);

$encoder = new Serializer($serializer, 'csv', array('foo' => 'bar'));

$encoded = $encoder->encode($message);
$decoded = $encoder->decode($encoded);

$this->assertSame('Yay', $encoded['body']);
$this->assertSame($message, $decoded);
}
}
8 changes: 5 additions & 3 deletions src/Symfony/Component/Messenger/Transport/Serialization/Serializer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,13 @@ class Serializer implements DecoderInterface, EncoderInterface
{
private $serializer;
private $format;
private $context;

public function __construct(SerializerInterface $serializer, string $format = 'json')
public function __construct(SerializerInterface $serializer, string $format = 'json', array $context = array())
{
$this->serializer = $serializer;
$this->format = $format;
$this->context = $context;
}

/**
Expand All @@ -40,7 +42,7 @@ public function decode(array $encodedMessage)
throw new \InvalidArgumentException('Encoded message does not have a `type` header.');
}

return $this->serializer->deserialize($encodedMessage['body'], $encodedMessage['headers']['type'], $this->format);
return $this->serializer->deserialize($encodedMessage['body'], $encodedMessage['headers']['type'], $this->format, $this->context);
}

/**
Expand All @@ -49,7 +51,7 @@ public function decode(array $encodedMessage)
public function encode($message): array
{
return array(
'body' => $this->serializer->serialize($message, $this->format),
'body' => $this->serializer->serialize($message, $this->format, $this->context),
'headers' => array('type' => \get_class($message)),
);
}
Expand Down