FFWEB-2840: Introduce improve logging

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
+##  Unreleased
+### Add
+- Add campaigns to category view page
+- Improve logging system
+
 ## [v4.2.1] - 2023.09.25
+### Fix
 - Fix problem with ssr/record-list.phtml template
 
 ## [v4.2.0] - 2023.09.18

src/Controller/Adminhtml/TestConnection/TestConnection.php

@@ -10,6 +10,7 @@
 use Omikron\FactFinder\Communication\Client\ClientBuilder;
 use Omikron\FactFinder\Communication\Credentials;
 use Omikron\FactFinder\Communication\Resource\AdapterFactory;
+use Omikron\Factfinder\Logger\FactFinderLogger;
 use Omikron\Factfinder\Model\Api\CredentialsFactory;
 use Omikron\Factfinder\Model\Config\AuthConfig;
 use Psr\Http\Client\ClientExceptionInterface;
@@ -21,19 +22,22 @@ class TestConnection extends Action
     private CredentialsFactory $credentialsFactory;
     private AuthConfig $authConfig;
     private ClientBuilder $clientBuilder;
+    private FactFinderLogger $logger;
 
     public function __construct(
         Action\Context $context,
         JsonFactory $jsonResultFactory,
         CredentialsFactory $credentialsFactory,
         AuthConfig $authConfig,
-        ClientBuilder $clientBuilder
+        ClientBuilder $clientBuilder,
+        FactFinderLogger $logger
     ) {
         parent::__construct($context);
         $this->jsonResultFactory  = $jsonResultFactory;
         $this->credentialsFactory = $credentialsFactory;
         $this->authConfig         = $authConfig;
         $this->clientBuilder      = $clientBuilder;
+        $this->logger = $logger;
     }
 
     public function execute()
@@ -54,6 +58,10 @@ public function execute()
 
             $message = new Phrase('Connection successfully established.');
         } catch (ClientExceptionInterface $e) {
+            $this->logger->error(new Phrase(
+                'FACT-Finder response exception: %1, thrown at %2',
+                [$e->getMessage(), $e->getTraceAsString()]
+            ));
             $message = $e->getMessage();
         }
 

src/Controller/Adminhtml/TestConnection/TestFtpConnection.php

@@ -7,6 +7,7 @@
 use Magento\Backend\App\Action;
 use Magento\Framework\Controller\Result\JsonFactory;
 use Magento\Framework\Phrase;
+use Omikron\Factfinder\Logger\FactFinderLogger;
 use Omikron\Factfinder\Model\Config\FtpConfig;
 use Omikron\Factfinder\Model\FtpUploader;
 
@@ -16,17 +17,20 @@ class TestFtpConnection extends Action
     private JsonFactory $jsonResultFactory;
     private FtpUploader $ftpUploader;
     private FtpConfig $ftpConfig;
+    private FactFinderLogger $logger;
 
     public function __construct(
         Action\Context $context,
         JsonFactory $jsonResultFactory,
         FtpUploader $ftpUploader,
-        FtpConfig $ftpConfig
+        FtpConfig $ftpConfig,
+        FactFinderLogger $logger
     ) {
         parent::__construct($context);
         $this->jsonResultFactory = $jsonResultFactory;
         $this->ftpUploader       = $ftpUploader;
         $this->ftpConfig         = $ftpConfig;
+        $this->logger            = $logger;
     }
 
     public function execute()
@@ -38,6 +42,10 @@ public function execute()
             $params  = $this->getConfig($this->getRealValuesFromObscured($request->getParams())) + $this->ftpConfig->toArray();
             $this->ftpUploader->testConnection($params);
         } catch (\Exception $e) {
+            $this->logger->error(new Phrase(
+                'FACT-Finder FTP exception: %1, thrown at %2',
+                [$e->getMessage(), $e->getTraceAsString()]
+            ));
             $message = $e->getMessage();
         }
 

src/Logger/FactFinderLogger.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Omikron\Factfinder\Logger;
+
+class FactFinderLogger extends \Monolog\Logger
+{
+}

src/Logger/Handler/FactFinderErrorHandler.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Omikron\Factfinder\Logger\Handler;
+
+use Magento\Framework\Logger\Handler\Base as BaseHandler;
+use Monolog\Logger as MonologLogger;
+
+class FactFinderErrorHandler extends BaseHandler
+{
+    protected $loggerType = MonologLogger::ERROR;
+    protected $fileName = '/var/log/factfinder.log';
+}

src/Test/Unit/Controller/Adminhtml/TestConnection/TestConnectionTest.php

@@ -11,6 +11,7 @@
 use Omikron\FactFinder\Communication\Client\ClientBuilder;
 use Omikron\FactFinder\Communication\Client\ClientInterface;
 use Omikron\FactFinder\Communication\Credentials;
+use Omikron\Factfinder\Logger\FactFinderLogger;
 use Omikron\Factfinder\Model\Api\CredentialsFactory;
 use Omikron\Factfinder\Model\Config\AuthConfig;
 use PHPUnit\Framework\MockObject\MockObject;
@@ -63,7 +64,8 @@ protected function setUp(): void
             $this->createConfiguredMock(JsonFactory::class, ['create' => $this->createMock(JsonResult::class)]),
             $credentialsFactory,
             $this->createMock(AuthConfig::class),
-            $this->builderMock
+            $this->builderMock,
+            $this->createMock(FactFinderLogger::class)
         );
     }
 }

src/Test/Unit/Controller/Adminhtml/TestConnection/TestFtpConnectionTest.php

@@ -8,6 +8,7 @@
 use Magento\Framework\App\RequestInterface;
 use Magento\Framework\Controller\Result\Json as JsonResult;
 use Magento\Framework\Controller\Result\JsonFactory;
+use Omikron\Factfinder\Logger\FactFinderLogger;
 use Omikron\Factfinder\Model\Config\FtpConfig;
 use Omikron\Factfinder\Model\FtpUploader;
 use PHPUnit\Framework\MockObject\MockObject;
@@ -77,7 +78,8 @@ protected function setUp(): void
             $this->createConfiguredMock(Context::class, ['getRequest' => $this->request]),
             $this->createConfiguredMock(JsonFactory::class, ['create' => $this->jsonResult]),
             $this->ftpUploader,
-            $this->createMock(FtpConfig::class)
+            $this->createMock(FtpConfig::class),
+            $this->createMock(FactFinderLogger::class)
         );
     }
 }

src/etc/di.xml

@@ -232,4 +232,17 @@
             </argument>
         </arguments>
     </type>
+    <type name="Omikron\Factfinder\Logger\Handler\FactFinderErrorHandler">
+        <arguments>
+            <argument name="filesystem" xsi:type="object">Magento\Framework\Filesystem\Driver\File</argument>
+        </arguments>
+    </type>
+    <type name="Omikron\Factfinder\Logger\FactFinderLogger">
+        <arguments>
+            <argument name="name" xsi:type="string">FACT-Finder</argument>
+            <argument name="handlers"  xsi:type="array">
+                <item name="system" xsi:type="object">Omikron\Factfinder\Logger\Handler\FactFinderErrorHandler</item>
+            </argument>
+        </arguments>
+    </type>
 </config>