Catching exceptions from Guzzle

Question

I m trying to catch exceptions from a set of tests I m running on an API I m developing and I m using Guzzle to consume the API methods  I ve got the tests wrapped in a try catch block but it is still throwing unhandled exception errors  Adding an event listener as described in their docs doesn t seem to do anything  I need to be able to retrieve the responses that have HTTP codes of 500  401  400  in fact anything that isn t 200 as the system will set the most appropriate code based on the result of the call if it didn t work   Current code example  foreach  tests as  test             client   new Client  api url            client- gt getEventDispatcher  - gt addListener  request error   function Event  event                         if   event  response  - gt getStatusCode      401                     newResponse   new Response  event  response  - gt getStatusCode                      event  response      newResponse                   event- gt stopPropagation                                                   try                 client- gt setDefaultOption  query    query string                request    client- gt get  api version    test  method    array    isset  test  query     test  query   array                    Do something with Guzzle               response    request- gt send                   displayTest  request   response                     catch  Guzzle Http Exception ClientErrorResponseException  e                  req    e- gt getRequest                 resp   e- gt getResponse                displayTest  req  resp                     catch  Guzzle Http Exception ServerErrorResponseException  e                  req    e- gt getRequest                 resp   e- gt getResponse                displayTest  req  resp                     catch  Guzzle Http Exception BadResponseException  e                  req    e- gt getRequest                 resp   e- gt getResponse                displayTest  req  resp                     catch  Exception  e               echo  AGH                       unset  client            client null           Even with the specific catch block for the thrown exception type I am still getting back   Fatal error  Uncaught exception  Guzzle Http Exception ClientErrorResponseException  with message  Client error response  status code  401  reason phrase  Unauthorized  url    and all execution on the page stops  as you d expect  The addition of the BadResponseException catch allowed me to catch 404s correctly  but this doesn t seem to work for 500 or 401 responses  Can anyone suggest where I am going wrong please

User · Answer

I want to update the answer for exception handling in Psr-7 Guzzle, Guzzle7 and HTTPClient(expressive, minimal API around the Guzzle HTTP client provided by laravel).

Guzzle7 (same works for Guzzle 6 as well)

Using RequestException, RequestException catches any exception that can be thrown while transferring requests.

try{
  $client = new \GuzzleHttp\Client(['headers' => ['Authorization' => 'Bearer ' . $token]]);
  
  $guzzleResponse = $client->get('/foobar');
  // or can use
  // $guzzleResponse = $client->request('GET', '/foobar')
    if ($guzzleResponse->getStatusCode() == 200) {
         $response = json_decode($guzzleResponse->getBody(),true);
         //perform your action with $response 
    } 
}
catch(\GuzzleHttp\Exception\RequestException $e){
   // you can catch here 400 response errors and 500 response errors
   // You can either use logs here use Illuminate\Support\Facades\Log;
   $error['error'] = $e->getMessage();
   $error['request'] = $e->getRequest();
   if($e->hasResponse()){
       if ($e->getResponse()->getStatusCode() == '400'){
           $error['response'] = $e->getResponse(); 
       }
   }
   Log::error('Error occurred in get request.', ['error' => $error]);
}catch(Exception $e){
   //other errors 
}

Psr7 Guzzle

use GuzzleHttp\Psr7;
use GuzzleHttp\Exception\RequestException;

try {
    $client->request('GET', '/foo');
} catch (RequestException $e) {
    $error['error'] = $e->getMessage();
    $error['request'] = Psr7\Message::toString($e->getRequest());
    if ($e->hasResponse()) {
        $error['response'] = Psr7\Message::toString($e->getResponse());
    }
    Log::error('Error occurred in get request.', ['error' => $error]);
}

For HTTPClient

