step 10: introduce domain events

Author: Antoine Lelaisant

config/packages/messenger.yaml

@@ -6,7 +6,16 @@ framework:
 
     buses:
       command.bus:
+        default_middleware: true
         middleware:
+          - Infrastructure\Symfony\Messenger\Middleware\DomainEventDispatcher
+          - dispatch_after_current_bus
           - doctrine_transaction
 
       query.bus: ~
+
+      event.bus:
+        default_middleware: allow_no_handlers
+        middleware:
+          - dispatch_after_current_bus
+          - doctrine_transaction

config/services.yaml

@@ -12,3 +12,5 @@ services:
 
     Application\:
         resource: '../src/Application/'
+        exclude:
+          - '../src/Application/DomainEventsHandler/'

config/services/domain_events.yaml

@@ -0,0 +1,12 @@
+---
+services:
+  _defaults:
+    autowire: true
+    public: false
+
+  Domain\EventsRegisterer: ~
+
+  Application\DomainEventsHandler\:
+    resource: '%kernel.project_dir%/src/Application/DomainEventsHandler/**.php'
+    tags:
+      - { name: messenger.message_handler, bus: event.bus }

config/services/messenger.yaml

@@ -5,6 +5,9 @@ services:
     autoconfigure: true
     public: false
 
+  Infrastructure\Symfony\Messenger\Middleware\:
+    resource: '%kernel.project_dir%/src/Infrastructure/Symfony/Messenger/Middleware/**.php'
+
   Infrastructure\Symfony\Messenger\CommandBus:
     $messageBus: '@command.bus'
 
@@ -16,3 +19,9 @@ services:
 
   Application\MessageBus\QueryBus:
     alias: Infrastructure\Symfony\Messenger\QueryBus
+
+  Infrastructure\Symfony\Messenger\EventBus:
+    $messageBus: '@event.bus'
+
+  Application\MessageBus\EventBus:
+    alias: Infrastructure\Symfony\Messenger\EventBus

src/Application/Controller/DinosaursController.php

@@ -5,7 +5,9 @@
 use Application\Form\Type\DinosaurType;
 use Application\Form\Type\SearchType;
 use Application\MessageBus\CommandBus;
+use Application\MessageBus\EventBus;
 use Application\MessageBus\QueryBus;
+use Domain\Event\DinosaurIsBorn;
 use Domain\Exception\DinosaurNotFoundException;
 use Domain\Query\GetSingleDinosaur;
 use Domain\Query\GetAllDinosaurs;
@@ -22,7 +24,8 @@ final class DinosaursController extends AbstractController
 {
     public function __construct(
         private CommandBus $commandBus,
-        private QueryBus $queryBus
+        private QueryBus $queryBus,
+        private EventBus $eventBus
     ) {
     }
 
@@ -55,12 +58,10 @@ public function list(Request $request): Response
     )]
     public function single(string $id): Response
     {
-        $dinosaur = $this
-            ->dinosaursCollection
-            ->find($id);
-
-        if (false === $dinosaur) {
-            throw $this->createNotFoundException('The dinosaur you are looking for does not exists.');
+        try {
+            $dinosaur = $this->queryBus->dispatch(new GetSingleDinosaur\Query($id));
+        } catch (DinosaurNotFoundException $e) {
+            throw $this->createNotFoundException();
         }
 
         return $this->render('dinosaur.html.twig', [

src/Application/DomainEventsHandler/LogWhenDinosaurDied.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Application\DomainEventsHandler;
+
+use Domain\Event\DinosaurDied;
+use Domain\Event\EventInterface;
+use Psr\Log\LoggerInterface;
+use Symfony\Component\Messenger\Handler\MessageSubscriberInterface;
+
+class LogWhenDinosaurDied implements MessageSubscriberInterface
+{
+    public function __construct(
+        private LoggerInterface $logger
+    ) {
+    }
+
+    public function __invoke(EventInterface $event): void
+    {
+        if (!$event instanceof DinosaurDied) {
+            return;
+        }
+
+        $this->logger->info(sprintf(
+            'Dinosaur %s died',
+            $event->getDinosaurName()
+        ));
+    }
+
+    public static function getHandledMessages(): iterable
+    {
+        yield DinosaurDied::class;
+    }
+}

src/Application/DomainEventsHandler/LogWhenDinosaurIsBorn.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Application\DomainEventsHandler;
+
+use Domain\Collection\DinosaursCollection;
+use Domain\Event\DinosaurIsBorn;
+use Domain\Event\EventInterface;
+use Domain\Exception\DinosaurNotFoundException;
+use Domain\Model\Dinosaur;
+use Psr\Log\LoggerInterface;
+use Symfony\Component\Messenger\Handler\MessageSubscriberInterface;
+
+class LogWhenDinosaurIsBorn implements MessageSubscriberInterface
+{
+    public function __construct(
+        private DinosaursCollection $dinosaursCollection,
+        private LoggerInterface $logger
+    ) {
+    }
+
+    public function __invoke(EventInterface $event): void
+    {
+        $dinosaurId = $event->getAggregateRootId();
+
+        $dinosaur = $this->dinosaursCollection->find($dinosaurId);
+
+        if (!$dinosaur instanceof Dinosaur) {
+            throw new DinosaurNotFoundException($dinosaurId);
+        }
+
+        $this->logger->info(sprintf(
+            'Dinosaur %s was born',
+            $dinosaur->getName()
+        ));
+    }
+
+    public static function getHandledMessages(): iterable
+    {
+        yield DinosaurIsBorn::class;
+    }
+}

src/Application/MessageBus/EventBus.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Application\MessageBus;
+
+interface EventBus
+{
+    public function dispatch(object $event): void;
+}

src/Domain/Event/DinosaurDied.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Domain\Event;
+
+use Domain\Model\Dinosaur;
+
+final class DinosaurDied implements EventInterface
+{
+    private string $dinosaurName;
+
+    public function __construct(private Dinosaur $dinosaur)
+    {
+        $this->dinosaurName = $dinosaur->getName();
+    }
+
+    public function getAggregateRootId(): string
+    {
+        return (string) $this->dinosaur->getId();
+    }
+
+    public function getDinosaurName(): string
+    {
+        return $this->dinosaurName;
+    }
+}

src/Domain/Event/DinosaurIsBorn.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Domain\Event;
+
+use Domain\Model\Dinosaur;
+
+class DinosaurIsBorn implements EventInterface
+{
+    public function __construct(
+        private Dinosaur $dinosaur
+    ) {
+    }
+
+    public function getAggregateRootId(): string
+    {
+        return (string) $this->dinosaur->getId();
+    }
+}