V1.x: Extend Testing & Update Found Issues (#10)

- Add PHP 7.1 to testing Matrix
- Add timestamp validation is within the offset limit
- Update test iterating through default events with validation
- Update .gitignore and composer.json
- Add option to post to Google Analytics on Event limit reached (Empties Events from Class)

Author: aawnu

.github/workflows/ci.yml

@@ -10,11 +10,11 @@ jobs:
   render-php:
     runs-on: ${{ matrix.operating-system }}
     strategy:
-      max-parallel: 4
+      max-parallel: 3
       fail-fast: false
       matrix:
         operating-system: ["ubuntu-latest", "windows-latest"]
-        php-versions: ["7.0", "7.4", "8.0", "8.1"]
+        php-versions: ["7.0", "7.1", "7.4", "8.0", "8.1"]
         phpunit-versions: ["latest"]
     steps:
       - uses: actions/checkout@v3
@@ -37,8 +37,9 @@ jobs:
       - if: ${{ matrix.php-versions >= 8.0 }}
         name: "PHP >8.0"
         run: composer require --dev --with-all-dependencies --no-install phpunit/phpunit
-      - name: "Install & Test"
+      - name: "Install"
         run: |
           composer update --no-install --with-all-dependencies
           composer install
-          ./vendor/bin/phpunit
+      - name: "PHPUnit Tests"
+        run: ./vendor/bin/phpunit

.gitignore

@@ -4,4 +4,4 @@
 
 # PHPUnit
 /.phpunit.cache
-.phpunit.result.cache
+/.phpunit.result.cache

src/Analytics.php

@@ -19,6 +19,7 @@ class Analytics extends Model\ToArray implements Facade\Analytics, Facade\Export
     private $debug;
     private $measurement_id;
     private $api_secret;
+    private $postOnEventLimit = false;
 
     protected $non_personalized_ads;
     protected $timestamp_micros;
@@ -84,11 +85,25 @@ public function setUserId(string $id)
      */
     public function setTimestamp($microOrUnix)
     {
+        $secondInMicro = intval('1_000_000');
+        $offsetLimit = strtotime('-3 days') * $secondInMicro;
+
         if (!is_numeric($microOrUnix)) {
             throw new GA4Exception("setTimestamp value must be numeric");
         }
 
-        $this->timestamp_micros = floor($microOrUnix * 1000000);
+        $formattedTime =  floor($microOrUnix * $secondInMicro);
+        if ($formattedTime < $offsetLimit) {
+            throw new GA4Exception("Timestamp can not be older than 3 days");
+        }
+
+        $this->timestamp_micros = $formattedTime;
+        return $this;
+    }
+
+    public function postOnEventLimit(bool $push = true)
+    {
+        $this->postOnEventLimit = $push;
         return $this;
     }
 
@@ -133,16 +148,22 @@ public function addEvent(Model\Event $event)
         }
 
         $this->events[] = $event->toArray();
+
+        if (count($this->events) >= 25 && $this->postOnEventLimit === true) {
+            $this->post();
+        }
         return $this;
     }
 
     /**
-     * Push your current stack to Google Analytics
+     * Push your current stack to Google Analytics \
+     * Will reset the events list on success
      *
+     * @var bool $skipReset Avoid resetting events list on success, default: false
      * @return bool Whether the request returned status 200
      * @throws AlexWestergaard\PhpGa4\GA4Exception
      */
-    public function post()
+    public function post($skipReset = false)
     {
         $errorStack = null;
 
@@ -187,6 +208,10 @@ public function post()
             throw $errorStack;
         }
 
+        if (!$skipReset) {
+            $this->events = [];
+        }
+
         return $resCode === 200;
     }
 

src/GA4Exception.php

