issue-resolution/server event additional fields (#172)

Author: priyambad

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

@@ -79,6 +79,11 @@ public function execute(): Json
             if ($eventName) {
                 $payload = $this->pixelEvents[$eventName]->getPayload($params);
                 if (count($payload)) {
+                    // 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();
+
                     $eventType = $this->pixelEvents[$eventName]->getEventType();
 
                     $event = ServerEventFactory::createEvent($eventType, array_filter($payload), $eventId);

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

@@ -162,6 +162,10 @@ private static function addCustomData($event, $data)
             $custom_data->setOrderId($data['order_id']);
         }
 
+        if (!empty($data['custom_properties']) && is_array($data['custom_properties'])) {
+            $custom_data->setCustomProperties($data['custom_properties']);
+        }
+
         return $event;
     }
 

app/code/Meta/Conversion/Observer/AddToCart.php

@@ -101,7 +101,11 @@ public function execute(Observer $observer)
                     'content_type'     => $this->magentoDataHelper->getContentType($product),
                     'content_ids'      => [$this->magentoDataHelper->getContentId($product)],
                     'content_category' => $this->magentoDataHelper->getCategoriesForProduct($product),
-                    'content_name'     => $this->escaper->escapeUrl($product->getName())
+                    'content_name'     => $this->escaper->escapeUrl($product->getName()),
+                    'custom_properties' => [
+                        'source'           => $this->fbeHelper->getSource(),
+                        'pluginVersion'    => $this->fbeHelper->getPluginVersion()
+                    ]
                 ];
                 $event = ServerEventFactory::createEvent('AddToCart', $customData, $eventId);
                 $this->serverSideHelper->sendEvent($event);

app/code/Meta/Conversion/Observer/InitiateCheckout.php

@@ -75,7 +75,11 @@ public function execute(Observer $observer)
                 'content_type' => 'product',
                 'content_ids'  => $this->magentoDataHelper->getCartContentIds(),
                 'num_items'    => $this->magentoDataHelper->getCartNumItems(),
-                'contents'     => $this->magentoDataHelper->getCartContents()
+                'contents'     => $this->magentoDataHelper->getCartContents(),
+                'custom_properties' => [
+                    'source'           => $this->fbeHelper->getSource(),
+                    'pluginVersion'    => $this->fbeHelper->getPluginVersion()
+                ]
             ];
             $event = ServerEventFactory::createEvent('InitiateCheckout', array_filter($customData), $eventId);
             $this->serverSideHelper->sendEvent($event);

app/code/Meta/Conversion/Observer/Purchase.php

@@ -75,7 +75,11 @@ public function execute(Observer $observer)
                 'content_type' => 'product',
                 'content_ids'  => $this->magentoDataHelper->getOrderContentIds(),
                 'contents'     => $this->magentoDataHelper->getOrderContents(),
-                'order_id'     => (string)$this->magentoDataHelper->getOrderId()
+                'order_id'     => (string)$this->magentoDataHelper->getOrderId(),
+                'custom_properties' => [
+                    'source'           => $this->fbeHelper->getSource(),
+                    'pluginVersion'    => $this->fbeHelper->getPluginVersion()
+                ]
             ];
             $event = ServerEventFactory::createEvent('Purchase', array_filter($customData), $eventId);
             $userDataFromOrder = $this->magentoDataHelper->getUserDataFromOrder();