Update the generateInit method on FbqGenerator class to make it more flexible

Author: loevgaard

src/Generator/FbqGenerator.php

@@ -4,18 +4,38 @@
 
 namespace Setono\MetaConversionsApi\Generator;
 
+use Psr\Log\LoggerAwareInterface;
+use Psr\Log\LoggerInterface;
+use Psr\Log\NullLogger;
 use Setono\MetaConversionsApi\Event\Event;
 use Setono\MetaConversionsApi\Event\Parameters;
 
-final class FbqGenerator implements FbqGeneratorInterface
+final class FbqGenerator implements FbqGeneratorInterface, LoggerAwareInterface
 {
-    public function generateInit(Event $event, bool $includePageView = true, bool $includeScriptTag = false): string
+    private LoggerInterface $logger;
+
+    public function __construct()
     {
-        $json = json_encode($event->userData->getPayload(Parameters::PAYLOAD_CONTEXT_BROWSER), \JSON_THROW_ON_ERROR);
+        $this->logger = new NullLogger();
+    }
+
+    public function generateInit(
+        array $pixels,
+        array $userData,
+        bool $includePageView = true,
+        bool $includeScriptTag = true
+    ): string {
+        try {
+            $json = json_encode($userData, \JSON_THROW_ON_ERROR);
+        } catch (\JsonException $e) {
+            $this->logger->error($e->getMessage());
+
+            return '';
+        }
 
         $str = '';
 
-        foreach ($event->pixels as $pixel) {
+        foreach ($pixels as $pixel) {
             $str .= sprintf("fbq('init', '%s', %s);", $pixel->id, $json);
         }
 
@@ -30,7 +50,7 @@ public function generateInit(Event $event, bool $includePageView = true, bool $i
         return $str;
     }
 
-    public function generateTrack(Event $event, bool $includeScriptTag = false): string
+    public function generateTrack(Event $event, bool $includeScriptTag = true): string
     {
         $str = sprintf(
             "fbq('%s', '%s', %s, {eventID: '%s'});",
@@ -46,4 +66,9 @@ public function generateTrack(Event $event, bool $includeScriptTag = false): str
 
         return $str;
     }
+
+    public function setLogger(LoggerInterface $logger): void
+    {
+        $this->logger = $logger;
+    }
 }

src/Generator/FbqGeneratorInterface.php

@@ -5,16 +5,24 @@
 namespace Setono\MetaConversionsApi\Generator;
 
 use Setono\MetaConversionsApi\Event\Event;
+use Setono\MetaConversionsApi\Pixel\Pixel;
 
 interface FbqGeneratorInterface
 {
     /**
-     * Will generate the fbq() init call based on the given event and for each pixel ids defined in the event
+     * Will generate the fbq() init call based on the given pixels. By default, this also includes the page view event
+     *
+     * @param list<Pixel> $pixels
      */
-    public function generateInit(Event $event, bool $includePageView = true, bool $includeScriptTag = false): string;
+    public function generateInit(
+        array $pixels,
+        array $userData,
+        bool $includePageView = true,
+        bool $includeScriptTag = true
+    ): string;
 
     /**
      * Will generate the fbq() tracking call based on the given event and for each pixel ids defined in the event
      */
-    public function generateTrack(Event $event, bool $includeScriptTag = false): string;
+    public function generateTrack(Event $event, bool $includeScriptTag = true): string;
 }

tests/Generator/FbqGeneratorTest.php

@@ -6,6 +6,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Setono\MetaConversionsApi\Event\Event;
+use Setono\MetaConversionsApi\Event\Parameters;
 use Setono\MetaConversionsApi\Pixel\Pixel;
 
 final class FbqGeneratorTest extends TestCase
@@ -27,12 +28,12 @@ public function it_generates_init(): void
         self::assertSame(<<<EXPECTED
 fbq('init', '111', {"db":["cccd631dbe89ae6c982a960f248fabab8a4ae7f899853a3ea5bceef8ca1d6585"]});fbq('init', '222', {"db":["cccd631dbe89ae6c982a960f248fabab8a4ae7f899853a3ea5bceef8ca1d6585"]});fbq('track', 'PageView');
 EXPECTED
-            , $generator->generateInit($event));
+            , $generator->generateInit($event->pixels, $event->userData->getPayload(Parameters::PAYLOAD_CONTEXT_BROWSER), true, false));
 
         self::assertSame(<<<EXPECTED
 <script>fbq('init', '111', {"db":["cccd631dbe89ae6c982a960f248fabab8a4ae7f899853a3ea5bceef8ca1d6585"]});fbq('init', '222', {"db":["cccd631dbe89ae6c982a960f248fabab8a4ae7f899853a3ea5bceef8ca1d6585"]});fbq('track', 'PageView');</script>
 EXPECTED
-            , $generator->generateInit($event, true, true));
+            , $generator->generateInit($event->pixels, $event->userData->getPayload(Parameters::PAYLOAD_CONTEXT_BROWSER)));
     }
 
     /**
@@ -50,11 +51,11 @@ public function it_generates_track(): void
         self::assertSame(<<<EXPECTED
 fbq('track', 'Purchase', {"content_ids":["PROD_1","PROD_2"],"value":110.51}, {eventID: 'event_id'});
 EXPECTED
-            , $generator->generateTrack($event));
+            , $generator->generateTrack($event, false));
 
         self::assertSame(<<<EXPECTED
 <script>fbq('track', 'Purchase', {"content_ids":["PROD_1","PROD_2"],"value":110.51}, {eventID: 'event_id'});</script>
 EXPECTED
-            , $generator->generateTrack($event, true));
+            , $generator->generateTrack($event));
     }
 }