[Event Hubs] Update RetryOptions interface to pass exponential retry params

sdk/eventhub/event-hubs/review/event-hubs.api.md

@@ -15,6 +15,7 @@ import { EventHubConnectionConfig } from '@azure/core-amqp';
 import { MessagingError } from '@azure/core-amqp';
 import { Receiver } from 'rhea-promise';
 import { ReceiverOptions } from 'rhea-promise';
+import { RetryPolicy } from '@azure/core-amqp';
 import { Sender } from 'rhea-promise';
 import { SharedKeyCredential } from '@azure/core-amqp';
 import { TokenCredential } from '@azure/core-amqp';
@@ -190,8 +191,11 @@ export class ReceiveHandler {
 
 // @public
 export interface RetryOptions {
+    maxExponentialRetryDelayInMs?: number;
     maxRetries?: number;
+    minExponentialRetryDelayInMs?: number;
     retryInterval?: number;
+    retryPolicy?: RetryPolicy;
     timeoutInMs?: number;
 }
 

sdk/eventhub/event-hubs/src/eventHubClient.ts

@@ -10,7 +10,8 @@ import {
   SharedKeyCredential,
   ConnectionConfig,
   isTokenCredential,
-  Constants
+  Constants,
+  RetryPolicy
 } from "@azure/core-amqp";
 
 import { ConnectionContext } from "./connectionContext";
@@ -40,16 +41,20 @@ export interface RetryOptions {
    * A minimum value of 60 seconds will be used if a value not greater than this is provided.
    */
   timeoutInMs?: number;
-  // /**
-  //  * The maximum value the `retryInterval` gets incremented exponentially between retries.
-  //  * Not applicable, when `isExponential` is set to `false`.
-  //  */
-  // maxRetryInterval?: number;
-  // /**
-  //  * Boolean denoting if the `retryInterval` should be incremented exponentially between
-  //  * retries or kept the same.
-  //  */
-  // isExponential?: boolean;
+  /**
+   * @property {RetryPolicy} [retryPolicy] Denotes which retry policy to apply. If undefined, defaults to `LinearRetryPolicy`
+   */
+  retryPolicy?: RetryPolicy;
+  /**
+   * @property {number} [maxExponentialRetryDelayInMs] Denotes the maximum delay between retries
+   * that the retry attempts will be capped at. Applicable only when performing exponential retry.
+   */
+  maxExponentialRetryDelayInMs?: number;
+  /**
+   * @property {number} [minExponentialRetryDelayInMs] Denotes the minimum delay between retries
+   * to use. Applicable only when performing exponential retry.
+   */
+  minExponentialRetryDelayInMs?: number;
 }
 
 export function getRetryAttemptTimeoutInMs(retryOptions: RetryOptions | undefined): number {

sdk/eventhub/event-hubs/src/eventHubSender.ts

@@ -754,7 +754,12 @@ export class EventHubSender extends LinkEntity {
       connectionId: this._context.connectionId,
       operationType: RetryOperationType.sendMessage,
       maxRetries: maxRetries,
-      delayInSeconds: delayInSeconds
+      delayInSeconds: delayInSeconds,
+      retryPolicy: options.retryOptions && options.retryOptions.retryPolicy,
+      minExponentialRetryDelayInMs:
+        options.retryOptions && options.retryOptions.minExponentialRetryDelayInMs,
+      maxExponentialRetryDelayInMs:
+        options.retryOptions && options.retryOptions.maxExponentialRetryDelayInMs
     };
     return retry<void>(config);
   }

sdk/eventhub/event-hubs/src/receiver.ts

@@ -11,7 +11,8 @@ import {
   Constants,
   RetryOperationType,
   retry,
-  MessagingError
+  MessagingError,
+  RetryPolicy
 } from "@azure/core-amqp";
 import { ReceiveHandler } from "./receiveHandler";
 import { AbortSignalLike, AbortError } from "@azure/abort-controller";
@@ -73,7 +74,10 @@ export class EventHubConsumer {
   /**
    * @property The set of retry options to configure the receiveBatch operation.
    */
-  private _retryOptions: Required<Pick<RetryOptions, "maxRetries" | "retryInterval">>;
+  private _retryOptions: Required<
+    Pick<RetryOptions, "maxRetries" | "retryInterval" | "retryPolicy">
+  > &
+    RetryOptions;
 
   /**
    * @property Returns `true` if the consumer is closed. This can happen either because the consumer
@@ -370,7 +374,7 @@ export class EventHubConsumer {
         );
 
         const addTimeout = (): void => {
-          let msg = "[%s] Setting the wait timer for %d seconds for receiver '%s'.";
+          const msg = "[%s] Setting the wait timer for %d seconds for receiver '%s'.";
           log.batching(
             msg,
             this._context.connectionId,
@@ -407,7 +411,10 @@ export class EventHubConsumer {
       delayInSeconds: retryOptions.retryInterval,
       operation: retrieveEvents,
       operationType: RetryOperationType.receiveMessage,
-      maxRetries: retryOptions.maxRetries
+      maxRetries: retryOptions.maxRetries,
+      retryPolicy: retryOptions.retryPolicy,
+      minExponentialRetryDelayInMs: retryOptions.minExponentialRetryDelayInMs,
+      maxExponentialRetryDelayInMs: retryOptions.maxExponentialRetryDelayInMs
     };
     return retry<ReceivedEventData[]>(config);
   }
@@ -436,9 +443,13 @@ export class EventHubConsumer {
     }
   }
 
+  /**
+   *
+   * @param retryOptions Sets default values for retryOptions if it exists.
+   */
   private _initRetryOptions(
     retryOptions: RetryOptions = {}
-  ): Required<Pick<RetryOptions, "maxRetries" | "retryInterval">> {
+  ): Required<Pick<RetryOptions, "maxRetries" | "retryInterval" | "retryPolicy">> & RetryOptions {
     const maxRetries =
       typeof retryOptions.maxRetries === "number"
         ? retryOptions.maxRetries
@@ -447,10 +458,21 @@ export class EventHubConsumer {
       typeof retryOptions.retryInterval === "number" && retryOptions.retryInterval > 0
         ? retryOptions.retryInterval / 1000
         : Constants.defaultDelayBetweenOperationRetriesInSeconds;
+    const retryPolicy = retryOptions.retryPolicy
+      ? retryOptions.retryPolicy
+      : RetryPolicy.LinearRetryPolicy;
+
+    const timeoutInMs = retryOptions.timeoutInMs;
+    const minExponentialRetryDelayInMs = retryOptions.minExponentialRetryDelayInMs;
+    const maxExponentialRetryDelayInMs = retryOptions.maxExponentialRetryDelayInMs;
 
     return {
       maxRetries,
-      retryInterval
+      retryInterval,
+      timeoutInMs,
+      retryPolicy,
+      minExponentialRetryDelayInMs,
+      maxExponentialRetryDelayInMs
     };
   }