Merge pull request #16 from ahacart-adexos/feature/adding_socket_and_updating_plugin

Add Socket Handler, Update Handler Injection, and Processor Compatibility

Author: thomas-kl1

Handler/ConsoleHandler.php

@@ -15,29 +15,11 @@
 
 class ConsoleHandler implements MagentoHandlerInterface
 {
-    /**
-     * @var string
-     */
-    private $isEnabled;
-
-    /**
-     * @var ScopeConfigInterface
-     */
-    private $scopeConfig;
-
-    /**
-     * @var string
-     */
-    private $levelPath;
-
     public function __construct(
-        ScopeConfigInterface $scopeConfig,
-        string $isEnabled,
-        string $levelPath
+        private ScopeConfigInterface $scopeConfig,
+        private string $isEnabled,
+        private string $levelPath
     ) {
-        $this->scopeConfig = $scopeConfig;
-        $this->isEnabled = $isEnabled;
-        $this->levelPath = $levelPath;
     }
 
     /**

Handler/GelfHandler.php

@@ -15,36 +15,12 @@
 
 class GelfHandler implements MagentoHandlerInterface
 {
-    /**
-     * @var PublisherInterface
-     */
-    private $publisher;
-
-    /**
-     * @var string
-     */
-    private $isEnabled;
-
-    /**
-     * @var string
-     */
-    private $levelPath;
-
-    /**
-     * @var ScopeConfigInterface
-     */
-    private $scopeConfig;
-
     public function __construct(
-        PublisherInterface $publisher,
-        ScopeConfigInterface $scopeConfig,
-        string $isEnabled,
-        string $levelPath
+        private PublisherInterface $publisher,
+        private ScopeConfigInterface $scopeConfig,
+        private string $isEnabled,
+        private string $levelPath
     ) {
-        $this->publisher = $publisher;
-        $this->isEnabled = $isEnabled;
-        $this->levelPath = $levelPath;
-        $this->scopeConfig = $scopeConfig;
     }
 
     public function getInstance(): HandlerInterface

Handler/MailHandler.php

@@ -14,50 +14,14 @@
 
 class MailHandler implements MagentoHandlerInterface
 {
-    /**
-     * @var ScopeConfigInterface
-     */
-    private $scopeConfig;
-
-    /**
-     * @var string
-     */
-    private $isEnabled;
-
-    /**
-     * @var string
-     */
-    private $toPath;
-
-    /**
-     * @var string
-     */
-    private $subjectPath;
-
-    /**
-     * @var string
-     */
-    private $fromPath;
-
-    /**
-     * @var string
-     */
-    private $levelPath;
-
     public function __construct(
-        ScopeConfigInterface $scopeConfig,
-        string $isEnabled,
-        string $toPath,
-        string $subjectPath,
-        string $fromPath,
-        string $levelPath
+        private ScopeConfigInterface $scopeConfig,
+        private string $isEnabled,
+        private string $toPath,
+        private string $subjectPath,
+        private string $fromPath,
+        private string $levelPath
     ) {
-        $this->scopeConfig = $scopeConfig;
-        $this->isEnabled = $isEnabled;
-        $this->toPath = $toPath;
-        $this->subjectPath = $subjectPath;
-        $this->fromPath = $fromPath;
-        $this->levelPath = $levelPath;
     }
 
     public function getInstance(): HandlerInterface

Handler/RotatingFileHandler.php

@@ -15,50 +15,14 @@
 
 class RotatingFileHandler implements MagentoHandlerInterface
 {
-    /**
-     * @var ScopeConfigInterface
-     */
-    private $scopeConfig;
-
-    /**
-     * @var DirectoryList
-     */
-    private $directoryList;
-
-    /**
-     * @var string
-     */
-    private $isEnabled;
-
-    /**
-     * @var string
-     */
-    private $levelPath;
-
-    /**
-     * @var string
-     */
-    private $filenamePath;
-
-    /**
-     * @var string
-     */
-    private $maxFilesPath;
-
     public function __construct(
-        ScopeConfigInterface $scopeConfig,
-        DirectoryList $directoryList,
-        string $isEnabled,
-        string $levelPath,
-        string $filenamePath,
-        string $maxFilesPath
+        private ScopeConfigInterface $scopeConfig,
+        private DirectoryList $directoryList,
+        private string $isEnabled,
+        private string $levelPath,
+        private string $filenamePath,
+        private string $maxFilesPath
     ) {
-        $this->scopeConfig = $scopeConfig;
-        $this->directoryList = $directoryList;
-        $this->isEnabled = $isEnabled;
-        $this->levelPath = $levelPath;
-        $this->filenamePath = $filenamePath;
-        $this->maxFilesPath = $maxFilesPath;
     }
 
     /**

Handler/SlackHandler.php

@@ -15,85 +15,19 @@
 
 class SlackHandler implements MagentoHandlerInterface
 {
-    /**
-     * @var ScopeConfigInterface
-     */
-    private $scopeConfig;
-
-    /**
-     * @var string
-     */
-    private $isEnabled;
-
-    /**
-     * @var string
-     */
-    private $levelPath;
-
-    /**
-     * @var string
-     */
-    private $tokenPath;
-
-    /**
-     * @var string
-     */
-    private $channelPath;
-
-    /**
-     * @var string
-     */
-    private $usernamePath;
-
-    /**
-     * @var string
-     */
-    private $useAttachmentPath;
-
-    /**
-     * @var string
-     */
-    private $iconEmojiPath;
-
-    /**
-     * @var string
-     */
-    private $bubblePath;
-
-    /**
-     * @var string
-     */
-    private $useShortAttachmentPath;
-
-    /**
-     * @var string
-     */
-    private $includeContextAndExtraPath;
-
     public function __construct(
-        ScopeConfigInterface $scopeConfig,
-        string $isEnabled,
-        string $levelPath,
-        string $tokenPath,
-        string $channelPath,
-        string $usernamePath,
-        string $useAttachmentPath,
-        string $iconEmojiPath,
-        string $bubblePath,
-        string $useShortAttachmentPath,
-        string $includeContextAndExtraPath
+        private ScopeConfigInterface $scopeConfig,
+        private string $isEnabled,
+        private string $levelPath,
+        private string $tokenPath,
+        private string $channelPath,
+        private string $usernamePath,
+        private string $useAttachmentPath,
+        private string $iconEmojiPath,
+        private string $bubblePath,
+        private string $useShortAttachmentPath,
+        private string $includeContextAndExtraPath
     ) {
-        $this->scopeConfig = $scopeConfig;
-        $this->isEnabled = $isEnabled;
-        $this->levelPath = $levelPath;
-        $this->tokenPath = $tokenPath;
-        $this->channelPath = $channelPath;
-        $this->usernamePath = $usernamePath;
-        $this->useAttachmentPath = $useAttachmentPath;
-        $this->iconEmojiPath = $iconEmojiPath;
-        $this->bubblePath = $bubblePath;
-        $this->useShortAttachmentPath = $useShortAttachmentPath;
-        $this->includeContextAndExtraPath = $includeContextAndExtraPath;
     }
 
     /**

Handler/SocketHandler.php

@@ -0,0 +1,51 @@
+<?php
+/**
+ * Copyright © OpenGento, All rights reserved.
+ * See LICENSE bundled with this library for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Opengento\Logger\Handler;
+
+use Exception;
+use Magento\Framework\App\Config\ScopeConfigInterface;
+use Monolog\Handler\HandlerInterface;
+use Monolog\Handler\SocketHandler as MonologSocketHandler;
+use Monolog\Formatter\JsonFormatter;
+use RuntimeException;
+
+class SocketHandler implements MagentoHandlerInterface
+{
+    public function __construct(
+        private ScopeConfigInterface $scopeConfig,
+        private string $isEnabled,
+        private string $levelPath,
+        private string $endpoint
+    ) {
+    }
+
+    /**
+     * @throws RuntimeException
+     */
+    public function getInstance(): HandlerInterface
+    {
+        $endpointUrl = trim((string) $this->scopeConfig->getValue($this->endpoint));
+        if ($endpointUrl === '') {
+            throw new RuntimeException(sprintf(
+                'Config key "%s" is missing or empty.',
+                $this->endpoint
+            ));
+        }
+
+        $handler = new MonologSocketHandler($endpointUrl, $this->scopeConfig->getValue($this->levelPath));
+        $handler->setFormatter(new JsonFormatter(JsonFormatter::BATCH_MODE_NEWLINES));
+
+        return $handler;
+    }
+
+    public function isEnabled(): bool
+    {
+        return $this->scopeConfig->isSetFlag($this->isEnabled);
+    }
+}

Plugin/MonologPlugin.php

@@ -8,23 +8,31 @@
 
 namespace Opengento\Logger\Plugin;
 
-use Magento\Framework\Logger\Monolog;
-use Monolog\Handler\HandlerInterface;
+use Monolog\Logger;
 use Opengento\Logger\Handler\MagentoHandlerInterface;
 
 class MonologPlugin
 {
-    public function beforeSetHandlers(Monolog $subject, array $handlers): array
+    /**
+     * @param  MagentoHandlerInterface[]  $magentoHandlers
+     */
+    public function __construct(private array $magentoHandlers)
     {
-        $magentoHandlers = [];
-        foreach ($handlers as $key => $handler) {
-            if ($handler instanceof MagentoHandlerInterface && $handler->isEnabled()) {
-                $magentoHandlers[$key] = $handler->getInstance();
-            } elseif ($handler instanceof HandlerInterface) {
-                $magentoHandlers[$key] = $handler;
+    }
+
+    /**
+     * @param  Logger  $subject
+     * @param  array  $handlers
+     * @return array
+     */
+    public function beforeSetHandlers(Logger $subject, array $handlers): array
+    {
+        foreach ($this->magentoHandlers as $handler) {
+            if ($handler->isEnabled()) {
+                array_unshift($handlers, $handler->getInstance());
             }
         }
 
-        return [$magentoHandlers];
+        return [$handlers];
     }
 }

Processor/CustomContextProcessor.php

@@ -11,6 +11,7 @@
 use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\Serialize\Serializer\Json;
 use Magento\Store\Model\ScopeInterface;
+use Monolog\LogRecord;
 use Monolog\Processor\ProcessorInterface;
 
 class CustomContextProcessor implements ProcessorInterface
@@ -31,7 +32,7 @@ public function __construct(ScopeConfigInterface $scopeConfig, Json $serializer)
         $this->serializer = $serializer;
     }
 
-    public function __invoke(array $records): array
+    public function __invoke(LogRecord $records): LogRecord
     {
         foreach ($this->resolveTypesLogger() as $value) {
             $records['context'][$value['custom_logger_key']] = $value['custom_logger_value'];