CE-32868: Fixed the codebase to take a compatibility

Author: andrewbess

app/code/Magento/Developer/Model/Logger/Handler/Debug.php

@@ -3,18 +3,23 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Developer\Model\Logger\Handler;
 
+use Exception;
 use Magento\Config\Setup\ConfigOptionsList;
-use Magento\Framework\App\Config\ScopeConfigInterface;
+use Magento\Framework\App\DeploymentConfig;
 use Magento\Framework\App\State;
+use Magento\Framework\Exception\FileSystemException;
+use Magento\Framework\Exception\RuntimeException;
 use Magento\Framework\Filesystem\DriverInterface;
-use Magento\Framework\App\DeploymentConfig;
+use Magento\Framework\Logger\Handler\Debug as DebugHandler;
 
 /**
  * Enable/disable debug logging based on the store config setting
  */
-class Debug extends \Magento\Framework\Logger\Handler\Debug
+class Debug extends DebugHandler
 {
     /**
      * @var State
@@ -30,14 +35,14 @@ class Debug extends \Magento\Framework\Logger\Handler\Debug
      * @param DriverInterface $filesystem
      * @param State $state
      * @param DeploymentConfig $deploymentConfig
-     * @param string $filePath
-     * @throws \Exception
+     * @param string|null $filePath
+     * @throws Exception
      */
     public function __construct(
         DriverInterface $filesystem,
         State $state,
         DeploymentConfig $deploymentConfig,
-        $filePath = null
+        ?string $filePath = null
     ) {
         parent::__construct($filesystem, $filePath);
 
@@ -48,30 +53,34 @@ public function __construct(
     /**
      * @inheritdoc
      */
-    public function isHandling(array $record)
+    public function isHandling(array $record): bool
     {
         if ($this->deploymentConfig->isAvailable()) {
-            return
-                parent::isHandling($record)
-                && $this->isLoggingEnabled();
+            return parent::isHandling($record) && $this->isLoggingEnabled();
         }
 
         return parent::isHandling($record);
     }
 
     /**
-     * Check that logging functionality is enabled.
+     * Check that logging functionality is enabled
      *
      * @return bool
+     * @throws FileSystemException
+     * @throws RuntimeException
      */
     private function isLoggingEnabled(): bool
     {
-        $configValue = $this->deploymentConfig->get(ConfigOptionsList::CONFIG_PATH_DEBUG_LOGGING);
+        $configValue = $this->deploymentConfig->get(
+            ConfigOptionsList::CONFIG_PATH_DEBUG_LOGGING
+        );
+
         if ($configValue === null) {
             $isEnabled = $this->state->getMode() !== State::MODE_PRODUCTION;
         } else {
-            $isEnabled = (bool)$configValue;
+            $isEnabled = (bool) $configValue;
         }
+
         return $isEnabled;
     }
 }

lib/internal/Magento/Framework/Logger/Handler/Base.php

@@ -3,9 +3,11 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
 
 namespace Magento\Framework\Logger\Handler;
 
+use InvalidArgumentException;
 use Magento\Framework\Filesystem\DriverInterface;
 use Monolog\Formatter\LineFormatter;
 use Monolog\Handler\StreamHandler;
@@ -33,19 +35,20 @@ class Base extends StreamHandler
 
     /**
      * @param DriverInterface $filesystem
-     * @param string $filePath
-     * @param string $fileName
-     * @throws \Exception
+     * @param string|null $filePath
+     * @param string|null $fileName
      */
     public function __construct(
         DriverInterface $filesystem,
-        $filePath = null,
-        $fileName = null
+        ?string $filePath = null,
+        ?string $fileName = null
     ) {
         $this->filesystem = $filesystem;
+
         if (!empty($fileName)) {
             $this->fileName = $this->sanitizeFileName($fileName);
         }
+
         parent::__construct(
             $filePath ? $filePath . $this->fileName : BP . DIRECTORY_SEPARATOR . $this->fileName,
             $this->loggerType
@@ -59,14 +62,9 @@ public function __construct(
      *
      * @param string $fileName
      * @return string
-     * @throws \InvalidArgumentException
      */
-    private function sanitizeFileName($fileName)
+    private function sanitizeFileName(string $fileName): string
     {
-        if (!is_string($fileName)) {
-            throw  new \InvalidArgumentException('Filename expected to be a string');
-        }
-
         $parts = explode('/', $fileName);
         $parts = array_filter($parts, function ($value) {
             return !in_array($value, ['', '.', '..']);
@@ -78,9 +76,10 @@ private function sanitizeFileName($fileName)
     /**
      * @inheritDoc
      */
-    protected function write(array $record)
+    protected function write(array $record): void
     {
         $logDir = $this->filesystem->getParentDirectory($this->url);
+
         if (!$this->filesystem->isDirectory($logDir)) {
             $this->filesystem->createDirectory($logDir);
         }

lib/internal/Magento/Framework/Logger/Handler/System.php

@@ -3,10 +3,13 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
 
 namespace Magento\Framework\Logger\Handler;
 
+use Exception;
 use Magento\Framework\Filesystem\DriverInterface;
+use Magento\Framework\Logger\Handler\Exception as ExceptionHandler;
 use Monolog\Logger;
 
 /**
@@ -25,38 +28,38 @@ class System extends Base
     protected $loggerType = Logger::INFO;
 
     /**
-     * @var Exception
+     * @var ExceptionHandler
      */
     protected $exceptionHandler;
 
     /**
      * @param DriverInterface $filesystem
-     * @param Exception $exceptionHandler
-     * @param string $filePath
+     * @param ExceptionHandler $exceptionHandler
+     * @param string|null $filePath
+     * @throws Exception
      */
     public function __construct(
         DriverInterface $filesystem,
-        Exception $exceptionHandler,
-        $filePath = null
+        ExceptionHandler $exceptionHandler,
+        ?string $filePath = null
     ) {
         $this->exceptionHandler = $exceptionHandler;
         parent::__construct($filesystem, $filePath);
     }
 
     /**
-     * Writes formatted record through the handler.
+     * Writes formatted record through the handler
      *
      * @param array $record The record metadata
      * @return void
      */
-    public function write(array $record)
+    public function write(array $record): void
     {
         if (isset($record['context']['exception'])) {
             $this->exceptionHandler->handle($record);
 
             return;
         }
-
         $record['formatted'] = $this->getFormatter()->format($record);
 
         parent::write($record);

lib/internal/Magento/Framework/Logger/Monolog.php

@@ -3,48 +3,32 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
 
 namespace Magento\Framework\Logger;
 
+use DateTimeZone;
 use Monolog\Logger;
 
+/**
+ * Monolog Logger
+ */
 class Monolog extends Logger
 {
     /**
      * @inheritdoc
      */
-    public function __construct($name, array $handlers = [], array $processors = [])
-    {
+    public function __construct(
+        string $name,
+        array $handlers = [],
+        array $processors = [],
+        ?DateTimeZone $timezone = null
+    ) {
         /**
          * TODO: This should be eliminated with MAGETWO-53989
          */
         $handlers = array_values($handlers);
 
-        parent::__construct($name, $handlers, $processors);
-    }
-
-    /**
-     * Adds a log record.
-     *
-     * @param integer $level The logging level
-     * @param string $message The log message
-     * @param array $context The log context
-     * @return bool Whether the record has been processed
-     */
-    public function addRecord($level, $message, array $context = [])
-    {
-        /**
-         * To preserve compatibility with Exception messages.
-         * And support PSR-3 context standard.
-         *
-         * @link http://www.php-fig.org/psr/psr-3/#context PSR-3 context standard
-         */
-        if ($message instanceof \Exception && !isset($context['exception'])) {
-            $context['exception'] = $message;
-        }
-
-        $message = $message instanceof \Exception ? $message->getMessage() : $message;
-
-        return parent::addRecord($level, $message, $context);
+        parent::__construct($name, $handlers, $processors, $timezone);
     }
 }