Merge pull request #21 from utopia-php/feat-additiona-error-details

Feat: return additional error object with exception

Author: abnegate

src/Pay/Adapter/Stripe.php

@@ -359,7 +359,7 @@ protected function handleError(int $code, mixed $response)
                 $type = $error['decline_code'] ?? $type;
             }
             $message = $error['message'] ?? 'Unknown error';
-            throw new Exception($type, $message, $code);
+            throw new Exception($type, $message, $code, $error);
         }
 
         throw new Exception($response, $code);

src/Pay/Exception.php

@@ -16,10 +16,18 @@ class Exception extends \Exception
 
     protected string $type = '';
 
-    public function __construct(string $type = Exception::GENERAL_UNKNOWN, string $message = null, int $code = null, \Throwable $previous = null)
+    /**
+     * Metadata object with additional error data
+     *
+     * @var array
+     */
+    protected array $metadata = [];
+
+    public function __construct(string $type = Exception::GENERAL_UNKNOWN, string $message = null, int $code = null, array $metadata = [], \Throwable $previous = null)
     {
         $this->type = $type;
         $this->code = $code ?? 500;
+        $this->metadata = $metadata;
 
         $this->message = $message ?? 'Unknown error';
 
@@ -46,4 +54,25 @@ public function setType(string $type): void
     {
         $this->type = $type;
     }
+
+    /**
+     * Get metadata object.
+     *
+     * @return string
+     */
+    public function getMetadata(): array
+    {
+        return $this->metadata;
+    }
+
+    /**
+     * Set metadata object.
+     *
+     * @param  array  $metadata
+     * @return void
+     */
+    public function setMetadata(array $metadata): void
+    {
+        $this->metadata = $metadata;
+    }
 }

tests/Pay/Adapter/StripeTest.php

@@ -408,6 +408,8 @@ public function testErrorHandling(): void
         } catch (Exception $e) {
             $this->assertEquals(402, $e->getCode());
             $this->assertEquals(Exception::AUTHENTICATION_REQUIRED, $e->getType());
+            $this->assertNotEmpty($e->getMetadata());
+            $this->assertEquals(Exception::AUTHENTICATION_REQUIRED, $e->getMetadata()['decline_code']);
             $this->assertInstanceOf(Exception::class, $e);
         }