MAGE-941 Refactor observers to use entity specific helper to centralize index name fetching logic

Author: cammonro

Observer/Insights/CheckoutCartProductAddAfter.php

@@ -5,7 +5,7 @@
 use Algolia\AlgoliaSearch\Exceptions\AlgoliaException;
 use Algolia\AlgoliaSearch\Helper\ConfigHelper;
 use Algolia\AlgoliaSearch\Helper\Configuration\PersonalizationHelper;
-use Algolia\AlgoliaSearch\Helper\Data;
+use Algolia\AlgoliaSearch\Helper\Entity\ProductHelper;
 use Algolia\AlgoliaSearch\Helper\InsightsHelper;
 use Magento\Catalog\Model\Product;
 use Magento\Framework\App\RequestInterface;
@@ -20,14 +20,8 @@ class CheckoutCartProductAddAfter implements ObserverInterface
     protected ConfigHelper $configHelper;
     protected PersonalizationHelper $personalizationHelper;
 
-    /**
-     * @param Data $dataHelper
-     * @param InsightsHelper $insightsHelper
-     * @param RequestInterface $request
-     * @param LoggerInterface $logger
-     */
     public function __construct(
-        protected Data $dataHelper,
+        protected ProductHelper $productHelper,
         protected InsightsHelper $insightsHelper,
         protected RequestInterface $request,
         protected LoggerInterface $logger
@@ -86,7 +80,7 @@ public function execute(Observer $observer): void
             try {
                 $eventsModel->convertAddToCart(
                     __('Added to Cart'),
-                    $this->dataHelper->getIndexName('_products', $storeId),
+                    $this->productHelper->getIndexName($storeId),
                     $quoteItem,
                     // A queryID should *only* be sent for conversions
                     // See https://www.algolia.com/doc/guides/sending-events/concepts/event-types/

Observer/Insights/CheckoutOnePageControllerSuccessAction.php

@@ -3,7 +3,7 @@
 namespace Algolia\AlgoliaSearch\Observer\Insights;
 
 use Algolia\AlgoliaSearch\Exceptions\AlgoliaException;
-use Algolia\AlgoliaSearch\Helper\Data;
+use Algolia\AlgoliaSearch\Helper\Entity\ProductHelper;
 use Algolia\AlgoliaSearch\Helper\InsightsHelper;
 use Magento\Framework\Event\Observer;
 use Magento\Framework\Event\ObserverInterface;
@@ -18,14 +18,8 @@ class CheckoutOnePageControllerSuccessAction implements ObserverInterface
     /** @var string  */
     public const PLACE_ORDER_EVENT_NAME = 'Placed order';
 
-    /**
-     * @param Data $dataHelper
-     * @param InsightsHelper $insightsHelper
-     * @param OrderFactory $orderFactory
-     * @param LoggerInterface $logger
-     */
     public function __construct(
-        protected Data $dataHelper,
+        protected ProductHelper $productHelper,
         protected InsightsHelper $insightsHelper,
         protected OrderFactory $orderFactory,
         protected LoggerInterface $logger
@@ -52,7 +46,7 @@ public function execute(Observer $observer): void
 
         $indexName = "";
         try {
-            $indexName = $this->dataHelper->getIndexName('_products', $order->getStoreId());
+            $indexName = $this->productHelper->getIndexName($order->getStoreId());
         } catch (NoSuchEntityException $e) {
             $this->logger->error("No store found for order: " . $e->getMessage());
             return;

Observer/Insights/WishlistProductAddAfter.php

@@ -3,7 +3,7 @@
 namespace Algolia\AlgoliaSearch\Observer\Insights;
 
 use Algolia\AlgoliaSearch\Helper\Configuration\PersonalizationHelper;
-use Algolia\AlgoliaSearch\Helper\Data;
+use Algolia\AlgoliaSearch\Helper\Entity\ProductHelper;
 use Algolia\AlgoliaSearch\Helper\InsightsHelper;
 use Magento\Framework\Event\Observer;
 use Magento\Framework\Event\ObserverInterface;
@@ -13,16 +13,8 @@
 class WishlistProductAddAfter implements ObserverInterface
 {
 
-    /**
-     * CheckoutCartProductAddAfter constructor.
-     *
-     * @param Data $dataHelper
-     * @param PersonalizationHelper $personalisationHelper
-     * @param InsightsHelper $insightsHelper
-     * @param LoggerInterface $logger
-     */
     public function __construct(
-        protected Data                  $dataHelper,
+        protected ProductHelper         $productHelper,
         protected PersonalizationHelper $personalisationHelper,
         protected InsightsHelper        $insightsHelper,
         protected LoggerInterface       $logger
@@ -51,7 +43,7 @@ public function execute(Observer $observer): void
         try {
             $eventsModel->convertedObjectIDs(
                 __('Added to Wishlist'),
-                $this->dataHelper->getIndexName('_products', $firstItem->getStoreId()),
+                $this->productHelper->getIndexName($firstItem->getStoreId()),
                 $productIds
             );
         } catch (\Exception $e) {