@@ -4,7 +4,7 @@
 
 class GA4Exception extends \Exception
 {
-    public function __construct(string $message = "", ?\Throwable $previous = null)
+    public function __construct(string $message = "", $previous = null)
     {
         parent::__construct($message, 0, $previous);
     }

test/AnalyticsTest.php

@@ -3,16 +3,14 @@
 use AlexWestergaard\PhpGa4\Analytics;
 use AlexWestergaard\PhpGa4\Item;
 use AlexWestergaard\PhpGa4\UserProperty;
+use AlexWestergaard\PhpGa4\GA4Exception;
 
 class AnalyticsTest extends \PHPUnit\Framework\TestCase
 {
     protected $prefill;
     protected $analytics;
     protected $item;
 
-    /**
-     * Setting up each test enviroment variables
-     */
     protected function prepareSituation()
     {
         $this->prefill = [
@@ -38,19 +36,37 @@ protected function prepareSituation()
             ->setQuantity(2);
     }
 
-    /**
-     * Testing that we can send request to Google Analytics with 200 response
-     */
     public function testAnalytics()
     {
         $this->prepareSituation();
 
         $this->assertTrue($this->analytics->post());
     }
 
-    /**
-     * Testing that out item is properly build
-     */
+    public function testTimeIsMicrotime()
+    {
+        $this->prepareSituation();
+
+        $this->analytics->setTimestamp(microtime(true));
+
+        $arr = $this->analytics->toArray();
+
+        $this->assertTrue($arr['timestamp_micros'] > intval('1_000_000'));
+    }
+
+    public function testExceptionIfTimeOlderThanOffsetLimit()
+    {
+        $this->prepareSituation();
+
+        try {
+            $this->analytics->setTimestamp(strtotime('-1 week'));
+        } catch (GA4Exception $e) {
+            $this->assertTrue(true);
+        } catch (Exception $e) {
+            $this->assertTrue(false, "Did not receive correct Exception");
+        }
+    }
+
     public function testItem()
     {
         $this->prepareSituation();
@@ -66,9 +82,6 @@ public function testItem()
         $this->assertArrayHasKey('quantity', $arr);
     }
 
-    /**
-     * Testing that we can send a User Property
-     */
     public function testUserProperty()
     {
         $this->prepareSituation();
@@ -95,17 +108,19 @@ public function testPrebuildEvents()
     {
         $this->prepareSituation();
 
-        $eventCount = 0;
-        foreach (glob(__DIR__ . '/../src/Event/*.php') as $file) {
-            $eventName = 'AlexWestergaard\\PhpGa4\\Event\\' . basename($file, '.php');
+        $getDefaultEventsByFile = glob(__DIR__ . '/../src/Event/*.php');
+
+        foreach (array_chunk($getDefaultEventsByFile, 25) as $chunk) {
+
+            foreach ($chunk as $file) {
+                $eventName = 'AlexWestergaard\\PhpGa4\\Event\\' . basename($file, '.php');
 
-            $this->assertTrue(class_exists($eventName), $eventName);
+                $this->assertTrue(class_exists($eventName), $eventName);
 
-            $event = new $eventName;
-            $required = $event->getRequiredParams();
-            $params = array_unique(array_merge($event->getParams(), $required));
+                $event = new $eventName;
+                $required = $event->getRequiredParams();
+                $params = array_unique(array_merge($event->getParams(), $required));
 
-            try {
                 $this->assertEquals(
                     strtolower(basename($file, '.php')),
                     strtolower(strtr($event->getName(), ['_' => ''])),
@@ -182,29 +197,9 @@ public function testPrebuildEvents()
                 $this->assertTrue(is_array($event->toArray()), $eventName);
 
                 $this->analytics->addEvent($event);
-                $eventCount += 1;
-            } catch (throwable $t) {
-                $this->assertTrue(false, $t->getFile() . ':' . $t->getLine() . ' > ' . $t->getMessage());
             }
 
-            if ($eventCount >= 25) {
-                try {
-                    $this->assertTrue($this->analytics->post());
-                } catch (throwable $t) {
-                    $this->assertTrue(false, $t->getFile() . ':' . $t->getLine() . ' > ' . $t->getMessage());
-                } finally {
-                    $eventCount = 1;
-                    $this->prepareSituation();
-                }
-            }
-        }
-
-        if ($eventCount > 0) {
-            try {
-                $this->assertTrue($this->analytics->post());
-            } catch (throwable $t) {
-                $this->assertTrue(false, $t->getFile() . ':' . $t->getLine() . ' > ' . $t->getMessage());
-            }
+            $this->assertTrue($this->analytics->post());
         }
     }
 }