layout: pattern

title: Retry

folder: retry

permalink: /patterns/retry/

categories: other

tags:

- java

- difficulty-expert

- performance

Enables an application to handle transient failures from external resources.

Transparently retry certain operations that involve communication with external

resources, particularly over the network, isolating calling code from the

retry implementation details.


The `Retry` pattern consists retrying operations on remote resources over the

network a set number of times. It closely depends on both business and technical

requirements: how much time will the business allow the end user to wait while

the operation finishes? What are the performance characteristics of the

remote resource during peak loads as well as our application as more threads

are waiting for the remote resource's availability? Among the errors returned

by the remote service, which can be safely ignored in order to retry? Is the

operation [idempotent](https://en.wikipedia.org/wiki/Idempotence)?

Another concern is the impact on the calling code by implementing the retry

mechanism. The retry mechanics should ideally be completely transparent to the

calling code (service interface remains unaltered). There are two general

approaches to this problem: from an enterprise architecture standpoint

(**strategic**), and a shared library standpoint (**tactical**).

*(As an aside, one interesting property is that, since implementations tend to

be configurable at runtime, daily monitoring and operation of this capability

is shifted over to operations support instead of the developers themselves.)*

From a strategic point of view, this would be solved by having requests

be redirected to a separate intermediary system, traditionally an

[ESB](https://en.wikipedia.org/wiki/Enterprise_service_bus), but more recently

a [Service Mesh](https://medium.com/microservices-in-practice/service-mesh-for-microservices-2953109a3c9a).

From a tactical point of view, this would be solved by reusing shared libraries

like [Hystrix](https://github.com/Netflix/Hystrix)[1]. This is the type of

solution showcased in the simple example that accompanies this *README*.

In our hypothetical application, we have a generic interface for all

operations on remote interfaces:

public interface BusinessOperation<T> {

T perform() throws BusinessException;

}

And we have an implementation of this interface that finds our customers

by looking up a database:

public final class FindCustomer implements BusinessOperation<String> {

@Override

public String perform() throws BusinessException {

...

}

}

Our `FindCustomer` implementation can be configured to throw

`BusinessException`s before returning the customer's ID, thereby simulating a

'flaky' service that intermittently fails. Some exceptions, like the

`CustomerNotFoundException`, are deemed to be recoverable after some

hypothetical analysis because the root cause of the error stems from "some

database locking issue". However, the `DatabaseNotAvailableException` is

considered to be a definite showstopper - the application should not attempt

to recover from this error.

We can model a 'recoverable' scenario by instantiating `FindCustomer` like this:

final BusinessOperation<String> op = new FindCustomer(

"12345",

new CustomerNotFoundException("not found"),

new CustomerNotFoundException("still not found"),

new CustomerNotFoundException("don't give up yet!")

);

In this configuration, `FindCustomer` will throw `CustomerNotFoundException`

three times, after which it will consistently return the customer's ID

(`12345`).

In our hypothetical scenario, our analysts indicate that this operation

typically fails 2-4 times for a given input during peak hours, and that each

worker thread in the database subsystem typically needs 50ms to

"recover from an error". Applying these policies would yield something like

this:

final BusinessOperation<String> op = new Retry<>(

new FindCustomer(

"1235",

new CustomerNotFoundException("not found"),

new CustomerNotFoundException("still not found"),

new CustomerNotFoundException("don't give up yet!")

),

5,

100,

e -> CustomerNotFoundException.class.isAssignableFrom(e.getClass())

);

Executing `op` *once* would automatically trigger at most 5 retry attempts,

with a 100 millisecond delay between attempts, ignoring any

`CustomerNotFoundException` thrown while trying. In this particular scenario,

due to the configuration for `FindCustomer`, there will be 1 initial attempt

and 3 additional retries before finally returning the desired result `12345`.

If our `FindCustomer` operation were instead to throw a fatal

`DatabaseNotFoundException`, which we were instructed not to ignore, but

more importantly we did *not* instruct our `Retry` to ignore, then the operation

would have failed immediately upon receiving the error, not matter how many

attempts were left.

<br/><br/>

[1] Please note that *Hystrix* is a complete implementation of the *Circuit

Breaker* pattern, of which the *Retry* pattern can be considered a subset of.

Whenever an application needs to communicate with an external resource,

particularly in a cloud environment, and if the business requirements allow it.

You can view Microsoft's article [here](https://docs.microsoft.com/en-us/azure/architecture/patterns/retry).

**Pros:**

* Resiliency

* Provides hard data on external failures

**Cons:**

* Complexity

* Operations maintenance

* [Circuit Breaker](https://martinfowler.com/bliki/CircuitBreaker.html)

package com.iluwatar.retry {

class App {

- LOG : Logger {static}

- op : BusinessOperation<String> {static}

+ App()

- errorNoRetry() {static}

- errorWithRetry() {static}

+ main(args : String[]) {static}

- noErrors() {static}

}

interface BusinessOperation<T> {

+ perform() : T {abstract}

}

class FindCustomer {

- customerId : String

- errors : Deque<BusinessException>

+ FindCustomer(customerId : String, errors : BusinessException[])

+ perform() : String

}

class Retry<T> {

- attempts : AtomicInteger

- delay : long

- errors : List<Exception>

- maxAttempts : int

- op : BusinessOperation<T>

- test : Predicate<Exception>

+ Retry<T>(op : BusinessOperation<T>, maxAttempts : int, delay : long, ignoreTests : Predicate<Exception>[])

+ attempts() : int

+ errors() : List<Exception>

+ perform() : T

}

}

Retry --> "-op" BusinessOperation

App --> "-op" BusinessOperation

FindCustomer ..|> BusinessOperation

Retry ..|> BusinessOperation

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

<modelVersion>4.0.0</modelVersion>

<parent>

<groupId>com.iluwatar</groupId>

<artifactId>java-design-patterns</artifactId>

<version>1.17.0-SNAPSHOT</version>

</parent>

<artifactId>retry</artifactId>

<packaging>jar</packaging>

<dependencies>

<dependency>

<groupId>junit</groupId>

<artifactId>junit</artifactId>

<scope>test</scope>

</dependency>

<dependency>

<groupId>org.hamcrest</groupId>

<artifactId>hamcrest-core</artifactId>

<scope>test</scope>

</dependency>

</dependencies>

</project>

package com.iluwatar.retry;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

public final class App {

private static final Logger LOG = LoggerFactory.getLogger(App.class);

private static BusinessOperation<String> op;

/**

public static void main(String[] args) throws Exception {

noErrors();

errorNoRetry();

errorWithRetry();

}

private static void noErrors() throws Exception {

op = new FindCustomer("123");

op.perform();

LOG.info("Sometimes the operation executes with no errors.");

}

private static void errorNoRetry() throws Exception {

op = new FindCustomer("123", new CustomerNotFoundException("not found"));

try {

op.perform();

} catch (CustomerNotFoundException e) {

LOG.info("Yet the operation will throw an error every once in a while.");

}

}

private static void errorWithRetry() throws Exception {

final Retry<String> retry = new Retry<>(

new FindCustomer("123", new CustomerNotFoundException("not found")),

3, //3 attempts

100, //100 ms delay between attempts

e -> CustomerNotFoundException.class.isAssignableFrom(e.getClass())

);

op = retry;

final String customerId = op.perform();

LOG.info(String.format(

"However, retrying the operation while ignoring a recoverable error will eventually yield "

+ "the result %s after a number of attempts %s", customerId, retry.attempts()

));

}

}

package com.iluwatar.retry;

public class BusinessException extends Exception {

private static final long serialVersionUID = 6235833142062144336L;

/**

public BusinessException(String message) {

super(message);

}

}