spatie/guzzle-redirect-history-middleware

A Guzzle middleware to keep track of redirects

1.0.1 2021-10-15 15:16 UTC

This package is auto-updated.

Last update: 2024-01-25 14:05:13 UTC


README

68747470733a2f2f6769746875622d6164732e73332e65752d63656e7472616c2d312e616d617a6f6e6177732e636f6d2f737570706f72742d756b7261696e652e7376673f743d31

A Guzzle middleware to keep track of redirects

Latest Version on Packagist Tests GitHub Code Style Action Status Total Downloads

This package contains middleware for Guzzle that allows you to track redirects that happened during a request.

Support us

68747470733a2f2f6769746875622d6164732e73332e65752d63656e7472616c2d312e616d617a6f6e6177732e636f6d2f67757a7a6c652d72656469726563742d686973746f72792d6d6964646c65776172652e6a70673f743d31

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Installation

You can install the package via composer:

composer require spatie/guzzle-redirect-history-middleware

Usage

Here is a quick example of how you can use the Spatie\GuzzleRedirectHistoryMiddleware\RedirectHistoryMiddleware to store the redirect history in a Spatie\GuzzleRedirectHistoryMiddleware\RedirectHistory instance.

use Spatie\GuzzleRedirectHistoryMiddleware\RedirectHistory;
use Spatie\GuzzleRedirectHistoryMiddleware\RedirectHistoryMiddleware;

/*
 * First create a new instance of `RedirectHistory`
 * This instance can be used after the requests to get the redirects.
 */
$redirectHistory = new RedirectHistory();

/*
 * This is the default way to add a middleware to Guzzle
 * default middleware stack.
 */
$stack = HandlerStack::create();
$stack->push(RedirectHistoryMiddleware::make($redirectHistory));

/*
 * Let's create Guzzle client that uses the middleware stack
 * containing our `RedirectHistoryMiddleware`.
 */
$client = new Client([
    'handler' => $stack,
]);

/*
 * Now, let's make a request.
 */
$response = $client->get($anyUrl);

/*
 * And tada, here are all the redirects performed
 * during the request.
 */
$redirects = $redirectHistory->toArray();

$redirects is an array of which item is an array with these keys:

  • status: the status code of the response
  • url: the URL of the performed request that resulted in a redirect

So if you make a request to https://example.com/page-a which redirects to /page-b which finally redirects to /page-c, this will be the content of $redirects

[
    ['status' => 302, 'url' => 'https://example.com/page-a'],
    ['status' => 302, 'url' => 'https://example.com/page-b'],
    ['status' => 200, 'url' => 'https://example.com/page-c'],
];

Even if your initial request results in a \GuzzleHttp\Exception\TooManyRedirectsException, the RedirectHistory will still contain the performed redirects

Why we created this package

Guzzle has built-in support for tracking redirects. Unfortunately, it isn't that developer friendly to use. You'll have to manipulate and combine arrays found in the X-Guzzle-Redirect-History and X-Guzzle-Redirect-Status-History headers.

Also, when hitting an exception such as TooManyRedirectsException, these headers won't be filled.

Our package makes it easy to retrieve the redirects in a sane format. You're also able to get the redirect history even if the request ultimately fails.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.