feat(logger): Modify logger instantiation and debug display error configs

Author: julienloizelet

src/AbstractBounce.php

@@ -4,7 +4,6 @@
 
 namespace CrowdSecBouncer;
 
-use Exception;
 use IPLib\Factory;
 use Monolog\Formatter\LineFormatter;
 use Monolog\Handler\RotatingFileHandler;
@@ -28,12 +27,6 @@ abstract class AbstractBounce implements IBounce
     /** @var array */
     protected $settings = [];
 
-    /** @var bool */
-    protected $debug = false;
-
-    /** @var bool */
-    protected $displayErrors = false;
-
     /** @var LoggerInterface */
     protected $logger;
 
@@ -121,44 +114,35 @@ protected function prepareBouncerConfigs(): array
      *
      * @return void
      * @throws CacheException
-     * @throws InvalidArgumentException
+     * @throws InvalidArgumentException|BouncerException
      */
     public function run(): void
     {
         $this->bounceCurrentIp();
     }
 
-    public function setDebug(bool $debug): void
-    {
-        $this->debug = $debug;
-    }
-
-    public function setDisplayErrors(bool $displayErrors): void
-    {
-        $this->displayErrors = $displayErrors;
-    }
-
     /**
-     * @param string $logDirectoryPath
+     * @param array $configs
      * @param string $loggerName
      * @return void
      */
-    protected function initLoggerHelper(string $logDirectoryPath, string $loggerName): void
+    protected function initLoggerHelper(array $configs, string $loggerName): void
     {
         // Singleton for this function
         if ($this->logger) {
             return;
         }
 
         $this->logger = new Logger($loggerName);
-        $logPath = $logDirectoryPath . '/prod.log';
+        $logDir = $configs['log_directory_path']??__DIR__.'/.logs';
+        $logPath = $logDir . '/prod.log';
         $fileHandler = new RotatingFileHandler($logPath, 0, Logger::INFO);
         $fileHandler->setFormatter(new LineFormatter("%datetime%|%level%|%context%\n"));
         $this->logger->pushHandler($fileHandler);
 
         // Set custom readable logger when debug=true
-        if ($this->debug) {
-            $debugLogPath = $logDirectoryPath . '/debug.log';
+        if (!empty($configs['debug_mode'])) {
+            $debugLogPath = $logDir . '/debug.log';
             $debugFileHandler = new RotatingFileHandler($debugLogPath, 0, Logger::DEBUG);
             $debugFileHandler->setFormatter(new LineFormatter("%datetime%|%level%|%context%\n"));
             $this->logger->pushHandler($debugFileHandler);

src/IBounce.php

@@ -22,7 +22,7 @@ public function init(array $configs, array $forcedConfigs = []): Bouncer;
     /**
      * Init the logger.
      */
-    public function initLogger(): void;
+    public function initLogger(array $configs): void;
 
     /**
      * Get the bouncer instance.

src/RestClient/ClientAbstract.php

@@ -32,7 +32,7 @@ abstract class ClientAbstract
     /** @var LoggerInterface */
     protected $logger;
 
-    /** @var array  */
+    /** @var array */
     protected $configs;
 
     /**
@@ -59,7 +59,7 @@ public function __construct(array $configs, LoggerInterface $logger)
             'type' => 'REST_CLIENT_INIT',
             'base_uri' => $this->baseUri,
             'timeout' => $this->timeout,
-            'user_agent' => $this->headers['User-Agent']
+            'user_agent' => $this->headers['User-Agent'],
         ]);
     }
 
@@ -68,10 +68,10 @@ public function __construct(array $configs, LoggerInterface $logger)
      */
     abstract public function request(
         string $endpoint,
-        array  $queryParams = null,
-        array  $bodyParams = null,
+        array $queryParams = null,
+        array $bodyParams = null,
         string $method = 'GET',
-        array  $headers = null,
-        int    $timeout = null
+        array $headers = null,
+        int $timeout = null
     ): ?array;
 }

src/RestClient/Curl.php

@@ -53,15 +53,9 @@ public function request(
     /**
      * Retrieve Curl options.
      *
-     * @param $endpoint
-     * @param array|null $queryParams
-     * @param array|null $bodyParams
-     * @param string $method
-     * @param array|null $headers
-     * @return array
      */
     private function createOptions(
-        $endpoint,
+        string $endpoint,
         ?array $queryParams,
         ?array $bodyParams,
         string $method,

src/RestClient/FileGetContents.php

@@ -76,7 +76,7 @@ public function request(
         $parts = explode(' ', $http_response_header[0]);
         $status = 0;
         if (\count($parts) > 1) {
-            $status = (int) ($parts[1]);
+            $status = (int) $parts[1];
         }
 
         if ($status < 200 || $status >= 300) {

src/StandaloneBounce.php

@@ -75,9 +75,9 @@ public function getBouncerInstance(array $settings, bool $forceReload = false):
         return $this->bouncer;
     }
 
-    public function initLogger(): void
+    public function initLogger(array $configs): void
     {
-        $this->initLoggerHelper($this->getStringSettings('log_directory_path'), 'php_standalone_bouncer');
+        $this->initLoggerHelper($configs, 'php_standalone_bouncer');
     }
 
     /**
@@ -359,9 +359,7 @@ public function safelyBounce(array $configs): bool
         });
         try {
             $this->settings = $configs;
-            $this->setDebug($this->getBoolSettings('debug_mode'));
-            $this->setDisplayErrors($this->getBoolSettings('display_errors'));
-            $this->initLogger();
+            $this->initLogger($configs);
             if ($this->shouldBounceCurrentIp()) {
                 $this->init($configs);
                 $this->run();
@@ -377,7 +375,7 @@ public function safelyBounce(array $configs): bool
                     'line' => $e->getLine(),
                 ]);
             }
-            if ($this->displayErrors) {
+            if (!empty($configs['display_errors'])) {
                 throw $e;
             }
         }