Add context to payload

Author: loevgaard

src/Client/Client.php

@@ -46,7 +46,7 @@ public function sendEvent(Event $event): void
         $httpClient = $this->getHttpClient();
         $requestFactory = $this->getRequestFactory();
 
-        $data = json_encode([$event], \JSON_THROW_ON_ERROR);
+        $data = json_encode([$event->getPayload()], \JSON_THROW_ON_ERROR);
 
         foreach ($event->pixels as $pixel) {
             $body = [

src/Event/Content.php

@@ -26,7 +26,7 @@ public function __construct(
         $this->deliveryCategory = $deliveryCategory;
     }
 
-    protected function getMapping(): array
+    protected function getMapping(string $context): array
     {
         return [
             'id' => $this->id,

src/Event/Custom.php

@@ -44,7 +44,7 @@ final class Custom extends Parameters
      */
     public array $customProperties = [];
 
-    protected function getMapping(): array
+    protected function getMapping(string $context): array
     {
         return array_merge($this->customProperties, [
             'content_category' => $this->contentCategory,

src/Event/Event.php

@@ -163,7 +163,7 @@ public static function getEvents(): array
         ];
     }
 
-    protected function getMapping(): array
+    protected function getMapping(string $context): array
     {
         return [
             'event_name' => $this->eventName,

src/Event/Parameters.php

@@ -6,34 +6,32 @@
 
 use FacebookAds\Object\ServerSide\Normalizer;
 use FacebookAds\Object\ServerSide\Util;
-use JsonSerializable;
 use Webmozart\Assert\Assert;
 
-abstract class Parameters implements JsonSerializable
+abstract class Parameters
 {
+    public const PAYLOAD_CONTEXT_BROWSER = 'browser';
+
+    public const PAYLOAD_CONTEXT_SERVER = 'server';
+
     /**
      * This method returns an array representation of the object ready
      * to be sent to Meta/Facebook, i.e. it's both normalized and hashed
      */
-    public function getPayload(): array
+    public function getPayload(string $context = self::PAYLOAD_CONTEXT_SERVER): array
     {
-        $payload = self::normalize($this->getMapping());
+        $payload = self::normalize($this->getMapping($context));
         Assert::isArray($payload);
 
         return $payload;
     }
 
-    public function jsonSerialize(): array
-    {
-        return $this->getPayload();
-    }
-
     /**
      * Returns the Meta/Facebook fields mapped to their respective values
      *
      * @return array<string, mixed>
      */
-    abstract protected function getMapping(): array;
+    abstract protected function getMapping(string $context): array;
 
     /**
      * Returns a list of Meta/Facebook field names that must be normalized by \FacebookAds\Object\ServerSide\Normalizer::normalize

src/Event/User.php

@@ -58,9 +58,9 @@ final class User extends Parameters
 
     public ?int $leadId = null;
 
-    protected function getMapping(): array
+    protected function getMapping(string $context): array
     {
-        return [
+        $mapping = [
             'em' => $this->email,
             'ph' => $this->phoneNumber,
             'fn' => $this->firstName,
@@ -80,6 +80,17 @@ protected function getMapping(): array
             'fb_login_id' => $this->fbLoginId,
             'lead_id' => $this->leadId,
         ];
+
+        if (self::PAYLOAD_CONTEXT_BROWSER === $context) {
+            unset(
+                $mapping['client_ip_address'],
+                $mapping['client_user_agent'],
+                $mapping['fbc'],
+                $mapping['fbp'],
+            );
+        }
+
+        return $mapping;
     }
 
     /**

src/Generator/FbqGenerator.php

@@ -5,12 +5,13 @@
 namespace Setono\MetaConversionsApi\Generator;
 
 use Setono\MetaConversionsApi\Event\Event;
+use Setono\MetaConversionsApi\Event\Parameters;
 
 final class FbqGenerator implements FbqGeneratorInterface
 {
     public function generateInit(Event $event, bool $includeScriptTag = false): string
     {
-        $json = json_encode($event->userData, \JSON_THROW_ON_ERROR);
+        $json = json_encode($event->userData->getPayload(Parameters::PAYLOAD_CONTEXT_BROWSER), \JSON_THROW_ON_ERROR);
 
         $str = '';
 
@@ -31,7 +32,7 @@ public function generateTrack(Event $event, bool $includeScriptTag = false): str
             "fbq('%s', '%s', %s, {eventID: '%s'});",
             $event->isCustom() ? 'trackCustom' : 'track',
             $event->eventName,
-            json_encode($event->customData, \JSON_THROW_ON_ERROR),
+            json_encode($event->customData->getPayload(Parameters::PAYLOAD_CONTEXT_BROWSER), \JSON_THROW_ON_ERROR),
             $event->eventId
         );
 

tests/Generator/FbqGeneratorTest.php

@@ -25,12 +25,12 @@ public function it_generates_init(): void
 
         $generator = new FbqGenerator();
         self::assertSame(<<<EXPECTED
-fbq('init', '111', {"db":["cccd631dbe89ae6c982a960f248fabab8a4ae7f899853a3ea5bceef8ca1d6585"],"client_ip_address":"192.168.0.1","client_user_agent":"Chrome"});fbq('init', '222', {"db":["cccd631dbe89ae6c982a960f248fabab8a4ae7f899853a3ea5bceef8ca1d6585"],"client_ip_address":"192.168.0.1","client_user_agent":"Chrome"});
+fbq('init', '111', {"db":["cccd631dbe89ae6c982a960f248fabab8a4ae7f899853a3ea5bceef8ca1d6585"]});fbq('init', '222', {"db":["cccd631dbe89ae6c982a960f248fabab8a4ae7f899853a3ea5bceef8ca1d6585"]});
 EXPECTED
             , $generator->generateInit($event));
 
         self::assertSame(<<<EXPECTED
-<script>fbq('init', '111', {"db":["cccd631dbe89ae6c982a960f248fabab8a4ae7f899853a3ea5bceef8ca1d6585"],"client_ip_address":"192.168.0.1","client_user_agent":"Chrome"});fbq('init', '222', {"db":["cccd631dbe89ae6c982a960f248fabab8a4ae7f899853a3ea5bceef8ca1d6585"],"client_ip_address":"192.168.0.1","client_user_agent":"Chrome"});</script>
+<script>fbq('init', '111', {"db":["cccd631dbe89ae6c982a960f248fabab8a4ae7f899853a3ea5bceef8ca1d6585"]});fbq('init', '222', {"db":["cccd631dbe89ae6c982a960f248fabab8a4ae7f899853a3ea5bceef8ca1d6585"]});</script>
 EXPECTED
             , $generator->generateInit($event, true));
     }