Add user data to all server events (#756)

* Add user data to all server events

* Fix tests

Author: zlik

app/code/Meta/Conversion/Helper/AAMFieldsExtractorHelper.php

@@ -192,14 +192,15 @@ private function normalizeMatchingFields(array $userDataArray): array
      * Set user data
      *
      * @param Event $event
-     * @param array $userDataArray
-     * @return mixed
+     * @param array|null $userDataArray
+     * @param Customer|null $customer
+     * @return Event
      * @SuppressWarnings(PHPMD)
      * Unable to refactor because UserData object from Facebook SDK does not have generic setter function
      */
-    public function setUserData($event, $userDataArray = null)
+    public function setUserData($event, $userDataArray = null, $customer = null)
     {
-        $userDataArray = $this->getNormalizedUserData(null, $userDataArray);
+        $userDataArray = $this->getNormalizedUserData($customer, $userDataArray);
 
         if (empty($userDataArray)) {
             return $event;

app/code/Meta/Conversion/Helper/ServerSideHelper.php

@@ -20,68 +20,90 @@
 
 namespace Meta\Conversion\Helper;
 
+use Magento\Customer\Model\Customer;
+use Magento\Customer\Model\Session as CustomerSession;
 use Magento\Store\Model\ScopeInterface;
 use Meta\BusinessExtension\Helper\FBEHelper;
 use Meta\BusinessExtension\Model\System\Config as SystemConfig;
 use FacebookAds\Api;
 use FacebookAds\Object\ServerSide\EventRequestAsync;
 use GuzzleHttp\Exception\RequestException;
-use FacebookAds\Object\ServerSide\Event;
 
 /**
  * Helper to fire ServerSide Event.
+ *
+ * @SuppressWarnings(PHPMD.CookieAndSessionMisuse)
  */
 class ServerSideHelper
 {
     /**
      * @var FBEHelper
      */
-    private $fbeHelper;
+    private FBEHelper $fbeHelper;
 
     /**
      * @var AAMFieldsExtractorHelper
      */
-    private $aamFieldsExtractorHelper;
+    private AAMFieldsExtractorHelper $aamFieldsExtractorHelper;
 
     /**
      * @var array
      */
-    private $trackedEvents = [];
+    private array $trackedEvents = [];
 
     /**
      * @var SystemConfig
      */
-    private $systemConfig;
+    private SystemConfig $systemConfig;
+
+    /**
+     * @var CustomerSession
+     */
+    private CustomerSession $customerSession;
 
     /**
      * Constructor
      *
      * @param FBEHelper $fbeHelper
      * @param AAMFieldsExtractorHelper $aamFieldsExtractorHelper
      * @param SystemConfig $systemConfig
+     * @param CustomerSession $customerSession
      */
     public function __construct(
         FBEHelper $fbeHelper,
         AAMFieldsExtractorHelper $aamFieldsExtractorHelper,
-        SystemConfig $systemConfig
+        SystemConfig $systemConfig,
+        CustomerSession $customerSession
     ) {
         $this->fbeHelper = $fbeHelper;
         $this->aamFieldsExtractorHelper = $aamFieldsExtractorHelper;
         $this->systemConfig = $systemConfig;
+        $this->customerSession = $customerSession;
+    }
+
+    /**
+     * Get logged in customer
+     *
+     * @return Customer|null
+     */
+    public function getCustomer(): ?Customer
+    {
+        return $this->customerSession->isLoggedIn() ? $this->customerSession->getCustomer() : null;
     }
 
     /**
      * Send event
      *
      * @param Event $event
      * @param array $userDataArray
+     * @return void
      */
     public function sendEvent($event, $userDataArray = null)
     {
         try {
             Api::init(null, null, $this->systemConfig->getAccessToken());
 
-            $event = $this->aamFieldsExtractorHelper->setUserData($event, $userDataArray);
+            $event = $this->aamFieldsExtractorHelper->setUserData($event, $userDataArray, $this->getCustomer());
 
             $this->trackedEvents[] = $event;
 

app/code/Meta/Conversion/Test/Unit/Helper/ServerSideHelperTest.php

@@ -20,7 +20,7 @@
 
 namespace Meta\Conversion\Test\Unit\Helper;
 
-use Magento\Store\Model\StoreManagerInterface;
+use Magento\Customer\Model\Session as CustomerSession;
 use Magento\Framework\App\Request\Http;
 use Meta\Conversion\Helper\AAMFieldsExtractorHelper;
 use Meta\BusinessExtension\Helper\FBEHelper;
@@ -52,6 +52,11 @@ class ServerSideHelperTest extends TestCase
      */
     private $systemConfig;
 
+    /**
+     * @var MockObject
+     */
+    private $customerSession;
+
     /**
      * Used to reset or change values after running a test
      *
@@ -69,14 +74,15 @@ public function tearDown(): void
     public function setUp(): void
     {
         $this->fbeHelper = $this->createMock(FBEHelper::class);
-        $this->aamFieldsExtractorHelper =
-        $this->createMock(AAMFieldsExtractorHelper::class);
+        $this->aamFieldsExtractorHelper = $this->createMock(AAMFieldsExtractorHelper::class);
         $this->systemConfig = $this->createMock(SystemConfig::class);
         $this->systemConfig->method('getAccessToken')->willReturn('abc');
+        $this->customerSession = $this->createMock(CustomerSession::class);
         $this->serverSideHelper = new ServerSideHelper(
             $this->fbeHelper,
             $this->aamFieldsExtractorHelper,
             $this->systemConfig,
+            $this->customerSession
         );
     }