[Messenger] Update the messenger documentation #9727

sroze · 2018-05-03T14:06:55Z

Fixes [Messenger] Added a middleware that validates messages #9641 with the middleware configuration.
Fixes [Messenger][WCM] Document how to register multiple buses using the framework #9617 with the multiple bus configuration.
Change adapters to transports (waiting merge: [Messenger] Rename Adapters to Transports symfony#27129)
middlewares config entry is renamed middleware (Rename middlewares to middleware symfony#27177)
in the config, message buses names are the full service id you'll use ([FrameworkBundle][Messenger] Remove convention-based service id generation for buses symfony#27162)
Add TransportInterface as first class citizen sender+receiver ([Messenger] Add TransportInterface as first class citizen sender+receiver symfony#27164)

yceruto · 2018-05-03T14:39:25Z

This is enough to allow you to route your message to the amqp.

What about to add a note block before that about install/enable the Serializer component, to make AMQP transport available?

ogizanagi · 2018-05-07T14:27:22Z

Some more entries to add to the list :)

Now that [Messenger] Support configuring messages when dispatching symfony#26945 is merged, examples should be updated to reflect the new Envelope usage (SenderInterface::send(Envelope $envelope) and receivers's handler (function (?Envelope $envelope) instead of function ($message)).
We can mention the EnvelopeAwareInterface, how to write items and how to benefit from it in custom middlewares (+ mention existing items)
middlewares config entry is renamed middleware (Rename middlewares to middleware symfony#27177)
in the config, message buses names are the full service id you'll use ([FrameworkBundle][Messenger] Remove convention-based service id generation for buses symfony#27162)

sroze · 2018-05-08T15:58:24Z

messenger.rst

+
+            # Create buses
+            buses:
+                commands: ~


Should be the full service name (and remove the note bellow)

sroze · 2018-05-08T15:58:59Z

messenger.rst

+
+    use Symfony\Component\Messenger\AbstractMessageBusDecorator;
+
+    final class CommandBus extends AbstractMessageBusDecorator


Recommend binding the message bus variable name instead

sroze · 2018-05-08T20:00:22Z

Now that symfony/symfony#26945 is merged, examples should be updated to reflect the new Envelope usage (SenderInterface::send(Envelope $envelope) and receivers's handler (function (?Envelope $envelope) instead of function ($message)).
We can mention the EnvelopeAwareInterface, how to write items and how to benefit from it in custom middlewares (+ mention existing items)

@ogizanagi could you send a PR for that? Has it's not been merged yet, I'd prefer to move it out of the scope of this PR.

ogizanagi · 2018-05-08T20:12:35Z

Sure I'll do once this one is merged.

sroze · 2018-05-08T20:20:40Z

@javiereguiluz @weaverryan could you have a look at this one? 🙏

ogizanagi · 2018-05-08T20:19:30Z

messenger.rst

+            buses:
+                messenger.bus.default:
+                    middleware:
+                        # Works with the FQCN if the class discovery is enabled


Or if you just name your service after the FQCN manually. No need to mention this IMHO. It's still a service id. ^^

I removed the use of the .-based service actually.

ogizanagi · 2018-05-08T20:21:08Z

messenger.rst

+                        # Or with some service name
+                        - app.middleware.yours
+
+Note that if the service is abstract, then a child service will be created per bus.


then a different instance of service will be created per bus.? (more concrete for the user I think)

yceruto · 2018-05-08T21:06:06Z

messenger.rst

@@ -107,11 +107,20 @@ configure the following services for you:
 1. A ``messenger.sender.amqp`` sender to be used when routing messages.
 2. A ``messenger.receiver.amqp`` receiver to be used when consuming messages.

+.. note::
+
+    In order to use Symfony's built-in AMQP adapter, you will need the Serializer


AMQP transport?

yceruto · 2018-05-08T21:07:26Z

messenger.rst

+                messenger.bus.default:
+                    middleware:
+                        - "App\\Middleware\\MyMiddleware"
+                        - "App\\Middleware\\AnotherMiddleware"


single quote and single backslash to be concistent?

…onfiguration

weaverryan · 2018-05-09T14:07:58Z

Thank you @sroze!

This PR was submitted for the master branch but it was squashed and merged into the 4.1 branch instead (closes #9727). Discussion ---------- [Messenger] Update the messenger documentation - [x] Fixes #9641 with the middleware configuration. - [x] Fixes #9617 with the multiple bus configuration. - [x] Change adapters to transports (waiting merge: symfony/symfony#27129) - [x] middlewares config entry is renamed middleware (symfony/symfony#27177) - [x] in the config, message buses names are the full service id you'll use (symfony/symfony#27162) - [x] Add TransportInterface as first class citizen sender+receiver (symfony/symfony#27164) Commits ------- c3c3528 Few updates following review 64bfd75 Change wording and don't use `.`-based services so it's just clearer e1f3b5a Fix the formating of the method name 9b7b85f Update the example of using multiple buses to use DI's `bind`s c76b2c2 Uses the full service name when configuring the buses from the YAML configuration 2409798 Middleware does not have a plural a20286d Add a note about the symfony serializer pack 10f46eb Introduce the `TransportInterface` ef70bc0 Add a documentation about the middlewares 3ff8cfe Add multiple buses configuration and type-hint example a4bc592 Rename the adapters to transport

carsonbot added the Status: Needs Review label May 3, 2018

sroze mentioned this pull request May 3, 2018

[Messenger] Allow to typehint multiple buses symfony/symfony#27054

Closed

sroze commented May 8, 2018

View reviewed changes

ogizanagi reviewed May 8, 2018

View reviewed changes

sroze force-pushed the revamp-the-messenger-documentation branch from 41bebe5 to 3ffc785 Compare May 8, 2018 20:29

sroze changed the title ~~[Messenger] Revamp the messenger documentation~~ [Messenger] Update the messenger documentation May 8, 2018

yceruto reviewed May 8, 2018

View reviewed changes

sroze added 11 commits May 9, 2018 10:07

Rename the adapters to transport

a4bc592

Add multiple buses configuration and type-hint example

3ff8cfe

Add a documentation about the middlewares

ef70bc0

Introduce the TransportInterface

10f46eb

Add a note about the symfony serializer pack

a20286d

Middleware does not have a plural

2409798

Uses the full service name when configuring the buses from the YAML c…

c76b2c2

…onfiguration

Update the example of using multiple buses to use DI's binds

9b7b85f

Fix the formating of the method name

e1f3b5a

Change wording and don't use .-based services so it's just clearer

64bfd75

Few updates following review

c3c3528

weaverryan changed the base branch from master to 4.1 May 9, 2018 14:07

weaverryan force-pushed the revamp-the-messenger-documentation branch from bfa508b to c3c3528 Compare May 9, 2018 14:07

weaverryan merged commit c3c3528 into symfony:4.1 May 9, 2018

sroze deleted the revamp-the-messenger-documentation branch May 9, 2018 14:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Messenger] Update the messenger documentation #9727

[Messenger] Update the messenger documentation #9727

sroze commented May 3, 2018 •

edited

Loading

yceruto commented May 3, 2018

ogizanagi commented May 7, 2018 •

edited

Loading

sroze May 8, 2018

sroze May 8, 2018

sroze commented May 8, 2018

ogizanagi commented May 8, 2018

sroze commented May 8, 2018

ogizanagi May 8, 2018

sroze May 8, 2018

ogizanagi May 8, 2018

yceruto May 8, 2018

yceruto May 8, 2018 •

edited

Loading

weaverryan commented May 9, 2018


		use Symfony\Component\Messenger\AbstractMessageBusDecorator;

		final class CommandBus extends AbstractMessageBusDecorator

[Messenger] Update the messenger documentation #9727

[Messenger] Update the messenger documentation #9727

Conversation

sroze commented May 3, 2018 • edited Loading

yceruto commented May 3, 2018

ogizanagi commented May 7, 2018 • edited Loading

sroze May 8, 2018

Choose a reason for hiding this comment

sroze May 8, 2018

Choose a reason for hiding this comment

sroze commented May 8, 2018

ogizanagi commented May 8, 2018

sroze commented May 8, 2018

ogizanagi May 8, 2018

Choose a reason for hiding this comment

sroze May 8, 2018

Choose a reason for hiding this comment

ogizanagi May 8, 2018

Choose a reason for hiding this comment

yceruto May 8, 2018

Choose a reason for hiding this comment

yceruto May 8, 2018 • edited Loading

Choose a reason for hiding this comment

weaverryan commented May 9, 2018

sroze commented May 3, 2018 •

edited

Loading

ogizanagi commented May 7, 2018 •

edited

Loading

yceruto May 8, 2018 •

edited

Loading