Merge pull request #22 from Sammyjo20/feature/better-error-handling

Now returning original error and tidied up response

Author: Sammyjo20

src/Http/Middleware/MockMiddleware.php

@@ -2,7 +2,6 @@
 
 namespace Sammyjo20\Saloon\Http\Middleware;
 
-use Psr\Http\Message\RequestInterface;
 use Sammyjo20\Saloon\Http\MockResponse;
 use GuzzleHttp\Promise\FulfilledPromise;
 
@@ -13,6 +12,9 @@ class MockMiddleware
      */
     protected MockResponse $mockResponse;
 
+    /**
+     * @param MockResponse $mockResponse
+     */
     public function __construct(MockResponse $mockResponse)
     {
         $this->mockResponse = $mockResponse;
@@ -26,7 +28,7 @@ public function __construct(MockResponse $mockResponse)
      */
     public function __invoke(callable $handler)
     {
-        return function (RequestInterface $request, array $options) use ($handler) {
+        return function () {
             return new FulfilledPromise($this->mockResponse->toGuzzleResponse());
         };
     }

src/Http/SaloonResponse.php

@@ -3,8 +3,11 @@
 namespace Sammyjo20\Saloon\Http;
 
 use Illuminate\Support\Arr;
+use GuzzleHttp\Psr7\Response;
+use GuzzleHttp\Cookie\CookieJar;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Traits\Macroable;
+use GuzzleHttp\Exception\RequestException;
 use Sammyjo20\Saloon\Exceptions\SaloonRequestException;
 
 class SaloonResponse
@@ -14,9 +17,9 @@ class SaloonResponse
     /**
      * The underlying PSR response.
      *
-     * @var \Psr\Http\Message\ResponseInterface
+     * @var Response
      */
-    protected $response;
+    protected Response $response;
 
     /**
      * The decoded JSON response.
@@ -30,7 +33,7 @@ class SaloonResponse
      *
      * @var array
      */
-    protected array $saloonRequestOptions;
+    protected array $requestOptions;
 
     /**
      * The original request
@@ -44,7 +47,14 @@ class SaloonResponse
      *
      * @var bool
      */
-    protected bool $shouldGuessStatusFromBody = false;
+    protected bool $guessesStatusFromBody = false;
+
+    /**
+     * The original Guzzle request exception
+     *
+     * @var RequestException|null
+     */
+    protected ?RequestException $guzzleRequestException = null;
 
     /**
      * Determines if the response has been cached
@@ -65,25 +75,25 @@ class SaloonResponse
      *
      * @param array $requestOptions
      * @param SaloonRequest $originalRequest
-     * @param $response
-     * @param bool $shouldGuessStatusFromBody
+     * @param Response $response
+     * @param RequestException|null $guzzleRequestException
      */
-    public function __construct(array $requestOptions, SaloonRequest $originalRequest, $response, bool $shouldGuessStatusFromBody = false)
+    public function __construct(array $requestOptions, SaloonRequest $originalRequest, Response $response, RequestException $guzzleRequestException = null)
     {
-        $this->saloonRequestOptions = $requestOptions;
+        $this->requestOptions = $requestOptions;
         $this->originalRequest = $originalRequest;
         $this->response = $response;
-        $this->shouldGuessStatusFromBody = $shouldGuessStatusFromBody;
+        $this->guzzleRequestException = $guzzleRequestException;
     }
 
     /**
      * Get the request options we attached to the request. Headers, Config etc.
      *
      * @return array
      */
-    public function getSaloonRequestOptions(): array
+    public function getRequestOptions(): array
     {
-        return $this->saloonRequestOptions;
+        return $this->requestOptions;
     }
 
     /**
@@ -103,14 +113,14 @@ public function getOriginalRequest(): SaloonRequest
      */
     public function body()
     {
-        return (string) $this->response->getBody();
+        return (string)$this->response->getBody();
     }
 
     /**
      * Get the JSON decoded body of the response as an array or scalar value.
      *
-     * @param  string|null  $key
-     * @param  mixed  $default
+     * @param string|null $key
+     * @param mixed $default
      * @return mixed
      */
     public function json($key = null, $default = null)
@@ -139,21 +149,21 @@ public function object()
     /**
      * Get the JSON decoded body of the response as a collection.
      *
-     * @param  string|null  $key
-     * @return \Illuminate\Support\Collection
+     * @param $key
+     * @return Collection
      */
-    public function collect($key = null)
+    public function collect($key = null): Collection
     {
         return Collection::make($this->json($key));
     }
 
     /**
      * Get a header from the response.
      *
-     * @param  string  $header
+     * @param string $header
      * @return string
      */
-    public function header(string $header)
+    public function header(string $header): string
     {
         return $this->response->getHeaderLine($header);
     }
@@ -163,7 +173,7 @@ public function header(string $header)
      *
      * @return array
      */
-    public function headers()
+    public function headers(): array
     {
         return $this->response->getHeaders();
     }
@@ -173,19 +183,19 @@ public function headers()
      *
      * @return int
      */
-    public function getStatusFromResponse(): int
+    private function getStatusFromResponse(): int
     {
-        return (int) $this->response->getStatusCode();
+        return (int)$this->response->getStatusCode();
     }
 
     /**
      * Get the status code of the response.
      *
      * @return int
      */
-    public function status()
+    public function status(): int
     {
-        if ($this->shouldGuessStatusFromBody === true) {
+        if ($this->guessesStatusFromBody === true) {
             return $this->guessStatusFromBody();
         }
 
@@ -200,33 +210,15 @@ public function status()
      *
      * @return int
      */
-    public function guessStatusFromBody(): int
+    private function guessStatusFromBody(): int
     {
-        $body = $this->json('status', null);
-
-        if (isset($body) === false) {
-            return $this->getStatusFromResponse();
-        }
-
-        if (! preg_match('/^[1-5][0-9][0-9]$/', $body)) {
-            return $this->getStatusFromResponse();
-        }
+        $status = $this->json('status');
 
-        if (is_numeric($body) === false) {
-            return $this->getStatusFromResponse();
+        if (preg_match('/^[1-5][0-9][0-9]$/', $status)) {
+            return (int)$status;
         }
 
-        return (int)$body;
-    }
-
-    /**
-     * Get the effective URI of the response.
-     *
-     * @return \Psr\Http\Message\UriInterface|null
-     */
-    public function effectiveUri()
-    {
-        return optional($this->transferStats)->getEffectiveUri();
+        return $this->getStatusFromResponse();
     }
 
     /**
@@ -292,10 +284,10 @@ public function serverError()
     /**
      * Execute the given callback if there was a server or client error.
      *
-     * @param  callable  $callback
+     * @param callable $callback
      * @return $this
      */
-    public function onError(callable $callback)
+    public function onError(callable $callback): self
     {
         if ($this->failed()) {
             $callback($this);
@@ -309,27 +301,17 @@ public function onError(callable $callback)
      *
      * @return \GuzzleHttp\Cookie\CookieJar
      */
-    public function cookies()
+    public function cookies(): CookieJar
     {
         return $this->cookies;
     }
 
-    /**
-     * Get the handler stats of the response.
-     *
-     * @return array
-     */
-    public function handlerStats()
-    {
-        return optional($this->transferStats)->getHandlerStats() ?? [];
-    }
-
     /**
      * Close the stream and any underlying resources.
      *
      * @return $this
      */
-    public function close()
+    public function close(): self
     {
         $this->response->getBody()->close();
 
@@ -339,19 +321,19 @@ public function close()
     /**
      * Get the underlying PSR response for the response.
      *
-     * @return \Psr\Http\Message\ResponseInterface
+     * @return Response
      */
-    public function toPsrResponse()
+    public function toPsrResponse(): Response
     {
         return $this->response;
     }
 
     /**
      * Get the underlying PSR response for the response.
      *
-     * @return \Psr\Http\Message\ResponseInterface
+     * @return Response
      */
-    public function toGuzzleResponse()
+    public function toGuzzleResponse(): Response
     {
         return $this->toPsrResponse();
     }
@@ -364,15 +346,17 @@ public function toGuzzleResponse()
     public function toException()
     {
         if ($this->failed()) {
-            return new SaloonRequestException($this, $this->response?->getBody()?->getContents());
+            $body = $this->response?->getBody()?->getContents();
+
+            return new SaloonRequestException($this, $body, 0, $this->guzzleRequestException);
         }
     }
 
     /**
      * Throw an exception if a server or client error occurred.
      *
      * @return $this
-     * @throws SaloonException
+     * @throws SaloonRequestException
      */
     public function throw()
     {
@@ -438,4 +422,26 @@ public function isMocked(): bool
     {
         return $this->isMocked;
     }
+
+    /**
+     * Get the original request exception
+     *
+     * @return RequestException|null
+     */
+    public function getGuzzleException(): ?RequestException
+    {
+        return $this->guzzleRequestException;
+    }
+
+    /**
+     * Should the response guess the status from the body?
+     *
+     * @return $this
+     */
+    public function guessesStatusFromBody(): self
+    {
+        $this->guessesStatusFromBody = true;
+
+        return $this;
+    }
 }

src/Managers/RequestManager.php

@@ -8,6 +8,7 @@
 use Sammyjo20\Saloon\Clients\MockClient;
 use Sammyjo20\Saloon\Http\SaloonRequest;
 use Sammyjo20\Saloon\Http\SaloonResponse;
+use GuzzleHttp\Exception\RequestException;
 use Sammyjo20\Saloon\Http\SaloonConnector;
 use Sammyjo20\Saloon\Traits\ManagesGuzzle;
 use Sammyjo20\Saloon\Traits\CollectsConfig;
@@ -175,7 +176,7 @@ public function send()
         try {
             $guzzleResponse = $client->send($this->createGuzzleRequest(), $requestOptions);
         } catch (BadResponseException $exception) {
-            return $this->createResponse($requestOptions, $exception->getResponse());
+            return $this->createResponse($requestOptions, $exception->getResponse(), $exception);
         }
 
         return $this->createResponse($requestOptions, $guzzleResponse);
@@ -186,23 +187,26 @@ public function send()
      *
      * @param array $requestOptions
      * @param Response $response
+     * @param RequestException|null $exception
      * @return SaloonResponse
-     * @throws \ReflectionException
      * @throws SaloonInvalidResponseClassException
-     *
+     * @throws \ReflectionException
+     * @throws \Sammyjo20\Saloon\Exceptions\SaloonInvalidConnectorException
      */
-    private function createResponse(array $requestOptions, Response $response): SaloonResponse
+    private function createResponse(array $requestOptions, Response $response, RequestException $exception = null): SaloonResponse
     {
         $request = $this->request;
-
-        $shouldGuessStatusFromBody = isset($this->connector->shouldGuessStatusFromBody) || isset($this->request->shouldGuessStatusFromBody);
-
         $responseClass = $request->getResponseClass();
 
-        $response = new $responseClass($requestOptions, $request, $response, $shouldGuessStatusFromBody);
+        /** @var SaloonResponse $response */
+        $response = new $responseClass($requestOptions, $request, $response, $exception);
 
         $response->setMocked($this->isMocking());
 
+        if (property_exists($this->connector, 'shouldGuessStatusFromBody') || property_exists($this->request, 'shouldGuessStatusFromBody')) {
+            $response->guessesStatusFromBody();
+        }
+
         // Run Response Interceptors
 
         foreach ($this->getResponseInterceptors() as $responseInterceptor) {