feat: store timestamp in ExpiredException (#604)

Author: cosmastech

src/ExpiredException.php

@@ -6,6 +6,8 @@ class ExpiredException extends \UnexpectedValueException implements JWTException
 {
     private object $payload;
 
+    private ?int $timestamp = null;
+
     public function setPayload(object $payload): void
     {
         $this->payload = $payload;
@@ -15,4 +17,14 @@ public function getPayload(): object
     {
         return $this->payload;
     }
+
+    public function setTimestamp(int $timestamp): void
+    {
+        $this->timestamp = $timestamp;
+    }
+
+    public function getTimestamp(): ?int
+    {
+        return $this->timestamp;
+    }
 }

src/JWT.php

@@ -185,6 +185,7 @@ public static function decode(
         if (isset($payload->exp) && ($timestamp - static::$leeway) >= $payload->exp) {
             $ex = new ExpiredException('Expired token');
             $ex->setPayload($payload);
+            $ex->setTimestamp($timestamp);
             throw $ex;
         }
 

tests/JWTTest.php

@@ -130,6 +130,29 @@ public function testExpiredExceptionPayload()
         }
     }
 
+    /**
+     * @runInSeparateProcess
+     */
+    public function testExpiredExceptionTimestamp()
+    {
+        $this->expectException(ExpiredException::class);
+
+        JWT::$timestamp = 98765;
+        $payload = [
+            'message' => 'abc',
+            'exp' => 1234,
+        ];
+        $encoded = JWT::encode($payload, 'my_key', 'HS256');
+
+        try {
+            JWT::decode($encoded, new Key('my_key', 'HS256'));
+        } catch (ExpiredException $e) {
+            $exTimestamp = $e->getTimestamp();
+            $this->assertSame(98765, $exTimestamp);
+            throw $e;
+        }
+    }
+
     public function testBeforeValidExceptionPayload()
     {
         $this->expectException(BeforeValidException::class);