Merge pull request #1756 from algolia/feat/MAGE-1272-concrete-injectable-logger

MAGE-1272 Concrete injectable logger

Author: cammonro

Api/LoggerInterface.php

@@ -0,0 +1,4 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Api;
+interface LoggerInterface extends \Psr\Log\LoggerInterface {}

Logger/AlgoliaLogger.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Logger;
+
+use Algolia\AlgoliaSearch\Api\LoggerInterface;
+use Monolog\Logger;
+
+class AlgoliaLogger extends Logger implements LoggerInterface {}

Logger/TimedLogger.php

@@ -2,9 +2,9 @@
 
 namespace Algolia\AlgoliaSearch\Logger;
 
+use Algolia\AlgoliaSearch\Api\LoggerInterface;
 use Algolia\AlgoliaSearch\Exception\DiagnosticsException;
 use Monolog\Logger;
-use Psr\Log\LoggerInterface;
 
 class TimedLogger
 {

Observer/Insights/CheckoutCartProductAddAfter.php

@@ -2,6 +2,7 @@
 
 namespace Algolia\AlgoliaSearch\Observer\Insights;
 
+use Algolia\AlgoliaSearch\Api\LoggerInterface;
 use Algolia\AlgoliaSearch\Exceptions\AlgoliaException;
 use Algolia\AlgoliaSearch\Helper\ConfigHelper;
 use Algolia\AlgoliaSearch\Helper\Configuration\PersonalizationHelper;
@@ -13,7 +14,6 @@
 use Magento\Framework\Event\ObserverInterface;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Quote\Model\Quote\Item;
-use Psr\Log\LoggerInterface;
 
 class CheckoutCartProductAddAfter implements ObserverInterface
 {

Observer/Insights/CheckoutOnePageControllerSuccessAction.php

@@ -2,6 +2,7 @@
 
 namespace Algolia\AlgoliaSearch\Observer\Insights;
 
+use Algolia\AlgoliaSearch\Api\LoggerInterface;
 use Algolia\AlgoliaSearch\Exceptions\AlgoliaException;
 use Algolia\AlgoliaSearch\Helper\Entity\ProductHelper;
 use Algolia\AlgoliaSearch\Helper\InsightsHelper;
@@ -11,7 +12,6 @@
 use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Sales\Model\Order;
 use Magento\Sales\Model\OrderFactory;
-use Psr\Log\LoggerInterface;
 
 class CheckoutOnePageControllerSuccessAction implements ObserverInterface
 {

Observer/Insights/WishlistProductAddAfter.php

@@ -2,13 +2,13 @@
 
 namespace Algolia\AlgoliaSearch\Observer\Insights;
 
+use Algolia\AlgoliaSearch\Api\LoggerInterface;
 use Algolia\AlgoliaSearch\Helper\Configuration\PersonalizationHelper;
 use Algolia\AlgoliaSearch\Helper\Entity\ProductHelper;
 use Algolia\AlgoliaSearch\Helper\InsightsHelper;
 use Magento\Framework\Event\Observer;
 use Magento\Framework\Event\ObserverInterface;
 use Magento\Wishlist\Model\Item;
-use Psr\Log\LoggerInterface;
 
 class WishlistProductAddAfter implements ObserverInterface
 {

Observer/RecommendSettings.php

@@ -3,6 +3,7 @@
 
 namespace Algolia\AlgoliaSearch\Observer;
 
+use Algolia\AlgoliaSearch\Api\LoggerInterface;
 use Algolia\AlgoliaSearch\Api\RecommendManagementInterface;
 use Algolia\AlgoliaSearch\Helper\ConfigHelper;
 use Magento\Catalog\Api\ProductRepositoryInterface;
@@ -14,7 +15,6 @@
 use Magento\Framework\Event\ObserverInterface;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Message\ManagerInterface as MessageManagerInterface;
-use Psr\Log\LoggerInterface;
 
 class RecommendSettings implements ObserverInterface
 {

Setup/Patch/Data/RebuildReplicasPatch.php

@@ -2,9 +2,9 @@
 
 namespace Algolia\AlgoliaSearch\Setup\Patch\Data;
 
+use Algolia\AlgoliaSearch\Api\LoggerInterface;
 use Algolia\AlgoliaSearch\Exceptions\AlgoliaException;
 use Algolia\AlgoliaSearch\Exceptions\ExceededRetriesException;
-use Algolia\AlgoliaSearch\Helper\ConfigHelper;
 use Algolia\AlgoliaSearch\Helper\Entity\ProductHelper;
 use Algolia\AlgoliaSearch\Registry\ReplicaState;
 use Algolia\AlgoliaSearch\Service\AlgoliaCredentialsManager;
@@ -16,7 +16,6 @@
 use Magento\Framework\Setup\Patch\DataPatchInterface;
 use Magento\Framework\Setup\Patch\PatchInterface;
 use Magento\Store\Model\StoreManagerInterface;
-use Psr\Log\LoggerInterface;
 
 class RebuildReplicasPatch implements DataPatchInterface
 {

Test/Unit/Logger/AlgoliaLoggerTest.php

@@ -2,24 +2,24 @@
 
 namespace Algolia\AlgoliaSearch\Test\Unit\Logger;
 
+use Algolia\AlgoliaSearch\Logger\AlgoliaLogger;
 use Algolia\AlgoliaSearch\Logger\Handler\AlgoliaLoggerHandler;
 use Algolia\AlgoliaSearch\Logger\Handler\SystemLoggerHandler;
-use Monolog\Logger;
 use PHPUnit\Framework\TestCase;
 use Psr\Log\LoggerInterface;
 
 class AlgoliaLoggerTest extends TestCase
 {
-    protected LoggerInterface $algoliaLogger;
-    protected SystemLoggerHandler $systemLoggerHandler;
-    protected AlgoliaLoggerHandler $algoliaLoggerHandler;
+    protected ?LoggerInterface $algoliaLogger;
+    protected ?SystemLoggerHandler $systemLoggerHandler;
+    protected ?AlgoliaLoggerHandler $algoliaLoggerHandler;
 
     protected function setUp(): void
     {
         $this->systemLoggerHandler = $this->createMock(SystemLoggerHandler::class);
         $this->algoliaLoggerHandler = $this->createMock(AlgoliaLoggerHandler::class);
 
-        $this->algoliaLogger = new Logger(
+        $this->algoliaLogger = new AlgoliaLogger(
             'algolia',
             [ $this->systemLoggerHandler, $this->algoliaLoggerHandler ]
         );

etc/di.xml

@@ -252,24 +252,14 @@
     </type>
     <!-- custom indexers END -->
 
-    <virtualType name="Algolia\AlgoliaSearch\Logger\AlgoliaLogger" type="Monolog\Logger">
+    <type name="Algolia\AlgoliaSearch\Logger\AlgoliaLogger">
         <arguments>
             <argument name="name" xsi:type="string">algolia</argument>
             <argument name="handlers" xsi:type="array">
                 <item name="system" xsi:type="object">Algolia\AlgoliaSearch\Logger\Handler\SystemLoggerHandler</item>
                 <item name="custom" xsi:type="object">Algolia\AlgoliaSearch\Logger\Handler\AlgoliaLoggerHandler</item>
             </argument>
         </arguments>
-    </virtualType>
-    <type name="Algolia\AlgoliaSearch\Logger\TimedLogger">
-        <arguments>
-            <argument name="logger" xsi:type="object">Algolia\AlgoliaSearch\Logger\AlgoliaLogger</argument>
-        </arguments>
-    </type>
-
-    <type name="\Algolia\AlgoliaSearch\Observer\RecommendSettings">
-        <arguments>
-            <argument name="logger" xsi:type="object">Algolia\AlgoliaSearch\Logger\AlgoliaLogger</argument>
-        </arguments>
     </type>
+    <preference for="Algolia\AlgoliaSearch\Api\LoggerInterface" type="Algolia\AlgoliaSearch\Logger\AlgoliaLogger"/>
 </config>