[9.x] Added 'throw' method to PendingRequest (#41953)

* Added 'throw' method to PendingRequest. * Added method to docblock. * formatting Co-authored-by: Taylor Otwell <[email protected]>
laravel · Apr 13, 2022 · 6a71131 · 6a71131
1 parent d7946f5
commit 6a71131
Show file tree

Hide file tree

Showing 4 changed files with 85 additions and 0 deletions.
diff --git a/src/Illuminate/Http/Client/Factory.php b/src/Illuminate/Http/Client/Factory.php
@@ -41,6 +41,7 @@
  * @method \Illuminate\Http\Client\PendingRequest withUserAgent(string $userAgent)
  * @method \Illuminate\Http\Client\PendingRequest withoutRedirecting()
  * @method \Illuminate\Http\Client\PendingRequest withoutVerifying()
+ * @method \Illuminate\Http\Client\PendingRequest throw(callable $callback = null)
  * @method array pool(callable $callback)
  * @method \Illuminate\Http\Client\Response delete(string $url, array $data = [])
  * @method \Illuminate\Http\Client\Response get(string $url, array|string|null $query = null)

diff --git a/src/Illuminate/Http/Client/PendingRequest.php b/src/Illuminate/Http/Client/PendingRequest.php
@@ -89,6 +89,13 @@ class PendingRequest
      */
     protected $options = [];
 
+    /**
+     * A callback to run when throwing if a server or client error occurs.
+     *
+     * @var \Closure
+     */
+    protected $throwCallback;
+
     /**
      * The number of times to try the request.
      *
@@ -547,6 +554,19 @@ public function beforeSending($callback)
         });
     }
 
+    /**
+     * Throw an exception if a server or client error occurs.
+     *
+     * @param  callable|null  $callback
+     * @return $this
+     */
+    public function throw(callable $callback = null)
+    {
+        $this->throwCallback = $callback ?: fn () => null;
+
+        return $this;
+    }
+
     /**
      * Dump the request before sending.
      *
@@ -726,6 +746,10 @@ public function send(string $method, string $url, array $options = [])
                             throw $exception;
                         }
 
+                        if ($this->throwCallback) {
+                            $response->throw($this->throwCallback);
+                        }
+
                         if ($attempt < $this->tries && $shouldRetry) {
                             $response->throw();
                         }

diff --git a/src/Illuminate/Support/Facades/Http.php b/src/Illuminate/Support/Facades/Http.php
@@ -34,6 +34,7 @@
  * @method static \Illuminate\Http\Client\PendingRequest withUserAgent(string $userAgent)
  * @method static \Illuminate\Http\Client\PendingRequest withoutRedirecting()
  * @method static \Illuminate\Http\Client\PendingRequest withoutVerifying()
+ * @method static \Illuminate\Http\Client\PendingRequest throw(callable $callback = null)
  * @method static array pool(callable $callback)
  * @method static \Illuminate\Http\Client\Response delete(string $url, array $data = [])
  * @method static \Illuminate\Http\Client\Response get(string $url, array|string|null $query = null)

diff --git a/tests/Http/HttpClientTest.php b/tests/Http/HttpClientTest.php
@@ -1386,4 +1386,63 @@ public function testMiddlewareRunsWhenFaked()
 
         $this->assertSame(['hyped-for' => 'laravel-movie'], json_decode(tap($history[0]['request']->getBody())->rewind()->getContents(), true));
     }
+
+    public function testRequestExceptionIsNotThrownIfThePendingRequestIsSetToThrowOnFailureButTheResponseIsSuccessful()
+    {
+        $this->factory->fake([
+            '*' => $this->factory->response(['success'], 200),
+        ]);
+
+        $response = $this->factory
+            ->throw()
+            ->get('http://foo.com/get');
+
+        $this->assertSame(200, $response->status());
+    }
+
+    public function testRequestExceptionIsThrownIfThePendingRequestIsSetToThrowOnFailure()
+    {
+        $this->factory->fake([
+            '*' => $this->factory->response(['error'], 403),
+        ]);
+
+        $exception = null;
+
+        try {
+            $this->factory
+                ->throw()
+                ->get('http://foo.com/get');
+        } catch (RequestException $e) {
+            $exception = $e;
+        }
+
+        $this->assertNotNull($exception);
+        $this->assertInstanceOf(RequestException::class, $exception);
+    }
+
+    public function testRequestExceptionIsThrownWithCallbackIfThePendingRequestIsSetToThrowOnFailure()
+    {
+        $this->factory->fake([
+            '*' => $this->factory->response(['error'], 403),
+        ]);
+
+        $exception = null;
+
+        $flag = false;
+
+        try {
+            $this->factory
+                ->throw(function ($exception) use (&$flag) {
+                    $flag = true;
+                })
+                ->get('http://foo.com/get');
+        } catch (RequestException $e) {
+            $exception = $e;
+        }
+
+        $this->assertTrue($flag);
+
+        $this->assertNotNull($exception);
+        $this->assertInstanceOf(RequestException::class, $exception);
+    }
 }