Feature/add monolog 3

Dockerfile

@@ -1,4 +1,4 @@
-FROM php:8.0-cli-alpine3.13
+FROM php:8.2-cli-alpine3.21
 
 RUN apk add --no-cache \
         libzip-dev \
@@ -9,12 +9,11 @@ RUN apk add --no-cache \
 
 RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/bin/ --filename=composer
 
-RUN apk add --no-cache --virtual .phpize_deps $PHPIZE_DEPS && \
-    pecl install xdebug-3.0.4 && \
-    docker-php-ext-enable xdebug && \
-    rm -rf /usr/share/php8 && \
-    rm -rf /tmp/pear && \
-    apk del .phpize_deps
+RUN apk add --no-cache --virtual .phpize_deps $PHPIZE_DEPS \
+  && apk add linux-headers \
+  && pecl install xdebug-3.4.5  \
+  && docker-php-ext-enable xdebug \
+  && apk del linux-headers ${PHPIZE_DEPS}
 
 ENV PATH /var/app/bin:/var/app/vendor/bin:$PATH
 

Makefile

@@ -24,6 +24,9 @@ bash:
 logs:
 		docker compose logs -f ${DOCKER_PHP_SERVICE}
 
+composer-show:
+		docker compose run --rm -u ${UID}:${GID} ${DOCKER_PHP_SERVICE} composer show
+
 .PHONY: tests
 tests:
-		docker compose run --rm -u ${UID}:${GID} ${DOCKER_PHP_SERVICE} phpunit
+		docker compose run --rm -u ${UID}:${GID} ${DOCKER_PHP_SERVICE} phpunit

README.md

@@ -10,4 +10,14 @@ La idea del middleware es muy simple. Para construirlo, requiere de cuatro depen
 - Serializador de excepciones, para logear si llega a ocurrir, la foto de la excepción disparada.
 
 ## Tracker
-Esta clase sirve para meter en el registro de logs el ID de una posible operación "padre", para posteriormente poder sacar trazas de tipo "árbol" por un sistema que sea capaz de centralizar estos logs.
+Esta clase sirve para meter en el registro de logs el ID de una posible operación "padre", para posteriormente poder sacar trazas de tipo "árbol" por un sistema que sea capaz de centralizar estos logs.
+
+## Comandos de desarrollo
+
+### Ver versiones de paquetes instalados
+Para ver qué versiones de paquetes tiene instalado Composer, ejecuta:
+```bash
+make composer-show
+```
+
+Este comando mostrará una lista de todos los paquetes instalados junto con sus versiones actuales.

composer.json

@@ -22,9 +22,9 @@
     }
   ],
   "require": {
-    "php": "^7.4|^8.0",
+    "php": "^8.2",
     "ext-json": "*",
-    "monolog/monolog": "^1.25|^2.0",
+    "monolog/monolog": "^3.0",
     "pccomponentes/ddd": "^2.1|^3.0|^4.0",
     "symfony/http-kernel": "^4.4|^5.0|^6.0|^7.0",
     "symfony/messenger": "^4.4|^5.0|^6.0|^7.0",

src/Context/NormalizeMessageProcessor.php

@@ -3,20 +3,33 @@
 
 namespace PcComponentes\DddLogging\Context;
 
+use Monolog\LogRecord;
 use Monolog\Processor\ProcessorInterface;
 
 final class NormalizeMessageProcessor implements ProcessorInterface
 {
-    public function __invoke(array $record): array
+    public function __invoke(LogRecord $record): LogRecord
     {
+        $returnRecord = $record;
+
         if (false === \array_key_exists('message', $record['context'])) {
-            return $record;
+            return $returnRecord;
         }
 
         if (false === \is_string($record['context']['message'])) {
-            $record['context']['message'] = \json_encode($record['context']['message']);
+            $context = $record['context'];
+            $context['message'] = \json_encode($record['context']['message']);
+
+            $returnRecord = new LogRecord(
+                $record->datetime,
+                $record->channel,
+                $record->level,
+                $record->message,
+                $context,
+                $record->extra,
+            );
         }
 
-        return $record;
+        return $returnRecord;
     }
 }

src/DomainTrace/DomainTraceProcessor.php

@@ -3,6 +3,7 @@
 
 namespace PcComponentes\DddLogging\DomainTrace;
 
+use Monolog\LogRecord;
 use Monolog\Processor\ProcessorInterface;
 use PcComponentes\Ddd\Domain\Model\ValueObject\Uuid;
 use PcComponentes\Ddd\Util\Message\Message;
@@ -16,17 +17,17 @@ public function __construct(Tracker $tracker)
         $this->tracker = $tracker;
     }
 
