Move ApplicationException (#299)

Move ApplicationException to Domain and rename it
to DomainException. This avoids casting domain exceptions
to application level exceptions. The DomainException
is meant to be used as a Layer Supertype.

Author: marein

config/config.yml

@@ -101,7 +101,7 @@ services:
         arguments: ['@logger']
         tags: [{ name: kernel.event_listener, method: 'messageFailed' }]
 
-    Gaming\Common\Bus\Integration\ReplyWithErrorResponseOnMessageFailedListener:
+    Gaming\Common\Domain\Integration\ReplyWithErrorResponseOnMessageFailedListener:
         tags: [{ name: kernel.event_listener, method: 'messageFailed', priority: 50 }]
 
     Gaming\Common\EventStore\Integration\Symfony\ResetServicesListener:
@@ -139,7 +139,7 @@ services:
         arguments: ['%env(APP_METRICS_SOCKET)%', '@gaming.prometheus.registry', 'app', '@logger']
 
     gaming.form-violation-mapper:
-        class: Gaming\Common\Bus\Integration\FormViolationMapper
+        class: Gaming\Common\Domain\Integration\FormViolationMapper
 
     gaming.scheduler:
         class: Gaming\Common\Scheduler\PcntlScheduler
@@ -171,8 +171,8 @@ services:
         tags: [{ name: kernel.event_listener, event: kernel.exception, priority: -100 }]
 
     # Lower priority so that the profiler is respected.
-    Gaming\Common\Bus\Integration\ApplicationExceptionToJsonListener:
-        arguments: [[]]
+    Gaming\Common\Domain\Integration\RespondWithViolationsAsJsonOnKernelExceptionListener:
+        arguments: [[], '@translator']
         tags: [{ name: kernel.event_listener, event: kernel.exception, priority: -99 }]
 
     Gaming\WebInterface\Infrastructure\Symfony\HandleFragmentExceptions:

src/Common/Bus/Bus.php

@@ -5,7 +5,6 @@
 namespace Gaming\Common\Bus;
 
 use Exception;
-use Gaming\Common\Bus\Exception\ApplicationException;
 use Gaming\Common\Bus\Exception\BusException;
 
 interface Bus
@@ -16,7 +15,6 @@ interface Bus
      * @param Request<TResponse> $request
      *
      * @return TResponse
-     * @throws ApplicationException
      * @throws BusException
      * @throws Exception Any application based exception
      */

src/Common/Bus/Exception/ApplicationException.php

@@ -5,10 +5,11 @@
 namespace Gaming\Common\Bus\Integration;
 
 use Gaming\Common\Bus\Bus;
-use Gaming\Common\Bus\Exception\ApplicationException;
 use Gaming\Common\Bus\Request;
-use Gaming\Common\Bus\Violation;
-use Gaming\Common\Bus\ViolationParameter;
+use Gaming\Common\Domain\Exception\DomainException;
+use Gaming\Common\Domain\Exception\Violation;
+use Gaming\Common\Domain\Exception\ViolationParameter;
+use Gaming\Common\Domain\Exception\Violations;
 use Symfony\Component\Validator\ConstraintViolationInterface;
 use Symfony\Component\Validator\ConstraintViolationListInterface;
 use Symfony\Component\Validator\Validator\ValidatorInterface;
@@ -26,8 +27,8 @@ public function handle(Request $request): mixed
         $symfonyViolations = $this->validator->validate($request);
 
         if ($symfonyViolations->count() > 0) {
-            throw new ApplicationException(
-                $this->mapFromSymfonyViolations($symfonyViolations)
+            throw new DomainException(
+                new Violations(...$this->mapFromSymfonyViolations($symfonyViolations))
             );
         }
 
@@ -43,9 +44,9 @@ private function mapFromSymfonyViolations(ConstraintViolationListInterface $symf
     {
         return array_map(
             fn(ConstraintViolationInterface $constraintViolation): Violation => new Violation(
-                $constraintViolation->getPropertyPath(),
                 (string)$constraintViolation->getMessage(),
-                $this->mapFromSymfonyParameters($constraintViolation->getParameters())
+                $this->mapFromSymfonyParameters($constraintViolation->getParameters()),
+                $constraintViolation->getPropertyPath()
             ),
             iterator_to_array($symfonyViolations)
         );

src/Common/Bus/Integration/ApplicationExceptionToJsonListener.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Gaming\Common\Domain\Exception;
+
+use Exception;
+
+/**
+ * Represents an exception raised when a domain invariant is violated.
+ * It's meant to be used as a Layer Supertype that encapsulates violations
+ * that can be translated into user-friendly error messages.
+ */
+class DomainException extends Exception
+{
+    public function __construct(
+        public readonly Violations $violations
+    ) {
+        parent::__construct('Domain exception occurred with ' . $violations->count() . ' violation(s).');
+    }
+}

src/Common/Bus/Integration/SymfonyValidatorBus.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Gaming\Common\Domain\Exception;
+
+final class Violation
+{
+    /**
+     * @param ViolationParameter[] $parameters
+     */
+    public function __construct(
+        public readonly string $identifier,
+        public readonly array $parameters = [],
+        public readonly string $propertyPath = ''
+    ) {
+    }
+}

src/Common/Bus/Violation.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Gaming\Common\Domain\Exception;
+
+final class ViolationParameter
+{
+    public function __construct(
+        public readonly string $name,
+        public readonly bool|int|float|string $value
+    ) {
+    }
+}