MAGE-941 Reclassify Events model under Service namespace

cammonro · cammonro · commit e4fb08ce094f · 2024-06-30T18:06:08.000-04:00
diff --git a/Api/Insights/EventsProcessorInterface.php b/Api/Insights/EventsProcessorInterface.php
@@ -9,7 +9,7 @@
 use Magento\Sales\Model\Order;
 use Magento\Store\Model\StoreManagerInterface;
 
-interface EventsInterface
+interface EventsProcessorInterface
 {
     /** @var string */
     public const EVENT_KEY_SUBTYPE = 'eventSubtype';
@@ -37,13 +37,13 @@ interface EventsInterface
     /** @var int */
     public const MAX_EVENTS_PER_REQUEST = 1000;
 
-    public function setInsightsClient(InsightsClient $client): EventsInterface;
+    public function setInsightsClient(InsightsClient $client): EventsProcessorInterface;
 
-    public function setAuthenticatedUserToken(string $token): EventsInterface;
+    public function setAuthenticatedUserToken(string $token): EventsProcessorInterface;
 
-    public function setAnonymousUserToken(string $token): EventsInterface;
+    public function setAnonymousUserToken(string $token): EventsProcessorInterface;
 
-    public function setStoreManager(StoreManagerInterface $storeManager): EventsInterface;
+    public function setStoreManager(StoreManagerInterface $storeManager): EventsProcessorInterface;
 
     /**
      * @param string $eventName
diff --git a/Helper/InsightsHelper.php b/Helper/InsightsHelper.php
@@ -2,8 +2,8 @@
 
 namespace Algolia\AlgoliaSearch\Helper;
 
-use Algolia\AlgoliaSearch\Api\Insights\EventsInterface;
-use Algolia\AlgoliaSearch\Api\Insights\EventsInterfaceFactory;
+use Algolia\AlgoliaSearch\Api\Insights\EventsProcessorInterface;
+use Algolia\AlgoliaSearch\Api\Insights\EventsProcessorInterfaceFactory;
 use Algolia\AlgoliaSearch\Api\InsightsClient;
 use Algolia\AlgoliaSearch\Helper\Configuration\PersonalizationHelper;
 use Magento\Customer\Model\Customer;
@@ -40,31 +40,20 @@ class InsightsHelper
     /** @var InsightsClient|null */
     protected ?InsightsClient $insightsClient = null;
 
-    /** @var EventsInterface|null  */
-    protected ?EventsInterface $eventsModel = null;
+    /** @var EventsProcessorInterface|null  */
+    protected ?EventsProcessorInterface $eventsProcessor = null;
 
-    /**
-     * InsightsHelper constructor.
-     *
-     * @param ConfigHelper $configHelper
-     * @param PersonalizationHelper $personalizationHelper
-     * @param CookieManagerInterface $cookieManager
-     * @param CookieMetadataFactory $cookieMetadataFactory
-     * @param CustomerSession $customerSession
-     * @param EventsInterfaceFactory $eventsFactory
-     * @param StoreManagerInterface $storeManager
-     * @param Logger $logger
-     */
     public function __construct(
-        private readonly ConfigHelper           $configHelper,
-        private readonly PersonalizationHelper  $personalizationHelper,
-        private readonly CookieManagerInterface $cookieManager,
-        private readonly CookieMetadataFactory  $cookieMetadataFactory,
-        private readonly CustomerSession        $customerSession,
-        private readonly EventsInterfaceFactory $eventsFactory,
-        private readonly StoreManagerInterface  $storeManager,
-        private readonly Logger                 $logger
-    ) { }
+        private readonly ConfigHelper                    $configHelper,
+        private readonly PersonalizationHelper           $personalizationHelper,
+        private readonly CookieManagerInterface          $cookieManager,
+        private readonly CookieMetadataFactory           $cookieMetadataFactory,
+        private readonly CustomerSession                 $customerSession,
+        private readonly EventsProcessorInterfaceFactory $eventsProcessorFactory,
+        private readonly StoreManagerInterface           $storeManager,
+        private readonly Logger                          $logger
+    )
+    {}
 
     public function getPersonalizationHelper(): PersonalizationHelper
     {
@@ -93,19 +82,19 @@ public function getInsightsClient(): InsightsClient
     }
 
     /**
-     * @return EventsInterface
+     * @return EventsProcessorInterface
      */
