Merge pull request #235 from sdinteractive/ADO-313-capi-changes

ADO-313: fixes issues with message queue implementation for capi events

Author: mpchadwick

app/code/Meta/Conversion/Controller/Pixel/Tracker.php

@@ -11,6 +11,7 @@
 use Magento\Framework\Controller\Result\Json;
 use Magento\Framework\MessageQueue\PublisherInterface;
 use Magento\Framework\Serialize\Serializer\Json as JsonSerializer;
+use FacebookAds\Object\ServerSide\Util;
 
 class Tracker implements HttpPostActionInterface
 {
@@ -84,6 +85,10 @@ public function execute(): Json
                 $payload = $this->pixelEvents[$eventName]->getPayload($params);
                 $payload['event_id'] = $params['eventId'];
                 $payload['event_type'] = $this->pixelEvents[$eventName]->getEventType();
+                $payload['request_uri'] = Util::getRequestUri();
+                $payload['user_agent'] = Util::getHttpUserAgent();
+                $payload['fbp'] = Util::getFbp();
+                $payload['fbc'] = Util::getFbc();
                 if (isset($payload)) {
                     $this->publisher->publish('send.conversion.event.to.meta', $this->jsonSerializer->serialize($payload));
                     $response['success'] = true;

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

@@ -62,19 +62,24 @@ public function __construct(
      * @param string|null $eventId
      * @return Event
      */
-    public function newEvent($eventName, $eventId = null)
+    public function newEvent($eventName, $additionalPayloadData, $eventId = null)
     {
         // Capture default user-data parameters passed down from the client browser.
+        
+        $userAgent = $this->getValueOrFallback('user_agent', $additionalPayloadData, [Util::class, 'getHttpUserAgent']);
+        $fbp = $this->getValueOrFallback('fbp', $additionalPayloadData, [Util::class, 'getFbp']);
+        $fbc = $this->getValueOrFallback('fbc', $additionalPayloadData, [Util::class, 'getFbc']);
         $userData = (new UserData())
                   ->setClientIpAddress($this->getIpAddress())
-                  ->setClientUserAgent(Util::getHttpUserAgent())
-                  ->setFbp(Util::getFbp())
-                  ->setFbc(Util::getFbc());
+                  ->setClientUserAgent($userAgent)
+                  ->setFbp($fbp)
+                  ->setFbc($fbc);
 
+        $requestUri = $this->getValueOrFallback('request_uri', $additionalPayloadData, [Util::class, 'getRequestUri']);
         $event = (new Event())
               ->setEventName($eventName)
               ->setEventTime(time())
-              ->setEventSourceUrl(Util::getRequestUri())
+              ->setEventSourceUrl($requestUri)
               ->setActionSource('website')
               ->setUserData($userData)
               ->setCustomData(new CustomData());
@@ -88,6 +93,11 @@ public function newEvent($eventName, $eventId = null)
         return $event;
     }
 
+    private function getValueOrFallback($key, $data, $fallbackCallback)
+    {
+        return (!empty($data[$key])) ? $data[$key] : $fallbackCallback();
+    }
+
     /**
      * Get the IP address from the $_SERVER variable
      *
@@ -178,9 +188,9 @@ private function addCustomData($event, $data)
      * @param string|null $eventId
      * @return Event
      */
-    public function createEvent($eventName, $data, $eventId = null)
+    public function createEvent($eventName, $data, $additionalPayloadData, $eventId = null)
     {
-        $event = $this->newEvent($eventName, $eventId);
+        $event = $this->newEvent($eventName, $additionalPayloadData, $eventId);
 
         return $this->addCustomData($event, $data);
     }

app/code/Meta/Conversion/Model/CapiEventHandler.php

@@ -34,12 +34,15 @@ public function process(string $message): void
             unset($payload['event_id']);
             unset($payload['event_type']);
 
+            $additionalPayloadKeys = ['request_uri', 'user_agent', 'fbp', 'fbc'];
+            $additionalPayloadData = array_intersect_key($payload, array_flip($additionalPayloadKeys));
+            $payload = array_diff_key($payload, array_flip($additionalPayloadKeys));
+
             // Add source and pluginVersion in the payload as custom properties
             $payload['custom_properties'] = [];
             $payload['custom_properties']['source'] = $this->fbeHelper->getSource();
             $payload['custom_properties']['pluginVersion'] = $this->fbeHelper->getPluginVersion();
-
-            $event = $this->serverEventFactory->createEvent($eventType, array_filter($payload), $eventId);
+            $event = $this->serverEventFactory->createEvent($eventType, array_filter($payload), $additionalPayloadData, $eventId);
             if (isset($payload['userDataFromOrder'])) {
                 $this->serverSideHelper->sendEvent($event, $payload['userDataFromOrder']);
             } else {

app/code/Meta/Conversion/Model/CapiTracker.php

@@ -3,6 +3,7 @@
 
 namespace Meta\Conversion\Model;
 
+use FacebookAds\Object\ServerSide\Util;
 use Magento\Customer\Model\Session as CustomerSession;
 use Magento\Framework\Serialize\Serializer\Json as JsonSerializer;
 use Magento\Framework\MessageQueue\PublisherInterface;
@@ -29,6 +30,10 @@ public function execute(array $payload, string $eventName, string $eventType, bo
             $eventId = $this->generateEventId($eventName, $useSessionForEventIds);
             $payload['event_id'] = $eventId;
             $payload['event_type'] = $eventType;
+            $payload['request_uri'] = Util::getRequestUri();
+            $payload['user_agent'] = Util::getHttpUserAgent();
+            $payload['fbp'] = Util::getFbp();
+            $payload['fbc'] = Util::getFbc();
             $this->publisher->publish('send.conversion.event.to.meta', $this->jsonSerializer->serialize($payload));
         }
     }