[HttpClient] throw DecodingExceptionInterface when toArray() fails because of content-type error

nicolas-grekas · nicolas-grekas · commit 3f167417fb97 · 2019-06-16T20:17:37.000+02:00
diff --git a/src/Symfony/Component/HttpClient/Exception/JsonException.php b/src/Symfony/Component/HttpClient/Exception/JsonException.php
@@ -11,7 +11,7 @@
 
 namespace Symfony\Component\HttpClient\Exception;
 
-use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
+use Symfony\Contracts\HttpClient\Exception\DecodingExceptionInterface;
 
 /**
  * Thrown by responses' toArray() method when their content cannot be JSON-decoded.
@@ -20,6 +20,6 @@
  *
  * @experimental in 4.3
  */
-final class JsonException extends \JsonException implements TransportExceptionInterface
+final class JsonException extends \JsonException implements DecodingExceptionInterface
 {
 }
diff --git a/src/Symfony/Component/HttpClient/composer.json b/src/Symfony/Component/HttpClient/composer.json
@@ -21,7 +21,7 @@
     "require": {
         "php": "^7.1.3",
         "psr/log": "^1.0",
-        "symfony/http-client-contracts": "^1.1.3",
+        "symfony/http-client-contracts": "^1.1.4",
         "symfony/polyfill-php73": "^1.11"
     },
     "require-dev": {
diff --git a/src/Symfony/Contracts/HttpClient/Exception/DecodingExceptionInterface.php b/src/Symfony/Contracts/HttpClient/Exception/DecodingExceptionInterface.php
@@ -0,0 +1,23 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Contracts\HttpClient\Exception;
+
+/**
+ * When a content-type cannot be decoded to the expected representation.
+ *
+ * @author Nicolas Grekas <p@tchwork.com>
+ *
+ * @experimental in 1.1
+ */
+interface DecodingExceptionInterface extends ExceptionInterface
+{
+}
diff --git a/src/Symfony/Contracts/HttpClient/ResponseInterface.php b/src/Symfony/Contracts/HttpClient/ResponseInterface.php
@@ -12,6 +12,7 @@
 namespace Symfony\Contracts\HttpClient;
 
 use Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface;
+use Symfony\Contracts\HttpClient\Exception\DecodingExceptionInterface;
 use Symfony\Contracts\HttpClient\Exception\ExceptionInterface;
 use Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface;
 use Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface;
@@ -64,7 +65,8 @@ public function getContent(bool $throw = true): string;
      *
      * @param bool $throw Whether an exception should be thrown on 3/4/5xx status codes
      *
-     * @throws TransportExceptionInterface   When the body cannot be decoded or when a network error occurs
+     * @throws DecodingExceptionInterface    When the body cannot be decoded to an array
+     * @throws TransportExceptionInterface   When a network error occurs
      * @throws RedirectionExceptionInterface On a 3xx when $throw is true and the "max_redirects" option has been reached
      * @throws ClientExceptionInterface      On a 4xx when $throw is true
      * @throws ServerExceptionInterface      On a 5xx when $throw is true

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\HttpClient\Exception;`
`13`	`13`
`14`		`-use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;`
	`14`	`+use Symfony\Contracts\HttpClient\Exception\DecodingExceptionInterface;`
`15`	`15`
`16`	`16`	`/**`
`17`	`17`	`* Thrown by responses' toArray() method when their content cannot be JSON-decoded.`
`@@ -20,6 +20,6 @@`
`20`	`20`	`*`
`21`	`21`	`* @experimental in 4.3`
`22`	`22`	`*/`
`23`		`-final class JsonException extends \JsonException implements TransportExceptionInterface`
	`23`	`+final class JsonException extends \JsonException implements DecodingExceptionInterface`
`24`	`24`	`{`
`25`	`25`	`}`