Improving exception handling to make it easier and isolate exception concerns from everywhere else. Plus, definining the first draft of the DDD architecture, yay!

Author: juananrey

config/services.yaml

@@ -15,7 +15,6 @@ services:
     # this creates a service per class whose id is the fully-qualified class name
     App\:
         resource: '../src/*'
-        exclude: '../src/{Entity,Migrations,Tests}'
 
     # controllers are imported separately to make sure services can be injected
     # as action arguments even if you don't extend any base controller class
@@ -25,7 +24,7 @@ services:
 
     # add more service definitions when explicit configuration is needed
     # please note that last definitions always *replace* previous ones
-    App\EventListener\ExceptionListener:
+    App\Infrastructure\EventListener\Symfony\ExceptionListener:
         arguments: ['%env(APP_ENV)%']
         tags:
             - { name: kernel.event_listener, event: kernel.exception }

src/Application/.gitignore renamed to src/Application/Command/.gitignore

@@ -0,0 +1,26 @@
+<?php
+
+namespace App\Domain\Exception;
+
+/**
+ * Global exception within our system, which will ALWAYS have a well-defined error code
+ * Such error code is defined in one of the files under ErrorCode/, which will be in this folder
+ */
+class AppException extends \Exception
+{
+    /**
+     * @var string
+     */
+    private $internalErrorCode;
+
+    public function __construct(string $internalErrorCode, string $message = '')
+    {
+        $this->internalErrorCode = $internalErrorCode;
+        parent::__construct($message);
+    }
+
+    public function internalErrorCode(): string
+    {
+        return $this->internalErrorCode;
+    }
+}

src/Domain/.gitignore renamed to src/Application/Query/Responses/.gitignore

@@ -1,6 +1,6 @@
 <?php
 
-namespace App\Exception\ErrorCode;
+namespace App\Domain\Exception\ErrorCode;
 
 final class GlobalErrorCodes
 {

src/Domain/Exception/AppException.php

@@ -1,9 +1,9 @@
 <?php
 
-namespace App\EventListener;
+namespace App\Infrastructure\EventListener\Symfony;
 
-use App\Exception\AppException;
-use App\Exception\ErrorCode\GlobalErrorCodes;
+use App\Domain\Exception\AppException;
+use App\Domain\Exception\ErrorCode\GlobalErrorCodes;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent;
 use Symfony\Component\HttpFoundation\Response;
@@ -30,7 +30,7 @@ public function onKernelException(GetResponseForExceptionEvent $event): void
         $response = new JsonResponse();
 
         if ($exception instanceof AppException) {
-            $response->setStatusCode($exception->getHttpErrorCode());
+            $response->setStatusCode($this->buildHttpErrorCodeFromInternalErrorCode($exception->internalErrorCode()));
         } elseif ($exception instanceof HttpExceptionInterface) {
             $response->setStatusCode($exception->getStatusCode());
         } else {
@@ -51,7 +51,7 @@ private function buildErrorMessage(\Exception $exception): array
     {
         $errorMessage = [];
         if ($exception instanceof AppException) {
-            $errorMessage['errorCode'] = $exception->getInternalErrorCode();
+            $errorMessage['errorCode'] = $exception->internalErrorCode();
         } else {
             $errorMessage['errorCode'] = GlobalErrorCodes::INTERNAL_SERVER_DRAMA;
         }
@@ -74,4 +74,13 @@ private function isProductionEnvironment(): bool
     {
         return in_array($this->environment, ['pre', 'pro']);
     }
+
+    private function buildHttpErrorCodeFromInternalErrorCode(string $internalErrorCode): string
+    {
+        switch ($internalErrorCode) {
+            case GlobalErrorCodes::INTERNAL_SERVER_DRAMA:
+            default:
+                return Response::HTTP_INTERNAL_SERVER_ERROR;
+        }
+    }
 }