Merge pull request #3 from Setono/middleware

Fix the populating of properties even if the event would be sent async
Setono · Dec 19, 2023 · cc1db27 · cc1db27
2 parents a70825e + 2b8d89a
commit cc1db27
Show file tree

Hide file tree

Showing 18 changed files with 148 additions and 128 deletions.
diff --git a/src/DependencyInjection/SetonoSyliusPlausibleExtension.php b/src/DependencyInjection/SetonoSyliusPlausibleExtension.php
@@ -37,7 +37,11 @@ public function prepend(ContainerBuilder $container): void
         $container->prependExtensionConfig('framework', [
             'messenger' => [
                 'buses' => [
-                    'setono_sylius_plausible.event_bus' => null,
+                    'setono_sylius_plausible.event_bus' => [
+                        'middleware' => [
+                            'setono_sylius_plausible.message.middleware.populate',
+                        ],
+                    ],
                 ],
             ],
         ]);

diff --git a/src/Event/Plausible/Event.php b/src/Event/Plausible/Event.php
@@ -12,9 +12,6 @@ class Event implements \JsonSerializable
 
     private ?Revenue $revenue = null;
 
-    /** @var array<string, mixed> */
-    private array $context = [];
-
     public function __construct(private readonly string $name)
     {
         $this->properties = new Properties();
@@ -66,31 +63,6 @@ public function setRevenue(string $currency, float $amount): static
         return $this;
     }
 
-    public function getContext(): array
-    {
-        return $this->context;
-    }
-
-    /**
-     * You can set an event specific context that event listeners can use to add more data to the event.
-     * The context is not sent to Plausible.
-     *
-     * @param array<string, mixed> $context
-     */
-    public function setContext(array $context): static
-    {
-        $this->context = $context;
-
-        return $this;
-    }
-
-    public function addContext(string $key, mixed $value): static
-    {
-        $this->context[$key] = $value;
-
-        return $this;
-    }
-
     public function clientSide(): static
     {
         $this->clientSide = true;

diff --git a/src/Event/Plausible/Properties.php b/src/Event/Plausible/Properties.php
@@ -83,9 +83,9 @@ public function offsetUnset(mixed $offset): void
         unset($this->properties[$offset]);
     }
 
-    public function jsonSerialize(): ?array
+    public function jsonSerialize(): array
     {
-        return $this->properties;
+        return array_filter($this->properties, static fn (mixed $value): bool => null !== $value && '' !== $value);
     }
 
     /**

diff --git a/src/Event/PopulateEvent.php b/src/Event/PopulateEvent.php
@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusPlausiblePlugin\Event;
+
+use Setono\SyliusPlausiblePlugin\Event\Plausible\Event;
+
+/**
+ * This event is dispatched in the middleware on the event bus, and you can listen to it to populate the event with data
+ */
+final class PopulateEvent
+{
+    public function __construct(public readonly Event $event)
+    {
+    }
+}
diff --git a/src/Event/PreSendEvent.php b/src/Event/PreSendEvent.php
diff --git a/src/EventSubscriber/AddressSubscriber.php b/src/EventSubscriber/AddressSubscriber.php
@@ -6,9 +6,6 @@
 
 use Setono\SyliusPlausiblePlugin\Event\Plausible\Event;
 use Setono\SyliusPlausiblePlugin\Event\Plausible\Events;
-use Sylius\Bundle\ResourceBundle\Event\ResourceControllerEvent;
-use Sylius\Component\Core\Model\OrderInterface;
-use Webmozart\Assert\Assert;
 
 final class AddressSubscriber extends AbstractEventSubscriber
 {
@@ -19,14 +16,10 @@ public static function getSubscribedEvents(): array
         ];
     }
 
-    public function track(ResourceControllerEvent $resourceControllerEvent): void
+    public function track(): void
     {
         try {
-            /** @var OrderInterface|mixed $order */
-            $order = $resourceControllerEvent->getSubject();
-            Assert::isInstanceOf($order, OrderInterface::class);
-
-            $this->eventBus->dispatch((new Event(Events::ADDRESS))->addContext('order', $order));
+            $this->eventBus->dispatch(new Event(Events::ADDRESS));
         } catch (\Throwable $e) {
             $this->log(Events::ADDRESS, $e);
         }

diff --git a/src/EventSubscriber/BeginCheckoutSubscriber.php b/src/EventSubscriber/BeginCheckoutSubscriber.php
@@ -46,7 +46,7 @@ public function track(RequestEvent $requestEvent): void
             $order = $this->cartContext->getCart();
             Assert::isInstanceOf($order, OrderInterface::class);
 
-            $this->eventBus->dispatch((new Event(Events::BEGIN_CHECKOUT))->addContext('order', $order));
+            $this->eventBus->dispatch(new Event(Events::BEGIN_CHECKOUT));
         } catch (\Throwable $e) {
             $this->log(Events::BEGIN_CHECKOUT, $e);
         }

