FFWEB-2651: Fix tracking for add to cart event

Author: grzegorz-jamroz

CHANGELOG.md

@@ -1,4 +1,10 @@
 # Changelog
+## Unreleased
+### Fix
+- Fix add to cart tracking for configurable products
+### Change
+- Replace getRecords event with object served from backend
+
 ## [v4.3.6] - 2022.01.16
 ### Add
 - Add option to switch between Api Version

composer.json

@@ -14,7 +14,7 @@
     "php": ">=7.2",
     "ext-ftp": "*",
     "ext-json": "*",
-    "omikron/factfinder-communication-sdk": "^0.9.5",
+    "omikron/factfinder-communication-sdk": "^0.9.6",
     "league/flysystem-sftp": "^2.2",
     "league/flysystem-ftp": "^2.3",
     "monolog/monolog": "^1.23"

src/metadata.php

@@ -80,6 +80,11 @@
             'block'    => 'details_relatedproducts_crossselling',
             'file'     => 'views/frontend/blocks/campaign/product.tpl',
         ],
+        [
+            'template' => 'page/details/inc/productmain.tpl',
+            'block'    => 'details_productmain_social',
+            'file'     => 'views/frontend/blocks/page/details/inc/productmain.tpl',
+        ],
         [
             'template' => 'page/list/list.tpl',
             'block'    => 'page_list_listbody',

src/out/js/tracking.js

@@ -1,41 +1,31 @@
-function registerAddToCartListener(selector, productId) {
-    let trackingSent = false;
-    const trackingHelper = factfinder.communication.Util.trackingHelper;
-
-    function trackAddToCart(product) {
-        factfinder.communication.Tracking.cart({
-            id: trackingHelper.getTrackingProductId(product),
-            masterId: trackingHelper.getMasterArticleNumber(product),
-            price: trackingHelper.getPrice(product),
-            title: trackingHelper.getTitle(product),
-            count: 1,
+function registerAddToCartListener(selector, productData) {
+    if (typeof factfinder === 'undefined') {
+        document.addEventListener('ffCommunicationReady', function () {
+            init(selector, productData);
         });
+    } else {
+        init(selector, productData);
     }
 
-    const element = document.querySelector(selector);
+    function init(selector, productData) {
+        const trackingHelper = factfinder.communication.Util.trackingHelper;
 
-    if (element) {
-        element.addEventListener('submit', function (e) {
-            if (trackingSent === false) {
-                e.preventDefault();
-            }
+        function trackAddToCart(product) {
+            factfinder.communication.Tracking.cart({
+                id: trackingHelper.getTrackingProductId(product),
+                masterId: trackingHelper.getMasterArticleNumber(product),
+                price: trackingHelper.getPrice(product),
+                title: trackingHelper.getTitle(product),
+                count: 1,
+            });
+        }
 
-            factfinder.communication.EventAggregator.addFFEvent({
-                type: 'getRecords',
-                recordId: productId,
-                idType: 'productNumber',
-                success: function (response) {
-                    if (response && response[0]) {
-                        const product = response[0];
-                        trackAddToCart(product);
-                    }
+        const element = document.querySelector(selector);
 
-                    if (trackingSent === false) {
-                        trackingSent = true;
-                        e.target.submit();
-                    }
-                },
+        if (element) {
+            element.addEventListener('submit', function (e) {
+                trackAddToCart(productData);
             });
-        });
+        }
     }
 }

src/views/frontend/blocks/campaign/product.tpl

@@ -18,8 +18,3 @@
 [{if $oConfig->getConfigParam("ffSimilarProducts")}]
     [{include file="ff/similar.tpl" recordId=$recordId}]
 [{/if}]
-<script>
-    document.addEventListener('ffCommunicationReady', function () {
-        registerAddToCartListener('.js-oxProductForm',"[{$recordId}]");
-    });
-</script>

src/views/frontend/blocks/page/details/inc/productmain.tpl

@@ -0,0 +1,9 @@
+[{$smarty.block.parent}]
+[{assign var="recordDataJson" value=$oView->getProduct()|record_data_json}]
+
+<script>
+    registerAddToCartListener(
+        '.js-oxProductForm',
+        JSON.parse('[{ $recordDataJson }]')
+    );
+</script>

src/views/smarty/modifier.record_data_json.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+use Omikron\FactFinder\Communication\Client\ClientBuilder;
+use Omikron\FactFinder\Communication\Credentials;
+use Omikron\FactFinder\Communication\Resource\AdapterFactory;
+use OxidEsales\Eshop\Core\Config;
+use OxidEsales\Eshop\Core\Model\BaseModel;
+use OxidEsales\Eshop\Core\Registry;
+
+function smarty_modifier_record_data_json(BaseModel $article): string
+{
+    /** @var Config $config */
+    $config = Registry::getConfig();
+    $recordId = (string) $article->getFieldData('oxartnum');
+    $credentials = new Credentials(
+        $config->getConfigParam('ffUsername'),
+        $config->getConfigParam('ffPassword'),
+        $config->getConfigParam('ffAuthPrefix'),
+        $config->getConfigParam('ffAuthPostfix')
+    );
+    $clientBuilder = oxNew(ClientBuilder::class)
+        ->withServerUrl($config->getConfigParam('ffServerUrl'))
+        ->withCredentials($credentials)
+        ->withVersion($config->getConfigParam('ffApiVersion'));
+    $adapterFactory = new AdapterFactory(
+        $clientBuilder,
+        $config->getConfigParam('ffVersion'),
+        $config->getConfigParam('ffApiVersion')
+    );
+    $searchAdapter = $adapterFactory->getSearchAdapter();
+    $response = $searchAdapter->records(
+        $config->getConfigParam('ffChannel')[Registry::getLang()->getLanguageAbbr()],
+        '',
+        [
+            'idType' => 'productNumber',
+            'productNumber' => $recordId,
+            'format' => 'json'
+        ]
+    );
+
+    $record = $response['records'][0] ?? [];
+
+    if ($record === []) {
+        return json_encode([]);
+    }
+
+    return json_encode([
+        'id' => $recordId,
+        'record' => $record,
+    ]);
+}