symfony/symfony-docsPublic

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

[Messenger] Show how to configure a doctrine transaction middleware#10013

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

Closed

Nyholm wants to merge3 commits intosymfony:masterfromNyholm:doctrine-transaction

Closed

[Messenger] Show how to configure a doctrine transaction middleware#10013

Nyholm wants to merge3 commits intosymfony:masterfromNyholm:doctrine-transaction

Conversation

Copy link

Member

Nyholm commentedJul 4, 2018•
edited
Loading

This willfix#9651

This is a first draft. Please add a quick review and after that I'll add code blocks for PHP and XML.

I use the title "Working with doctrine" because I believe we should mention the DispatchAfterCurrentBusMiddleware on this page as well. (Code PR,Doc PR) and the "recording" from entities (Code PR)

carsonbot added Status: Needs Review Messenger labels

Jul 4, 2018

Nyholm mentioned this pull request

Jul 4, 2018

[Messenger] Added documentation about DispatchAfterCurrentBusMiddleware#10015

Closed

javiereguiluz changed the title~~[Messenger] Show ow to configure a doctrine transaction middleware~~[Messenger] Show how to configure a doctrine transaction middleware

Jul 4, 2018

Copy link

Contributor

ogizanagi commentedJul 4, 2018

It looks great!...but we already mentioned the transaction middleware briefly inhttps://symfony.com/doc/current/messenger.html#using-middleware-factories where we explain middleware factories.
But having this dedicated docs really makes sense. However end-users should not have to deal with the factories themselves for this middleware as everything should be wired by the DoctrineBundle. So it could be actually simplified butdoctrine/DoctrineBundle#817 isn't merged yet :'(

Users are supposed to be able to just use:

framework:messenger:buses:command_bus:middleware:# Using default entity manager                            -doctrine_transaction_middleware# Using "custom" entity manager                            -doctrine_transaction_middleware:['custom']

Copy link

MemberAuthor

Nyholm commentedJul 5, 2018

Oh, I've missed that entire page of documentation!

Okey, Lets wait fordoctrine/DoctrineBundle#817

Copy link

MemberAuthor

Nyholm commentedSep 13, 2018

Now when the doctrine PR is merge, I will update these docs to the new config syntax, right?

ogizanagi reviewed

Sep 18, 2018

View reviewed changes

messenger/working-with-doctrine.rst OutdatedShow resolvedHide resolved

nicolas-grekas reviewed

Nov 10, 2018

View reviewed changes

messenger/working-with-doctrine.rst OutdatedShow resolvedHide resolved

Nyholm added2 commits

April 8, 2019 20:56

Show ow to configure a doctrine transaction middleware

c497ed2

Adding PHP and XML configuration

cc05ed2

Nyholm force-pushed thedoctrine-transaction branch from43169a3 tocc05ed2Compare

April 8, 2019 19:05

Copy link

MemberAuthor

Nyholm commentedApr 8, 2019

This PR is updated.
Ping@sroze

carsonbot removed the Status: Needs Review label

Apr 22, 2019

sroze approved these changes

Apr 22, 2019

View reviewed changes

Copy link

Contributor

sroze left a comment

Choose a reason for hiding this comment

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

Looks good to me (except these two changes) 👍

messenger/working-with-doctrine.rst OutdatedShow resolvedHide resolved

carsonbot added the Status: Reviewed label

Apr 22, 2019

typos

5b0d719

Copy link

MemberAuthor

Nyholm commentedApr 28, 2019

Thank you for the review. I've updated the RP

maxhelias approved these changes

May 14, 2019

View reviewed changes

weaverryan reviewed

May 24, 2019

View reviewed changes

Copy link

Member

weaverryan left a comment

Choose a reason for hiding this comment

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

My instinct is that this should be included in the main doc, but we can figure that out later. I added one real question.

Also, correct me if I'm wrong, isn't this only relevant if you have multiple handlers that are doing flushes? So the transaction would roll back all of them (instead of some working and others not working)? I want it to be clear when a user should definitely use this versus when it won't make any difference for them.

messenger/working-with-doctrine.rst

		buses:
		messenger.bus.command:
		middleware:
		- validation

Copy link

Member

weaverryanMay 24, 2019

Choose a reason for hiding this comment

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

are we purposely also including validation?

Copy link

Contributor

ogizanagiMay 24, 2019

Choose a reason for hiding this comment

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

That's a bit unrelated with the content of this doc indeed, but a good practice, as content of the command in a CQRS application are most of the input by users (on contrary of events which are mostly crafted by developers from already validated data).

Copy link

Contributor

ogizanagi commentedMay 24, 2019

@weaverryan

Also, correct me if I'm wrong, isn't this only relevant if you have multiple handlers that are doing flushes?

No it's relevant even with a single command bus and single handler for the message, so you don't have to deal with flushing changes yourself, nor you can commit changes partially to the database if a command handler failed at some point, rollbacking any change.

Copy link

Contributor

OskarStark commentedAug 1, 2019

Friendly ping@Nyholm 🎶 👋

Could you please find some time and finish this PR? Thank you 🙏

Copy link

Member

javiereguiluz commentedSep 24, 2019

I'm closing this old pull request because we already mention thedoctrine_transaction in the main Messenger article (seehttps://symfony.com/doc/current/messenger.html#middleware-for-doctrine) so this is probably no longer needed. Thanks.