Add retry policies into DPS service

SDK v2 migration guide.md

@@ -328,7 +328,7 @@ What was a loose affiliation of separate clients is now a consolidated client wi
 - Added support for setting a client web socket instance in the client options so that users can have better control over AMQP web socket connections.
 - Added support for setting the web socket level keep alive interval for AMQP web socket connections.
 - Added support for setting the remote certificate validation callback for AMQP TCP connections.
-- The library now includes `IProvisioningClientRetryPolicy` implementations: `ProvisioningClientExponentialBackoffRetryPolicy`, `ProvisioningClientFixedDelayRetryPolicy`, `IotHubServiceIncrementalDelayRetryPolicy` and `ProvisioningClientNoRetry`,
+- The library now includes `IProvisioningClientRetryPolicy` implementations: `ProvisioningClientExponentialBackoffRetryPolicy`, `ProvisioningClientFixedDelayRetryPolicy`, `ProvisioningClientIncrementalDelayRetryPolicy` and `ProvisioningClientNoRetry`,
  which can be set via `ProvisioningClientOptions.RetryPolicy`.
 
 #### API mapping
@@ -350,6 +350,11 @@ What was a loose affiliation of separate clients is now a consolidated client wi
 - ETag fields on the classes `IndividualEnrollment`, `EnrollmentGroup`, and `DeviceRegistrationState` are now taken as the `Azure.ETag` type instead of strings.
 - Twin.Tags is now of type `IDictionary<string, object>`.
 
+#### Notable additions
+
+- The library now includes `IProvisioningServiceRetryPolicy` implementations: `ProvisioningServiceExponentialBackoffRetryPolicy`, `ProvisioningServiceFixedDelayRetryPolicy`, `ProvisioningServiceIncrementalDelayRetryPolicy` and `ProvisioningServiceNoRetry`,
+ which can be set via `ProvisioningServiceOptions.RetryPolicy`.
+
 #### API mapping
 
 | v1 API | Equivalent v2 API | Notes |

e2e/test/helpers/RetryOperationHelper.cs

@@ -4,7 +4,7 @@
 using System;
 using System.Threading;
 using System.Threading.Tasks;
