🎯Retrying Requests

Sometimes you may use APIs that are unreliable or require you to retry multiple times before a request is successful. Saloon has a global retry system that can be configured to automatically retry failed requests.

Configuring our connector

Let's say that we have an API which isn't reliable. We can define a public $tries property on our connector which defines how many times a request will be sent if it fails.

class ForgeConnector extends Connector
{
    public ?int $tries = 3;
}

Now when we send any request through this connector, if it fails it will be retried.

$forgeConnector = new ForgeConnector;

$response = $forgeConnector->send(new UnreliableRequest);

If we get to attempt three and it still fails, Saloon will throw a FatalRequestException (for connection errors) or a RequestException for typical HTTP errors.

The retry functionality will only work when sending requests synchronously. The retry logic will not work when using sendAsync or pools because Saloon needs to wait for a response to come back to determine if it needs to be retried.

What does Saloon consider a failed request?

By default, if the API couldn't be connected to or if the response status code is either a 4xx or 5xx, then Saloon will consider it a failed request. You can change this by extending the hasRequestFailed method on your connector. Click here to learn more.

Intervals

You can also configure an interval in milliseconds that Saloon should wait between retries. You can configure an interval with the $retryInterval property.

class ForgeConnector extends Connector
{
    public ?int $tries = 3;
    
    public ?int $retryInterval = 1000;
}

Exponential Backoff

You can also use exponential backoff when retrying which will double the retry interval after each unsuccessful attempt. This is useful as it can be less strenuous on the API if it is experiencing issues.

class ForgeConnector extends Connector
{
    public ?int $tries = 3;
    
    public ?int $retryInterval = 500;
    
    public ?bool $useExponentialBackoff = true;
}

Exceptions

By default, when all attempts have been exceeded, Saloon will either throw a FatalRequestException or a RequestException. You can choose to disable this behaviour and return the last response that Saloon received instead.

If the exception was FatalRequestException then the exception will still be thrown as we wouldn't have a response to return.

class ForgeConnector extends Connector
{
    public ?int $tries = 3;
    
    public ?bool $throwOnMaxTries = false;
}

Customising the request before the next retry

In some situations, you might want to change the next request to improve the chances of the next retry being successful. You can overwrite the handleRetry method on the connector or request and use it to customise the Request class. You must also return a boolean in this method to tell Saloon if the retry should commence.

<?php

use Saloon\Exceptions\RequestException;
use Saloon\Http\Auth\TokenAuthenticator;
use Saloon\Exceptions\FatalRequestException;

class ForgeConnector extends Connector
{
    public ?int $tries = 3;
    
    public function handleRetry(FatalRequestException|RequestException $exception, Request $request): bool
    {
        if ($exception instanceof RequestException && $exception->getResponse()->status() === 401) {
            $request->authenticate(new TokenAuthenticator($this->getNewToken()));
        }
        
        return true;
    }
}

Using the sendAndRetry method

This method has been deprecated since Saloon v3.6.4

Saloon also has a sendAndRetry method which can be used on the fly on any connector or request without needing to configure anything. This method has the same functionality in the format of a method.

<?php

$forgeConnector = new ForgeConnector;

$response = $forgeConnector->sendAndRetry(
    request: new UnreliableRequest,
    tries: 3,
    interval: 500,
    handleRetry: function (FatalRequestException|RequestException $exception, Request $request) {
        //
    },
    throw: true,
    useExponentialBackoff: true,
);