use Illuminate\Support\Facades\Http;
try{
    $response = Http::get('http://api.foo.com');
    if($response->successful()){
        $reply = $response->json();
    }
    if($response->failed()){
        if($response->clientError()){
            //catch all 400 exceptions
            Log::debug('client Error occurred in get request.');
            $response->throw();
        }
        if($response->serverError()){
            //catch all 500 exceptions
            Log::debug('server Error occurred in get request.');
            $response->throw();
        }
        
    }
 }catch(Exception $e){
     //catch the exception here
 }

User · Answer

If the Exception is being thrown in that try block then at worst case scenario Exception should be catching anything uncaught   Consider that the first part of the test is throwing the Exception and wrap that in the try block as well

User · Answer

I was catching GuzzleHttp Exception BadResponseException as  dado is suggesting  But one day I got GuzzleHttp Exception ConnectException when DNS for domain wasn t available  So my suggestion is - catch GuzzleHttp Exception ConnectException to be safe about DNS errors as well

User · Answer

In my case I was throwing Exception on a namespaced file  so php tried to catch My Namespace Exception therefore not catching any exceptions at all   Worth checking if catch  Exception  e  is finding the right Exception class    Just try catch   Exception  e   with that   there  and see if it works

User · Answer

Old question  but Guzzle adds the response within the exception object   So a simple try-catch on GuzzleHttp Exception ClientException and then using getResponse on that exception to see what 400-level error and continuing from there

User · Answer

You need to add a extra parameter with http errors    false   request    client- gt get  url    http errors    gt  false

User · Answer

To catch Guzzle errors you can do something like this   try        response    client- gt get   not found xml  - gt send      catch  Guzzle Http Exception BadResponseException  e        echo  Uh oh       e- gt getMessage            but  to be able to  log  or  resend  your request try something like this      Add custom error handling to any request created by this client  client- gt getEventDispatcher  - gt addListener       request error        function Event  event               write log here              if   event  response  - gt getStatusCode      401                    create new token and resend your request                 newRequest    event  request  - gt clone                 newRequest- gt setHeader  X-Auth-Header   MyApplication  getNewAuthToken                  newResponse    newRequest- gt send                    Set the response object of the request without firing more events              event  response      newResponse                  You can also change the response and fire the normal chain of                events by calling  event  request  - gt setResponse  newResponse                   Stop other events from firing when you override 401 responses              event- gt stopPropagation                         or if you want to  stop event propagation  you can overridde event listener  with a higher priority than -255  and simply stop event propagation     client- gt getEventDispatcher  - gt addListener  request error   function Event  event    if   event  response  - gt getStatusCode      200               Stop other events from firing when you get stytus-code    200          event- gt stopPropagation                thats a good idea to prevent guzzle errors like   request CRITICAL  Uncaught PHP Exception Guzzle Http Exception ClientErrorResponseException   Client error response   in your application

User · Answer

Depending on your project  disabling exceptions for guzzle might be necessary  Sometimes coding rules disallow exceptions for flow control  You can disable exceptions for Guzzle 3 like this    client   new  Guzzle Http Client  httpBase  array     request options    gt  array        exceptions    gt  false             This does not disable curl exceptions for something like timeouts  but now you can get every status code easily    request    client- gt get  uri    response    request- gt send     statuscode    response- gt getStatusCode      To check  if you got a valid code  you can use something like this   if   statuscode  gt  300         Do some error handling         or better handle all expected codes   if  200      statuscode         Do something   elseif  304      statuscode         Nothing to do   elseif  404      statuscode         Clean up DB or something like this   else     throw new MyException  Invalid response from api           For Guzzle 5 3   client   new  GuzzleHttp Client   defaults    gt     exceptions    gt  false         Thanks to  mika  For Guzzle 6   client   new  GuzzleHttp Client   http errors    gt  false

[php] Catching exceptions from Guzzle

Guzzle7 (same works for Guzzle 6 as well)

Psr7 Guzzle

For HTTPClient

Examples related to php

Examples related to api

Examples related to functional-testing

Examples related to guzzle