feat: enhance GenericErrorFormatter with customizable format

Author: jenky

src/Formatter/GenericErrorFormatter.php

@@ -9,6 +9,9 @@
 
 final class GenericErrorFormatter extends AbstractErrorFormatter
 {
+    /**
+     * @var array<string, mixed>
+     */
     private array $format = [
         'message' => '{title}',
         'status' => '{status_code}',

tests/ErrorFormatterTest.php

@@ -6,6 +6,10 @@
 
 use Jenky\ApiError\Formatter\GenericErrorFormatter;
 use Jenky\ApiError\Formatter\Rfc7807ErrorFormatter;
+use Jenky\ApiError\GenericProblem;
+use Jenky\ApiError\Problem;
+use Jenky\ApiError\Rfc7807Problem;
+use Jenky\ApiError\Transformer\ExceptionTransformer;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 
@@ -37,14 +41,15 @@ public function test_generic_error_formatter(\Throwable $exception, bool $debug)
     #[DataProvider('provideExceptions')]
     public function test_rfc7808_error_formatter(\Throwable $exception, bool $debug): void
     {
-        $formatter = new Rfc7807ErrorFormatter($debug);
+        $formatter = new Rfc7807ErrorFormatter($debug, new Rfc7807Transformer());
 
         $data = $formatter->format($exception)->data;
 
         $this->assertIsArray($data);
         $this->assertArrayHasKey('type', $data);
         $this->assertArrayHasKey('title', $data);
         $this->assertArrayHasKey('status', $data);
+        $this->assertArrayHasKey('invalid-params', $data);
 
         if ($debug) {
             $this->assertArrayHasKey('debug', $data);
@@ -57,11 +62,33 @@ public function test_rfc7808_error_formatter(\Throwable $exception, bool $debug)
             $this->assertSame($data['detail'], $exception->getMessage());
         }
 
-        $this->assertSame($data['type'], 'about:blank');
+        $this->assertSame($data['type'], 'http://localhost');
         $this->assertSame($data['title'], 'Internal Server Error');
         $this->assertSame($data['status'], 500);
     }
 
+    #[DataProvider('provideExceptions')]
+    public function test_custom_formatter(\Throwable $exception, bool $debug): void
+    {
+        $formatter = new GenericErrorFormatter(transformer: new ExceptionClassTransformer());
+        $formatter->setFormat([
+            'message' => '{title}',
+            'status' => '{status_code}',
+            'class' => '{class}',
+        ]);
+
+        $data = $formatter->format($exception)->data;
+
+        $this->assertIsArray($data);
+        $this->assertArrayHasKey('message', $data);
+        $this->assertArrayHasKey('status', $data);
+        $this->assertArrayHasKey('class', $data);
+
+        $this->assertSame($data['message'], $exception->getMessage() ?: 'Internal Server Error');
+        $this->assertSame($data['status'], 500);
+        $this->assertSame($data['class'], \get_class($exception));
+    }
+
     public static function provideExceptions(): iterable
     {
         yield [new \RuntimeException(), false];
@@ -74,3 +101,29 @@ public static function provideExceptions(): iterable
         yield [new \InvalidArgumentException('', 100), true];
     }
 }
+
+final class ExceptionClassTransformer implements ExceptionTransformer
+{
+    public function transform(\Throwable $exception): Problem
+    {
+        $problem = GenericProblem::createFromThrowable($exception);
+
+        $problem->set('class', $problem->getClass());
+
+        return $problem;
+    }
+}
+
+final class Rfc7807Transformer implements ExceptionTransformer
+{
+    public function transform(\Throwable $exception): Problem
+    {
+        $problem = Rfc7807Problem::createFromThrowable($exception);
+
+        $problem->setType('http://localhost')
+            ->addInvalidParam('foo', 'bar')
+            ->addInvalidParam('quiz', 'qux');
+
+        return $problem;
+    }
+}

tests/ProblemTest.php

@@ -100,4 +100,19 @@ public static function provideRfc7807ProblemExceptions(): iterable
             ],
         ];
     }
+
+    public function test_rfc7807_setters(): void
+    {
+        $problem = Rfc7807Problem::createFromThrowable(new \RuntimeException('foo'));
+
+        $this->expectException(\InvalidArgumentException::class);
+
+        $problem->setType('bar');
+
+        $problem->addInvalidParam('foo', 'bar');
+        $context = $problem->context();
+
+        $this->assertArrayHasKey('invalid_params', $context);
+        $this->assertEquals($context['invalid_params']['foo'], 'bar');
+    }
 }