Split event message from builder (#34)

Split event message from builder

Makefile

@@ -8,7 +8,7 @@ debug:
 
 .PHONY: update-dependencies
 update-dependencies:
-	docker-compose run composer update
+	docker-compose run composer update --ignore-platform-req=ext-sockets
 
 .PHONY: checkstyle
 checkstyle:

README.md

@@ -121,12 +121,14 @@ class EventServiceProvider extends ServiceProvider
 
 ### Custom middlewares
 
-The middlewares should implement the `Softonic\TransactionalEventPublisher\Contracts\EventStoreMiddlewareContract` interface.
+The middlewares should implement the `Softonic\TransactionalEventPublisher\Interfaces\EventStoreMiddlewareInterface` interface.
 Its purpose is to store the domain event provided, so you can implement any storage for domain events.
 
 ### Custom messages
 
-The `transactional-event.message` class must implement `EventMessageContract` and `transactional-event.middleware` class must implement `EventStoreMiddlewareContract`.
+The `transactional-event.messageBuilder` class must implement `EventMessageBuilderInterface` and `transactional-event.middleware` class must implement `EventStoreMiddlewareInterface`.
+
+The builder should return a `EventMessageInterface` value object. It just needs to implement the `toArray` and `jsonSerialize` methods with all the attributes that you need.
 
 Considerations
 ==============

config/transactional-event-publisher.php

@@ -1,8 +1,9 @@
 <?php
 
+use Softonic\TransactionalEventPublisher\Builders\EventMessageBuilder;
+use Softonic\TransactionalEventPublisher\ValueObjects\EventMessage;
 use Softonic\TransactionalEventPublisher\EventStoreMiddlewares\AmqpMiddleware;
 use Softonic\TransactionalEventPublisher\EventStoreMiddlewares\DatabaseMiddleware;
-use Softonic\TransactionalEventPublisher\ValueObjects\EventMessage;
 
 return [
     /*
@@ -28,10 +29,10 @@
 
     /*
     |--------------------------------------------------------------------------
-    | Event Message class.
+    | Event Message Builder class.
     |--------------------------------------------------------------------------
     */
-    'message' => EventMessage::class,
+    'messageBuilder' => EventMessageBuilder::class,
 
     /*
     |--------------------------------------------------------------------------

database/factories/DomainEventFactory.php

@@ -5,7 +5,6 @@
 use Illuminate\Database\Eloquent\Factories\Factory;
 use Softonic\TransactionalEventPublisher\CustomEventMessage;
 use Softonic\TransactionalEventPublisher\Models\DomainEvent;
-use Softonic\TransactionalEventPublisher\TestModel;
 
 class DomainEventFactory extends Factory
 {
@@ -18,13 +17,11 @@ class DomainEventFactory extends Factory
 
     /**
      * Define the model's default state.
-     *
-     * @return array
      */
     public function definition(): array
     {
         return [
-            'message' => new CustomEventMessage(new TestModel(), 'testEvent')
+            'message' => new CustomEventMessage()
         ];
     }
 }

src/Builders/EventMessageBuilder.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Softonic\TransactionalEventPublisher\Builders;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Carbon;
+use Softonic\TransactionalEventPublisher\Interfaces\EventMessageBuilderInterface;
+use Softonic\TransactionalEventPublisher\Interfaces\EventMessageInterface;
+use Softonic\TransactionalEventPublisher\ValueObjects\EventMessage;
+
+class EventMessageBuilder implements EventMessageBuilderInterface
+{
+
+    public function build(Model $model, string $eventType): EventMessageInterface
+    {
+        $modelName = class_basename($model);
+
+        return new EventMessage(
+            service: config('transactional-event-publisher.service'),
+            eventType: $eventType,
+            modelName: $modelName,
+            eventName: $modelName . ucfirst($eventType),
+            payload: $model->toArray(),
+            createdAt: Carbon::now()->toDateTimeString(),
+        );
+    }
+}

src/Console/Commands/EmitEvents.php

@@ -11,7 +11,7 @@
 use Illuminate\Support\LazyCollection;
 use InvalidArgumentException;
 use RuntimeException;
-use Softonic\TransactionalEventPublisher\Contracts\EventStoreMiddlewareContract;
+use Softonic\TransactionalEventPublisher\Interfaces\EventStoreMiddlewareInterface;
 use Softonic\TransactionalEventPublisher\Models\DomainEvent;
 
 class EmitEvents extends Command
@@ -38,7 +38,7 @@ class EmitEvents extends Command
 
     protected $description = 'Continuously emits domain events in batches';
 
-    public EventStoreMiddlewareContract $eventPublisherMiddleware;
+    public EventStoreMiddlewareInterface $eventPublisherMiddleware;
 
     public string $dbConnection;
 
@@ -52,7 +52,7 @@ class EmitEvents extends Command
 
     private bool $eventsProcessed;
 
-    public function handle(EventStoreMiddlewareContract $eventPublisherMiddleware): void
+    public function handle(EventStoreMiddlewareInterface $eventPublisherMiddleware): void
     {
         $this->eventPublisherMiddleware = $eventPublisherMiddleware;
 

src/EventStoreMiddlewares/AmqpMiddleware.php

@@ -5,11 +5,11 @@
 use Exception;
 use Illuminate\Support\Facades\Log;
 use Softonic\Amqp\Amqp;
-use Softonic\TransactionalEventPublisher\Contracts\EventMessageContract;
-use Softonic\TransactionalEventPublisher\Contracts\EventStoreMiddlewareContract;
 use Softonic\TransactionalEventPublisher\Factories\AmqpMessageFactory;
+use Softonic\TransactionalEventPublisher\Interfaces\EventMessageInterface;
+use Softonic\TransactionalEventPublisher\Interfaces\EventStoreMiddlewareInterface;
 
-class AmqpMiddleware implements EventStoreMiddlewareContract
+class AmqpMiddleware implements EventStoreMiddlewareInterface
 {
     public function __construct(
         private readonly AmqpMessageFactory $messageFactory,
@@ -21,7 +21,7 @@ public function __construct(
     /**
      * Publishes the messages to the AMQP Message broker.
      */
-    public function store(EventMessageContract ...$messages): bool
+    public function store(EventMessageInterface ...$messages): bool
     {
         try {
             if (count($messages) === 1) {
@@ -55,7 +55,7 @@ public function store(EventMessageContract ...$messages): bool
      * Returns the message routing key based in the configured parameters
      * or a default value based in service, eventType and modelName.
      */
-    private function getRoutingKey(EventMessageContract $message): string
+    private function getRoutingKey(EventMessageInterface $message): string
     {
         $routingKey = $message->service . '.' . $message->eventType . '.' . $message->modelName;
         if (isset($this->properties['routing_key_fields'])) {

src/EventStoreMiddlewares/DatabaseMiddleware.php

@@ -4,16 +4,16 @@
 
 use Exception;
 use Illuminate\Support\Facades\DB;
-use Softonic\TransactionalEventPublisher\Contracts\EventMessageContract;
-use Softonic\TransactionalEventPublisher\Contracts\EventStoreMiddlewareContract;
+use Softonic\TransactionalEventPublisher\Interfaces\EventMessageInterface;
+use Softonic\TransactionalEventPublisher\Interfaces\EventStoreMiddlewareInterface;
 use Softonic\TransactionalEventPublisher\Models\DomainEvent;
 
-class DatabaseMiddleware implements EventStoreMiddlewareContract
+class DatabaseMiddleware implements EventStoreMiddlewareInterface
 {
     /**
      * Stores the messages in database.
      */
-    public function store(EventMessageContract ...$messages): bool
+    public function store(EventMessageInterface ...$messages): bool
     {
         try {
             $inserts = [];

src/Factories/AmqpMessageFactory.php

@@ -4,14 +4,14 @@
 
 use LogicException;
 use PhpAmqpLib\Message\AMQPMessage;
-use Softonic\TransactionalEventPublisher\Contracts\EventMessageContract;
+use Softonic\TransactionalEventPublisher\Interfaces\EventMessageInterface;
 
 class AmqpMessageFactory
 {
     /**
      * Makes a AMQPMessage object.
      */
-    public function make(EventMessageContract $eventMessage, array $properties = []): AMQPMessage
+    public function make(EventMessageInterface $eventMessage, array $properties = []): AMQPMessage
     {
         $this->checkMessage($eventMessage->toArray());
 

src/Interfaces/EventMessageBuilderInterface.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Softonic\TransactionalEventPublisher\Interfaces;
+
+use Illuminate\Database\Eloquent\Model;
+
+interface EventMessageBuilderInterface
+{
+    public function build(Model $model, string $eventType): EventMessageInterface;
+}

src/Interfaces/EventMessageInterface.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Softonic\TransactionalEventPublisher\Interfaces;
+
+use JsonSerializable;
+
+interface EventMessageInterface extends JsonSerializable
+{
+    /**
+     * Returns the message in an array format.
+     */
+    public function toArray(): array;
+}

src/Interfaces/EventStoreMiddlewareInterface.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Softonic\TransactionalEventPublisher\Interfaces;
+
+interface EventStoreMiddlewareInterface
+{
+    /**
+     * Stores in the message-oriented middleware.
+     */
+    public function store(EventMessageInterface ...$messages): bool;
+}

src/Models/DomainEvent.php

@@ -5,8 +5,8 @@
 use Illuminate\Database\Eloquent\Factories\Factory;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
-use Softonic\TransactionalEventPublisher\Contracts\EventMessageContract;
 use Softonic\TransactionalEventPublisher\Database\Factories\DomainEventFactory;
+use Softonic\TransactionalEventPublisher\Interfaces\EventMessageInterface;
 
 class DomainEvent extends Model
 {
@@ -26,7 +26,7 @@ class DomainEvent extends Model
      */
     public $timestamps = false;
 
-    public function setMessageAttribute(EventMessageContract $message)
+    public function setMessageAttribute(EventMessageInterface $message)
     {
         $this->attributes['message'] = serialize(clone $message);
     }

src/Observers/ModelObserver.php

@@ -3,19 +3,23 @@
 namespace Softonic\TransactionalEventPublisher\Observers;
 
 use Illuminate\Database\Eloquent\Model;
-use Softonic\TransactionalEventPublisher\Contracts\EventStoreMiddlewareContract;
 use Softonic\TransactionalEventPublisher\Exceptions\EventStoreFailedException;
+use Softonic\TransactionalEventPublisher\Interfaces\EventMessageBuilderInterface;
+use Softonic\TransactionalEventPublisher\Interfaces\EventStoreMiddlewareInterface;
 
 class ModelObserver
 {
-    private $eventStoreMiddleware;
+    /**
+     * @var EventStoreMiddlewareInterface[]
+     */
+    private array $eventStoreMiddleware;
 
     /**
-     * @param EventStoreMiddlewareContract | EventStoreMiddlewareContract[] $eventStoreMiddleware
+     * @param EventStoreMiddlewareInterface | EventStoreMiddlewareInterface[] $eventStoreMiddleware
      */
     public function __construct(
-        $eventStoreMiddleware,
-        private readonly string $messageClass
+        array|EventStoreMiddlewareInterface $eventStoreMiddleware,
+        protected readonly EventMessageBuilderInterface $builder
     ) {
         $this->eventStoreMiddleware = is_array($eventStoreMiddleware) ? $eventStoreMiddleware : [$eventStoreMiddleware];
     }
@@ -77,7 +81,7 @@ public function deleted(Model $model): bool
     private function performStoreEventMessage(Model $model, $modelEvent): void
     {
         $connection = $model->getConnection();
-        $message = new $this->messageClass($model, $modelEvent);
+        $message = $this->builder->build($model, $modelEvent);
 
         if (true === $this->executeMiddlewares($message)) {
             $connection->commit();

src/ServiceProvider.php

@@ -68,7 +68,7 @@ public function register()
 
             return new ModelObserver(
                 $middlewares,
-                config('transactional-event-publisher.message')
+                new (config('transactional-event-publisher.messageBuilder'))
             );
         });
 

src/ValueObjects/EventMessage.php

@@ -2,54 +2,33 @@
 
 namespace Softonic\TransactionalEventPublisher\ValueObjects;
 
-use Illuminate\Database\Eloquent\Model;
-use Softonic\TransactionalEventPublisher\Contracts\EventMessageContract;
+use Softonic\TransactionalEventPublisher\Interfaces\EventMessageInterface;
 
-class EventMessage implements EventMessageContract
+class EventMessage implements EventMessageInterface
 {
-    public $service;
-
-    public $eventType;
-
-    public $modelName;
-
-    public $eventName;
-
-    public $createdAt;
-
-    public $payload;
-
-    public function __construct(Model $model, $eventType)
-    {
-        $this->service   = config('transactional-event-publisher.service');
-        $this->eventType = $eventType;
-        $this->modelName = class_basename($model);
-        $this->eventName = $this->buildEventName($this->modelName, $eventType);
-        $this->payload   = $model->toArray();
-        $this->createdAt = date('Y-m-d H:i:s');
+    public function __construct(
+        public readonly string $service,
+        public readonly string $eventType,
+        public readonly string $modelName,
+        public readonly string $eventName,
+        public readonly array $payload,
+        public readonly string $createdAt,
+    ) {
     }
 
     public function toArray(): array
     {
         return [
             'service'   => $this->service,
+            'eventType' => $this->eventType,
+            'modelName' => $this->modelName,
             'eventName' => $this->eventName,
-            'createdAt' => $this->createdAt,
             'payload'   => $this->payload,
+            'createdAt' => $this->createdAt,
         ];
     }
 
-    private function buildEventName($modelName, $event)
-    {
-        return $modelName . ucfirst($event);
-    }
-
-    public function __toString(): string
-    {
-        return serialize($this->toArray());
-    }
-
-    public function jsonSerialize()
+    public function jsonSerialize(): array
     {
         return $this->toArray();
     }