[11.x] Add ability to customize or disable `Http\Client\RequestExcept…

…ion` message truncation (#53734) * Add ability to disable or customize exception message truncation * Add tests for truncation * Spacing * Fix spacing * formatting --------- Co-authored-by: Taylor Otwell <[email protected]>
laravel · Dec 6, 2024 · 69d3d07 · 69d3d07
1 parent 5ed48d3
commit 69d3d07
Show file tree

Hide file tree

Showing 3 changed files with 103 additions and 1 deletion.
diff --git a/src/Illuminate/Foundation/Configuration/Exceptions.php b/src/Illuminate/Foundation/Configuration/Exceptions.php
@@ -4,6 +4,7 @@
 
 use Closure;
 use Illuminate\Foundation\Exceptions\Handler;
+use Illuminate\Http\Client\RequestException;
 use Illuminate\Support\Arr;
 
 class Exceptions
@@ -200,4 +201,27 @@ public function stopIgnoring(array|string $class)
 
         return $this;
     }
+
+    /**
+     * Set the truncation length for request exception messages.
+     *
+     * @param  int  $length
+     * @return $this
+     */
+    public function truncateRequestExceptionsAt(int $length)
+    {
+        RequestException::truncateAt($length);
+
+        return $this;
+    }
+
+    /**
+     * Disable truncation of request exception messages.
+     *
+     * @return $this
+     */
+    public function dontTruncateRequestExceptions()
+    {
+        RequestException::dontTruncate();
+    }
 }
diff --git a/src/Illuminate/Http/Client/RequestException.php b/src/Illuminate/Http/Client/RequestException.php
@@ -13,6 +13,13 @@ class RequestException extends HttpClientException
      */
     public $response;
 
+    /**
+     * The truncation length for the exception message.
+     *
+     * @var int|false
+     */
+    public static $truncateAt = 120;
+
     /**
      * Create a new exception instance.
      *
@@ -26,6 +33,37 @@ public function __construct(Response $response)
         $this->response = $response;
     }
 
+    /**
+     * Enable truncation of request exception messages.
+     *
+     * @return void
+     */
+    public static function truncate()
+    {
+        static::$truncateAt = 120;
+    }
+
+    /**
+     * Set the truncation length for request exception messages.
+     *
+     * @param  int  $length
+     * @return void
+     */
+    public static function truncateAt(int $length)
+    {
+        static::$truncateAt = $length;
+    }
+
+    /**
+     * Disable truncation of request exception messages.
+     *
+     * @return void
+     */
+    public static function dontTruncate()
+    {
+        static::$truncateAt = false;
+    }
+
     /**
      * Prepare the exception message.
      *
@@ -36,7 +74,9 @@ protected function prepareMessage(Response $response)
     {
         $message = "HTTP request returned status code {$response->status()}";
 
-        $summary = Message::bodySummary($response->toPsrResponse());
+        $summary = static::$truncateAt
+            ? Message::bodySummary($response->toPsrResponse(), static::$truncateAt)
+            : Message::toString($response->toPsrResponse());
 
         return is_null($summary) ? $message : $message .= ":\n{$summary}\n";
     }

diff --git a/tests/Http/HttpClientTest.php b/tests/Http/HttpClientTest.php
@@ -51,6 +51,8 @@ protected function setUp(): void
         parent::setUp();
 
         $this->factory = new Factory;
+
+        RequestException::truncate();
     }
 
     protected function tearDown(): void
@@ -1257,6 +1259,42 @@ public function testRequestExceptionTruncatedSummary()
         throw new RequestException(new Response($response));
     }
 
+    public function testRequestExceptionWithoutTruncatedSummary()
+    {
+        RequestException::dontTruncate();
+
+        $this->expectException(RequestException::class);
+        $this->expectExceptionMessage('{"error":{"code":403,"message":"The Request can not be completed because quota limit was exceeded. Please, check our support team to increase your limit');
+
+        $error = [
+            'error' => [
+                'code' => 403,
+                'message' => 'The Request can not be completed because quota limit was exceeded. Please, check our support team to increase your limit',
+            ],
+        ];
+        $response = new Psr7Response(403, [], json_encode($error));
+
+        throw new RequestException(new Response($response));
+    }
+
+    public function testRequestExceptionWithCustomTruncatedSummary()
+    {
+        RequestException::truncateAt(60);
+
+        $this->expectException(RequestException::class);
+        $this->expectExceptionMessage('{"error":{"code":403,"message":"The Request can not be compl (truncated...)');
+
+        $error = [
+            'error' => [
+                'code' => 403,
+                'message' => 'The Request can not be completed because quota limit was exceeded. Please, check our support team to increase your limit',
+            ],
+        ];
+        $response = new Psr7Response(403, [], json_encode($error));
+
+        throw new RequestException(new Response($response));
+    }
+
     public function testRequestExceptionEmptyBody()
     {
         $this->expectException(RequestException::class);