Gtag ecommerce tracking improvements

app/code/Magento/GoogleGtag/Block/Ga.php

@@ -7,8 +7,10 @@
 
 namespace Magento\GoogleGtag\Block;
 
+use Magento\Catalog\Api\ProductRepositoryInterface;
 use Magento\Cookie\Helper\Cookie;
 use Magento\Framework\Api\SearchCriteriaBuilder;
+use Magento\Framework\App\ObjectManager;
 use Magento\Framework\Serialize\SerializerInterface;
 use Magento\Framework\View\Element\Template;
 use Magento\Framework\View\Element\Template\Context;
@@ -25,27 +27,32 @@ class Ga extends Template
     /**
      * @var GtagConfiguration
      */
-    private $googleGtagConfig;
+    private GtagConfiguration $googleGtagConfig;
 
     /**
      * @var Cookie
      */
-    private $cookieHelper;
+    private Cookie $cookieHelper;
 
     /**
      * @var SerializerInterface
      */
-    private $serializer;
+    private SerializerInterface $serializer;
 
     /**
      * @var OrderRepositoryInterface
      */
-    private $orderRepository;
+    private OrderRepositoryInterface $orderRepository;
 
     /**
      * @var SearchCriteriaBuilder
      */
-    private $searchCriteriaBuilder;
+    private SearchCriteriaBuilder $searchCriteriaBuilder;
+
+    /**
+     * @var ProductRepositoryInterface
+     */
+    private ProductRepositoryInterface $productRepository;
 
     /**
      * @param Context $context
@@ -55,6 +62,7 @@ class Ga extends Template
      * @param SearchCriteriaBuilder $searchCriteriaBuilder
      * @param OrderRepositoryInterface $orderRepository
      * @param array $data
+     * @param ProductRepositoryInterface|null $productRepository
      */
     public function __construct(
         Context $context,
@@ -63,13 +71,17 @@ public function __construct(
         SerializerInterface $serializer,
         SearchCriteriaBuilder $searchCriteriaBuilder,
         OrderRepositoryInterface $orderRepository,
-        array $data = []
+        array $data = [],
+        ProductRepositoryInterface $productRepository = null
     ) {
         $this->googleGtagConfig = $googleGtagConfig;
         $this->cookieHelper = $cookieHelper;
         $this->serializer = $serializer;
         $this->orderRepository = $orderRepository;
         $this->searchCriteriaBuilder = $searchCriteriaBuilder;
+        $this->productRepository = $productRepository ?:
+            ObjectManager::getInstance()->get(ProductRepositoryInterface::class);
+
         parent::__construct($context, $data);
     }
 
@@ -97,6 +109,7 @@ public function isCookieRestrictionModeEnabled(): bool
      * Return current website id.
      *
      * @return int
+     * @throws \Magento\Framework\Exception\LocalizedException
      */
     public function getCurrentWebsiteId(): int
     {
@@ -116,7 +129,7 @@ public function getPageTrackingData($measurementId): array
     {
         return [
             'optPageUrl' => $this->getOptPageUrl(),
-            'measurementId' => $this->escapeHtmlAttr($measurementId, false)
+            'measurementId' => $measurementId
         ];
     }
 
@@ -129,11 +142,12 @@ public function getPageTrackingData($measurementId): array
      * @link https://developers.google.com/gtagjs/reference/event#purchase
      *
      * @return array
+     * @throws \Magento\Framework\Exception\NoSuchEntityException
      */
     public function getOrdersTrackingData(): array
     {
         $result = [];
-        $orderIds = $this->getOrderIds();
+        $orderIds = $this->getData('order_ids');
         if (empty($orderIds) || !is_array($orderIds)) {
             return $result;
         }
@@ -145,24 +159,45 @@ public function getOrdersTrackingData(): array
         $collection = $this->orderRepository->getList($this->searchCriteriaBuilder->create());
 
         foreach ($collection->getItems() as $order) {
-            foreach ($order->getAllVisibleItems() as $item) {
-                $result['products'][] = [
-                    'item_id' => $this->escapeJsQuote($item->getSku()),
-                    'item_name' =>  $this->escapeJsQuote($item->getName()),
-                    'price' => number_format((float) $item->getPrice(), 2),
-                    'quantity' => (int)$item->getQtyOrdered(),
+            foreach ($order->getAllVisibleItems() as $index => $item) {
+                $product = $this->productRepository->get($item->getSku());
+                $orderProduct = [
+                    'index' => $index+1,
+                    'item_id' => $item->getSku(),
+                    'item_name' =>  $item->getName(),
+                    'item_brand' => $product->getAttributeText('manufacturer'),
+                    'affiliation' => $this->_storeManager->getStore()->getFrontendName(),
+                    'price' => round((float) $item->getPrice(), 2),
+                    'quantity' => (int)$item->getQtyOrdered()
                 ];
+
+                if ($item->getDiscountAmount() > 0) {
+                    $orderProduct['discount'] = $item->getDiscountAmount();
+
+                    if (!empty($order->getCouponCode())) {
+                        $orderProduct['coupon'] = $order->getCouponCode();
+                    }
+                }
+
+                $result['products'][] = $orderProduct;
             }
-            $result['orders'][] = [
+
+            $resultOrder = [
                 'transaction_id' =>  $order->getIncrementId(),
                 'affiliation' => $this->escapeJsQuote($this->_storeManager->getStore()->getFrontendName()),
                 'value' => number_format((float) $order->getGrandTotal(), 2),
                 'tax' => number_format((float) $order->getTaxAmount(), 2),
                 'shipping' => number_format((float) $order->getShippingAmount(), 2),
                 'currency' => $order->getOrderCurrencyCode(),
             ];
-            $result['currency'] = $order->getOrderCurrencyCode();
+
+            if (!empty($order->getCouponCode())) {
+                $resultOrder['coupon'] = $order->getCouponCode();
+            }
+
+            $result['orders'][] = $resultOrder;
         }
+
         return $result;
     }
 
@@ -175,8 +210,8 @@ private function getOptPageUrl(): string
     {
         $optPageURL = '';
         $pageName = $this->getPageName() !== null ? trim($this->getPageName()) : '';
-        if ($pageName && substr($pageName, 0, 1) === '/' && strlen($pageName) > 1) {
-            $optPageURL = ", '" . $this->escapeHtmlAttr($pageName, false) . "'";
+        if ($pageName && str_starts_with($pageName, '/') && strlen($pageName) > 1) {
+            $optPageURL = ", '" . $pageName . "'";
         }
         return $optPageURL;
     }
@@ -185,6 +220,7 @@ private function getOptPageUrl(): string
      * Provide analytics events data
      *
      * @return bool|string
+     * @throws \Magento\Framework\Exception\NoSuchEntityException|\Magento\Framework\Exception\LocalizedException
      */
     public function getAnalyticsData()
     {
@@ -196,6 +232,7 @@ public function getAnalyticsData()
             'ordersTrackingData' => $this->getOrdersTrackingData(),
             'googleAnalyticsAvailable' => $this->googleGtagConfig->isGoogleAnalyticsAvailable()
         ];
+
         return $this->serializer->serialize($analyticData);
     }
 }

app/code/Magento/GoogleGtag/Test/Unit/Block/GaTest.php

@@ -7,6 +7,8 @@
 
 namespace Magento\GoogleGtag\Test\Unit\Block;
 
+use Magento\Catalog\Api\ProductRepositoryInterface;
+use Magento\Catalog\Model\Product;
 use Magento\Cookie\Helper\Cookie;
 use Magento\Framework\Api\SearchCriteriaBuilder;
 use Magento\Framework\Api\SearchCriteriaInterface;
@@ -52,6 +54,11 @@ class GaTest extends TestCase
      */
     private $storeMock;
 
+    /**
+     * @var MockObject
+     */
+    private $productMock;
+
     /**
      * @var GtagConfiguration|mixed|MockObject
      */
@@ -61,29 +68,41 @@ class GaTest extends TestCase
      * @var SearchCriteriaBuilder|mixed|MockObject
      */
     private $searchCriteriaBuilder;
+
     /**
      * @var OrderRepositoryInterface|mixed|MockObject
      */
     private $orderRepository;
+
+    /**
+     * @var OrderRepositoryInterface|mixed|MockObject
+     */
+    private $productRepository;
+
     /**
      * @var SerializerInterface|mixed|MockObject
      */
     private $serializerMock;
 
+    /**
+     * @var Escaper|MockObject
+     */
+    private $escaperMock;
+
     protected function setUp(): void
     {
         $objectManager = new ObjectManager($this);
         $contextMock = $this->getMockBuilder(Context::class)
             ->disableOriginalConstructor()
             ->getMock();
-
-        $contextMock->expects($this->once())
-            ->method('getEscaper')
-            ->willReturn($objectManager->getObject(Escaper::class));
-
+        $this->escaperMock = $this->getMockBuilder(Escaper::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+        $this->escaperMock->expects($this->any())->method('escapeJsQuote')->with('test')->willReturn('test');
         $this->storeManagerMock = $this->getMockBuilder(StoreManagerInterface::class)
             ->disableOriginalConstructor()
             ->getMockForAbstractClass();
+
         $this->serializerMock = $this->getMockBuilder(SerializerInterface::class)
             ->disableOriginalConstructor()
             ->getMockForAbstractClass();
@@ -92,6 +111,7 @@ protected function setUp(): void
             ->disableOriginalConstructor()
             ->getMock();
         $contextMock->expects($this->once())->method('getStoreManager')->willReturn($this->storeManagerMock);
+        $contextMock->expects($this->once())->method('getEscaper')->willReturn($this->escaperMock);
 
         $this->orderRepository = $this->getMockBuilder(OrderRepositoryInterface::class)
             ->onlyMethods(['getList'])
@@ -102,6 +122,18 @@ protected function setUp(): void
             ->disableOriginalConstructor()
             ->getMockForAbstractClass();
 
+        $this->productRepository = $this->getMockBuilder(ProductRepositoryInterface::class)
+            ->onlyMethods(['get'])
+            ->disableOriginalConstructor()
+            ->getMockForAbstractClass();
+
+        $this->productMock = $this->getMockBuilder(Product::class)
+            ->disableOriginalConstructor()
+            ->onlyMethods(['getAttributeText'])
+            ->getMock();
+
+        $this->productRepository->expects($this->any())->method('get')->willReturn($this->productMock);
+
         $this->googleGtagConfig = $this->getMockBuilder(GtagConfiguration::class)
             ->disableOriginalConstructor()
             ->getMock();
@@ -118,7 +150,8 @@ protected function setUp(): void
                 'cookieHelper' => $this->cookieHelperMock,
                 'serializer' => $this->serializerMock,
                 'searchCriteriaBuilder' => $this->searchCriteriaBuilder,
-                'orderRepository' => $this->orderRepository
+                'orderRepository' => $this->orderRepository,
+                'productRepository' => $this->productRepository
             ]
         );
     }
@@ -142,6 +175,7 @@ public function testGetCurrentWebsiteId()
     /**
      * Test for getOrdersTrackingData()
      * @return void
+     * @throws \Magento\Framework\Exception\NoSuchEntityException
      */
     public function testOrderTrackingData()
     {
@@ -157,28 +191,36 @@ public function testOrderTrackingData()
         $orderSearchResult->method('getTotalCount')->willReturn(1);
         $orderSearchResult->method('getItems')->willReturn([ 1 => $this->createOrderMock(1)]);
         $this->searchCriteriaBuilder->method('create')->willReturn($searchCriteria);
-        $this->storeMock->expects($this->once())->method('getFrontendName')->willReturn('test');
-        $this->storeManagerMock->expects($this->once())->method('getStore')->willReturn($this->storeMock);
+        $this->storeMock->expects($this->atLeastOnce())->method('getFrontendName')->willReturn('test');
+        $this->storeManagerMock->expects($this->atLeastOnce())->method('getStore')->willReturn($this->storeMock);
+        $this->productMock->expects($this->once())->method('getAttributeText')
+            ->with('manufacturer')->willReturn('Brand 1');
+
         $expectedResult = [
             'orders' => [
                 [
                     'transaction_id' => 100,
-                    'affiliation' => 'test',
+                    'currency' => 'USD',
                     'value' => 10.00,
                     'tax' => 2.00,
                     'shipping' => 1.00,
-                    'currency' => 'USD'
+                    'coupon' => 'coupon1',
+                    'affiliation' => 'test',
                 ]
             ],
             'products' => [
                 [
+                    'index' => 1,
                     'item_id' => 'sku0',
                     'item_name' => 'testName0',
+                    'item_brand' => 'Brand 1',
+                    'affiliation' => 'test',
                     'price' => 0.00,
-                    'quantity' => 1
+                    'quantity' => 1,
+                    'discount' => 0.01,
+                    'coupon' => 'coupon1',
                 ]
             ],
-            'currency' => 'USD'
         ];
         $this->gaBlock->setOrderIds([1, 2]);
         $tempResults = $this->gaBlock->getOrdersTrackingData();
@@ -209,10 +251,11 @@ protected function createOrderMock($orderItemCount = 1)
             $orderItemMock = $this->getMockBuilder(OrderItemInterface::class)
                 ->disableOriginalConstructor()
                 ->getMockForAbstractClass();
-            $orderItemMock->expects($this->once())->method('getSku')->willReturn('sku' . $i);
+            $orderItemMock->expects($this->exactly(2))->method('getSku')->willReturn('sku' . $i);
             $orderItemMock->expects($this->once())->method('getName')->willReturn('testName' . $i);
             $orderItemMock->expects($this->once())->method('getPrice')->willReturn($i . '.00');
             $orderItemMock->expects($this->once())->method('getQtyOrdered')->willReturn($i + 1);
+            $orderItemMock->expects($this->exactly(2))->method('getDiscountAmount')->willReturn(0.01);
             $orderItems[] = $orderItemMock;
         }
 
@@ -224,7 +267,8 @@ protected function createOrderMock($orderItemCount = 1)
         $orderMock->expects($this->once())->method('getGrandTotal')->willReturn(10);
         $orderMock->expects($this->once())->method('getTaxAmount')->willReturn(2);
         $orderMock->expects($this->once())->method('getShippingAmount')->willReturn($orderItemCount);
-        $orderMock->expects($this->exactly(2))->method('getOrderCurrencyCode')->willReturn('USD');
+        $orderMock->expects($this->once())->method('getOrderCurrencyCode')->willReturn('USD');
+        $orderMock->expects($this->exactly(4))->method('getCouponCode')->willReturn('coupon1');
         return $orderMock;
     }
 

app/code/Magento/GoogleGtag/composer.json

@@ -7,6 +7,7 @@
     "require": {
         "php": "~8.1.0||~8.2.0",
         "magento/framework": "*",
+        "magento/module-catalog": "*",
         "magento/module-cookie": "*",
         "magento/module-sales": "*",
         "magento/module-store": "*"

app/code/Magento/GoogleGtag/etc/module.xml

@@ -8,6 +8,7 @@
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
     <module name="Magento_GoogleGtag" >
         <sequence>
+            <module name="Magento_Catalog"/>
             <module name="Magento_Store"/>
             <module name="Magento_Checkout"/>
         </sequence>

app/code/Magento/GoogleGtag/view/frontend/templates/ga.phtml

@@ -15,7 +15,8 @@ $analyticsData = $block->getAnalyticsData();
     <script type="text/x-magento-init">
     {
         "*": {
-            "Magento_GoogleGtag/js/google-analytics": <?= /* @noEscape */ $block->getAnalyticsData() ?>
+            "Magento_GoogleGtag/js/google-analytics":
+            <?= /* @noEscape */ $escaper->escapeHtml($escaper->escapeJs($block->getAnalyticsData())) ?>
         }
     }
     </script>