diff --git a/src/EventSubscriber/PageviewSubscriber.php b/src/EventSubscriber/PageviewSubscriber.php
@@ -20,11 +20,11 @@ public static function getSubscribedEvents(): array
 
     public function track(RequestEvent $requestEvent): void
     {
-        try {
-            if (!$requestEvent->isMainRequest()) {
-                return;
-            }
+        if (!$requestEvent->isMainRequest()) {
+            return;
+        }
 
+        try {
             $this->eventBus->dispatch(new Event(Events::PAGEVIEW));
         } catch (\Throwable $e) {
             $this->log(Events::PAGEVIEW, $e);

diff --git a/src/EventSubscriber/PopulateOrderRelatedPropertiesSubscriber.php b/src/EventSubscriber/PopulateOrderRelatedPropertiesSubscriber.php
@@ -5,45 +5,55 @@
 namespace Setono\SyliusPlausiblePlugin\EventSubscriber;
 
 use Setono\SyliusPlausiblePlugin\Event\Plausible\Event;
-use Setono\SyliusPlausiblePlugin\Event\PreSendEvent;
+use Setono\SyliusPlausiblePlugin\Event\PopulateEvent;
 use Sylius\Component\Core\Model\OrderInterface;
+use Sylius\Component\Order\Context\CartContextInterface;
+use Sylius\Component\Order\Context\CartNotFoundException;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
-use Webmozart\Assert\Assert;
 
 final class PopulateOrderRelatedPropertiesSubscriber implements EventSubscriberInterface
 {
+    public function __construct(private readonly CartContextInterface $cartContext)
+    {
+    }
+
     public static function getSubscribedEvents(): array
     {
         return [
-            PreSendEvent::class => 'populate',
+            PopulateEvent::class => 'populate',
         ];
     }
 
-    public function populate(PreSendEvent $event): void
+    public function populate(PopulateEvent $event): void
     {
-        $context = $event->event->getContext();
-        if (!isset($context['order'])) {
+        try {
+            $order = $this->cartContext->getCart();
+        } catch (CartNotFoundException) {
+            return;
+        }
+
+        if (!$order instanceof OrderInterface) {
             return;
         }
 
-        /** @var OrderInterface|mixed $order */
-        $order = $context['order'];
-        Assert::isInstanceOf($order, OrderInterface::class);
+        /** @var mixed $orderId */
+        $orderId = $order->getId();
+
+        // if the order id is null it means that the order has not been persisted yet
+        if (null === $orderId) {
+            return;
+        }
 
         $event->event
-            ->setProperty('order_id', (string) $order->getId())
-            ->setProperty('order_number', (string) $order->getNumber())
+            ->setProperty('order_id', $orderId)
+            ->setProperty('order_number', $order->getNumber())
             ->setProperty('shipping_total', $order->getShippingTotal())
             ->setProperty('order_promotion_total', $order->getOrderPromotionTotal())
+            ->setProperty('payment_method', $order->getLastPayment()?->getMethod()?->getCode())
+            ->setProperty('coupon_code', $order->getPromotionCoupon()?->getCode())
         ;
 
-        $couponCode = $order->getPromotionCoupon()?->getCode();
-        if (null !== $couponCode) {
-            $event->event->setProperty('coupon_code', $couponCode);
-        }
-
         self::populateShippingMethod($order, $event->event);
-        self::populatePaymentMethod($order, $event->event);
     }
 
     private static function populateShippingMethod(OrderInterface $order, Event $event): void
@@ -58,16 +68,6 @@ private static function populateShippingMethod(OrderInterface $order, Event $eve
             $shippingMethodCode = $shippingMethod->getCode();
         }
 
-        if (null !== $shippingMethodCode) {
-            $event->setProperty('shipping_method', $shippingMethodCode);
-        }
-    }
-
-    private static function populatePaymentMethod(OrderInterface $order, Event $event): void
-    {
-        $paymentMethodCode = $order->getLastPayment()?->getMethod()?->getCode();
-        if (null !== $paymentMethodCode) {
-            $event->setProperty('payment_method', $paymentMethodCode);
-        }
+        $event->setProperty('shipping_method', $shippingMethodCode);
     }
 }
diff --git a/src/EventSubscriber/PurchaseSubscriber.php b/src/EventSubscriber/PurchaseSubscriber.php
@@ -54,7 +54,6 @@ public function track(RequestEvent $requestEvent): void
 
             $this->eventBus->dispatch(
                 (new Event(Events::PURCHASE))
-                    ->addContext('order', $order)
                     ->setRevenue((string) $order->getCurrencyCode(), self::formatAmount($order->getTotal())),
             );
         } catch (\Throwable $e) {

diff --git a/src/EventSubscriber/SelectPaymentMethodSubscriber.php b/src/EventSubscriber/SelectPaymentMethodSubscriber.php
@@ -6,9 +6,6 @@
 
 use Setono\SyliusPlausiblePlugin\Event\Plausible\Event;
 use Setono\SyliusPlausiblePlugin\Event\Plausible\Events;
-use Sylius\Bundle\ResourceBundle\Event\ResourceControllerEvent;
-use Sylius\Component\Core\Model\OrderInterface;
-use Webmozart\Assert\Assert;
 
 final class SelectPaymentMethodSubscriber extends AbstractEventSubscriber
 {
@@ -19,14 +16,10 @@ public static function getSubscribedEvents(): array
         ];
     }
 
-    public function track(ResourceControllerEvent $resourceControllerEvent): void
+    public function track(): void
     {
         try {
-            /** @var OrderInterface|mixed $order */
-            $order = $resourceControllerEvent->getSubject();
-            Assert::isInstanceOf($order, OrderInterface::class);
-
-            $this->eventBus->dispatch((new Event(Events::SELECT_PAYMENT_METHOD))->addContext('order', $order));
+            $this->eventBus->dispatch(new Event(Events::SELECT_PAYMENT_METHOD));
         } catch (\Throwable $e) {
             $this->log(Events::SELECT_PAYMENT_METHOD, $e);
         }

diff --git a/src/EventSubscriber/SelectShippingMethodSubscriber.php b/src/EventSubscriber/SelectShippingMethodSubscriber.php
@@ -6,9 +6,6 @@
 
 use Setono\SyliusPlausiblePlugin\Event\Plausible\Event;
 use Setono\SyliusPlausiblePlugin\Event\Plausible\Events;
-use Sylius\Bundle\ResourceBundle\Event\ResourceControllerEvent;
-use Sylius\Component\Core\Model\OrderInterface;
-use Webmozart\Assert\Assert;
 
 final class SelectShippingMethodSubscriber extends AbstractEventSubscriber
 {
@@ -19,14 +16,10 @@ public static function getSubscribedEvents(): array
         ];
     }
 
-    public function track(ResourceControllerEvent $resourceControllerEvent): void
+    public function track(): void
     {
         try {
-            /** @var OrderInterface|mixed $order */
-            $order = $resourceControllerEvent->getSubject();
-            Assert::isInstanceOf($order, OrderInterface::class);
-
-            $this->eventBus->dispatch((new Event(Events::SELECT_SHIPPING_METHOD))->addContext('order', $order));
+            $this->eventBus->dispatch(new Event(Events::SELECT_SHIPPING_METHOD));
         } catch (\Throwable $e) {
             $this->log(Events::SELECT_SHIPPING_METHOD, $e);
         }

diff --git a/src/Message/EventHandler/ClientSideEventHandler.php b/src/Message/EventHandler/ClientSideEventHandler.php
@@ -4,35 +4,24 @@
 
 namespace Setono\SyliusPlausiblePlugin\Message\EventHandler;
 
-use Psr\EventDispatcher\EventDispatcherInterface;
 use Psr\Log\LoggerAwareInterface;
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
 use Setono\SyliusPlausiblePlugin\Event\Plausible\Event;
-use Setono\SyliusPlausiblePlugin\Event\PreSendEvent;
 use Setono\TagBag\Tag\InlineScriptTag;
 use Setono\TagBag\TagBagInterface;
 
 final class ClientSideEventHandler implements LoggerAwareInterface
 {
     private LoggerInterface $logger;
 
-    public function __construct(
-        private readonly TagBagInterface $tagBag,
-        private readonly EventDispatcherInterface $eventDispatcher,
-    ) {
+    public function __construct(private readonly TagBagInterface $tagBag)
+    {
         $this->logger = new NullLogger();
     }
 
     public function __invoke(Event $event): void
     {
-        $preSendEvent = new PreSendEvent($event);
-        $this->eventDispatcher->dispatch($preSendEvent);
-
-        if (!$preSendEvent->send) {
-            return;
-        }
-
         $event->clientSide();
 
         try {

diff --git a/src/Message/Middleware/PopulateMiddleware.php b/src/Message/Middleware/PopulateMiddleware.php
@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusPlausiblePlugin\Message\Middleware;
+
+use Psr\EventDispatcher\EventDispatcherInterface;
+use Setono\SyliusPlausiblePlugin\Event\Plausible\Event;
+use Setono\SyliusPlausiblePlugin\Event\PopulateEvent;
+use Setono\SyliusPlausiblePlugin\Message\Stamp\PopulatedStamp;
+use Symfony\Component\Messenger\Envelope;
+use Symfony\Component\Messenger\Middleware\MiddlewareInterface;
+use Symfony\Component\Messenger\Middleware\StackInterface;
+
+final class PopulateMiddleware implements MiddlewareInterface
+{
+    public function __construct(private readonly EventDispatcherInterface $eventDispatcher)
+    {
+    }
+
+    public function handle(Envelope $envelope, StackInterface $stack): Envelope
+    {
+        $message = $envelope->getMessage();
+
+        if ($message instanceof Event && $envelope->last(PopulatedStamp::class) === null) {
+            $this->eventDispatcher->dispatch(new PopulateEvent($message));
+            $envelope = $envelope->with(new PopulatedStamp());
+        }
+
+        return $stack->next()->handle($envelope, $stack);
+    }
+}
diff --git a/src/Message/Stamp/PopulatedStamp.php b/src/Message/Stamp/PopulatedStamp.php
@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusPlausiblePlugin\Message\Stamp;
+
+use Symfony\Component\Messenger\Stamp\StampInterface;
+
+final class PopulatedStamp implements StampInterface
+{
+}