Met a jour la gestion des erreurs

GribouilleVert · Apr 25, 2021 · ddb7143 · ddb7143
1 parent d3be94e
commit ddb7143
Show file tree

Hide file tree

Showing 12 changed files with 1,498 additions and 63 deletions.
diff --git a/Framework/App.php b/Framework/App.php
@@ -5,8 +5,9 @@
 use DI\ContainerBuilder;
 use DI\NotFoundException;
 use Exception;
-use Framework\Exceptions\SystemException;
+use Framework\Errors\Exceptions\SystemException;
 use Framework\Factories\ContainerFactory;
+use Framework\Factories\ErrorMiddlewareFactory;
 use Framework\Factories\StaticInstancierFactory;
 use Framework\Middlewares\Internals\FileUploadErrorDetectionMiddleware;
 use Framework\Middlewares\Internals\RequestParametersCustomsMiddleware;
@@ -28,10 +29,15 @@ final class App implements RequestHandlerInterface {
 
     public const VERSION = '1.1';
 
-    private const INTERNAL_MIDDLEWARES = [
-        FileUploadErrorDetectionMiddleware::class,
-        RequestParametersCustomsMiddleware::class,
-    ];
+    //List of internal middlewares
+    private function getInternalMiddlewares(): array
+    {
+        return [
+            FileUploadErrorDetectionMiddleware::class,
+            RequestParametersCustomsMiddleware::class,
+            ErrorMiddlewareFactory::make($this->getContainer())
+        ];
+    }
 
     /**
      * Router de l'application
@@ -65,7 +71,7 @@ public function run(ServerRequestInterface $request, Router $router): ResponseIn
 
         $this->index = 0;
         $this->hasHandledGenericMiddlewares = false;
-        $this->middlewares = array_merge(self::INTERNAL_MIDDLEWARES, $router->getMiddlewares());
+        $this->middlewares = array_merge($this->getInternalMiddlewares(), $router->getMiddlewares());
         $this->runTimeRoute = $router;
 
         try {
@@ -193,4 +199,4 @@ private function error(...$exceptions)
         }
         die;
     }
-}
+}
diff --git a/Framework/Exceptions/SystemException.php → ...ork/Errors/Exceptions/SystemException.php b/Framework/Exceptions/SystemException.php → ...ork/Errors/Exceptions/SystemException.php
@@ -1,5 +1,5 @@
 <?php
-namespace Framework\Exceptions;
+namespace Framework\Errors\Exceptions;
 
 class SystemException extends \Exception {
 
@@ -45,4 +45,4 @@ public function getSeverityText(): ?string
         }
     }
 
-}
+}
diff --git a/Framework/Errors/sentry_global.php b/Framework/Errors/sentry_global.php
@@ -0,0 +1,10 @@
+<?php
+
+if (SENTRY_DSN AND SENTRY_ALL) {
+    Sentry\init([
+        'dsn' => SENTRY_DSN,
+        'capture_silenced_errors' => true,
+        'environment' => ENV,
+        'release' => RELEASE,
+    ]);
+}
diff --git a/Framework/Factories/ErrorMiddlewareFactory.php b/Framework/Factories/ErrorMiddlewareFactory.php
@@ -0,0 +1,98 @@
+<?php
+namespace Framework\Factories;
+
+use Exception;
+use Framework\Guard\AuthenticationInterface;
+use Middlewares\Whoops;
+use Psr\Container\ContainerInterface;
+use Sentry\State\Scope;
+use Whoops\Handler\CallbackHandler;
+use Whoops\Handler\PrettyPageHandler;
+use Whoops\Run;
+use function Sentry\captureException;
+use function Sentry\configureScope;
+use function Sentry\init;
+use const PRODUCTION;
+use const SENTRY_ALL;
+use const SENTRY_DSN;
+
+class ErrorMiddlewareFactory {
+
+    public static function make(ContainerInterface $container)
+    {
+        $whoops = new Run();
+
+        if (is_string(SENTRY_DSN)) {
+            if (!SENTRY_ALL) {
+                init([
+                    'dsn' => SENTRY_DSN,
+                    'capture_silenced_errors' => true,
+                    'environment' => ENV,
+                    'release' => RELEASE,
+                ]);
+            }
+
+            if ($container->has(AuthenticationInterface::class)) {
+                $authentification = $container->get(AuthenticationInterface::class);
+                if ($authentification->isLogged()) {
+                    $user = $authentification->getUser();
+                    configureScope(function (Scope $scope) use ($user): void {
+                        $scope->setUser([
+                            'id' => $user->getId(),
+                            'username' => $user->getUsername(),
+                            'email' => $user->email ?? null,
+                        ]);
+                    });
+                }
+            }
+
+            $whoops->appendHandler(new CallbackHandler(function (\Throwable $error) {
+                captureException($error);
+            }));
+        }
+
+        if (!PRODUCTION) {
+            $whoops->appendHandler(new PrettyPageHandler);
+        } else {
+            $whoops->appendHandler(new CallbackHandler(function () use ($container) {
+                self::productionErrorHandler($container);
+            }));
+        }
+
+        $whoops->register();
+
+        return new Whoops($whoops);
+    }
+
+    public static function productionErrorHandler(ContainerInterface $container): void
+    {
+        ob_end_flush();
+        http_response_code(500);
+        try {
+            require 'templates/errors/500.php';
+        } catch (Exception $e) {
+            echo <<<HTML
+            <!doctype html>
+            <html lang="fr">
+                <head>
+                    <meta charset="UTF-8">
+                     <meta name="viewport" content="width=device-width, initial-scale=1.0">
+                     <meta http-equiv="X-UA-Compatible" content="ie=edge">
+                     <title>Errur 500</title>
+                </head>
+                <body>
+                    <h1>Erreur 500</h1>
+                    <p>Une erreur est survenue lors du chargement de cette page.</p>
+                    <p>
+                         <b>De plus, une erreur est survenue lors de l'affichage de la page d'erreur:</b>
+                         <br>
+                         {$e->__toString()}                
+                    </p>
+                </body>
+            </html>
+            HTML;
+        }
+        die;
+    }
+
+}
diff --git a/Framework/Middlewares/Internals/FileUploadErrorDetectionMiddleware.php b/Framework/Middlewares/Internals/FileUploadErrorDetectionMiddleware.php
@@ -1,7 +1,7 @@
 <?php
 namespace Framework\Middlewares\Internals;
 
-use Framework\Exceptions\SystemException;
+use Framework\Errors\Exceptions\SystemException;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use Psr\Http\Message\UploadedFileInterface;

diff --git a/Framework/Middlewares/Internals/RequestParametersCustomsMiddleware.php b/Framework/Middlewares/Internals/RequestParametersCustomsMiddleware.php
@@ -1,7 +1,7 @@
 <?php
 namespace Framework\Middlewares\Internals;
 
-use Framework\Exceptions\SystemException;
+use Framework\Errors\Exceptions\SystemException;
 use Psr\Container\ContainerInterface;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;

diff --git a/Framework/System/views/error.php b/Framework/System/views/error.php
@@ -1,6 +1,6 @@
 <?php
 
-use Framework\Exceptions\SystemException;
+use Framework\Errors\Exceptions\SystemException;
 
 /**
  * @var SystemException[] $exceptions
@@ -47,4 +47,4 @@
             </div>
         </main>
     </body>
-</html>
+</html>
diff --git a/composer.json b/composer.json
@@ -17,6 +17,7 @@
         },
         "files": [
             "config/constants.php",
+            "Framework/Errors/sentry_global.php",
             "Framework/functions.php",
             "App/functions.php"
         ]
@@ -30,7 +31,8 @@
         "laminas/laminas-httphandlerrunner": "^1",
         "robmorgan/phinx": "^0.12.4",
         "pagerfanta/pagerfanta": "^2.7",
-        "altorouter/altorouter": "^2.0"
+        "altorouter/altorouter": "^2.0",
+        "sentry/sdk": "^3.1"
     },
     "require-dev": {
         "middlewares/whoops": "^2",