Event bus #4

mvrhov · 2017-12-26T14:06:56Z

This adds the Event bus along with the Message bus.

The example in current documentation, with email sending is bad(TM) so we need to find a better one.
Imagine that we have an middleware that wraps command handling into an transaction. This means that the commit will happen after the command has been handled, and if there is something wrong during the commit, we could have easily already sent the email however the user wasn't persisted.
What should instead happen 8000 is that message handler that created an user should instead record an event/new message at the end of the __invoke function.
Then there should be middleware that's executed last which gets the recorded events and publishes them to another bus named Event bus.

example bellow:

namespace Component\User\Model\Event;

use Component\User\Model\User;

class UserRegistered
{
    /** @var User */
    private $user;

    public function __construct(User $user)
    {
        $this->user = $user;
    }

    public function user(): User
    {
        return $this->user;
    }
}

namespace Component\User\Model\Handler;

use Component\Security\PasswordEncoder\PasswordEncoderInterface;
use Component\User\Model\Event\UserRegistered;
use Component\User\Model\User;
use Component\User\Model\UserRepository;
use Symfony\Component\Message\Recorder\RecordsMessages;

class RegisterUser
{
    /** @var UserRepository */
    private $repository;
    /** @var RecordsMessages */
    private $eventRecorder;
    /** @var PasswordEncoderInterface */
    private $encoder;

    public function __construct(UserRepository $repository, RecordsMessages $eventRecorder, PasswordEncoderInterface $encoder) {
        $this->repository = $repository;
        $this->eventRecorder = $eventRecorder;
        $this->encoder = $encoder;
    }

    public function __invoke(\Component\User\Model\Command\RegisterUser $cmd)
    {
        $user = User::registerWith($cmd->getId(), $cmd->getEmail());

        $user->changePassword($this->encoder->encodePassword($cmd->getPassword()));
        $user->enable();
        if ($cmd->isSuperAdmin()) {
            $user->promoteToSuperAdmin();
        }
        $user->changeFirstName($cmd->getFirstName());

        $this->repository->save($user);

        $event = new UserRegistered($user);
        $this->eventRecorder->record($event);
    }
}

namespace Component\User\Infra\EventHandler;

use Component\User\Model\Event\UserRegistered;

class RegisteredUserEmailSender
{
    private $emailSender;
    private $mailer;
    
    public function __construct(\Swift_Mailer $mailer, string $emailSender)
    {
        $this->mailer = $mailer;
        $this->emailSender = $emailSender;
    }
    
    public function __invoke(UserRegistered $user)
    {        
        $this->mailer->send(
            (new \Swift_Message('Welcome to the site'))
                ->setTo($user->user()->email())
                ->setSender($this->emailSender)
                ->setBody(
                    '<h1>Hello '.$user->user()->firstName().'</h1><p>Welcome to the site</p>',
                    'text/html'
                )
        );
    }
}

the recorder is taken directly from SimpleBus, that's the reason behind the author tag. I hadn't done any renaming as there will probably be a lot of discussion here.
@sroze will you merge this so the discussion happens in the main Symfony repo?

…small comments on the PR.

…an find automatically the Message handler is supposed to handle

…llers

…` channel

sroze · 2017-12-27T10:28:01Z

That's a very interesting question here.

As of now, I don't think that we need such "event bus" in the "default package". All you need - as a user - is to define multiple buses if you'd like to (maybe we can use some configuration in the FrameworkBundle). Therefore, I'll mention this PR in the Symfony PR :)

mvrhov · 2017-12-27T10:36:46Z

The problem is that just multiple buses is not enough. You really need to store the events somewhere and dispatch them after the current bus is done with them. You don't know what other middlewares will do.

sroze · 2017-12-27T10:39:35Z

Oh yeah, and the "store middleware" you've added :)

mvrhov · 2017-12-27T10:42:13Z

Deleted. Will move this into the symfony thread

This PR was merged into the 3.3 branch. Discussion ---------- Restore RoleInterface import | Q | A | ------------- | --- | Branch? | 3.3 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no  | Tests pass? | yes | License | MIT The import is use on PHPDoc but was accidentally removed. Maybe because PHPStorm does not match with the import when you use parenthesis. Not really a bug as it is concerning only PHPDoc, but it make some analysis tools like PHPStan yelling: ``` ------ ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Line src/AppBundle/Security/Authentication/ApiKeyAuthenticator.php ------ ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 64 Parameter #4 $roles of class Symfony\Component\Security\Core\Authentication\Token\PreAuthenticatedToken constructor expects array<string|Symfony\Component\Security\Core\Authentication\Token\RoleInterface>, array<string|Symfony\Component\Security\Core\Role\Role> given. ------ ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ------ ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Line tests/AppBundle/Controller/WebTestCase.php ------ ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 59 Parameter #4 $roles of class Symfony\Component\Security\Core\Authentication\Token\PreAuthenticatedToken constructor expects array<string|Symfony\Component\Security\Core\Authentication\Token\RoleInterface>, array<string|Symfony\Component\Security\Core\Role\Role> given. ------ ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ``` Commits ------- 8ecfeb1 Restore RoleInterface import

sroze and others added 12 commits December 24, 2017 11:41

Create the Message component

f79533e

Rename consumers to receivers and producers to senders. And a lot of …

099b423

…small comments on the PR.

Add return to dispatch method and no need for handles parameter. We c…

29a15e5

…an find automatically the Message handler is supposed to handle

Rename Producer -> Sender in the FrameworkBundle as well

dd0d640

Do not pass anything if the message_bus service do not exists

ac80529

service class typo fix.

923324b

Various valid changes based on reviews

af34b5c

Mention tags with the README

8c3c12e

The message bus is accessible via its interface and within the contro…

697b722

…llers

Logging middleware containers the message class and uses the `message…

383f5aa

…` channel

Add messages in the profiler

7549ea5

Message's collector is within the same XML file, not in collectors

ee806ad

sroze mentioned this pull request Dec 27, 2017

Handlers should be lazy loaded #3

Closed

Handlers should be lazy loaded

3847968

sroze and others added 3 commits December 27, 2017 11:48

Fix multiple typos from Javier's review

7e1d7b5

Rename MessageHandlerCollection to ChainHandler

93fe7cf

Added EventBus

36a170a

mvrhov mentioned this pull request Dec 27, 2017

[Messenger] Add a new Messenger component symfony/symfony#24411

Closed

sroze force-pushed the add-message-component branch from 1c81979 to 56d5da4 Compare January 26, 2018 13:37

sroze force-pushed the add-message-component branch 3 times, most recently from 3967eda to e63c5b9 Compare March 19, 2018 17:54

sroze force-pushed the add-message-component branch from 86a91ec to c091d66 Compare March 21, 2018 23:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Event bus #4

Event bus #4

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Event bus #4

Are you sure you want to change the base?

Event bus #4

Uh oh!

Conversation

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!