-using Microsoft.Azure.Devices.Client;
+using Microsoft.Azure.Devices.Provisioning.Service;
 
 namespace Microsoft.Azure.Devices.E2ETests.Helpers
 {
@@ -17,14 +17,14 @@ public class RetryOperationHelper
         /// Retry an async operation based on the retry strategy supplied.
         /// </summary>
         /// <remarks>
-        /// This is for E2E tests of provisioning service clients.
+        /// This is for E2E tests of the provisioning service clients.
         /// </remarks>
         /// <param name="asyncOperation">The async operation to be retried.</param>
         /// <param name="retryPolicy">The retry policy of hub device/module to be applied.</param>
         /// <param name="cancellationToken">The cancellation token to cancel the operation.</param>
-        public static async Task RunWithHubClientRetryAsync(
+        public static async Task RunWithProvisioningServiceRetryAsync(
             Func<Task> asyncOperation,
-            IIotHubClientRetryPolicy retryPolicy,
+            IProvisioningServiceRetryPolicy retryPolicy,
             CancellationToken cancellationToken = default)
         {
             uint counter = 0;
@@ -57,7 +57,7 @@ public class RetryOperationHelper
         /// Retry an async operation based on the retry strategy supplied.
         /// </summary>
         /// <remarks>
-        /// This is for E2E tests of provisioning service clients.
+        /// This is for E2E tests of the hub service clients.
         /// </remarks>
         /// <param name="asyncOperation">The async operation to be retried.</param>
         /// <param name="retryPolicy">The retry policy of hub service to be applied.</param>

e2e/test/provisioning/ProvisioningE2ETests.cs

@@ -35,7 +35,8 @@ public class ProvisioningE2ETests : E2EMsTestBase
         private static readonly string s_proxyServerAddress = TestConfiguration.IotHub.ProxyServerAddress;
         private static readonly string s_certificatePassword = TestConfiguration.Provisioning.CertificatePassword;
 
-        private static readonly IIotHubClientRetryPolicy s_provisioningServiceRetryPolicy = new ProvisioningServiceRetryPolicy();
+        private static readonly IProvisioningServiceRetryPolicy s_provisioningServiceRetryPolicy = 
+            new ProvisioningServiceExponentialBackoffRetryPolicy(20, TimeSpan.FromSeconds(3), true);
 
         private readonly string _idPrefix = $"e2e-{nameof(ProvisioningE2ETests).ToLower()}-";
 
@@ -1124,7 +1125,7 @@ private static void ValidateDeviceRegistrationResult(bool validatePayload, Devic
                 if (enrollmentType == EnrollmentType.Individual)
                 {
                     await RetryOperationHelper
-                        .RunWithHubClientRetryAsync(
+                        .RunWithProvisioningServiceRetryAsync(
                             async () =>
                             {
                                 await dpsClient.IndividualEnrollments.DeleteAsync(authProvider.GetRegistrationId()).ConfigureAwait(false);
@@ -1136,7 +1137,7 @@ await RetryOperationHelper
                 else if (enrollmentType == EnrollmentType.Group)
                 {
                     await RetryOperationHelper
-                        .RunWithHubClientRetryAsync(
+                        .RunWithProvisioningServiceRetryAsync(
                             async () =>
                             {
                                 await dpsClient.EnrollmentGroups.DeleteAsync(groupId).ConfigureAwait(false);

e2e/test/provisioning/ProvisioningServiceClientE2ETests.cs

@@ -8,7 +8,6 @@
 using System.Threading;
 using System.Threading.Tasks;
 using FluentAssertions;
-using Microsoft.Azure.Devices.Client;
 using Microsoft.Azure.Devices.E2ETests.Helpers;
 using Microsoft.Azure.Devices.Provisioning.Service;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
@@ -23,7 +22,8 @@ public class ProvisioningServiceClientE2ETests : E2EMsTestBase
         private static readonly string s_proxyServerAddress = TestConfiguration.IotHub.ProxyServerAddress;
         private static readonly string s_devicePrefix = $"{nameof(ProvisioningServiceClientE2ETests)}_";
 
-        private static readonly IIotHubClientRetryPolicy s_provisioningServiceRetryPolicy = new ProvisioningServiceRetryPolicy();
+        private static readonly IProvisioningServiceRetryPolicy s_provisioningServiceRetryPolicy =
+            new ProvisioningServiceExponentialBackoffRetryPolicy(20, TimeSpan.FromSeconds(3), true);
 
         public enum EnrollmentType
         {
@@ -172,7 +172,7 @@ public async Task ProvisioningServiceClient_GetIndividualEnrollmentAttestation(A
 
                 AttestationMechanism attestationMechanism = null;
                 await RetryOperationHelper
-                    .RunWithHubClientRetryAsync(
+                    .RunWithProvisioningServiceRetryAsync(
                         async () =>
                         {
                             attestationMechanism = await provisioningServiceClient.IndividualEnrollments.GetAttestationAsync(individualEnrollment.RegistrationId);
@@ -224,7 +224,7 @@ public async Task ProvisioningServiceClient_GetEnrollmentGroupAttestation(Attest
 
                 AttestationMechanism attestationMechanism = null;
                 await RetryOperationHelper
-                    .RunWithHubClientRetryAsync(
+                    .RunWithProvisioningServiceRetryAsync(
                         async () =>
                         {
                             attestationMechanism = await provisioningServiceClient.EnrollmentGroups.GetAttestationAsync(enrollmentGroup.EnrollmentGroupId);
@@ -325,7 +325,7 @@ public async Task ProvisioningServiceClient_IndividualEnrollments_Create_Ok(stri
 
                 IndividualEnrollment individualEnrollmentResult = null;
                 await RetryOperationHelper
-                    .RunWithHubClientRetryAsync(
+                    .RunWithProvisioningServiceRetryAsync(
                         async () =>
                         {
                             individualEnrollmentResult = await provisioningServiceClient.IndividualEnrollments.GetAsync(individualEnrollment.RegistrationId).ConfigureAwait(false);
@@ -398,7 +398,7 @@ public async Task ProvisioningServiceClient_GroupEnrollments_Create_Ok(string pr
 
                     EnrollmentGroup enrollmentGroupResult = null;
                     await RetryOperationHelper
-                        .RunWithHubClientRetryAsync(
+                        .RunWithProvisioningServiceRetryAsync(
                             async () =>
                             {
                                 enrollmentGroupResult = await provisioningServiceClient.EnrollmentGroups.GetAsync(enrollmentGroup.EnrollmentGroupId).ConfigureAwait(false);
@@ -479,7 +479,7 @@ await RetryOperationHelper
             };
 
             await RetryOperationHelper
-                .RunWithHubClientRetryAsync(
+                .RunWithProvisioningServiceRetryAsync(
                     async () =>
                     {
                         createdEnrollment = await provisioningServiceClient.IndividualEnrollments
@@ -534,7 +534,7 @@ await RetryOperationHelper
 
             EnrollmentGroup createdEnrollmentGroup = null;
             await RetryOperationHelper
-               .RunWithHubClientRetryAsync(
+               .RunWithProvisioningServiceRetryAsync(
                    async () =>
                    {
                        createdEnrollmentGroup = await provisioningServiceClient.EnrollmentGroups.CreateOrUpdateAsync(enrollmentGroup).ConfigureAwait(false);
@@ -556,28 +556,28 @@ await RetryOperationHelper
             string registrationId,
             string groupId)
         {
-            using ProvisioningServiceClient dpsClient = CreateProvisioningService();
+            using ProvisioningServiceClient provisioningServiceClient = CreateProvisioningService();
 
             try
             {
                 if (enrollmentType == EnrollmentType.Individual)
                 {
                     await RetryOperationHelper
-                        .RunWithHubClientRetryAsync(
+                        .RunWithProvisioningServiceRetryAsync(
                             async () =>
                             {
-                                await dpsClient.IndividualEnrollments.DeleteAsync(registrationId).ConfigureAwait(false);
+                                await provisioningServiceClient.IndividualEnrollments.DeleteAsync(registrationId).ConfigureAwait(false);
                             },
                             s_provisioningServiceRetryPolicy)
                         .ConfigureAwait(false);
                 }
                 else if (enrollmentType == EnrollmentType.Group)
                 {
                     await RetryOperationHelper
-                        .RunWithHubClientRetryAsync(
+                        .RunWithProvisioningServiceRetryAsync(
                             async () =>
                             {
-                                await dpsClient.EnrollmentGroups.DeleteAsync(groupId).ConfigureAwait(false);
+                                await provisioningServiceClient.EnrollmentGroups.DeleteAsync(groupId).ConfigureAwait(false);
                             },
                             s_provisioningServiceRetryPolicy)
                         .ConfigureAwait(false);

provisioning/device/src/RetryPolicies/RetryHandler.cs

@@ -1,10 +1,10 @@
 // Copyright (c) Microsoft. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
+using System;
 using System.Diagnostics;
 using System.Threading.Tasks;
 using System.Threading;
-using System;
 
 namespace Microsoft.Azure.Devices.Provisioning.Client
 {

provisioning/service/src/DeviceRegistrationsClient.cs

@@ -23,6 +23,7 @@ public class DeviceRegistrationStatesClient
 
         private readonly IContractApiHttp _contractApiHttp;
         private readonly ServiceConnectionString _serviceConnectionString;
+        private readonly RetryHandler _internalRetryHandler;
 
         /// <summary>
         /// Creates an instance of this class. Provided for unit testing purposes only.
@@ -31,10 +32,11 @@ protected DeviceRegistrationStatesClient()
         {
         }
 
-        internal DeviceRegistrationStatesClient(ServiceConnectionString serviceConnectionString, IContractApiHttp contractApiHttp)
+        internal DeviceRegistrationStatesClient(ServiceConnectionString serviceConnectionString, IContractApiHttp contractApiHttp, RetryHandler retryHandler)
         {
             _serviceConnectionString = serviceConnectionString;
             _contractApiHttp = contractApiHttp;
+            _internalRetryHandler = retryHandler;
         }
 
         /// <summary>
@@ -55,13 +57,22 @@ public async Task<DeviceRegistrationState> GetAsync(string registrationId, Cance
 
             cancellationToken.ThrowIfCancellationRequested();
 
-            ContractApiResponse contractApiResponse = await _contractApiHttp
-                .RequestAsync(
-                    HttpMethod.Get,
-                    GetDeviceRegistrationStatusUri(registrationId),
-                    null,
-                    null,
-                    new ETag(),
+            ContractApiResponse contractApiResponse = null;
+
+            await _internalRetryHandler
+                .RunWithRetryAsync(
+                    async () =>
+                    {
+                        contractApiResponse = await _contractApiHttp
+                            .RequestAsync(
+                                HttpMethod.Get,
+                                GetDeviceRegistrationStatusUri(registrationId),
+                                null,
+                                null,
+                                new ETag(),
+                                cancellationToken)
+                            .ConfigureAwait(false);
+                    },
                     cancellationToken)
                 .ConfigureAwait(false);
 
@@ -102,13 +113,20 @@ public async Task DeleteAsync(DeviceRegistrationState deviceRegistrationState, C
 
             cancellationToken.ThrowIfCancellationRequested();
 
-            await _contractApiHttp
-                .RequestAsync(
-                    HttpMethod.Delete,
-                    GetDeviceRegistrationStatusUri(deviceRegistrationState.RegistrationId),
-                    null,
-                    null,
-                    deviceRegistrationState.ETag,
+            await _internalRetryHandler
+                .RunWithRetryAsync(
+                    async () =>
+                    {
+                        await _contractApiHttp
+                            .RequestAsync(
+                                HttpMethod.Delete,
+                                GetDeviceRegistrationStatusUri(deviceRegistrationState.RegistrationId),
+                                null,
+                                null,
+                                deviceRegistrationState.ETag,
+                                cancellationToken)
+                            .ConfigureAwait(false);
+                    },
                     cancellationToken)
                 .ConfigureAwait(false);
         }
@@ -128,7 +146,7 @@ await _contractApiHttp
         public Query CreateEnrollmentGroupQuery(string query, string enrollmentGroupId, int pageSize = 0, CancellationToken cancellationToken = default)
         {
             Argument.AssertNotNullOrWhiteSpace(query, nameof(query));
-            return new Query(_serviceConnectionString, GetDeviceRegistrationStatusUri(enrollmentGroupId).ToString(), query, _contractApiHttp, pageSize, cancellationToken);
+            return new Query(_serviceConnectionString, GetDeviceRegistrationStatusUri(enrollmentGroupId).ToString(), query, _contractApiHttp, pageSize, _internalRetryHandler, cancellationToken);
         }
 
         private static Uri GetDeviceRegistrationStatusUri(string id)