A nice API to handle API errors

Author: dunglas

src/Bridge/Symfony/Bundle/Test/Client.php

@@ -75,7 +75,7 @@ public function request(string $method, string $url, array $options = []): Respo
                 (\is_array($options['body']) || $options['body'] instanceof \JsonSerializable) &&
                 (
                     $json ||
-                    false !== preg_match('#^application/(?:.+\+)?json$#', $options['headers']['content-type'][0])
+                    false !== preg_match('#^application/(?:.+\+)?json#', $options['headers']['content-type'][0])
                 )
             ) {
                 // Encode the JSON

src/Bridge/Symfony/Bundle/Test/Exception/ClientException.php

@@ -0,0 +1,27 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\Bridge\Symfony\Bundle\Test\Exception;
+
+use Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface;
+
+/**
+ * Represents a 4xx response.
+ *
+ * @author Kévin Dunglas <[email protected]>
+ *
+ * @internal
+ */
+final class ClientException extends \RuntimeException implements ClientExceptionInterface
+{
+}

src/Bridge/Symfony/Bundle/Test/Exception/JsonException.php

@@ -0,0 +1,27 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\Bridge\Symfony\Bundle\Test;
+
+use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
+
+/**
+ * Thrown by responses' toArray() method when their content cannot be JSON-decoded.
+ *
+ * @author Kévin Dunglas <[email protected]>
+ *
+ * @internal
+ */
+final class JsonException extends \JsonException implements TransportExceptionInterface
+{
+}

src/Bridge/Symfony/Bundle/Test/Exception/RedirectionException.php

@@ -0,0 +1,27 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\Bridge\Symfony\Bundle\Test;
+
+use Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface;
+
+/**
+ * Represents a 3xx response.
+ *
+ * @author Kévin Dunglas <[email protected]>
+ *
+ * @internal
+ */
+final class RedirectionException extends \RuntimeException implements RedirectionExceptionInterface
+{
+}

src/Bridge/Symfony/Bundle/Test/Exception/ServerException.php

@@ -0,0 +1,27 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\Bridge\Symfony\Bundle\Test;
+
+use Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface;
+
+/**
+ * Represents a 5xx response.
+ *
+ * @author Kévin Dunglas <[email protected]>
+ *
+ * @internal
+ */
+final class ServerException extends \RuntimeException implements ServerExceptionInterface
+{
+}

src/Bridge/Symfony/Bundle/Test/Exception/TransportException.php

@@ -0,0 +1,25 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\Bridge\Symfony\Bundle\Test;
+
+use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
+
+/**
+ * @author Kévin Dunglas <[email protected]>
+ *
+ * @internal
+ */
+final class TransportException extends \RuntimeException implements TransportExceptionInterface
+{
+}

src/Bridge/Symfony/Bundle/Test/Response.php

@@ -13,6 +13,7 @@
 
 namespace ApiPlatform\Core\Bridge\Symfony\Bundle\Test;
 
+use ApiPlatform\Core\Bridge\Symfony\Bundle\Test\Exception\ClientException;
 use Symfony\Component\BrowserKit\Response as BrowserKitResponse;
 use Symfony\Component\HttpClient\Exception\JsonException;
 use Symfony\Component\HttpFoundation\Response as HttpFoundationResponse;
@@ -65,21 +66,29 @@ public function getInfo(string $type = null)
         return $this->info;
     }
 
+    /**
+     * Checks the status, and try to extract message if appropriate.
+     */
     private function checkStatusCode()
     {
+        $message = 'An error '.$this->info['http_code'].' occured.';
+        if (isset($this->headers['content-type'][0]) && false !== preg_match('#^application/(?:.+\+)?json#', $this->headers['content-type'][0])) {
+            if ($json = json_decode($this->content, true)) {
+                // Try to extract the error message from Hydra or RFC 7807 error structures
+                $message = $json['hydra:description'] ?? $json['hydra:title'] ?? $json['detail'] ?? $json['title'] ?? $message;
+            }
+        }
+
         if (500 <= $this->info['http_code']) {
-            throw new class('', $this->info['http_code']) extends \RuntimeException implements ServerExceptionInterface {
-            };
+            throw new ServerException($message, $this->info['http_code']);
         }
 
         if (400 <= $this->info['http_code']) {
-            throw new class('', $this->info['http_code']) extends \RuntimeException implements ClientExceptionInterface {
-            };
+            throw new ClientException($message, $this->info['http_code']);
         }
 
         if (300 <= $this->info['http_code']) {
-            throw new class('', $this->info['http_code']) extends \RuntimeException implements RedirectionExceptionInterface {
-            };
+            throw new RedirectionException($message, $this->info['http_code']);
         }
     }