FFWEB-3229: Add the ability to set CategoryPath

Add the ability to set a name for the CategoryPath field

CHANGELOG.md

@@ -1,4 +1,8 @@
 # Changelog
+## Unreleased
+### Improve
+- Add the ability to set a name for the CategoryPath field
+
 ## [v5.0.1] - 2024.11.07
 ### Update
 - Update FactFinder logo

README.md

@@ -355,6 +355,11 @@ Sending each request to FACT-Finder instance trough Magento, you lose on perform
 Module in order to preserve categories URLs and hence SEO get use of standard Magento routing with the combination of FACT-Finder availability to pass custom parameters to search request.
 Once user is landed on category page. Search request is performed immediately (thanks to `searchImmediately` parameter usage).
 To enable that, turn on corresponding option in *Main Settings* section.
+
+#### Set correct name for CategoryPath field
+By default, SDK uses a field named CategoryPath (default category field name for FactFinder instance). If in your FactFinder instance configuration you have a different field name for Category field then you must set this name in the SDK configuration page:
+
+![Main Settings](docs/assets/category-field-name.png "Category field name")
 
 ### Tracking
 The module uses Web Components API to track following events:

src/Test/Unit/ViewModel/CategoryPathTest.php

@@ -5,6 +5,7 @@
 namespace Omikron\Factfinder\ViewModel;
 
 use Magento\Catalog\Model\Category;
+use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\Registry;
 use Omikron\Factfinder\Model\Config\CommunicationConfig;
 use PHPUnit\Framework\MockObject\MockObject;
@@ -24,6 +25,9 @@ class CategoryPathTest extends TestCase
     /** @var MockObject|CommunicationConfig */
     private MockObject $communicationConfig;
 
+    /** @var MockObject|ScopeConfigInterface */
+    private MockObject $scopeConfig;
+
     public function test_category_names_are_trimmed()
     {
         $this->communicationConfig->method('getVersion')->willReturn('ng');
@@ -39,6 +43,7 @@ public function test_category_names_are_trimmed()
     protected function setUp(): void
     {
         $this->communicationConfig = $this->createMock(CommunicationConfig::class);
+        $this->scopeConfig = $this->createMock(ScopeConfigInterface::class);
         $this->currentCategory = $this->createMock(Category::class);
         $this->registry              = new Registry();
         $this->registry->register('current_category', $this->currentCategory);
@@ -51,6 +56,6 @@ private function category(string $name, int $level): Category
 
     private function newCategoryPath(): CategoryPath
     {
-        return new CategoryPath($this->registry, $this->communicationConfig);
+        return new CategoryPath($this->registry, $this->communicationConfig, $this->scopeConfig);
     }
 }

src/ViewModel/CategoryPath.php

@@ -5,17 +5,20 @@
 namespace Omikron\Factfinder\ViewModel;
 
 use Magento\Catalog\Model\Category;
+use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\Registry;
 use Magento\Framework\View\Element\Block\ArgumentInterface;
+use Magento\Store\Model\ScopeInterface as Scope;
 use Omikron\Factfinder\Model\Config\CommunicationConfig;
 
 class CategoryPath implements ArgumentInterface
 {
+    private const PATH_CATEGORY_PATH_NAME = 'factfinder/general/category_path_name';
+
     public function __construct(
-        private readonly Registry            $registry,
+        private readonly Registry             $registry,
         private readonly CommunicationConfig $communicationConfig,
-        private readonly string              $param = 'CategoryPath',
-        private readonly array               $initial = [],
+        private readonly ScopeConfigInterface $scopeConfig,
     ) {
     }
 
@@ -33,7 +36,7 @@ public function getCategoryPath(): array
 
     public function getCategoryPathFieldName(): string
     {
-        return $this->param;
+        return $this->scopeConfig->getValue(self::PATH_CATEGORY_PATH_NAME, Scope::SCOPE_STORE) ?? 'CategoryPath';
     }
 
     /**

src/etc/adminhtml/system/general.xml

@@ -31,7 +31,13 @@
             <label>Use FACT-Finder® for category pages?</label>
             <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
         </field>
-        <field id="use_ssr" translate="label" type="select" sortOrder="76" showInDefault="1" showInWebsite="1" showInStore="1">
+        <field id="category_path_name" translate="label" type="text" sortOrder="76" showInDefault="1" showInWebsite="1" showInStore="1">
+            <label>Category Path field name</label>
+            <depends>
+                <field id="use_for_categories">1</field>
+            </depends>
+        </field>
+        <field id="use_ssr" translate="label" type="select" sortOrder="77" showInDefault="1" showInWebsite="1" showInStore="1">
             <label>Use server-side rendering?</label>
             <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
         </field>

src/etc/config.xml

@@ -7,6 +7,7 @@
                 <logging_enabled>0</logging_enabled>
                 <ff_api_key backend_model="Magento\Config\Model\Config\Backend\Encrypted" />
                 <use_for_categories>1</use_for_categories>
+                <category_path_name>CategoryPath</category_path_name>
                 <show_add_to_cart_button>1</show_add_to_cart_button>
                 <ff_enrichment>0</ff_enrichment>
                 <tracking_product_number_field_role>{"brand":"Brand","deeplink":"Deeplink","description":"Description","ean":"EAN","imageUrl":"ImageURL","masterId":"Master","price":"Price","productName":"Name","productNumber":"ProductNumber"}</tracking_product_number_field_role>

src/view/frontend/layout/factfinder_category_view.xml

@@ -10,6 +10,7 @@
             <block class="Magento\Framework\View\Element\Template" name="factfinder.category.page" template="Omikron_Factfinder::category/category_page.phtml" after="factfinder.communication" >
                 <arguments>
                     <argument name="category_path" xsi:type="helper" helper="Omikron\Factfinder\ViewModel\CategoryPath::getCategoryPath" />
+                    <argument name="category_path_field_name" xsi:type="helper" helper="Omikron\Factfinder\ViewModel\CategoryPath::getCategoryPathFieldName" />
                 </arguments>
             </block>
         </referenceBlock>

src/view/frontend/templates/category/category_page.phtml

@@ -2,13 +2,14 @@
 /** @var Magento\Framework\View\Element\Template $block */
 /** @var Magento\Framework\Escaper $escaper */
 $categoryPath = (array) $block->getData('category_path');
+$categoryPathFieldName = $block->getData('category_path_field_name');
 ?>
 
 <script>
     document.addEventListener(`ffCoreReady`, ({ factfinder }) => {
         factfinder.config.setAppConfig({
             categoryPage: [
-                factfinder.utils.filterBuilders.categoryFilter(`CategoryPath`, <?= /* @noEscape */ json_encode($categoryPath); ?>)
+                factfinder.utils.filterBuilders.categoryFilter('<?= /* @noEscape */ $categoryPathFieldName ?>', <?= /* @noEscape */ json_encode($categoryPath); ?>)
             ],
         });