Update logging

composer.json

@@ -23,12 +23,10 @@
         "nyholm/psr7-server": "^1.0",
         "php-di/php-di": "^7",
         "selective/basepath": "^2",
-        "slim/slim": "^4",
-        "symfony/uid": "^6"
+        "slim/slim": "^4"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3",
-        "mikey179/vfsstream": "^1.6",
         "phpstan/phpstan": "1.*",
         "phpunit/phpunit": "^10",
         "selective/test-traits": "^4",

config/container.php

@@ -1,15 +1,18 @@
 <?php
 
-use App\Factory\LoggerFactory;
 use App\Handler\DefaultErrorHandler;
 use Cake\Database\Connection;
+use Monolog\Formatter\LineFormatter;
+use Monolog\Handler\RotatingFileHandler;
+use Monolog\Logger;
 use Nyholm\Psr7\Factory\Psr17Factory;
 use Psr\Container\ContainerInterface;
 use Psr\Http\Message\ResponseFactoryInterface;
 use Psr\Http\Message\ServerRequestFactoryInterface;
 use Psr\Http\Message\StreamFactoryInterface;
 use Psr\Http\Message\UploadedFileFactoryInterface;
 use Psr\Http\Message\UriFactoryInterface;
+use Psr\Log\LoggerInterface;
 use Selective\BasePath\BasePathMiddleware;
 use Slim\App;
 use Slim\Factory\AppFactory;
@@ -60,11 +63,6 @@
         return $container->get(App::class)->getRouteCollector()->getRouteParser();
     },
 
-    // The logger factory
-    LoggerFactory::class => function (ContainerInterface $container) {
-        return new LoggerFactory($container->get('settings')['logger']);
-    },
-
     BasePathMiddleware::class => function (ContainerInterface $container) {
         return new BasePathMiddleware($container->get(App::class));
     },
@@ -84,21 +82,32 @@
         return $method->invoke($driver);
     },
 
