Refactor microseconds converstion to helper and add tests (#43)

Author: aawnu

src/Analytics.php

@@ -71,15 +71,16 @@ public function setUserId(string $id)
 
     public function setTimestampMicros(int|float $microOrUnix)
     {
-        $secondInMicro = 1_000_000;
-        $offsetLimit = (strtotime('-3 days') + 90) * $secondInMicro;
+        $min = Helper\ConvertHelper::timeAsMicro(strtotime('-3 days') + 10);
+        $max = Helper\ConvertHelper::timeAsMicro(time() + 3);
 
-        $formattedTime =  floor($microOrUnix * $secondInMicro);
-        if ($formattedTime < $offsetLimit) {
+        $time = Helper\ConvertHelper::timeAsMicro($microOrUnix);
+
+        if ($time < $min || $time > $max) {
             throw Ga4Exception::throwMicrotimeExpired();
         }
 
-        $this->timestamp_micros = intval($formattedTime);
+        $this->timestamp_micros = $time;
         return $this;
     }
 

src/Exception/Ga4Exception.php

@@ -42,6 +42,11 @@ public static function throwMissingApiSecret()
         return new static("Timestamp must be numeric", static::REQUEST_MISSING_API_SECRET);
     }
 
+    public static function throwMicrotimeInvalid($inp)
+    {
+        return new static("Timestamp $inp is not valid", static::MICROTIME_INVALID_FORMAT);
+    }
+
     public static function throwMicrotimeExpired()
     {
         return new static("Timestamp is too old, max 3 days", static::MICROTIME_EXPIRED);

src/Helper/ConvertHelper.php

@@ -3,9 +3,32 @@
 namespace AlexWestergaard\PhpGa4\Helper;
 
 use AlexWestergaard\PhpGa4\Facade\Type\EventType;
+use AlexWestergaard\PhpGa4\Exception\Ga4Exception;
 
 class ConvertHelper
 {
+    /**
+     * Converts unix or microtime to microseconds; 1 second = 1,000,000 microseconds
+     *
+     * @param int|float $unixOrMicro time() or microtime(true)
+     *
+     * @return int
+     * @throws Ga4Exception
+     */
+    public static function timeAsMicro(int|float $unixOrMicro)
+    {
+        $secondAsMicro = 1_000_000;
+
+        $input = strlen(intval($unixOrMicro));
+        $current = strlen(time()) + 1;
+
+        if ($input > $current) {
+            throw Ga4Exception::throwMicrotimeInvalid($unixOrMicro);
+        }
+
+        return intval($secondAsMicro * $unixOrMicro);
+    }
+
     /**
      * @param string $input
      * @return string snake_case

test/Unit/AnalyticsTest.php

@@ -4,7 +4,6 @@
 
 use AlexWestergaard\PhpGa4\UserProperty;
 use AlexWestergaard\PhpGa4\Facade;
-use AlexWestergaard\PhpGa4\Exception\Ga4Exception;
 use AlexWestergaard\PhpGa4\Event;
 use AlexWestergaard\PhpGa4\Analytics;
 use AlexWestergaard\PhpGa4Test\TestCase;
@@ -61,7 +60,7 @@ public function test_converts_to_full_microtime_stamp()
 
     public function test_throws_if_microtime_older_than_three_days()
     {
-        $this->expectException(Ga4Exception::class);
+        $this->expectException(Facade\Type\Ga4ExceptionType::class);
         $this->expectExceptionCode(Facade\Type\Ga4ExceptionType::MICROTIME_EXPIRED);
 
         $this->analytics->setTimestampMicros(strtotime('-1 week'));
@@ -106,16 +105,16 @@ public function test_exports_events_to_array()
 
     public function test_throws_missing_measurement_id()
     {
-        $this->expectException(Ga4Exception::class);
-        $this->expectExceptionCode(Ga4Exception::REQUEST_MISSING_MEASUREMENT_ID);
+        $this->expectException(Facade\Type\Ga4ExceptionType::class);
+        $this->expectExceptionCode(Facade\Type\Ga4ExceptionType::REQUEST_MISSING_MEASUREMENT_ID);
 
         Analytics::new('', $this->prefill['api_secret'], true)->post();
     }
 
     public function test_throws_missing_apisecret()
     {
-        $this->expectException(Ga4Exception::class);
-        $this->expectExceptionCode(Ga4Exception::REQUEST_MISSING_API_SECRET);
+        $this->expectException(Facade\Type\Ga4ExceptionType::class);
+        $this->expectExceptionCode(Facade\Type\Ga4ExceptionType::REQUEST_MISSING_API_SECRET);
 
         Analytics::new($this->prefill['measurement_id'], '', true)->post();
     }
@@ -128,8 +127,8 @@ public function test_throws_on_too_large_request_package()
             $preparyKB .= 'AAAAAAAA'; // 8 bytes
         }
 
-        $this->expectException(Ga4Exception::class);
-        $this->expectExceptionCode(Ga4Exception::REQUEST_TOO_LARGE);
+        $this->expectException(Facade\Type\Ga4ExceptionType::class);
+        $this->expectExceptionCode(Facade\Type\Ga4ExceptionType::REQUEST_TOO_LARGE);
 
         $userProperty = UserProperty::new()->setName('large_package');
 
@@ -141,4 +140,24 @@ public function test_throws_on_too_large_request_package()
 
         $this->analytics->addUserProperty($userProperty)->post();
     }
+
+    public function test_timeasmicro_throws_exceeding_max()
+    {
+        $time = time() + 60;
+
+        $this->expectException(Facade\Type\Ga4ExceptionType::class);
+        $this->expectExceptionCode(Facade\Type\Ga4ExceptionType::MICROTIME_EXPIRED);
+
+        $this->analytics->setTimestampMicros($time);
+    }
+
+    public function test_timeasmicro_throws_exceeding_min()
+    {
+        $time = strtotime('-1 month');
+
+        $this->expectException(Facade\Type\Ga4ExceptionType::class);
+        $this->expectExceptionCode(Facade\Type\Ga4ExceptionType::MICROTIME_EXPIRED);
+
+        $this->analytics->setTimestampMicros($time);
+    }
 }

test/Unit/HelperTest.php

@@ -3,6 +3,7 @@
 namespace AlexWestergaard\PhpGa4Test\Unit;
 
 use AlexWestergaard\PhpGa4\Helper;
+use AlexWestergaard\PhpGa4\Facade;
 use AlexWestergaard\PhpGa4\Event;
 use AlexWestergaard\PhpGa4Test\TestCase;
 
@@ -36,4 +37,25 @@ public function test_camelcase_helper_transforms_snakecase_names()
         $output = Helper\ConvertHelper::camel('snake_case');
         $this->assertEquals('snakeCase', $output);
     }
+
+    public function test_timeasmicro_converts_to_microseconds()
+    {
+        $time = time();
+        $secondAsMicro = 1_000_000;
+        $timeAsMicro = $time * $secondAsMicro;
+
+        $convert = Helper\ConvertHelper::timeAsMicro($time);
+
+        $this->assertEquals($timeAsMicro, $convert);
+    }
+
+    public function test_timeasmicro_throws_too_large()
+    {
+        $time = time() * 100;
+
+        $this->expectException(Facade\Type\Ga4ExceptionType::class);
+        $this->expectExceptionCode(Facade\Type\Ga4ExceptionType::MICROTIME_INVALID_FORMAT);
+
+        $this->analytics->setTimestampMicros($time);
+    }
 }