Merge pull request #15 from SebKay/logging

Logging

Author: SebKay

.gitignore

@@ -4,6 +4,7 @@ vendor/
 coverage/
 .cache/
 public/assets/
+logs/
 
 # Files
 .phpunit.result.cache

composer.json

@@ -28,7 +28,8 @@
         "twig/twig": "^3.1",
         "slim/csrf": "^1.0",
         "illuminate/database": "^8.27",
-        "fakerphp/faker": "^1.13"
+        "fakerphp/faker": "^1.13",
+        "monolog/monolog": "^2.2"
     },
     "require-dev": {
         "squizlabs/php_codesniffer": "^3.5",

composer.lock

@@ -2,17 +2,13 @@
 
 namespace App;
 
-use App\Container\Container;
 use App\Container\ContainerCreator;
 use App\Database\Database;
-use App\Middleware\ExampleMiddleware;
-use App\Handlers\HttpErrorHandler;
-use App\Handlers\ShutdownHandler;
+use App\Dependencies\Logger;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use Slim\App as SlimApp;
 use DI\Bridge\Slim\Bridge as AppFactory;
-use Slim\Factory\ServerRequestCreatorFactory;
 
 class App
 {
@@ -32,9 +28,9 @@ class App
     protected $slim;
 
     /**
-     * @var HttpErrorHandler
+     * @var Logger
      */
-    protected $error_handler;
+    protected $logger;
 
     /**
      * @var Database
@@ -52,6 +48,9 @@ public function __construct()
         $this->slim              = AppFactory::create($this->container());
 
         $this->container_creator->setup();
+
+        $this->logger = $this->container()->get('logger');
+
         $this->setupSlim();
 
         $this->database = new Database();
@@ -94,12 +93,14 @@ protected function addMiddleware(): void
     {
         $this->slim()->addRoutingMiddleware();
 
-        $this->slim()
-            ->addErrorMiddleware($this->dev_mode, false, false)
-            ->setDefaultErrorHandler($this->error_handler);
-
         $this->slim()->add($this->container()->get('csrf'));
-        // $this->slim()->add(ExampleMiddleware::class);
+
+        $this->slim()->addErrorMiddleware(
+            $this->isDevelopmentMode(),
+            true,
+            true,
+            $this->logger
+        );
     }
 
     /**
@@ -110,37 +111,11 @@ protected function addRoutes(): void
         require_once __DIR__ . '/../inc/routes/web.php';
     }
 
-    /**
-     * Add error handler
-     */
-    protected function addErrorHandler(): void
-    {
-        $this->error_handler = new HttpErrorHandler(
-            $this->container(),
-            $this->slim()->getCallableResolver(),
-            $this->slim()->getResponseFactory()
-        );
-    }
-
-    /**
-     * Add shutdown (fatal error) handler
-     */
-    protected function addShutdownHandler(): void
-    {
-        $serverRequestCreator = ServerRequestCreatorFactory::create();
-        $request              = $serverRequestCreator->createServerRequestFromGlobals();
-        $shutdownHandler      = new ShutdownHandler($request, $this->error_handler, $this->dev_mode);
-
-        \register_shutdown_function($shutdownHandler);
-    }
-
     /**
      * Setup the app (called in the constructor)
      */
     protected function setupSlim(): void
     {
-        $this->addErrorHandler();
-        $this->addShutdownHandler();
         $this->addMiddleware();
         $this->addRoutes();
     }

src/App.php

@@ -26,18 +26,23 @@ public function __construct(App $app)
     protected function services(): array
     {
         return [
-            new CSRFService($this->container, $this->app),
-            new ViewService($this->container, $this->app),
+            LoggerService::class,
+            CSRFService::class,
+            ViewService::class
         ];
     }
 
     protected function addServices(): void
     {
-        foreach ($this->services() as $service) {
-            $this->container->set(
-                $service->name(),
-                $service->config()
-            );
+        foreach ($this->services() as $service_class) {
+            $service = new $service_class($this->container(), $this->app);
+
+            if ($service instanceof Service) {
+                $this->container->set(
+                    $service->name(),
+                    $service->config()
+                );
+            }
         }
     }
 

src/Container/ContainerCreator.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace App\Container;
+
+use App\Dependencies\Logger;
+
+class LoggerService extends Service
+{
+    public static function name(): string
+    {
+        return 'logger';
+    }
+
+    public function config(): Logger
+    {
+        return new Logger();
+    }
+}

src/Container/LoggerService.php

@@ -0,0 +1,71 @@
+<?php
+
+namespace App\Dependencies;
+
+use Monolog\Handler\StreamHandler;
+use Monolog\Logger as MonologLogger;
+use Psr\Log\LoggerInterface;
+
+class Logger implements LoggerInterface
+{
+    /**
+     * @var MonologLogger
+     */
+    protected $logger;
+
+    public function __construct(string $log_path = null)
+    {
+        $log_path = ($log_path ?: __DIR__ . '/../../logs/app.log');
+
+        $this->logger = new MonologLogger('App');
+
+        $this->logger->pushHandler(
+            new StreamHandler($log_path)
+        );
+    }
+
+    public function log($level, $message, array $context = [])
+    {
+        $this->logger->addRecord($level, $message, $context);
+    }
+
+    public function debug($message, array $context = [])
+    {
+        $this->logger->debug($message, $context);
+    }
+
+    public function info($message, array $context = [])
+    {
+        $this->logger->info($message, $context);
+    }
+
+    public function notice($message, array $context = [])
+    {
+        $this->logger->notice($message, $context);
+    }
+
+    public function warning($message, array $context = [])
+    {
+        $this->logger->warning($message, $context);
+    }
+
+    public function error($message, array $context = [])
+    {
+        $this->logger->error($message, $context);
+    }
+
+    public function critical($message, array $context = [])
+    {
+        $this->logger->critical($message, $context);
+    }
+
+    public function alert($message, array $context = [])
+    {
+        $this->logger->alert($message, $context);
+    }
+
+    public function emergency($message, array $context = [])
+    {
+        $this->logger->emergency($message, $context);
+    }
+}