+    LoggerInterface::class => function (ContainerInterface $container) {
+        $settings = $container->get('settings')['logger'];
+
+        $logger = new Logger('app');
+
+        if (isset($settings['path'])) {
+            $filename = sprintf('%s/app.log', $settings['path']);
+            $level = $settings['level'];
+            $rotatingFileHandler = new RotatingFileHandler($filename, 0, $level, true, 0777);
+            $rotatingFileHandler->setFormatter(new LineFormatter(null, null, false, true));
+            $logger->pushHandler($rotatingFileHandler);
+        }
+
+        return $logger;
+    },
+
     ErrorMiddleware::class => function (ContainerInterface $container) {
         $settings = $container->get('settings')['error'];
         $app = $container->get(App::class);
 
-        $logger = $container->get(LoggerFactory::class)
-            ->addFileHandler('error.log')
-            ->createLogger();
-
         $errorMiddleware = new ErrorMiddleware(
             $app->getCallableResolver(),
             $app->getResponseFactory(),
             (bool)$settings['display_error_details'],
             (bool)$settings['log_errors'],
             (bool)$settings['log_error_details'],
-            $logger
         );
 
         $errorMiddleware->setDefaultErrorHandler($container->get(DefaultErrorHandler::class));

docs/logging.md

@@ -13,72 +13,14 @@ To help you learn more about what's happening within your application,
 this Slim skeleton provides robust logging services that allow you to log messages to files, 
 the system error log, and even to Slack to notify your entire team.
 
-Under the hood, this project utilizes the [Monolog](https://github.com/Seldaek/monolog) library,
+This project uses the [Monolog](https://seldaek.github.io/monolog/) package,
 which provides support for a variety of powerful log handlers.
 
 ## Configuration
 
-The directory for all log files is: `logs/`
-
 The default settings are stored in `config/defaults.php`, `$settings['logger']`
 
-## Usage
-
-It's recommended using the `App\Factory\LoggerFactory` class to
-create a custom logger for each context.
-
-The `LoggerFactory` provides methods to generate a
-file- and console based logging output.
-
-Inject the `LoggerFactory` instance and generate a specific logger as follows:
-
-```php
-<?php
-
-use App\Factory\LoggerFactory;
-use Psr\Log\LoggerInterface;
-
-final class Example
-{
-    private LoggerInterface $logger;
-
-    // ...
-
-    public function __construct(LoggerFactory $loggerFactory) {
-        $this->logger = $loggerFactory
-            ->addFileHandler('my_log_file.log')
-            ->createLogger();
-    }
-
-    // ...
-}
-```
-
-Creating a file logger:
-
-```php
-$this->logger = $loggerFactory->addFileHandler('my_log_file.log')->createInstance();
-$this->logger->info('Test');
-```
-
-Creating a console logger:
-
-```php
-$this->logger = $loggerFactory->addConsoleHandler()->createInstance();
-$this->logger->info('Console test output');
-```
-
-
-Creating a file and console logger:
-
-```php
-$this->logger = $loggerFactory
-    ->addFileHandler('my_log_file.log')
-    ->addConsoleHandler()
-    ->createInstance();
-
-$this->logger->info('File and console output');
-```
+The directory for all log files is: `logs/`
 
 ## Read more
 

src/Domain/Customer/Service/CustomerCreator.php

@@ -3,7 +3,6 @@
 namespace App\Domain\Customer\Service;
 
 use App\Domain\Customer\Repository\CustomerRepository;
-use App\Factory\LoggerFactory;
 use Psr\Log\LoggerInterface;
 
 final class CustomerCreator
@@ -17,13 +16,11 @@ final class CustomerCreator
     public function __construct(
         CustomerRepository $repository,
         CustomerValidator $customerValidator,
-        LoggerFactory $loggerFactory
+        LoggerInterface $logger
     ) {
         $this->repository = $repository;
         $this->customerValidator = $customerValidator;
-        $this->logger = $loggerFactory
-            ->addFileHandler('customer_creator.log')
-            ->createLogger();
+        $this->logger = $logger;
     }
 
     public function createCustomer(array $data): int

src/Domain/Customer/Service/CustomerUpdater.php

@@ -3,7 +3,6 @@
 namespace App\Domain\Customer\Service;
 
 use App\Domain\Customer\Repository\CustomerRepository;
-use App\Factory\LoggerFactory;
 use DomainException;
 use Psr\Log\LoggerInterface;
 
@@ -18,13 +17,11 @@ final class CustomerUpdater
     public function __construct(
         CustomerRepository $repository,
         CustomerValidator $customerValidator,
-        LoggerFactory $loggerFactory
+        LoggerInterface $logger
     ) {
         $this->repository = $repository;
         $this->customerValidator = $customerValidator;
-        $this->logger = $loggerFactory
-            ->addFileHandler('customer_updater.log')
-            ->createLogger();
+        $this->logger = $logger;
     }
 
     public function updateCustomer(int $customerId, array $data): void

src/Handler/DefaultErrorHandler.php

@@ -2,7 +2,6 @@
 
 namespace App\Handler;
 
-use App\Factory\LoggerFactory;
 use App\Renderer\JsonRenderer;
 use DomainException;
 use Fig\Http\Message\StatusCodeInterface;
@@ -29,13 +28,11 @@ final class DefaultErrorHandler implements ErrorHandlerInterface
     public function __construct(
         JsonRenderer $jsonRenderer,
         ResponseFactoryInterface $responseFactory,
-        LoggerFactory $loggerFactory
+        LoggerInterface $logger,
     ) {
         $this->jsonRenderer = $jsonRenderer;
         $this->responseFactory = $responseFactory;
-        $this->logger = $loggerFactory
-            ->addFileHandler('error.log')
-            ->createLogger();
+        $this->logger = $logger;
     }
 
     /**

tests/TestCase/Action/Customer/CustomerCreatorActionTest.php

@@ -43,11 +43,6 @@ public function testCreateCustomer(): void
         $this->assertJsonContentType($response);
         $this->assertJsonData(['customer_id' => 1], $response);
 
-        // Check logger
-        // No logger errors
-        $this->assertSame([], $this->getLoggerErrors());
-        $this->assertTrue($this->getLogger()->hasInfoThatContains('Customer created successfully: 1'));
-
         // Check database
         $this->assertTableRowCount(1, 'customers');
 

tests/TestCase/Action/Customer/CustomerUpdaterActionTest.php

@@ -45,9 +45,6 @@ public function testUpdateCustomer(): void
         $this->assertSame(StatusCodeInterface::STATUS_OK, $response->getStatusCode());
         $this->assertJsonContentType($response);
 
-        // Check logger
-        $this->assertTrue($this->getLogger()->hasInfoThatContains('Customer updated successfully'));
-
         // Check database
         $expected = [
             'id' => '1',

tests/Traits/AppTestTrait.php

@@ -19,7 +19,6 @@ trait AppTestTrait
     use ContainerTestTrait;
     use HttpTestTrait;
     use HttpJsonTestTrait;
-    use LoggerTestTrait;
     use MockTestTrait;
 
     protected App $app;
@@ -41,7 +40,6 @@ protected function setUpApp(): void
         $this->app = $container->get(App::class);
 
         $this->setUpContainer($container);
-        $this->setUpLogger();
 
         /** @phpstan-ignore-next-line */
         if (method_exists($this, 'setUpDatabase')) {