Retry overhaul #4718

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

conniey merged 36 commits into Azure:master from conniey:retry-per-send

Aug 1, 2019

sdk/core/azure-core-amqp/src/main/java/com/azure/core/amqp/AmqpSession.java

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -32,21 +32,21 @@ public interface AmqpSession extends EndpointStateNotifier, Closeable {
  
         * @param linkName Name of the link.

         * @param entityPath The entity path this link connects to when producing events.

         * @param timeout Timeout required for creating and opening AMQP link.

         * @param retry The retry policy to use when sending messages.

         * @param retryPolicy The retry policy to use when sending messages.

         * @return A newly created AMQP link.

         */

        Mono<AmqpLink> createProducer(String linkName, String entityPath, Duration timeout, Retry retry);

        Mono<AmqpLink> createProducer(String linkName, String entityPath, Duration timeout, RetryPolicy retryPolicy);

        /**

         * Creates a new AMQP link that consumes events from the message broker.

         *

         * @param linkName Name of the link.

         * @param entityPath The entity path this link connects to, so that it may read events from the message broker.

         * @param timeout Timeout required for creating and opening an AMQP link.

         * @param retry The retry policy to use when consuming messages.

         * @param retryPolicy The retry policy to use when consuming messages.

         * @return A newly created AMQP link.

         */

        Mono<AmqpLink> createConsumer(String linkName, String entityPath, Duration timeout, Retry retry);

        Mono<AmqpLink> createConsumer(String linkName, String entityPath, Duration timeout, RetryPolicy retryPolicy);

        /**

         * Removes an {@link AmqpLink} with the given {@code linkName}.

sdk/core/azure-core-amqp/src/main/java/com/azure/core/amqp/ExponentialRetry.java

This file was deleted.

sdk/core/azure-core-amqp/src/main/java/com/azure/core/amqp/ExponentialRetryPolicy.java

-Original file line number
+Diff line change
@@ -0,0 +1,93 @@
+    // Copyright (c) Microsoft Corporation. All rights reserved.
+    // Licensed under the MIT License.
+    package com.azure.core.amqp;
+    import java.time.Duration;
+    import java.util.concurrent.ThreadLocalRandom;
+    /**
+     * A policy to govern retrying of messaging operations in which the delay between retries will grow in an exponential
+     * manner, allowing more time to recover as the number of retries increases.
+     */
+    public final class ExponentialRetryPolicy extends RetryPolicy {
+        private final double retryFactor;
+        /**
+         * Creates a new instance with a minimum and maximum retry period in addition to maximum number of retry attempts.
+         *
+         * @param retryOptions The options to apply to this retry policy.
+         * @throws NullPointerException if {@code retryOptions} is {@code null}.
+         */
+        public ExponentialRetryPolicy(RetryOptions retryOptions) {
+            super(retryOptions);
+            this.retryFactor = computeRetryFactor();
+        }
+        /**
+         * Calculates the retry delay using exponential backoff.
+         *
+         * @param retryCount The number of attempts that have been made, including the initial attempt before any
+         *         retries.
+         * @param baseDelay The delay to use for the basis of the exponential backoff.
+         * @param baseJitter The duration to use for the basis of the random jitter value.
+         * @param random The random number generator used to calculate the jitter.
+         * @return The duration to delay before retrying a request.
+         */
+        @Override
+        protected Duration calculateRetryDelay(int retryCount, Duration baseDelay, Duration baseJitter,
+                                               ThreadLocalRandom random) {
+            final double jitterSeconds = random.nextDouble() * baseJitter.getSeconds();
+            final double nextRetrySeconds = Math.pow(retryFactor, (double) retryCount);
+            final Double nextRetryNanos = (jitterSeconds + nextRetrySeconds) * NANOS_PER_SECOND;
+            return baseDelay.plus(Duration.ofNanos(nextRetryNanos.longValue()));
+        }
+        /**
+         * {@inheritDoc}
+         */
+        @Override
+        public int hashCode() {
+            return super.hashCode();
+        }
+        /**
+         * {@inheritDoc}
+         */
+        @Override
+        public boolean equals(Object obj) {
+            if (this == obj) {
+                return true;
+            }
+            return obj instanceof ExponentialRetryPolicy
+                && super.equals(obj);
+        }
+        /**
+         * Creates a clone of this instance.
+         *
+         * @return A clone of the {@link ExponentialRetryPolicy} instance.
+         */
+        @Override
+        public RetryPolicy clone() {
+            final RetryOptions cloned = getRetryOptions().clone();
+            return new ExponentialRetryPolicy(cloned);
+        }
+        private double computeRetryFactor() {
+            final RetryOptions options = getRetryOptions();
+            final Duration maxBackoff = options.maxDelay();
+            final Duration minBackoff = options.delay();
+            final int maximumRetries = options.maxRetries();
+            final long deltaBackoff = maxBackoff.minus(minBackoff).getSeconds();
+            if (deltaBackoff <= 0 || maximumRetries <= 0) {
+                return 0;
+            }
+            return Math.log(deltaBackoff) / Math.log(maximumRetries);
+        }
+    }

sdk/core/azure-core-amqp/src/main/java/com/azure/core/amqp/FixedRetryPolicy.java

-Original file line number
+Diff line change
@@ -0,0 +1,71 @@
+    // Copyright (c) Microsoft Corporation. All rights reserved.
+    // Licensed under the MIT License.
+    package com.azure.core.amqp;
+    import java.time.Duration;
+    import java.util.concurrent.ThreadLocalRandom;
+    /**
+     * A policy to govern retrying of messaging operations in which the base delay between retries remains the same.
+     */
+    public final class FixedRetryPolicy extends RetryPolicy {
+        /**
+         * Creates an instance with the given retry options.
+         *
+         * @param retryOptions The options to set on this retry policy.
+         */
+        public FixedRetryPolicy(RetryOptions retryOptions) {
+            super(retryOptions);
+        }
+        /**
+         * Calculates the delay for a fixed backoff.
+         *
+         * @param retryCount The number of attempts that have been made, including the initial attempt before any
+         *         retries.
+         * @param baseDelay The delay to use for the fixed backoff.
+         * @param baseJitter The duration to use for the basis of the random jitter value.
+         * @param random The random number generator used to calculate the jitter.
+         * @return The duration to delay before retrying a request.
+         */
+        @Override
+        protected Duration calculateRetryDelay(int retryCount, Duration baseDelay, Duration baseJitter, ThreadLocalRandom random) {
+            final Double jitterNanos = random.nextDouble() * baseJitter.getSeconds() * RetryPolicy.NANOS_PER_SECOND;
+            final Duration jitter = Duration.ofNanos(jitterNanos.longValue());
+            return baseDelay.plus(jitter);
+        }
+        /**
+         * {@inheritDoc}
+         */
+        @Override
+        public int hashCode() {
+            return super.hashCode();
+        }
+        /**
+         * {@inheritDoc}
+         */
+        @Override
+        public boolean equals(Object obj) {
+            if (this == obj) {
+                return true;
+            }
+            return obj instanceof FixedRetryPolicy
+                && super.equals(obj);
+        }
+        /**
+         * Creates a clone of this instance.
+         *
+         * @return A clone of the {@link FixedRetryPolicy} instance.
+         */
+        @Override
+        public RetryPolicy clone() {
+            final RetryOptions cloned = getRetryOptions().clone();
+            return new FixedRetryPolicy(cloned);
+        }
+    }

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Retry overhaul #4718

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Uh oh!

Uh oh!