harden tests, move errors to E_USER_WARNING for backward compatibilit…

…y until 5.0
Vonage · Oct 9, 2023 · 7439793 · 7439793
1 parent aa19853
commit 7439793
Show file tree

Hide file tree

Showing 2 changed files with 55 additions and 5 deletions.
diff --git a/src/Client/Credentials/Keypair.php b/src/Client/Credentials/Keypair.php
@@ -61,9 +61,10 @@ public function generateJwt(array $claims = []): Token
         $generator = new TokenGenerator($this->application, $this->getKeyRaw());
 
         if (isset($claims['exp'])) {
+            // This will change to an Exception in 5.0
             trigger_error('Expiry date is automatically generated from now and TTL, so cannot be passed in
             as an argument in claims', E_USER_WARNING);
-            unset($claims['exp']);
+            unset($claims['nbf']);
         }
 
         if (isset($claims['ttl'])) {
@@ -79,7 +80,9 @@ public function generateJwt(array $claims = []): Token
         if (isset($claims['nbf'])) {
             // Due to older versions of lcobucci/jwt, this claim has
             // historic fraction conversation issues. For now, nbf is not supported.
-            throw new Validation('NotBefore Claim is not supported in Vonage JWT');
+            // This will change to an Exception in 5.0
+            trigger_error('NotBefore Claim is not supported in Vonage JWT', E_USER_WARNING);
+            unset($claims['nbf']);
         }
 
         if (isset($claims['sub'])) {

diff --git a/test/Client/Credentials/KeypairTest.php b/test/Client/Credentials/KeypairTest.php
@@ -9,6 +9,7 @@
 
 namespace VonageTest\Client\Credentials;
 
+use Vonage\Client\Exception\Validation;
 use VonageTest\VonageTestCase;
 use Vonage\Client\Credentials\Keypair;
 
@@ -19,8 +20,8 @@
 
 class KeypairTest extends VonageTestCase
 {
-    protected $key;
-    protected $application = 'c90ddd99-9a5d-455f-8ade-dde4859e590e';
+    protected string $key;
+    protected string $application = 'c90ddd99-9a5d-455f-8ade-dde4859e590e';
 
     public function setUp(): void
     {
@@ -48,7 +49,6 @@ public function testDefaultJWT(): void
     {
         $credentials = new Keypair($this->key, $this->application);
 
-        //could use the JWT object, but hope to remove as a dependency
         $jwt = (string)$credentials->generateJwt()->toString();
 
         [$header, $payload] = $this->decodeJWT($jwt);
@@ -81,6 +81,53 @@ public function testAdditionalClaims(): void
         $this->assertEquals($claims['arbitrary'], $payload['arbitrary']);
     }
 
+    public function testNbfNotSupported(): void
+    {
+        set_error_handler(static function (int $errno, string $errstr) {
+            throw new \Exception($errstr, $errno);
+        }, E_USER_WARNING);
+
+        $this->expectExceptionMessage('NotBefore Claim is not supported in Vonage JWT');
+
+        $credentials = new Keypair($this->key, $this->application);
+
+        $claims = [
+            'nbf' => time() + 900
+        ];
+
+        $jwt = $credentials->generateJwt($claims);
+        [, $payload] = $this->decodeJWT($jwt->toString());
+
+        $this->assertArrayHasKey('arbitrary', $payload);
+        $this->assertEquals($claims['arbitrary'], $payload['arbitrary']);
+
+        restore_error_handler();
+    }
+
+    public function testExpNotSupported(): void
+    {
+        set_error_handler(static function (int $errno, string $errstr) {
+            throw new \Exception($errstr, $errno);
+        }, E_USER_WARNING);
+
+        $this->expectExceptionMessage('Expiry date is automatically generated from now and TTL, so cannot be passed in
+            as an argument in claims');
+
+        $credentials = new Keypair($this->key, $this->application);
+
+        $claims = [
+            'exp' => time() + 900
+        ];
+
+        $jwt = $credentials->generateJwt($claims);
+        [, $payload] = $this->decodeJWT($jwt->toString());
+
+        $this->assertArrayHasKey('arbitrary', $payload);
+        $this->assertEquals($claims['arbitrary'], $payload['arbitrary']);
+
+        restore_error_handler();
+    }
+
     /**
      * @link https://github.com/Vonage/vonage-php-sdk-core/issues/276
      */