Refactor Logging System: Enhance Logger Handler Factory and Service Provider

- Implement LoggerHandlerFactory with improved factory methods for handlers
- Ensure channel and optional handler configurations are correctly merged
- Add method to retrieve handlers configuration cleanly
- Update LoggerServiceProvider to include better registration of default, emergency, and optional loggers
- Refactor logger configuration for better clarity and maintainability
- Enhance logging configuration file for better separation of concerns and flexibility

Author: walmir-silva

.env.example

@@ -26,17 +26,17 @@ ASYNC_LOG_ENABLED=true
 
 # Habilitar logs de consulta
 QUERY_LOG_ENABLED=true
-QUERY_LOG_CHANNEL=daily
+QUERY_LOG_CHANNEL=file
 QUERY_LOG_THRESHOLD=100
 
 # Habilitar logs de desempenho
 PERFORMANCE_LOG_ENABLED=false
-PERFORMANCE_LOG_CHANNEL=daily
+PERFORMANCE_LOG_CHANNEL=file
 PERFORMANCE_LOG_THRESHOLD=1000
 
 # Habilitar logs de erro
 ERROR_LOG_ENABLED=true
-ERROR_LOG_CHANNEL=daily
+ERROR_LOG_CHANNEL=file
 
 # Configurações do limpador de logs
 LOG_CLEANER_ENABLED=true

config/logging.php

@@ -233,11 +233,11 @@
         'driver' => \KaririCode\Logging\Decorator\AsyncLogger::class,
         'batch_size' => 10,
     ],
-    'emergency_logger' => [
+    'emergency' => [
         'path' => ConfigHelper::storagePath('logs/emergency.log'),
         'level' => LogLevel::EMERGENCY,
     ],
-    'query_logger' => [
+    'query' => [
         'enabled' => ConfigHelper::env('QUERY_LOG_ENABLED', false),
         'channel' => ConfigHelper::env('QUERY_LOG_CHANNEL', 'file'),
         'threshold' => ConfigHelper::env('QUERY_LOG_THRESHOLD', 100), // in milliseconds
@@ -250,7 +250,7 @@
             ],
         ],
     ],
-    'performance_logger' => [
+    'performance' => [
         'enabled' => ConfigHelper::env('PERFORMANCE_LOG_ENABLED', false),
         'channel' => ConfigHelper::env('PERFORMANCE_LOG_CHANNEL', 'file'),
         'threshold' => ConfigHelper::env('PERFORMANCE_LOG_THRESHOLD', 1000), // in milliseconds
@@ -265,7 +265,7 @@
             'execution_time_processor',
         ],
     ],
