Middleware to log Guzzle requests with Telescope

example.php

<?php

$stack = \GuzzleHttp\HandlerStack::create();
$stack->push(new \App\Http\Client\HttpClientEventsMiddleware());
$client = new \GuzzleHttp\Client(['handler' => $stack]);

$client->get('http://example.com');

HttpClientEventsMiddleware.php

<?php

namespace App\Http\Client;

use GuzzleHttp\Promise;
use Illuminate\Http\Client\Events\ConnectionFailed;
use Illuminate\Http\Client\Events\RequestSending;
use Illuminate\Http\Client\Events\ResponseReceived;
use Illuminate\Http\Client\Request;
use Illuminate\Http\Client\Response;

class HttpClientEventsMiddleware {

    public function __invoke(callable $handler)
    {
        return function ($request, array $options) use ($handler) {

            $laravelRequest = new Request($request);

            event(new RequestSending($laravelRequest));

            return $handler($request, $options)->then(
                $this->onSuccess($laravelRequest),
                $this->onFailure($laravelRequest)
            );
        };
    }

    protected function onSuccess(Request $request)
    {
        return function ($response) use ($request) {

            event(new ResponseReceived($request, new Response($response)));

            return $response;
        };
    }

    protected function onFailure(Request $request)
    {
        return function ($reason) use ($request) {

            event(new ConnectionFailed($request));

            return Promise\Create::rejectionFor($reason);
        };
    }


}

Exactly what I was looking for! Barry strikes again with a real gem 👍

We have to pass a Guzzle instance to an external library but we don't get tracking with the Laravel Sentry integration. This should fix that for us. Thanks.

Edit: There is a caveat to be aware of. If an event handler reads the body of the response then your actual code that was using the Guzzle client in the first place will get an empty response body. This is due to the body being a stream that can only be read once. I'm not sure of the best solution, but I ended up introducing this change:

protected function onSuccess(Request $request)
{
    return function ($response) use ($request) {

        event(new ResponseReceived($request, new Response($response)));

+       $response->getBody()->rewind(); // Rewind the body so that the caller can read it again

        return $response;
    };
}

This looks promising but if we are using a 3rd party package that uses Guzzle how do we force the middleware to kick in? The example.php makes sense but I don't see how to apply this to a vendor package without branching and making our own.

@emergingdzns, if they don't allow you to pass in a guzzle instance then it may not be possible. There is a default middleware stack that you could mess with - but sometimes it is just easier to take the fork of the package. We do this with a few smaller packages to take control of the network stack.

Since I'm working with Laravel 11, ConnectionFailed requires two parameters, so I changed the code to this:

<?php

namespace App\Http\Client;

use GuzzleHttp\Promise;
use Illuminate\Http\Client\Events\ConnectionFailed;
use Illuminate\Http\Client\Events\RequestSending;
use Illuminate\Http\Client\Events\ResponseReceived;
use Illuminate\Http\Client\Request;
use Illuminate\Http\Client\Response;

class HttpClientEventsMiddleware {
{
    public function __invoke(callable $handler)
    {
        return function ($request, array $options) use ($handler) {

            $laravelRequest = new Request($request);

            event(new RequestSending($laravelRequest));

            return $handler($request, $options)->then(
                $this->onSuccess($laravelRequest),
                $this->onFailure($laravelRequest)
            );
        };
    }

    protected function onSuccess(Request $request)
    {
        return function ($response) use ($request) {
            event(new ResponseReceived($request, new Response($response)));

            return $response;
        };
    }

    protected function onFailure(Request $request)
    {
        return function ($e) use ($request) {
            event(new ConnectionFailed($request, new ConnectionException($e->getMessage(), $e->getCode(), $e)));

            return Promise\Create::rejectionFor($e);
        };
    }
}