io.sphere.sdk.client

Interface RetrySphereClientDecorator

All Superinterfaces:

AutoCloseable, SphereClient

public interface RetrySphereClientDecorator
extends SphereClient

Wraps a SphereClient to handle failures like gateway timeouts and version conflicts through retrying the request.

A best practice example to retry on gateway timeouts and similar problems

import io.sphere.sdk.client.RetrySphereClientDecorator;

import io.sphere.sdk.client.SphereClient;

import io.sphere.sdk.retry.RetryAction;

import io.sphere.sdk.retry.RetryPredicate;

import io.sphere.sdk.retry.RetryRule;

import java.time.Duration;

import java.util.List;

import static io.sphere.sdk.http.HttpStatusCode.BAD_GATEWAY_502;

import static io.sphere.sdk.http.HttpStatusCode.GATEWAY_TIMEOUT_504;

import static io.sphere.sdk.http.HttpStatusCode.SERVICE_UNAVAILABLE_503;

import static java.util.Collections.singletonList;

public class RetryBadGatewayExample {
    public static SphereClient ofRetry(final SphereClient delegate) {
        final int maxAttempts = 5;
        final List<RetryRule> retryRules = singletonList(RetryRule.of(
                RetryPredicate.ofMatchingStatusCodes(BAD_GATEWAY_502, SERVICE_UNAVAILABLE_503, GATEWAY_TIMEOUT_504),
                RetryAction.ofScheduledRetry(maxAttempts, context -> Duration.ofSeconds(context.getAttempt() * 2)))
        );
        return RetrySphereClientDecorator.of(delegate, retryRules);
    }
}
See the test code.

Not best practice but a lot of people requested to retry deletes on version conflicts:

import io.sphere.sdk.client.*;

import io.sphere.sdk.http.HttpMethod;

import io.sphere.sdk.retry.RetryAction;

import io.sphere.sdk.retry.RetryContext;

import io.sphere.sdk.retry.RetryStrategy;

import io.sphere.sdk.retry.RetryRule;

import java.util.List;

import java.util.function.Predicate;

import static java.util.Collections.singletonList;

public class RetryDeleteExample {
    public static SphereClient ofRetry(final SphereClient delegate) {
        final List<RetryRule> retryRules = singletonList(RetryRule.of(isDeleteAndNewVersionIsKnown(), retryWithNewVersion()));
        return RetrySphereClientDecorator.of(delegate, retryRules);
    }

    private static Predicate<RetryContext> isDeleteAndNewVersionIsKnown() {
        return retryContext -> retryContext.getLatestError() instanceof ConcurrentModificationException
                && ((ConcurrentModificationException) retryContext.getLatestError()).getCurrentVersion() != null
                && retryContext.getLatestParameter() instanceof SphereRequest
                && ((SphereRequest) retryContext.getLatestParameter()).httpRequestIntent().getHttpMethod() == HttpMethod.DELETE;
    }

    @SuppressWarnings("unchecked")
    private static RetryAction retryWithNewVersion() {
        return (RetryContext c) -> {
            final SphereRequest sphereRequest = (SphereRequest) c.getLatestParameter();
            final Object newParameter = new SphereRequestDecorator(sphereRequest) {
                @Override
                public HttpRequestIntent httpRequestIntent() {
                    final HttpRequestIntent original = super.httpRequestIntent();
                    final Long currentVersion = ((ConcurrentModificationException) c.getLatestError()).getCurrentVersion();
                    final String path = original.getPath().replaceAll("\\bversion=\\d+", "version=" + currentVersion);
                    return original.withPath(path);
                }
            };
            return RetryStrategy.retryImmediately(newParameter);
        };
    }
}
See the test code.

Method Summary

Modifier and Type	Method and Description
static SphereClient	of(SphereClient delegate, List<RetryRule> retryRules)

Methods inherited from interface io.sphere.sdk.client.SphereClient

close, execute, getConfig, of, of

Method Detail

of

static SphereClient of(SphereClient delegate,
                       List<RetryRule> retryRules)