-    'error_logger' => [
+    'error' => [
         'enabled' => ConfigHelper::env('ERROR_LOG_ENABLED', true),
         'channel' => ConfigHelper::env('ERROR_LOG_CHANNEL', 'file'),
         'levels' => [

src/Handler/LoggerHandlerFactory.php

@@ -4,6 +4,7 @@
 
 namespace KaririCode\Logging\Handler;
 
+use InvalidArgumentException;
 use KaririCode\Contract\Logging\LogHandler;
 use KaririCode\Logging\Contract\Logging\LoggerConfigurableFactory;
 use KaririCode\Logging\LoggerConfiguration;
@@ -14,7 +15,8 @@ class LoggerHandlerFactory implements LoggerConfigurableFactory
     use ReflectionFactoryTrait;
 
     private array $handlerMap = [];
-    private array $channelConfigs = [];
+    private LoggerConfiguration $config;
+
 
     public function initializeFromConfiguration(LoggerConfiguration $config): void
     {
@@ -25,23 +27,43 @@ public function initializeFromConfiguration(LoggerConfiguration $config): void
             'syslog' => SyslogUdpHandler::class,
         ]);
 
-        $this->channelConfigs = $config->get('channels', []);
+        $this->config = $config;
     }
 
-    public function createHandlers(string $channelName): array
+    public function createHandlers(string $handlerName): array
     {
-        $channelConfig = $this->channelConfigs[$channelName] ?? [];
-        $handlersConfig = $channelConfig['handlers'] ?? [];
+        $handlersConfig = $this->getHandlersConfig($handlerName);
 
         $handlers = [];
         foreach ($handlersConfig as $key => $value) {
             [$handlerName, $handlerOptions] = $this->extractMergedConfig($key, $value);
             $handlers[] = $this->createHandler($handlerName, $handlerOptions);
         }
-
         return $handlers;
     }
 
+    private function getHandlersConfig(string $channelName): array
+    {
+        $channelHandlerConfig = $this->getChannelHandlersConfig($channelName);
+        $optionalHandlerConfig = $this->getOptionalHandlersConfig($channelName);
+
+        return $channelHandlerConfig ?? $optionalHandlerConfig ?? [];
+    }
+
+    private function getChannelHandlersConfig(string $channelName): ?array
+    {
+        $channelConfigs = $this->config->get('channels', []);
+        return $channelConfigs[$channelName]['handlers'] ?? null;
+    }
+
+    private function getOptionalHandlersConfig(string $channelName): ?array
+    {
+        $optionalHandlerConfigs = $this->config->get($channelName, []);
+        return $optionalHandlerConfigs['handlers'] ?? $this->getChannelHandlersConfig(
+            $optionalHandlerConfigs['channel'] ?? 'file'
+        );
+    }
+
     private function createHandler(string $handlerName, array $handlerOptions): LogHandler
     {
         $handlerClass = $this->getClassFromMap($this->handlerMap, $handlerName);

src/Service/LoggerServiceProvider.php

@@ -56,9 +56,9 @@ private function registerEmergencyLogger(): void
 
     private function registerOptionalLoggers(): void
     {
-        $this->registerLoggerIfEnabled('query_logger', 'createQueryLogger');
-        $this->registerLoggerIfEnabled('performance_logger', 'createPerformanceLogger');
-        $this->registerLoggerIfEnabled('error_logger', 'createErrorLogger', true);
+        $this->registerLoggerIfEnabled('query', 'createQueryLogger');
+        $this->registerLoggerIfEnabled('performance', 'createPerformanceLogger');
+        $this->registerLoggerIfEnabled('error', 'createErrorLogger', true);
         $this->registerAsyncLoggerIfEnabled();
     }
 

tests/application.php

@@ -26,22 +26,22 @@
 
 $serviceProvider->register();
 
-// $defaultLogger = $loggerRegistry->getLogger('file');
-// $defaultLogger->debug('This is a debug message', ['context' => 'debug']);
-// $defaultLogger->info('This is an info message');
-// $defaultLogger->notice('This is a notice message', ['context' => 'notice']);
-// $defaultLogger->warning('This is a warning message', ['context' => 'warning']);
-// $defaultLogger->error('This is an error message', ['context' => 'error']);
-// $defaultLogger->critical('This is a critical message', ['context' => 'critical']);
-// $defaultLogger->alert('This is an alert message', ['context' => 'alert']);
-// $defaultLogger->emergency('This is an emergency message', ['context' => 'emergency']);
-
-// $asyncLogger = $loggerRegistry->getLogger('async');
-// if ($asyncLogger) {
-//     for ($i = 0; $i < 2; ++$i) {
-//         $asyncLogger->info("Async log message {$i}", ['context' => "batch {$i}"]);
-//     }
-// }
+$defaultLogger = $loggerRegistry->getLogger('console');
+$defaultLogger->debug('This is a debug message', ['context' => 'debug']);
+$defaultLogger->info('This is an info message');
+$defaultLogger->notice('This is a notice message', ['context' => 'notice']);
+$defaultLogger->warning('This is a warning message', ['context' => 'warning']);
+$defaultLogger->error('This is an error message', ['context' => 'error']);
+$defaultLogger->critical('This is a critical message', ['context' => 'critical']);
+$defaultLogger->alert('This is an alert message', ['context' => 'alert']);
+$defaultLogger->emergency('This is an emergency message', ['context' => 'emergency']);
+
+$asyncLogger = $loggerRegistry->getLogger('async');
+if ($asyncLogger) {
+    for ($i = 0; $i < 2; ++$i) {
+        $asyncLogger->info("Async log message {$i}", ['context' => "batch {$i}"]);
+    }
+}
 
 $queryLogger = $loggerRegistry->getLogger('query');
 $queryLogger->info('Executing a query', ['query' => 'SELECT * FROM users', 'bindings' => [], 'time' => 150]);