MAGE-640 Make category page ID attribute configurable

cammonro · cammonro · commit 018aeaa49755 · 2023-05-11T09:29:17.000-04:00
diff --git a/Helper/ConfigHelper.php b/Helper/ConfigHelper.php
@@ -50,6 +50,7 @@ class ConfigHelper
     public const USE_ADAPTIVE_IMAGE = 'algoliasearch_products/products/use_adaptive_image';
     public const INDEX_OUT_OF_STOCK_OPTIONS = 'algoliasearch_products/products/index_out_of_stock_options';
     public const ENABLE_VISUAL_MERCHANDISING = 'algoliasearch_products/products/enable_visual_merchandising';
+    public const CATEGORY_PAGE_ID_ATTRIBUTE_NAME = 'algoliasearch_products/products/category_page_id_attribute_name';
 
     public const CATEGORY_ATTRIBUTES = 'algoliasearch_categories/categories/category_additional_attributes';
     public const CATEGORY_CUSTOM_RANKING = 'algoliasearch_categories/categories/custom_ranking_category_attributes';
@@ -885,6 +886,15 @@ public function isVisualMerchEnabled($storeId = null): bool
         return $this->configInterface->isSetFlag(self::ENABLE_VISUAL_MERCHANDISING, ScopeInterface::SCOPE_STORE, $storeId);
     }
 
+    /**
+     * @param $storeId
+     * @return string
+     */
+    public function getCategoryPageIdAttributeName($storeId = null): string
+    {
+        return (string) $this->configInterface->getValue(self::CATEGORY_PAGE_ID_ATTRIBUTE_NAME, ScopeInterface::SCOPE_STORE, $storeId);
+    }
+
     /**
      * @param $storeId
      * @return mixed
@@ -1624,4 +1634,4 @@ public function isAutocompleteNavigatorEnabled($storeId = null)
             $storeId
         );
     }
-}
+}
diff --git a/Helper/Entity/ProductHelper.php b/Helper/Entity/ProductHelper.php
@@ -36,7 +36,6 @@
 class ProductHelper
 {
     public const CATEGORY_SEPARATOR = ' /// ';
-    public const CATEGORY_PAGE_ID_ATTRIBUTE = 'categoryPageId';
 
     /**
      * @var CollectionFactory
@@ -852,8 +851,8 @@ protected function addCategoryData(array $algoliaData, Product $product): array
         $algoliaData['categories_without_path'] = $categoryData['categoryNames'];
         $algoliaData['categoryIds'] = array_values(array_unique($categoryData['categoryIds']));
 
-        if ($this->configHelper->isVisualMerchEnabled()) {
-            $algoliaData[self::CATEGORY_PAGE_ID_ATTRIBUTE] = $this->flattenCategoryPaths($categoryData['categoriesWithPath']);
+        if ($this->configHelper->isVisualMerchEnabled($product->getStoreId())) {
+            $algoliaData[$this->configHelper->getCategoryPageIdAttributeName($product->getStoreId())] = $this->flattenCategoryPaths($categoryData['categoriesWithPath']);
         }
 
         return $algoliaData;
@@ -1286,7 +1285,7 @@ protected function getAttributesForFaceting($storeId)
         $attributesForFaceting[] = 'categoryIds';
 
         if ($this->configHelper->isVisualMerchEnabled($storeId)) {
-            $attributesForFaceting[] = 'searchable(' . self::CATEGORY_PAGE_ID_ATTRIBUTE . ')';
+            $attributesForFaceting[] = 'searchable(' . $this->configHelper->getCategoryPageIdAttributeName($storeId) . ')';
         }
 
         return $attributesForFaceting;
diff --git a/etc/adminhtml/system.xml b/etc/adminhtml/system.xml
@@ -326,7 +326,7 @@
                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
                     <comment>
                         <![CDATA[
-                            Virtual Replica is only available on Premium plans <a target="_blank" href="https://www.algolia.com/doc/integration/magento-2/how-it-works/indexing/?client=php#switching-to-virtual-replica">documentation</a> 
+                            Virtual Replica is only available on Premium plans <a target="_blank" href="https://www.algolia.com/doc/integration/magento-2/how-it-works/indexing/?client=php#switching-to-virtual-replica">documentation</a>
                         ]]>
                     </comment>
                     <depends>
@@ -459,10 +459,23 @@
                             If enabled, products will be indexed into Algolia with a compatible category data format that supports advanced merchandising features
                             such as visual rules and the new Merchandising Studio.
                             <br><br>
-                            NOTE: Merchandising Studio is only available on Premium plans.
+                            <strong>NOTE:</strong> After enabling, you must run a full product reindex to ensure that the attribute data is properly applied to your storefront catalog.
+                            Merchandising Studio is only available on Premium plans.
                         ]]>
                     </comment>
                 </field>
+                <field id="category_page_id_attribute_name" translate="label comment" type="text" sortOrder="60" showInDefault="1" showInWebsite="1" showInStore="1">
+                    <label>Category page ID attribute</label>
+                    <comment>
+                        <![CDATA[
+                            Specify the name of the attribute that will contain your <a href="https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/merchandising-category-pages/#configure-the-visual-editor-for-category-merchandising" target="_blank">category page ID</a>. Default is <code>categoryPageId</code>.
+                        ]]>
+                    </comment>
+                    <validate>required-entry validate-data</validate>
+                    <depends>
+                        <field id="enable_visual_merchandising">1</field>
+                    </depends>
+                </field>
             </group>
         </section>
         <section id="algoliasearch_categories" translate="label" type="text" sortOrder="40" showInDefault="1" showInWebsite="1" showInStore="1">
@@ -1210,4 +1223,4 @@
             </group>
         </section>
     </system>
-</config>
+</config>
diff --git a/etc/config.xml b/etc/config.xml
@@ -27,6 +27,7 @@
                 <product_additional_attributes><![CDATA[{"_1581608784535_535":{"attribute":"name","searchable":"1","order":"unordered","retrievable":"1"},"_1581608793630_630":{"attribute":"sku","searchable":"1","order":"unordered","retrievable":"1"},"_1582212731087_87":{"attribute":"manufacturer","searchable":"1","order":"unordered","retrievable":"1"},"_1582212739021_21":{"attribute":"categories","searchable":"1","order":"unordered","retrievable":"1"},"_1582212749587_587":{"attribute":"color","searchable":"1","order":"unordered","retrievable":"1"},"_1582212776086_86":{"attribute":"price","searchable":"2","order":"unordered","retrievable":"1"},"_1582212790407_407":{"attribute":"rating_summary","searchable":"2","order":"unordered","retrievable":"1"}}]]></product_additional_attributes>
                 <custom_ranking_product_attributes><![CDATA[{"_1600352070901_901":{"attribute":"in_stock","order":"desc"},"_1600352075148_148":{"attribute":"ordered_qty","order":"desc"},"_1600352080300_300":{"attribute":"created_at","order":"desc"}}]]></custom_ranking_product_attributes>
                 <enable_visual_merchandising>0</enable_visual_merchandising>
+                <category_page_id_attribute_name>categoryPageId</category_page_id_attribute_name>
             </products>
         </algoliasearch_products>
         <algoliasearch_categories>
