Implements #2 - use filesystem

thomas-kl1 · thomas-kl1 · commit a2442a57e50a · 2024-07-22T21:41:24.000+02:00
diff --git a/Controller/Adminhtml/Reports/Delete.php b/Controller/Adminhtml/Reports/Delete.php
@@ -9,11 +9,11 @@
 namespace Opengento\WebapiLogger\Controller\Adminhtml\Reports;
 
 use Exception;
-use Magento\Framework\Controller\Result\Redirect;
-use Opengento\WebapiLogger\Model\Clean;
 use Magento\Backend\App\Action;
 use Magento\Backend\App\Action\Context;
 use Magento\Framework\App\Action\HttpGetActionInterface;
+use Magento\Framework\Controller\Result\Redirect;
+use Opengento\WebapiLogger\Model\Clean;
 
 class Delete extends Action implements HttpGetActionInterface
 {
diff --git a/Model/Config.php b/Model/Config.php
@@ -10,10 +10,14 @@
 
 use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Store\Model\ScopeInterface;
+use Opengento\WebapiLogger\Model\Config\SaveMode;
+
+use function array_map;
 
 class Config
 {
     private const WEBAPI_LOGS_IS_ENABLED = 'webapi_logs/log/enabled';
+    private const WEBAPI_LOGS_SAVE_MODES = 'webapi_logs/log/save_modes';
     private const WEBAPI_LOGS_LOG_SECRET_MODE = 'webapi_logs/log/secret_mode';
     private const WEBAPI_LOGS_LOG_SECRET_WORDS = 'webapi_logs/log/secret_words';
     private const WEBAPI_LOGS_LOG_CLEAN_OLDER_THAN_HOURS = 'webapi_logs/log/clean_older_than_hours';
@@ -25,6 +29,14 @@ public function isEnabled(): bool
         return $this->scopeConfig->isSetFlag(self::WEBAPI_LOGS_IS_ENABLED, ScopeInterface::SCOPE_WEBSITE);
     }
 
+    public function getSaveModes(): array
+    {
+        return array_map(
+            static fn (string $saveMode): SaveMode => SaveMode::from($saveMode),
+            $this->scopeConfig->getValue(self::WEBAPI_LOGS_SAVE_MODES)
+        );
+    }
+
     public function isSecretMode(): bool
     {
         return $this->scopeConfig->isSetFlag(self::WEBAPI_LOGS_LOG_SECRET_MODE, ScopeInterface::SCOPE_WEBSITE);
diff --git a/Model/Config/SaveMode.php b/Model/Config/SaveMode.php
@@ -0,0 +1,40 @@
+<?php
+/**
+ * Copyright © OpenGento, All rights reserved.
+ * See LICENSE bundled with this library for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Opengento\WebapiLogger\Model\Config;
+
+use Magento\Framework\Phrase;
+
+use function array_map;
+
+enum SaveMode: string
+{
+    private const PSR = 'psr';
+    private const DATABASE = 'database';
+
+    private const LABELS = [
+        self::PSR => 'PSR Logger',
+        self::DATABASE => 'Database'
+    ];
+
+    case Psr = self::PSR;
+    case DataBase = self::DATABASE;
+
+    public function getLabel(): Phrase
+    {
+        return new Phrase(self::LABELS[$this->value] ?? $this->name);
+    }
+
+    public static function toOptionArray(): array
+    {
+        return array_map(
+            static fn (self $saveMode): array => ['label' => $saveMode->getLabel(), 'value' => $saveMode->value],
+            self::cases()
+        );
+    }
+}
diff --git a/Model/Config/Source/Code.php b/Model/Config/Source/Code.php
@@ -8,9 +8,9 @@
 
 namespace Opengento\WebapiLogger\Model\Config\Source;
 
+use Magento\Framework\Data\OptionSourceInterface;
 use Opengento\WebapiLogger\Model\ResourceModel\Entity\LogCollection;
 use Opengento\WebapiLogger\Model\ResourceModel\Entity\LogCollectionFactory;
-use Magento\Framework\Data\OptionSourceInterface;
 
 class Code implements OptionSourceInterface
 {
diff --git a/Model/Config/Source/Methods.php b/Model/Config/Source/Methods.php
@@ -8,9 +8,9 @@
 
 namespace Opengento\WebapiLogger\Model\Config\Source;
 
+use Magento\Framework\Data\OptionSourceInterface;
 use Opengento\WebapiLogger\Model\ResourceModel\Entity\LogCollection;
 use Opengento\WebapiLogger\Model\ResourceModel\Entity\LogCollectionFactory;
-use Magento\Framework\Data\OptionSourceInterface;
 
 class Methods implements OptionSourceInterface
 {
diff --git a/Model/Config/Source/RequestorIp.php b/Model/Config/Source/RequestorIp.php
@@ -8,9 +8,9 @@
 
 namespace Opengento\WebapiLogger\Model\Config\Source;
 
+use Magento\Framework\Data\OptionSourceInterface;
 use Opengento\WebapiLogger\Model\ResourceModel\Entity\LogCollection;
 use Opengento\WebapiLogger\Model\ResourceModel\Entity\LogCollectionFactory;
-use Magento\Framework\Data\OptionSourceInterface;
 
 class RequestorIp implements OptionSourceInterface
 {
diff --git a/Model/Config/Source/SaveModes.php b/Model/Config/Source/SaveModes.php
@@ -0,0 +1,22 @@
+<?php
+/**
+ * Copyright © OpenGento, All rights reserved.
+ * See LICENSE bundled with this library for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Opengento\WebapiLogger\Model\Config\Source;
+
+use Magento\Framework\Data\OptionSourceInterface;
+use Opengento\WebapiLogger\Model\Config\SaveMode;
+
+class SaveModes implements OptionSourceInterface
+{
+    private ?array $options = null;
+
+    public function toOptionArray(): array
+    {
+        return $this->options ??= SaveMode::toOptionArray();
+    }
+}
diff --git a/Model/Log.php b/Model/Log.php
@@ -8,8 +8,8 @@
 
 namespace Opengento\WebapiLogger\Model;
 
-use Opengento\WebapiLogger\Model\ResourceModel\LogResourceModel;
 use Magento\Framework\Model\AbstractModel;
+use Opengento\WebapiLogger\Model\ResourceModel\LogResourceModel;
 
 class Log extends AbstractModel
 {
diff --git a/Model/LogHandle.php b/Model/LogHandle.php
@@ -9,7 +9,6 @@
 namespace Opengento\WebapiLogger\Model;
 
 use Exception;
-use Opengento\WebapiLogger\Model\ResourceModel\LogResourceModel;
 use Psr\Log\LoggerInterface;
 
 class LogHandle
@@ -18,9 +17,9 @@ class LogHandle
 
     public function __construct(
         private LogFactory $logFactory,
-        private LogResourceModel $logResourceModel,
         private SecretParser $secretParser,
         private Config $config,
+        private LoggerManager $loggerManager,
         private LoggerInterface $logger
     ) {}
 
@@ -31,7 +30,7 @@ public function before(
         string $requestHeaders,
         string $requestBody,
         string $requestDateTime
-    ) {
+    ): void {
         try {
             if ($this->config->isSecretMode()) {
                 $requestorIp = $this->secretParser->parseIp();
@@ -41,40 +40,43 @@ public function before(
 
             $log = $this->logFactory->create();
             $log->setData([
+                'is_request' => true,
                 'request_method' => $requestMethod,
                 'requestor_ip' => $requestorIp,
                 'request_url' => $requestPath,
                 'request_headers' => $requestHeaders,
                 'request_body' => $requestBody,
                 'request_datetime' => $requestDateTime
             ]);
-            $this->logResourceModel->save($log);
+            $this->loggerManager->log($log);
             $this->lastLog = $log;
         } catch (Exception $exception) {
-            $this->logger->error(__('Cant complete webapi log save because of error: %1', $exception->getMessage()));
+            $this->logger->error('Cant complete webapi log save because of error: ' . $exception->getMessage());
         }
     }
 
     public function after(
         string $responseCode,
         string $responseBody,
         string $responseDateTime
-    ) {
-        if (!$this->lastLog) {
-            return;
-        }
+    ): void {
+        if ($this->lastLog) {
+            try {
+                if ($this->config->isSecretMode()) {
+                    $responseBody = $this->secretParser->parseBody($responseBody);
+                }
 
-        try {
-            if ($this->config->isSecretMode()) {
-                $responseBody = $this->secretParser->parseBody($responseBody);
+                $this->lastLog->unsetData('is_request');
+                $this->lastLog->addData([
+                    'is_response' => true,
+                    'response_body' => $responseBody,
+                    'response_code' => $responseCode,
+                    'response_datetime' => $responseDateTime
+                ]);
+                $this->loggerManager->log($log);
+            } catch (Exception $exception) {
+                $this->logger->error('Cant complete webapi log save because of error: ' . $exception->getMessage());
             }
-
-            $this->lastLog->setResponseBody($responseBody);
-            $this->lastLog->setResponseCode($responseCode);
-            $this->lastLog->setResponseDatetime($responseDateTime);
-            $this->logResourceModel->save($this->lastLog);
-        } catch (Exception $exception) {
-            $this->logger->error(__('Cant complete webapi log save because of error: %1', $exception->getMessage()));
         }
     }
 }
diff --git a/Model/LoggerManager.php b/Model/LoggerManager.php
@@ -0,0 +1,60 @@
+<?php
+/**
+ * Copyright © OpenGento, All rights reserved.
+ * See LICENSE bundled with this library for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Opengento\WebapiLogger\Model;
+
+use Magento\Framework\Exception\AlreadyExistsException;
+use Opengento\WebapiLogger\Model\Config\SaveMode;
+use Opengento\WebapiLogger\Model\ResourceModel\LogResourceModel;
+use Psr\Log\LoggerInterface;
+
+use function in_array;
+
+class LoggerManager
+{
+    public function __construct(
+        private LogResourceModel $logResourceModel,
+        private Config $config,
+        private LoggerInterface $logger
+    ) {}
+
+    /**
+     * @throws AlreadyExistsException
+     */
+    public function log(Log $log): void
+    {
+        $saveModes = $this->config->getSaveModes();
+
+        if (in_array(SaveMode::Psr, $saveModes, true)) {
+            $this->savePsr($log);
+        }
+        if (in_array(SaveMode::DataBase, $saveModes, true)) {
+            $this->saveDb($log);
+        }
+    }
+
+    private function savePsr(Log $log): void
+    {
+        $this->logger->debug(
+            match(true) {
+                $log->getData('is_response') => 'Logged WEBAPI Response',
+                $log->getData('is_request') => 'Logged WEBAPI Request',
+                default => 'n/a',
+            },
+            $log->toArray()
+        );
+    }
+
+    /**
+     * @throws AlreadyExistsException
+     */
+    private function saveDb(Log $log): void
+    {
+        $this->logResourceModel->save($log);
+    }
+}
diff --git a/Model/ResourceModel/Entity/LogCollection.php b/Model/ResourceModel/Entity/LogCollection.php
@@ -8,9 +8,9 @@
 
 namespace Opengento\WebapiLogger\Model\ResourceModel\Entity;
 
+use Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection;
 use Opengento\WebapiLogger\Model\Log;
 use Opengento\WebapiLogger\Model\ResourceModel\LogResourceModel;
-use Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection;
 
 class LogCollection extends AbstractCollection
 {
diff --git a/Plugin/FrontControllerDispatch.php b/Plugin/FrontControllerDispatch.php
@@ -8,11 +8,11 @@
 
 namespace Opengento\WebapiLogger\Plugin;
 
-use Opengento\WebapiLogger\Model\Config;
-use Opengento\WebapiLogger\Model\LogHandle;
 use Magento\Framework\App\RequestInterface;
 use Magento\Framework\Stdlib\DateTime\DateTime;
 use Magento\Webapi\Controller\Rest;
+use Opengento\WebapiLogger\Model\Config;
+use Opengento\WebapiLogger\Model\LogHandle;
 
 class FrontControllerDispatch
 {
@@ -25,20 +25,13 @@ public function __construct(
     public function beforeDispatch(Rest $subject, RequestInterface $request): array
     {
         if ($this->config->isEnabled() && !$request->isXmlHttpRequest()) {
-            $requestMethod = $request->getMethod();
-            $requestorIp = $request->getClientIp();
-            $requestPath = $request->getUriString();
-            $requestHeaders = $request->getHeaders()->toString();
-            $requestBody = $request->getContent();
-            $requestDateTime = $this->date->gmtDate();
-
             $this->logHandle->before(
-                $requestMethod,
-                $requestorIp,
-                $requestPath,
-                $requestHeaders,
-                $requestBody,
-                $requestDateTime
+                $request->getMethod(),
+                $request->getClientIp(),
+                $request->getUriString(),
+                $request->getHeaders()->toString(),
+                $request->getContent(),
+                $this->date->gmtDate()
             );
         }
 
@@ -65,8 +58,7 @@ public function afterDispatch(Rest $subject, $result, RequestInterface $request)
                 $responseBody = trim($responseBody, '"');
             }
 
-            $responseDateTime = $this->date->gmtDate();
-            $this->logHandle->after($responseCode, $responseBody, $responseDateTime);
+            $this->logHandle->after($responseCode, $responseBody, $this->date->gmtDate());
         }
 
         return $result;
diff --git a/Ui/Component/Listing/Column/Actions.php b/Ui/Component/Listing/Column/Actions.php
@@ -9,10 +9,10 @@
 namespace Opengento\WebapiLogger\Ui\Component\Listing\Column;
 
 use Magento\Framework\Phrase;
+use Magento\Framework\UrlInterface;
 use Magento\Framework\View\Element\UiComponent\ContextInterface;
 use Magento\Framework\View\Element\UiComponentFactory;
 use Magento\Ui\Component\Listing\Columns\Column;
-use Magento\Framework\UrlInterface;
 
 class Actions extends Column
 {
diff --git a/ViewModel/Detail.php b/ViewModel/Detail.php
@@ -8,11 +8,11 @@
 
 namespace Opengento\WebapiLogger\ViewModel;
 
+use Magento\Framework\App\RequestInterface;
+use Magento\Framework\View\Element\Block\ArgumentInterface;
 use Opengento\WebapiLogger\Model\Log;
 use Opengento\WebapiLogger\Model\LogFactory;
 use Opengento\WebapiLogger\Model\ResourceModel\LogResourceModel;
-use Magento\Framework\App\RequestInterface;
-use Magento\Framework\View\Element\Block\ArgumentInterface;
 
 class Detail implements ArgumentInterface
 {
diff --git a/composer.json b/composer.json
@@ -13,7 +13,7 @@
         "log"
     ],
     "require": {
-        "php": "^8.0",
+        "php": "^8.1",
         "psr/log": "*",
         "magento/framework": "*",
         "magento/module-webapi": "*"
diff --git a/etc/adminhtml/menu.xml b/etc/adminhtml/menu.xml
diff --git a/etc/adminhtml/system.xml b/etc/adminhtml/system.xml
diff --git a/etc/config.xml b/etc/config.xml
diff --git a/etc/di.xml b/etc/di.xml

Original file line number	Diff line number	Diff line change
`@@ -8,9 +8,9 @@`
`8`	`8`
`9`	`9`	`namespace Opengento\WebapiLogger\Model\Config\Source;`
`10`	`10`
	`11`	`+use Magento\Framework\Data\OptionSourceInterface;`
`11`	`12`	`use Opengento\WebapiLogger\Model\ResourceModel\Entity\LogCollection;`
`12`	`13`	`use Opengento\WebapiLogger\Model\ResourceModel\Entity\LogCollectionFactory;`
`13`		`-use Magento\Framework\Data\OptionSourceInterface;`
`14`	`14`
`15`	`15`	`class Code implements OptionSourceInterface`
`16`	`16`	`{`
Original file line number	Diff line number	Diff line change
`@@ -8,8 +8,8 @@`
`8`	`8`
`9`	`9`	`namespace Opengento\WebapiLogger\Model;`
`10`	`10`
`11`		`-use Opengento\WebapiLogger\Model\ResourceModel\LogResourceModel;`
`12`	`11`	`use Magento\Framework\Model\AbstractModel;`
	`12`	`+use Opengento\WebapiLogger\Model\ResourceModel\LogResourceModel;`
`13`	`13`
`14`	`14`	`class Log extends AbstractModel`
`15`	`15`	`{`