-    public function __invoke(array $record): array
+    public function __invoke(LogRecord $record): LogRecord
     {
         $messageId = $this->getMessageId($record);
 
-        $record['context']['trace']['correlation_id'] = $this->tracker->correlationId($messageId);
-        $record['context']['trace']['reply_to'] = $this->tracker->replyTo($messageId);
+        $record['extra']['trace']['correlation_id'] = $this->tracker->correlationId($messageId);
+        $record['extra']['trace']['reply_to'] = $this->tracker->replyTo($messageId);
 
         return $record;
     }
-    
-    private function getMessageId(array $record): ?Uuid
+
+    private function getMessageId(LogRecord $record): ?Uuid
     {
         if (false === \array_key_exists('message', $record['context'])) {
             return null;

src/ExceptionCatcher/TraceOfExceptionProcessor.php

@@ -3,31 +3,41 @@
 
 namespace PcComponentes\DddLogging\ExceptionCatcher;
 
+use Monolog\LogRecord;
 use Monolog\Processor\ProcessorInterface;
 use PcComponentes\DddLogging\Util\AssocSerializer;
 
 final class TraceOfExceptionProcessor implements ProcessorInterface
 {
-    public function __invoke(array $record): array
+    public function __invoke(LogRecord $record): LogRecord
     {
         if (false === \array_key_exists('exception', $record['context'])) {
             return $record;
         }
 
-        $exception = $record['context']['exception'];
-        $record['context']['exception'] = AssocSerializer::from($record['context']['exception']);
+        $context = $record->context;
+
+        $exception = $context['exception'];
+        $context['exception'] = AssocSerializer::from($context['exception']);
 
         if ($exception instanceof \JsonSerializable) {
-            $record['context']['exception']['data'] = \json_encode($exception, JSON_THROW_ON_ERROR);
+            $context['exception']['data'] = \json_encode($exception, \JSON_THROW_ON_ERROR);
         }
 
-        if (true === \array_key_exists('trace', $record['context']['exception'])) {
-            $record['context']['exception']['trace'] = \json_encode(
-                $record['context']['exception']['trace'],
-                JSON_THROW_ON_ERROR
+        if (true === \array_key_exists('trace', $context['exception'])) {
+            $context['exception']['trace'] = \json_encode(
+                $context['exception']['trace'],
+                \JSON_THROW_ON_ERROR,
             );
         }
 
-        return $record;
+        return new LogRecord(
+            $record->datetime,
+            $record->channel,
+            $record->level,
+            $record->message,
+            $context,
+            $record->extra,
+        );
     }
 }

src/ExecutionTime/ExecutionTimeProcessor.php

@@ -3,6 +3,7 @@
 
 namespace PcComponentes\DddLogging\ExecutionTime;
 
+use Monolog\LogRecord;
 use Monolog\Processor\ProcessorInterface;
 use PcComponentes\Ddd\Util\Message\Message;
 use Symfony\Component\Stopwatch\Stopwatch;
@@ -16,7 +17,7 @@ public function __construct(Stopwatch $stopwatch)
         $this->stopwatch = $stopwatch;
     }
 
-    public function __invoke(array $record): array
+    public function __invoke(LogRecord $record): LogRecord
     {
         if (false === \array_key_exists('message', $record['context'])) {
             return $record;
@@ -28,7 +29,7 @@ public function __invoke(array $record): array
             return $record;
         }
 
-        $record['context']['execution_time'] = $this->getExecutionTime($message);
+        $record['extra']['execution_time'] = $this->getExecutionTime($message);
 
         return $record;
     }

src/Hostname/HostnameProcessor.php

@@ -3,6 +3,7 @@
 
 namespace PcComponentes\DddLogging\Hostname;
 
+use Monolog\LogRecord;
 use Monolog\Processor\ProcessorInterface;
 
 final class HostnameProcessor implements ProcessorInterface
@@ -14,7 +15,7 @@ public function __construct()
         $this->host = \gethostname();
     }
 
-    public function __invoke(array $record): array
+    public function __invoke(LogRecord $record): LogRecord
     {
         $record['extra']['hostname'] = $this->host;
 

src/Info/InfoProcessor.php

@@ -3,13 +3,14 @@
 
 namespace PcComponentes\DddLogging\Info;
 
+use Monolog\LogRecord;
 use Monolog\Processor\ProcessorInterface;
 use PcComponentes\Ddd\Util\Message\AggregateMessage;
 use PcComponentes\Ddd\Util\Message\Message;
 
 final class InfoProcessor implements ProcessorInterface
 {
-    public function __invoke(array $record)
+    public function __invoke(LogRecord $record): LogRecord
     {
         if (false === \array_key_exists('message', $record['context'])) {
             return $record;
@@ -21,33 +22,33 @@ public function __invoke(array $record)
         return $record;
     }
 
-    private function messageInfo(array $record): array
+    private function messageInfo(LogRecord $record): LogRecord
     {
         $message = $record['context']['message'];
 
         if (false === $message instanceof Message) {
             return $record;
         }
 
-        $record['context']['message_id'] = $message->messageId()->value();
-        $record['context']['name'] = $message::messageName();
-        $record['context']['type'] = $message::messageType();
-        $record['context']['payload'] = \json_encode($message->messagePayload());
+        $record['extra']['message']['message_id'] = $message->messageId()->value();
+        $record['extra']['message']['name'] = $message::messageName();
+        $record['extra']['message']['type'] = $message::messageType();
+        $record['extra']['message']['payload'] = \json_encode($message->messagePayload());
 
         return $record;
     }
 
-    private function aggregateInfo(array $record): array
+    private function aggregateInfo(LogRecord $record): LogRecord
     {
         $message = $record['context']['message'];
 
         if (false === $message instanceof AggregateMessage) {
             return $record;
         }
 
-        $record['context']['aggregate_id'] = $message->aggregateId();
-        $record['context']['aggregate_version'] = $message->aggregateVersion();
-        $record['context']['occurred_on'] = $message->occurredOn()->format(\DateTime::ATOM);
+        $record['extra']['message']['aggregate_id'] = $message->aggregateId();
+        $record['extra']['message']['aggregate_version'] = $message->aggregateVersion();
+        $record['extra']['message']['occurred_on'] = $message->occurredOn()->format(\DateTime::ATOM);
 
         return $record;
     }

src/MonologIteratorProcessor.php

@@ -3,6 +3,7 @@
 
 namespace PcComponentes\DddLogging;
 
+use Monolog\LogRecord;
 use Monolog\Processor\ProcessorInterface;
 
 final class MonologIteratorProcessor implements ProcessorInterface
@@ -14,7 +15,7 @@ public function __construct(ProcessorInterface ...$processors)
         $this->processors = $processors;
     }
 
-    public function __invoke(array $record)
+    public function __invoke(LogRecord $record): LogRecord
     {
         foreach ($this->processors as $processor) {
             $record = $processor($record);

src/OccurredOn/OccurredOnProcessor.php

@@ -3,13 +3,14 @@
 
 namespace PcComponentes\DddLogging\OccurredOn;
 
+use Monolog\LogRecord;
 use Monolog\Processor\ProcessorInterface;
 use PcComponentes\Ddd\Domain\Model\DomainEvent;
 use PcComponentes\Ddd\Domain\Model\ValueObject\DateTimeValueObject;
 
 final class OccurredOnProcessor implements ProcessorInterface
 {
-    public function __invoke(array $record): array
+    public function __invoke(LogRecord $record): LogRecord
     {
         if (false === \array_key_exists('message', $record['context'])) {
             return $record;
@@ -18,12 +19,12 @@ public function __invoke(array $record): array
         $message = $record['context']['message'];
 
         if ($message instanceof DomainEvent) {
-            $record['occurred_on'] = (int) $message->occurredOn()->format('Uv');
+            $record['extra']['occurred_on'] = (int)$message->occurredOn()->format('Uv');
 
             return $record;
         }
 
-        $record['occurred_on'] = (int) DateTimeValueObject::now()->format('Uv');
+        $record['extra']['occurred_on'] = (int)DateTimeValueObject::now()->format('Uv');
 
         return $record;
     }

tests/Context/NormalizeContextProcessorTest.php

@@ -3,16 +3,16 @@
 
 namespace PcComponentes\DddLogging\Tests\Context;
 
+use Monolog\LogRecord;
 use PcComponentes\DddLogging\Context\NormalizeMessageProcessor;
+use PcComponentes\DddLogging\Tests\Mock\LogRecordMother;
 use PHPUnit\Framework\TestCase;
 
 final class NormalizeContextProcessorTest extends TestCase
 {
     public function testShouldReturnedRecordWithoutMessage()
     {
-        $record = [
-            'context' => []
-        ];
+        $record = LogRecordMother::default();
 
         $result = (new NormalizeMessageProcessor())($record);
 
@@ -21,13 +21,12 @@ public function testShouldReturnedRecordWithoutMessage()
 
     public function testShouldReturnedRecordWithEncodedMessage()
     {
-        $record = [
-            'context' => [
+        $record = LogRecordMother::withContext([
                 'message' => [
                     'This is a message',
                 ],
             ],
-        ];
+        );
 
         $expectedEncodedMessage = \json_encode($record['context']['message']);