Add validation for optional log configurations

- Added constants OPTIONAL_LOG_KEYS and OPTIONAL_LOGS to define minimum required keys and the list of optional logs.
- Implemented validateOptionalLogs method to validate optional logs (query, performance, error) in the configuration.
- Ensured that optional logs have at least 'enabled' and 'channel' keys.
- Added checks to ensure 'handlers' and 'processors' are arrays if present in optional logs.
- Integrated validateOptionalLogs into the main validate method.

Author: walmir-silva

src/Service/LoggerServiceProvider.php

@@ -56,32 +56,27 @@ private function registerEmergencyLogger(): void
 
     private function registerOptionalLoggers(): void
     {
-        $this->registerLoggerIfEnabled('query', 'createQueryLogger');
-        $this->registerLoggerIfEnabled('performance', 'createPerformanceLogger');
-        $this->registerLoggerIfEnabled('error', 'createErrorLogger', true);
+        $this->registerLogger('query', 'createQueryLogger');
+        $this->registerLogger('performance', 'createPerformanceLogger');
+        $this->registerLogger('error', 'createErrorLogger');
         $this->registerAsyncLoggerIfEnabled();
     }
 
-    private function registerLoggerIfEnabled(
+    private function registerLogger(
         string $configKey,
         string $factoryMethod,
-        bool $defaultEnabled = false
     ): void {
-        if ($this->config->get("$configKey.enabled", $defaultEnabled)) {
-            $loggerConfig = $this->config->get($configKey, []);
-            $logger = $this->loggerFactory->$factoryMethod($loggerConfig);
-            $this->loggerRegistry->addLogger(explode('_', $configKey)[0], $logger);
-        }
+        $loggerConfig = $this->config->get($configKey, []);
+        $logger = $this->loggerFactory->$factoryMethod($loggerConfig);
+        $this->loggerRegistry->addLogger($configKey, $logger);
     }
 
     private function registerAsyncLoggerIfEnabled(): void
     {
-        if ($this->config->get('async.enabled', true)) {
-            $asyncLogger = $this->loggerFactory->createAsyncLogger(
-                $this->loggerRegistry->getLogger('default'),
-                (int) $this->config->get('async.batch_size', 10)
-            );
-            $this->loggerRegistry->addLogger('async', $asyncLogger);
-        }
+        $asyncLogger = $this->loggerFactory->createAsyncLogger(
+            $this->loggerRegistry->getLogger('default'),
+            (int) $this->config->get('async.batch_size', 10)
+        );
+        $this->loggerRegistry->addLogger('async', $asyncLogger);
     }
 }

src/Validation/ConfigurationValidator.php

@@ -32,13 +32,25 @@ class ConfigurationValidator
         'class',
     ];
 
+    private const OPTIONAL_LOG_KEYS = [
+        'enabled',
+        'channel',
+    ];
+
+    private const OPTIONAL_LOGS = [
+        'query',
+        'performance',
+        'error',
+    ];
+
     public function validate(array $config): void
     {
         $this->validateRequiredKeys($config, self::REQUIRED_KEYS);
         $this->validateChannels($config['channels']);
         $this->validateHandlers($config['handlers']);
         $this->validateProcessors($config['processors']);
         $this->validateFormatters($config['formatters']);
+        $this->validateOptionalLogs($config);
     }
 
     private function validateRequiredKeys(array $config, array $requiredKeys, string $context = ''): void
@@ -93,4 +105,21 @@ private function validateFormatters(array $formatters): void
             }
         }
     }
+
+    private function validateOptionalLogs(array $config): void
+    {
+        foreach (self::OPTIONAL_LOGS as $log) {
+            if (isset($config[$log])) {
+                $this->validateRequiredKeys($config[$log], self::OPTIONAL_LOG_KEYS, "optional log '{$log}'");
+
+                if (isset($config[$log]['handlers']) && !is_array($config[$log]['handlers'])) {
+                    throw new InvalidConfigurationException("Handlers for optional log '{$log}' must be an array");
+                }
+
+                if (isset($config[$log]['processors']) && !is_array($config[$log]['processors'])) {
+                    throw new InvalidConfigurationException("Processors for optional log '{$log}' must be an array");
+                }
+            }
+        }
+    }
 }

tests/application.php

@@ -26,7 +26,7 @@
 
 $serviceProvider->register();
 
-$defaultLogger = $loggerRegistry->getLogger('console');
+$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']);