-    public function getEventsModel(): EventsInterface
+    public function getEventsProcessor(): EventsProcessorInterface
     {
-        if (!$this->eventsModel) {
-            $this->eventsModel = $this->eventsFactory->create([
+        if (!$this->eventsProcessor) {
+            $this->eventsProcessor = $this->eventsProcessorFactory->create([
                 'client'                 => $this->getInsightsClient(),
                 'userToken'              => $this->getAnonymousUserToken(),
                 'authenticatedUserToken' => $this->getAuthenticatedUserToken(),
                 'storeManager'           => $this->storeManager
             ]);
         }
-        return $this->eventsModel;
+        return $this->eventsProcessor;
     }
 
     public function getAnonymousUserToken(): string
diff --git a/Observer/Insights/CheckoutCartProductAddAfter.php b/Observer/Insights/CheckoutCartProductAddAfter.php
@@ -21,11 +21,12 @@ class CheckoutCartProductAddAfter implements ObserverInterface
     protected PersonalizationHelper $personalizationHelper;
 
     public function __construct(
-        protected ProductHelper $productHelper,
-        protected InsightsHelper $insightsHelper,
+        protected ProductHelper    $productHelper,
+        protected InsightsHelper   $insightsHelper,
         protected RequestInterface $request,
-        protected LoggerInterface $logger
-    ) {
+        protected LoggerInterface  $logger
+    )
+    {
         $this->configHelper = $this->insightsHelper->getConfigHelper();
         $this->personalizationHelper = $this->insightsHelper->getPersonalizationHelper();
     }
@@ -66,7 +67,7 @@ public function execute(Observer $observer): void
             return;
         }
 
-        $eventsModel = $this->insightsHelper->getEventsModel();
+        $eventsProcessor = $this->insightsHelper->getEventsProcessor();
 
         $queryId = $this->request->getParam('queryID');
 
@@ -78,7 +79,7 @@ public function execute(Observer $observer): void
         // This logic handles both perso and conversion tracking
         if ($isAddToCartTracked) {
             try {
-                $eventsModel->convertAddToCart(
+                $eventsProcessor->convertAddToCart(
                     __('Added to Cart'),
                     $this->productHelper->getIndexName($storeId),
                     $quoteItem,
diff --git a/Observer/Insights/CheckoutOnePageControllerSuccessAction.php b/Observer/Insights/CheckoutOnePageControllerSuccessAction.php
@@ -19,11 +19,12 @@ class CheckoutOnePageControllerSuccessAction implements ObserverInterface
     public const PLACE_ORDER_EVENT_NAME = 'Placed order';
 
     public function __construct(
-        protected ProductHelper $productHelper,
-        protected InsightsHelper $insightsHelper,
-        protected OrderFactory $orderFactory,
+        protected ProductHelper   $productHelper,
+        protected InsightsHelper  $insightsHelper,
+        protected OrderFactory    $orderFactory,
         protected LoggerInterface $logger
-    ) {}
+    )
+    {}
 
     /**
      * @param Observer $observer
@@ -52,10 +53,10 @@ public function execute(Observer $observer): void
             return;
         }
 
-        $eventsModel = $this->insightsHelper->getEventsModel();
+        $eventsProcessor = $this->insightsHelper->getEventsProcessor();
 
         try {
-            $eventsModel->convertPurchase(
+            $eventsProcessor->convertPurchase(
                 __(self::PLACE_ORDER_EVENT_NAME),
                 $indexName,
                 $order
diff --git a/Observer/Insights/WishlistProductAddAfter.php b/Observer/Insights/WishlistProductAddAfter.php
@@ -35,13 +35,13 @@ public function execute(Observer $observer): void
             return;
         }
 
-        $eventsModel = $this->insightsHelper->getEventsModel();
+        $eventsProcessor = $this->insightsHelper->getEventsProcessor();
         $productIds = array_map(function (Item $item) {
             return $item->getProductId();
         }, $items);
 
         try {
-            $eventsModel->convertedObjectIDs(
+            $eventsProcessor->convertedObjectIDs(
                 __('Added to Wishlist'),
                 $this->productHelper->getIndexName($firstItem->getStoreId()),
                 $productIds
diff --git a/Service/Insights/EventsProcessor.php b/Service/Insights/EventsProcessor.php
@@ -1,8 +1,8 @@
 <?php
 
-namespace Algolia\AlgoliaSearch\Model\Insights;
+namespace Algolia\AlgoliaSearch\Service\Insights;
 
-use Algolia\AlgoliaSearch\Api\Insights\EventsInterface;
+use Algolia\AlgoliaSearch\Api\Insights\EventsProcessorInterface;
 use Algolia\AlgoliaSearch\Api\InsightsClient;
 use Algolia\AlgoliaSearch\Exceptions\AlgoliaException;
 use Algolia\AlgoliaSearch\Helper\InsightsHelper;
@@ -12,7 +12,7 @@
 use Magento\Sales\Model\Order\Item as OrderItem;
 use Magento\Store\Model\StoreManagerInterface;
 
-class Events implements EventsInterface
+class EventsProcessor implements EventsProcessorInterface
 {
     /** @var string  */
     protected const NO_QUERY_ID_KEY = '__NO_QUERY_ID__';
@@ -24,25 +24,25 @@ public function __construct(
         protected ?StoreManagerInterface $storeManager = null
     ) {}
 
-    public function setInsightsClient(InsightsClient $client): EventsInterface
+    public function setInsightsClient(InsightsClient $client): EventsProcessorInterface
     {
         $this->client = $client;
         return $this;
     }
 
-    public function setAnonymousUserToken(string $token): EventsInterface
+    public function setAnonymousUserToken(string $token): EventsProcessorInterface
     {
         $this->userToken = $token;
         return $this;
     }
 
-    public function setAuthenticatedUserToken(string $token): EventsInterface
+    public function setAuthenticatedUserToken(string $token): EventsProcessorInterface
     {
         $this->authenticatedUserToken = $token;
         return $this;
     }
 
-    public function setStoreManager(StoreManagerInterface $storeManager): EventsInterface
+    public function setStoreManager(StoreManagerInterface $storeManager): EventsProcessorInterface
     {
         $this->storeManager = $storeManager;
         return $this;
diff --git a/etc/di.xml b/etc/di.xml
@@ -33,7 +33,7 @@
     <!-- Declare implementation for QueueArchiveInterface -->
     <preference for="Algolia\AlgoliaSearch\Api\Data\QueueArchiveInterface" type="Algolia\AlgoliaSearch\Model\QueueArchive" />
 
-    <preference for="Algolia\AlgoliaSearch\Api\Insights\EventsInterface" type="Algolia\AlgoliaSearch\Model\Insights\Events"/>
+    <preference for="Algolia\AlgoliaSearch\Api\Insights\EventsProcessorInterface" type="Algolia\AlgoliaSearch\Service\Insights\EventsProcessor"/>
 
     <preference for="Algolia\AlgoliaSearch\Api\Product\ReplicaManagerInterface" type="Algolia\AlgoliaSearch\Service\Product\ReplicaManager"/>
 

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,8 @@`
`1`	`1`	`<?php`
`2`	`2`
`3`		`-namespace Algolia\AlgoliaSearch\Model\Insights;`
	`3`	`+namespace Algolia\AlgoliaSearch\Service\Insights;`
`4`	`4`
`5`		`-use Algolia\AlgoliaSearch\Api\Insights\EventsInterface;`
	`5`	`+use Algolia\AlgoliaSearch\Api\Insights\EventsProcessorInterface;`
`6`	`6`	`use Algolia\AlgoliaSearch\Api\InsightsClient;`
`7`	`7`	`use Algolia\AlgoliaSearch\Exceptions\AlgoliaException;`
`8`	`8`	`use Algolia\AlgoliaSearch\Helper\InsightsHelper;`
`@@ -12,7 +12,7 @@`
`12`	`12`	`use Magento\Sales\Model\Order\Item as OrderItem;`
`13`	`13`	`use Magento\Store\Model\StoreManagerInterface;`
`14`	`14`
`15`		`-class Events implements EventsInterface`
	`15`	`+class EventsProcessor implements EventsProcessorInterface`
`16`	`16`	`{`
`17`	`17`	`/** @var string */`
`18`	`18`	`protected const NO_QUERY_ID_KEY = '__NO_QUERY_ID__';`
`@@ -24,25 +24,25 @@ public function __construct(`
`24`	`24`	`protected ?StoreManagerInterface $storeManager = null`
`25`	`25`	`) {}`
`26`	`26`
`27`		`- public function setInsightsClient(InsightsClient $client): EventsInterface`
	`27`	`+ public function setInsightsClient(InsightsClient $client): EventsProcessorInterface`
`28`	`28`	`{`
`29`	`29`	`$this->client = $client;`
`30`	`30`	`return $this;`
`31`	`31`	`}`
`32`	`32`
`33`		`- public function setAnonymousUserToken(string $token): EventsInterface`
	`33`	`+ public function setAnonymousUserToken(string $token): EventsProcessorInterface`
`34`	`34`	`{`
`35`	`35`	`$this->userToken = $token;`
`36`	`36`	`return $this;`
`37`	`37`	`}`
`38`	`38`
`39`		`- public function setAuthenticatedUserToken(string $token): EventsInterface`
	`39`	`+ public function setAuthenticatedUserToken(string $token): EventsProcessorInterface`
`40`	`40`	`{`
`41`	`41`	`$this->authenticatedUserToken = $token;`
`42`	`42`	`return $this;`
`43`	`43`	`}`
`44`	`44`
`45`		`- public function setStoreManager(StoreManagerInterface $storeManager): EventsInterface`
	`45`	`+ public function setStoreManager(StoreManagerInterface $storeManager): EventsProcessorInterface`
`46`	`46`	`{`
`47`	`47`	`$this->storeManager = $storeManager;`
`48`	`48`	`return $this;`