symfony/symfony-docsPublic

NotificationsYou must be signed in to change notification settings
Fork5.3k
Star2.3k

[Messenger] Update the messenger documentation#9727

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.

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

Already on GitHub?Sign in to your account

Jump to bottom

Merged

weaverryan merged 11 commits intosymfony:4.1fromsroze:revamp-the-messenger-documentation

May 9, 2018

Merged

[Messenger] Update the messenger documentation#9727

weaverryan merged 11 commits intosymfony:4.1fromsroze:revamp-the-messenger-documentation

May 9, 2018

Conversation

Copy link

Contributor

sroze commentedMay 3, 2018•
edited
Loading

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)

carsonbot added the Status: Needs Review label

May 3, 2018

sroze mentioned this pull request

May 3, 2018

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

Closed

Copy link

Member

yceruto commentedMay 3, 2018

This is enough to allow you to route your message to theamqp.

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

Copy link

Contributor

ogizanagi commentedMay 7, 2018•
edited
Loading

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 newEnvelope usage (SenderInterface::send(Envelope $envelope) and receivers's handler (function (?Envelope $envelope) instead offunction ($message)).
We can mention theEnvelopeAwareInterface, how to write items and how to benefit from it in custom middlewares (+ mention existing items)
middlewares config entry is renamedmiddleware (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 commented

May 8, 2018

View reviewed changes

messenger.rst Outdated


		# Create buses
		buses:
		commands:~

Copy link

ContributorAuthor

srozeMay 8, 2018

Choose a reason for hiding this comment

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

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

messenger.rst Outdated


		use Symfony\Component\Messenger\AbstractMessageBusDecorator;

		final class CommandBus extends AbstractMessageBusDecorator

Copy link

ContributorAuthor

srozeMay 8, 2018

Choose a reason for hiding this comment

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

Recommend binding the message bus variable name instead

Copy link

ContributorAuthor

sroze commentedMay 8, 2018

Now thatsymfony/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.

Copy link

Contributor

ogizanagi commentedMay 8, 2018

Sure I'll do once this one is merged.

Copy link

ContributorAuthor

sroze commentedMay 8, 2018

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

ogizanagi reviewed

May 8, 2018

View reviewed changes

messenger.rst Outdated

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

Copy link

Contributor

ogizanagiMay 8, 2018

Choose a reason for hiding this comment

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

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

Copy link

ContributorAuthor

srozeMay 8, 2018

Choose a reason for hiding this comment

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

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

messenger.rst Outdated

		# Or with some service name
		-app.middleware.yours

		Note that if the service is abstract, then a child service will be created per bus.

Copy link

Contributor

ogizanagiMay 8, 2018

Choose a reason for hiding this comment

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

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

sroze force-pushed therevamp-the-messenger-documentation branch from41bebe5 to3ffc785Compare

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

messenger.rst Outdated


		..note::

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

Copy link

Member

ycerutoMay 8, 2018

Choose a reason for hiding this comment

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

AMQP transport?

yceruto reviewed

May 8, 2018

View reviewed changes

messenger.rst Outdated

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

Copy link

Member

ycerutoMay 8, 2018•
edited
Loading

Choose a reason for hiding this comment

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

single quote and single backslash to be concistent?

sroze added11 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 theTransportInterface

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'sbinds

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 frommaster to4.1

May 9, 2018 14:07

weaverryan force-pushed therevamp-the-messenger-documentation branch frombfa508b toc3c3528Compare

May 9, 2018 14:07

Copy link

Member

weaverryan commentedMay 9, 2018

Thank you@sroze!

weaverryan merged commitc3c3528 intosymfony:4.1

May 9, 2018

weaverryan added a commit that referenced this pull request

May 9, 2018

feature#9727[Messenger] Update the messenger documentation (sroze)

2099d48

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 review64bfd75 Change wording and don't use `.`-based services so it's just clearere1f3b5a Fix the formating of the method name9b7b85f Update the example of using multiple buses to use DI's `bind`sc76b2c2 Uses the full service name when configuring the buses from the YAML configuration2409798 Middleware does not have a plurala20286d Add a note about the symfony serializer pack10f46eb Introduce the `TransportInterface`ef70bc0 Add a documentation about the middlewares3ff8cfe Add multiple buses configuration and type-hint examplea4bc592 Rename the adapters to transport

sroze deleted the revamp-the-messenger-documentation branch

May 9, 2018 14:10

Labels

Status: Needs Review

Movatterモバイル変換

Uh oh!

[Messenger] Update the messenger documentation#9727

[Messenger] Update the messenger documentation#9727

Uh oh!

Conversation

sroze commentedMay 3, 2018• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Uh oh!

yceruto commentedMay 3, 2018

Uh oh!

ogizanagi commentedMay 7, 2018• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Uh oh!

srozeMay 8, 2018

Choose a reason for hiding this comment

Uh oh!

srozeMay 8, 2018

Choose a reason for hiding this comment

Uh oh!

sroze commentedMay 8, 2018

Uh oh!

ogizanagi commentedMay 8, 2018

Uh oh!

sroze commentedMay 8, 2018

Uh oh!

ogizanagiMay 8, 2018

Choose a reason for hiding this comment

Uh oh!

srozeMay 8, 2018

Choose a reason for hiding this comment

Uh oh!

ogizanagiMay 8, 2018

Choose a reason for hiding this comment

Uh oh!

ycerutoMay 8, 2018

Choose a reason for hiding this comment

Uh oh!

ycerutoMay 8, 2018• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

weaverryan commentedMay 9, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

sroze commentedMay 3, 2018•
edited
Loading

ogizanagi commentedMay 7, 2018•
edited
Loading

ycerutoMay 8, 2018•
edited
Loading