Add Exception Event (#102)

https://developers.google.com/analytics/devguides/collection/ga4/exceptions

Author: aawnu

src/Event/Exception.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace AlexWestergaard\PhpGa4\Event;
+
+use AlexWestergaard\PhpGa4\Helper\EventHelper;
+use AlexWestergaard\PhpGa4\Facade;
+use AlexWestergaard\PhpGa4\Facade\Type\Ga4ExceptionType;
+
+class Exception extends EventHelper implements Facade\Group\ExceptionFacade
+{
+    protected null|string $description;
+    protected null|bool $fatal;
+
+    public function getName(): string
+    {
+        return 'exception';
+    }
+
+    public function getParams(): array
+    {
+        return [
+            'description',
+            'fatal',
+        ];
+    }
+
+    public function getRequiredParams(): array
+    {
+        return [];
+    }
+
+    public function setDescription(null|string $description)
+    {
+        $this->description = $description;
+        return $this;
+    }
+
+    public function setFatal(null|bool $isFatal)
+    {
+        $this->fatal = $isFatal;
+        return $this;
+    }
+
+    public function parseException(\Exception $exception, $isFatal = false)
+    {
+        if ($exception instanceof Ga4ExceptionType) {
+            return $this;
+        }
+
+        $this->setDescription($exception->getMessage());
+        $this->setFatal($isFatal);
+
+        return $this;
+    }
+}

src/Facade/Group/ExceptionFacade.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace AlexWestergaard\PhpGa4\Facade\Group;
+
+use Exception;
+
+interface ExceptionFacade
+{
+    /**
+     * Report exception data
+     *
+     * @var description
+     * @param string $description eg. Exception->Message()
+     */
+    public function setDescription(null|string $description);
+
+    /**
+     * Report if the exception is fatal
+     *
+     * @var fatal
+     * @param bool $isFatal
+     */
+    public function setFatal(null|bool $isFatal);
+
+    /**
+     * Attempt to parse the message from the Exception and error own known GA4 Exceptions
+     *
+     * @param \Exception $exception
+     */
+    public function parseException(Exception $exception);
+}

test/Unit/EventTest.php

@@ -715,6 +715,26 @@ public function getName(): string
         $class->toArray();
     }
 
+    public function test_exception()
+    {
+
+        $event = new Event\Exception;
+        $this->assertEventNaming($event);
+        $this->assertEventFills($this->populateEventByMethod(clone $event));
+        $this->assertEventFills($this->populateEventByArrayable(clone $event));
+        $this->assertEventFills($this->populateEventByFromArray(clone $event));
+
+        $this->assertImportableByConvertHelper(
+            [
+                [ConvertHelper::camel($event->getName()) => $this->populateEventByFromArray(clone $event)->toArray()]
+            ],
+            $event
+        );
+
+        $this->analytics->addEvent($this->populateEventByFromArray(clone $event));
+        $this->analytics->post();
+    }
+
     protected function assertEventNaming($event)
     {
         $this->assertInstanceOf(Type\EventType::class, $event);
@@ -765,6 +785,9 @@ private function populateEventByFromArray(Type\EventType $event)
             'page_title' => 'Home - Site',
             'screen_resolution' => '1920x1080',
             // ---
+            'description' => "This is a short description",
+            'fatal' => true,
+            // ---
             'currency' => $this->prefill['currency'],
             'value' => 9.99,
             'affiliation' => 'affiliation',
@@ -807,6 +830,9 @@ private function populateEventByArrayable(Type\EventType $event)
         $event['page_title'] = 'Home - Site';
         $event['screen_resolution'] = '1920x1080';
 
+        $event['description'] = 'This is a short description';
+        $event['fatal'] = true;
+
         $event['currency'] = $this->prefill['currency'];
         $event['value'] = 9.99;
         $event['affiliation'] = 'affiliation';
@@ -843,7 +869,7 @@ private function populateEventByArrayable(Type\EventType $event)
     }
 
     private function populateEventByMethod(
-        Type\EventType|Group\AddPaymentInfoFacade|Group\AddShippingInfoFacade|Group\AddToCartFacade|Group\AddToWishlistFacade|Group\AnalyticsFacade|Group\BeginCheckoutFacade|Group\EarnVirtualCurrencyFacade|Group\ExportFacade|Group\GenerateLeadFacade|Group\ItemFacade|Group\JoinGroupFacade|Group\LevelUpFacade|Group\LoginFacade|Group\PostScoreFacade|Group\PurchaseFacade|Group\RefundFacade|Group\RemoveFromCartFacade|Group\SearchFacade|Group\SelectContentFacade|Group\SelectItemFacade|Group\SelectPromotionFacade|Group\ShareFacade|Group\SignUpFacade|Group\SpendVirtualCurrencyFacade|Group\UnlockAchievementFacade|Group\ViewCartFacade|Group\ViewItemFacade|Group\ViewItemListFacade|Group\ViewPromotionFacade|Group\ViewSearchResultsFacade|Group\hasItemsFacade $event
+        Type\EventType|Group\ExceptionFacade|Group\AddPaymentInfoFacade|Group\AddShippingInfoFacade|Group\AddToCartFacade|Group\AddToWishlistFacade|Group\AnalyticsFacade|Group\BeginCheckoutFacade|Group\EarnVirtualCurrencyFacade|Group\ExportFacade|Group\GenerateLeadFacade|Group\ItemFacade|Group\JoinGroupFacade|Group\LevelUpFacade|Group\LoginFacade|Group\PostScoreFacade|Group\PurchaseFacade|Group\RefundFacade|Group\RemoveFromCartFacade|Group\SearchFacade|Group\SelectContentFacade|Group\SelectItemFacade|Group\SelectPromotionFacade|Group\ShareFacade|Group\SignUpFacade|Group\SpendVirtualCurrencyFacade|Group\UnlockAchievementFacade|Group\ViewCartFacade|Group\ViewItemFacade|Group\ViewItemListFacade|Group\ViewPromotionFacade|Group\ViewSearchResultsFacade|Group\hasItemsFacade $event
     ) {
         $params = $event->getAllParams();
 
@@ -853,6 +879,13 @@ private function populateEventByMethod(
         $event->setPageTitle('Home - Site');
         $event->setScreenResolution('1920x1080');
 
+        if (in_array('description', $params)) {
+            $event->setDescription("This is a short description");
+            if (in_array('fatal', $params)) {
+                $event->setFatal(1);
+            }
+        }
+
         if (in_array('currency', $params)) {
             $event->setCurrency($this->prefill['currency']);
             if (in_array('value', $params)) {