MAGE-1112: add price attribute notice

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,32 @@ 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>';
+
+        $this->notices[] = [
+            'selector' => '.entry-edit',
+            'method' => 'before',
+            'message' => $this->formatNotice($noticeTitle, $noticeContent),
+        ];
+    }
 }

Service/Product/RecordBuilder.php

@@ -190,13 +190,7 @@ protected function addAttribute($attribute, $defaultData, $customData, $addition
      */
     public function isAttributeEnabled($additionalAttributes, $attributeName): bool
     {
-        foreach ($additionalAttributes as $attr) {
-            if ($attr['attribute'] === $attributeName) {
-                return true;
-            }
-        }
-
-        return false;
+        return $this->configHelper->isAttributeInList($additionalAttributes, $attributeName);
     }
 
     /**
@@ -205,7 +199,7 @@ public function isAttributeEnabled($additionalAttributes, $attributeName): bool
      */
     protected function isPriceIndexingEnabled(array $additionalAttributes): bool
     {
-        return $this->isAttributeEnabled($additionalAttributes, 'price');
+        return $this->configHelper->isAttributeInList($additionalAttributes, 'price');
     }
 
     /**