[Messenger] Allow to configure the transport #26941

sroze · 2018-04-16T08:43:32Z

Q	A
Branch?	master
Bug fix?	no
New feature?	ish
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#26900, #26908, #26935
License	MIT
Doc PR	ø

We allow users to configure the encoder/decoder used by the built-in adapter(s). This also adds the support of configuring the default's encoder/decoder format and context.

ogizanagi · 2018-04-16T10:39:07Z

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php

@@ -1446,6 +1446,20 @@ private function registerMessengerConfiguration(array $config, ContainerBuilder

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

+        if ($config['transport']['serializer']['enabled']) {


Detail, but could use Extension::isConfigEnabled

ogizanagi · 2018-04-16T10:42:11Z

src/Symfony/Component/Messenger/DependencyInjection/MessengerPass.php

-            $container->removeAlias('messenger.transport.default_decoder');
+        if (!$container->has('serializer') && $container->hasAlias('messenger.transport.encoder')) {
+            if ('messenger.transport.symfony_serializer_encoder' === (string) $container->getAlias('messenger.transport.encoder')) {
+                throw new RuntimeException('Using the default encoder/decoder, Symfony Messenger requires the Serializer. Try running "composer require symfony/serializer-pack".');


\LogicException

That could also happen when the serializer component is simply disabled (but sure, using flex the component is enabled by default when installed).

However, what about throwing directly from the FrameworkExtension? When $this->isConfigEnabled($container, $config['transport']['serializer']) is true and the $this->isConfigEnabled($container, $config['serializer']) is false, we should throw an exception about enabling the component. If trying to enabling it without the component installed, the Fwb ext will already hint for installing the component.

The 'messenger.transport.symfony_serializer_encoder' === (string) $container->getAlias('messenger.transport.encoder') check doesn't look really relevant to me. If the messenger.transport.serializer config is enabled without the Serializer component installed/enabled, it should throw anyway.

However, what about throwing directly from the FrameworkExtension? When $this->isConfigEnabled($container, $config['transport']['serializer']) is true and the $this->isConfigEnabled($container, $config['serializer']) is false, we should throw an exception about enabling the component. If trying to enabling it without the component installed, the Fwb ext will already hint for installing the component.

Very good idea!

ogizanagi · 2018-04-16T10:58:59Z

src/Symfony/Bundle/FrameworkBundle/Resources/config/messenger.xml

        </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" />
+        <service id="messenger.transport.symfony_serializer_encoder" alias="messenger.transport.symfony_serializer" />


Are those aliases really needed? I think messenger.transport.symfony_serializer is fine as default encoder/decoder config value.

Yeah, definitely now that we have the aliases generated by FWB.

sroze · 2018-04-16T12:50:55Z

@ogizanagi changed the PR based on your feedbacks. Looks better 👌

ogizanagi · 2018-04-16T13:17:17Z

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php

    {
        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['transport']['serializer'])) {
+            if (count($config['adapters']) > 0 && !$this->isConfigEnabled($container, $serializerConfig)) {


Is the count($config['adapters']) > 0 required?
To me, as soon as the $config['transport']['serializer'] is enabled without serializer support enabled we should throw anyway. We don't really care if it's used by an adapter or not at this point:
in any case, messenger.transport.serializer will never be automatically enabled, unless using flex and both Serializer and Messenger component are installed (so everything is fine).
If enabled without without the Serializer installed/enabled, it means the developer explicitly enabled messenger.transport.serializer or disabled serializer. 😃

I was actually changing this (see the last commit). Now this makes sense (by have the Symfony Serialized based Transport enabled no matter what). It's important to have the count($config['adapters']) so that it doesn't throw anything if you don't use any adapter (i.e. don't require an encoder/decoder).

nicolas-grekas · 2018-04-16T21:03:08Z

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php

+                                        ->end()
+                                    ->end()
+                                ->end()
+                                ->scalarNode('encoder')->defaultValue('messenger.transport.symfony_serializer')->end()


what about removing the symdony_ here (and in the other places in this PR also)?

I don't see either a benefit nor a downside 🙃

Except that it's about Symfony's internal here so it might make sense to remove symfony_

Removed 👍

nicolas-grekas · 2018-04-16T21:12:41Z

src/Symfony/Bundle/FrameworkBundle/Resources/config/messenger.xml

        </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" />


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

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

sroze · 2018-04-17T06:52:05Z

Though, if we rename "adapters" to "transports" this would clash 🤔. WDYT about removing this .transport configuration layer and just having framework.messenger.encoder, framework.messenger.decoder & framework.messenger.serializer ?

nicolas-grekas · 2018-04-17T07:05:43Z

Yes for less nesting levels

This PR was squashed before being merged into the 4.1-dev branch (closes #26941). Discussion ---------- [Messenger] Allow to configure the transport | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | ish | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #26900, #26908, #26935 | License | MIT | Doc PR | ø We allow users to configure the encoder/decoder used by the built-in adapter(s). This also adds the support of configuring the default's encoder/decoder format and context. Commits ------- 1a3f0bb [Messenger] Allow to configure the transport

r3m4k3 · 2018-10-07T01:36:52Z

Why framework.messenger.serializer is expecting an array instead of a string?

sroze · 2018-10-07T10:10:36Z

@r3m4k3 it does now supports a string directly on framework.messenger.serializer (it will configure framework.messenger.serializer.id)

r3m4k3 · 2018-10-07T10:23:41Z

@sroze Thank you for the answer. But hmm, I got this error: Invalid type for path "framework.messenger.serializer". Expected array, but got string when I set serializer: App\Serializer\CustomSerializer under framework.messenger.

sroze · 2018-10-07T10:26:01Z

"now" is in 4.2, the development branch. So make sure you use it :)

r3m4k3 · 2018-10-07T11:48:10Z

@sroze I have managed to do this, now I use dev branch.
I have installed symfony/* component with all dependencies on version 4.2@dev.

But is there any example of this serializer implementing Encoder and DecoderInterface, which is handling circular references properly?

I'm asking because it's working like it still loads default symfony serializer instead of my custom, setting setCircularReferenceLimit or setCircularReferenceHandler doesn't change anything indeed.

carsonbot added the Status: Needs Review label Apr 16, 2018

sroze mentioned this pull request Apr 16, 2018

[Messenger] Lazy dependency to the Serializer #26908

Closed

sroze force-pushed the configure-messenger-transport branch from 293eb67 to 0c3d0a3 Compare April 16, 2018 08:45

sroze added the Messenger label Apr 16, 2018

ogizanagi reviewed Apr 16, 2018

View reviewed changes

sroze added this to the 4.1 milestone Apr 16, 2018

sroze force-pushed the configure-messenger-transport branch from f8145c4 to 2fd43ab Compare April 16, 2018 12:50

sroze force-pushed the configure-messenger-transport branch 2 times, most recently from 6de67e1 to 97ffc7b Compare April 16, 2018 12:52

ogizanagi approved these changes Apr 16, 2018

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Apr 16, 2018

sroze force-pushed the configure-messenger-transport branch 2 times, most recently from 3c41fb9 to 45cdf4e Compare April 16, 2018 17:42

nicolas-grekas approved these changes Apr 16, 2018

View reviewed changes

nicolas-grekas reviewed Apr 16, 2018

View reviewed changes

nicolas-grekas approved these changes Apr 16, 2018

View reviewed changes

[Messenger] Allow to configure the transport

1a3f0bb

sroze force-pushed the configure-messenger-transport branch from b8e7347 to 1a3f0bb Compare April 17, 2018 16:48

sroze merged commit 1a3f0bb into symfony:master Apr 17, 2018

sroze deleted the configure-messenger-transport branch April 17, 2018 16:49

This was referenced Apr 17, 2018

[Messenger] No way to avoid circular reference exception #26935

Closed

[Messenger] Allow to provide context in the Serializer class #26900

Closed

javiereguiluz mentioned this pull request Apr 22, 2018

[Messenger] Allow to configure the transport symfony/symfony-docs#9662

Closed

sroze mentioned this pull request May 2, 2018

[Messenger] Relax messenger config and fix some bugs #27084

Merged

fabpot mentioned this pull request May 7, 2018

Release v4.1.0-BETA1 #27181

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Messenger] Allow to configure the transport #26941

[Messenger] Allow to configure the transport #26941

sroze commented Apr 16, 2018

ogizanagi Apr 16, 2018

ogizanagi Apr 16, 2018

ogizanagi Apr 16, 2018

sroze Apr 16, 2018

ogizanagi Apr 16, 2018

sroze Apr 16, 2018

sroze commented Apr 16, 2018

ogizanagi Apr 16, 2018

sroze Apr 16, 2018

nicolas-grekas Apr 16, 2018

sroze Apr 16, 2018

sroze Apr 16, 2018

sroze Apr 16, 2018

nicolas-grekas Apr 16, 2018

sroze Apr 16, 2018

sroze commented Apr 17, 2018 •

edited

Loading

nicolas-grekas commented Apr 17, 2018

r3m4k3 commented Oct 7, 2018

sroze commented Oct 7, 2018

r3m4k3 commented Oct 7, 2018 •

edited

Loading

sroze commented Oct 7, 2018

r3m4k3 commented Oct 7, 2018 •

edited

Loading

		@@ -1446,6 +1446,20 @@ private function registerMessengerConfiguration(array $config, ContainerBuilder

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

		if ($config['transport']['serializer']['enabled']) {

[Messenger] Allow to configure the transport #26941

[Messenger] Allow to configure the transport #26941

Conversation

sroze commented Apr 16, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sroze commented Apr 16, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sroze commented Apr 17, 2018 • edited Loading

nicolas-grekas commented Apr 17, 2018

r3m4k3 commented Oct 7, 2018

sroze commented Oct 7, 2018

r3m4k3 commented Oct 7, 2018 • edited Loading

sroze commented Oct 7, 2018

r3m4k3 commented Oct 7, 2018 • edited Loading

sroze commented Apr 17, 2018 •

edited

Loading

r3m4k3 commented Oct 7, 2018 •

edited

Loading

r3m4k3 commented Oct 7, 2018 •

edited

Loading