Refactored Transaction Log

Author: ihorvansach

Api/Transaction/LogInterface.php

@@ -0,0 +1,26 @@
+<?php
+/**
+ * Copyright © Magefan ([email protected]). All rights reserved.
+ * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
+ */
+
+declare(strict_types=1);
+
+namespace Magefan\GoogleTagManager\Api\Transaction;
+
+interface LogInterface
+{
+    /**
+     * @param mixed $order
+     * @param string $requester
+     * @return void
+     */
+    public function logTransaction($order, string $requester);
+
+    /**
+     * @param mixed $order
+     * @param string $requester
+     * @return bool
+     */
+    public function isTransactionUnique($order, string $requester): bool;
+}

Model/Transaction/Log.php

@@ -11,11 +11,13 @@
 use Magefan\GoogleTagManager\Model\ResourceModel\Transaction\CollectionFactory as TransactionCollectionFactory;
 use Magefan\GoogleTagManager\Model\TransactionFactory;
 use Magefan\GoogleTagManager\Model\TransactionRepository;
+use Magefan\GoogleTagManager\Api\Transaction\LogInterface;
+use Magento\Sales\Model\OrderFactory;
 use Magento\Sales\Api\Data\OrderInterface as Order;
 use Magento\Framework\Exception\CouldNotSaveException;
 use Psr\Log\LoggerInterface;
 
-class Log
+class Log implements LogInterface
 {
     /**
      * @var TransactionCollectionFactory
@@ -32,37 +34,47 @@ class Log
      */
     private $transactionRepository;
 
+    /**
+     * @var OrderFactory
+     */
+    private $orderFactory;
+
     /**
      * @var LoggerInterface
      */
     private $logger;
 
+
     /**
-     * Log constructor.
      * @param TransactionCollectionFactory $transactionCollectionFactory
      * @param TransactionFactory $transactionFactory
      * @param TransactionRepository $transactionRepository
+     * @param OrderFactory $orderFactory
      * @param LoggerInterface $logger
      */
     public function __construct(
         TransactionCollectionFactory $transactionCollectionFactory,
         TransactionFactory $transactionFactory,
         TransactionRepository $transactionRepository,
+        OrderFactory $orderFactory,
         LoggerInterface $logger
     ) {
         $this->transactionCollectionFactory = $transactionCollectionFactory;
         $this->transactionFactory = $transactionFactory;
         $this->transactionRepository = $transactionRepository;
+        $this->orderFactory = $orderFactory;
         $this->logger = $logger;
     }
 
     /**
-     * @param Order $order
+     * @param mixed $order
      * @param string $requester
      * @return void
      */
-    public function logTransaction(Order $order, string $requester)
+    public function logTransaction($order, string $requester)
     {
+        $order = $this->getOrder($order);
+
         $transactionModel = $this->transactionFactory->create();
 
         $transactionModel->setTransactionId((string)$order->getIncrementId());
@@ -78,18 +90,20 @@ public function logTransaction(Order $order, string $requester)
     }
 
     /**
-     * @param Order $order
+     * @param mixed $order
      * @param string $requester
-     * @return void
+     * @return bool
      */
-    public function isTransactionUnique(Order $order, string $requester): bool
+    public function isTransactionUnique($order, string $requester): bool
     {
+        $order = $this->getOrder($order);
+
         $transactionsForRequesterByTransactionId = $this->transactionFactory->create()->getCollection()->addFieldToFilter(
             'requester',
             $requester
         )->addFieldToFilter(
             'transaction_id',
-            (string)$order->getIncrementId()
+            $order->getIncrementId()
         )->addFieldToFilter(
             'store_id',
             (int)$order->getStoreId()
@@ -101,4 +115,25 @@ public function isTransactionUnique(Order $order, string $requester): bool
 
         return true;
     }
+
+    /**
+     * @param $order
+     * @return Order
+     * @throws \Exception
+     */
+    private function getOrder($order): Order
+    {
+        if (is_object()) {
+            if (!($order instanceof Order)) {
+                throw new \Exception('Object is not instance of OrderInterface.');
+            }
+        } else {
+            $order = $this->orderFactory->create()->loadByIncrementId((string)$order);
+            if (!$order->getId()) {
+                throw new \Exception('Order with such ID does not exist.');
+            }
+        }
+
+        return $order;
+    }
 }

Plugin/Magefan/GoogleTagManager/Api/DataLayer/PurchaseInterface.php

@@ -11,7 +11,7 @@
 use Magefan\GoogleTagManager\Api\DataLayer\PurchaseInterface as Subject;
 use Magefan\GoogleTagManager\Model\TransactionFactory;
 use Magento\Sales\Model\Order;
-use Magefan\GoogleTagManager\Model\Transaction\Log as TransactionLog;
+use Magefan\GoogleTagManager\Api\Transaction\LogInterface as TransactionLog;
 
 class PurchaseInterface
 {
@@ -30,6 +30,7 @@ public function __construct(
     }
 
     /**
+     * Prevent double purchase tracking by the same requester
      * @param Subject $subject
      * @param $proceed
      * @param Order $order

etc/adminhtml/system.xml

@@ -202,6 +202,9 @@ height="0" width="0" style="display:none;visibility:hid
                 </field>
                 <group id="measurement_protocol" translate="label" type="text" sortOrder="50" showInDefault="1" showInWebsite="1" showInStore="1">
                     <label>Measurement Protocol /GA4 Server Side Tracking (GTM Extra)</label>
+                    <depends>
+                        <field id="mfgoogletagmanager/server_container/enabled">0</field>
+                    </depends>
                     <attribute type="expanded">1</attribute>
 
                     <field id="info" translate="label comment" type="text" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1">

etc/di.xml

@@ -13,6 +13,7 @@
     <preference for="Magefan\GoogleTagManager\Api\DataLayer\Cart\ItemInterface" type="Magefan\GoogleTagManager\Model\DataLayer\Cart\Item" />
     <preference for="Magefan\GoogleTagManager\Api\DataLayer\Order\ItemInterface" type="Magefan\GoogleTagManager\Model\DataLayer\Order\Item" />
     <preference for="Magefan\GoogleTagManager\Api\DataLayer\Product\ItemInterface" type="Magefan\GoogleTagManager\Model\DataLayer\Product\Item" />
+    <preference for="Magefan\GoogleTagManager\Api\Transaction\LogInterface" type="Magefan\GoogleTagManager\Model\Transaction\Log" />
     <type name="Magefan\GoogleTagManager\Api\DataLayer\PurchaseInterface">
         <plugin name="Plugin_Magefan_GoogleTagManager_Api_DataLayer_PurchaseInterface" type="Magefan\GoogleTagManager\Plugin\Magefan\GoogleTagManager\Api\DataLayer\PurchaseInterface" sortOrder="10" disabled="false"/>
     </type>