Merge pull request #1781 from algolia/feat/MAGE-1112-price-indexing

MAGE-1112: Make `price` attribute optional during product indexing

Author: damcou

Helper/ConfigHelper.php

@@ -1068,17 +1068,42 @@ public function getAttributesToRetrieve($groupId)
         return ['attributesToRetrieve' => $attributes];
     }
 
+    /**
+     * @param $attributes
+     * @param $attributeName
+     * @return bool
+     */
+    public function isAttributeInList($attributes, $attributeName): bool
+    {
+        foreach ($attributes as $attr) {
+            if ($attr['attribute'] === $attributeName) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
     /**
      * @param $storeId
-     * @return array
+     * @return mixed
      */
-    public function getProductAdditionalAttributes($storeId = null)
+    public function getProductAttributesList($storeId = null)
     {
-        $attributes = $this->serializer->unserialize($this->configInterface->getValue(
+        return $this->serializer->unserialize($this->configInterface->getValue(
             self::PRODUCT_ATTRIBUTES,
             ScopeInterface::SCOPE_STORE,
             $storeId
         ));
+    }
+
+    /**
+     * @param $storeId
+     * @return array
+     */
+    public function getProductAdditionalAttributes($storeId = null)
+    {
+        $attributes = $this->getProductAttributesList($storeId);
 
         $facets = $this->serializer->unserialize($this->configInterface->getValue(
             self::FACETS,

Helper/Configuration/NoticeHelper.php

@@ -23,6 +23,7 @@ class NoticeHelper extends \Magento\Framework\App\Helper\AbstractHelper
         'getRecommendNotice',
         'getCookieConfigurationNotice',
         'getMultiApplicationIDsNotice',
+        'getPriceIndexingNotice',
     ];
 
     /** @var array[] */
@@ -189,8 +190,8 @@ protected function getClickAnalyticsNotice()
         ];
     }
 
-   protected function getCookieConfigurationNotice()
-   {
+    protected function getCookieConfigurationNotice()
+    {
         $noticeContent = '';
         $selector = '';
         $method = 'after';
@@ -363,4 +364,33 @@ protected function getMultiApplicationIDsNotice(): void
             'message' => $this->formatNotice($noticeTitle, $noticeContent),
         ];
     }
+
+
+    /**
+     * This notice serves as a warning when user removes the price attribute from the attributes list but it's still present either in the sortings or in the facets
+     * @return void
+     */
+    protected function getPriceIndexingNotice(): void
+    {
+        $attributesToIndex = $this->configHelper->getProductAdditionalAttributes();
+        $attributesList = $this->configHelper->getProductAttributesList();
+
+        // we want to display the warning only if price is not present in the attribute list but is present somewhere else
+        if (!($this->configHelper->isAttributeInList($attributesToIndex, 'price')
+            && !$this->configHelper->isAttributeInList($attributesList, 'price'))
+        ) {
+            return;
+        }
+
+        $noticeTitle = 'Price attribute indexing';
+        $noticeContent = '<p>Price attribute has been removed from the product attributes list but is still present in the facets, sortings or custom rankings lists.</p>
+        <p>If you want to remove prices from the product records, you need to remove them from those lists as well.</p>
+        <p>If you want the prices to be included in the product records, you need to add the price attribute in the product attributes list in the "Products" section of the configuration.</p>';
+
+        $this->notices[] = [
+            'selector' => '.entry-edit',
+            'method' => 'before',
+            'message' => $this->formatNotice($noticeTitle, $noticeContent),
+        ];
+    }
 }

Service/Product/RecordBuilder.php

@@ -123,7 +123,11 @@ public function buildRecord(DataObject $entity): array
         }
         $subProducts = $this->getSubProducts($product);
         $customData = $this->addAdditionalAttributes($customData, $additionalAttributes, $product, $subProducts);
-        $customData = $this->priceManager->addPriceDataByProductType($customData, $product, $subProducts);
+
+        if ($this->isPriceIndexingEnabled($additionalAttributes)) {
+            $customData = $this->priceManager->addPriceDataByProductType($customData, $product, $subProducts);
+        }
+
         $transport = new DataObject($customData);
         $this->eventManager->dispatch(
             'algolia_subproducts_index',
@@ -186,13 +190,16 @@ protected function addAttribute($attribute, $defaultData, $customData, $addition
      */
     public function isAttributeEnabled($additionalAttributes, $attributeName): bool
     {
-        foreach ($additionalAttributes as $attr) {
-            if ($attr['attribute'] === $attributeName) {
-                return true;
-            }
-        }
+        return $this->configHelper->isAttributeInList($additionalAttributes, $attributeName);
+    }
 
-        return false;
+    /**
+     * @param array $additionalAttributes
+     * @return bool
+     */
+    protected function isPriceIndexingEnabled(array $additionalAttributes): bool
+    {
+        return $this->configHelper->isAttributeInList($additionalAttributes, 'price');
     }
 
     /**
@@ -816,3 +823,4 @@ public function productIsInStock($product, $storeId): bool
         return $product->isSaleable() && $stockItem->getIsInStock();
     }
 }
+

Test/Integration/Indexing/Product/ProductsIndexingTest.php

@@ -70,7 +70,7 @@ public function testDefaultIndexableAttributes()
             'thumbnail_url',
             'image_url',
             'in_stock',
-            'price',
+            //'price', since version 3.17.0, the price attribute is not mandatory if it's not present in any attributes list
             'type_id',
             'algoliaLastUpdateAtCET',
             'categoryIds',
@@ -85,6 +85,8 @@ public function testDefaultIndexableAttributes()
             unset($hit[$attribute]);
         }
 
+        $this->assertArrayNotHasKey('price', $hit, 'Record has a price attribute but it should not');
+
         $extraAttributes = implode(', ', array_keys($hit));
         $this->assertEmpty($hit, 'Extra products attributes (' . $extraAttributes . ') are indexed and should not be.');
     }