Simplified usage of ReliabilitySettings, RetryCount defins whether policy is enabled

Author: dylan-asos

src/SendGrid/Reliability/ReliabilitySettings.cs

@@ -17,12 +17,7 @@ public ReliabilitySettings()
         }
 
         /// <summary>
-        /// Gets or sets whether the retry policy is enabled when sending HTTP requests. Defaults to false
-        /// </summary>
-        public bool UseRetryPolicy { get; set; }
-
-        /// <summary>
-        ///     Gets or sets the number of retries to execute against an HTTP service endpoint before throwing an exceptions. Defaults to 2
+        ///     Gets or sets the number of retries to execute against an HTTP service endpoint before throwing an exceptions. Defaults to 0 (no retries, you must explicitly enable)
         /// </summary>
         public int RetryCount { get; set; }
 

src/SendGrid/Reliability/RetryDelegatingHandler.cs

@@ -14,6 +14,10 @@ public class RetryDelegatingHandler : DelegatingHandler
 
         private RetryPolicy retryPolicy;
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="RetryDelegatingHandler"/> class.
+        /// </summary>
+        /// <param name="settings">A ReliabilitySettings instance</param>
         public RetryDelegatingHandler(ReliabilitySettings settings)
             : this(new HttpClientHandler(), settings)
         {
@@ -28,7 +32,7 @@ public RetryDelegatingHandler(HttpMessageHandler innerHandler, ReliabilitySettin
 
         protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
         {
-            if (!settings.UseRetryPolicy)
+            if (settings.RetryCount == 0)
             {
                 return await base.SendAsync(request, cancellationToken).ConfigureAwait(false);
             }
@@ -41,7 +45,7 @@ protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage
                                      try
                                      {
                                          responseMessage = await base.SendAsync(request, cancellationToken).ConfigureAwait(false);
-                                         EnsureResponseIsValid(responseMessage);
+                                         ThrowHttpRequestExceptionIfResponseIsWithinTheServerErrorRange(responseMessage);
                                      }
                                      catch (TaskCanceledException)
                                      {
@@ -59,7 +63,7 @@ protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage
             throw result.FinalException;
         }
 
-        private static void EnsureResponseIsValid(HttpResponseMessage responseMessage)
+        private static void ThrowHttpRequestExceptionIfResponseIsWithinTheServerErrorRange(HttpResponseMessage responseMessage)
         {
             if ((int)responseMessage.StatusCode >= 500 && (int)responseMessage.StatusCode < 600)
             {

src/SendGrid/SendGridClient.cs

@@ -98,6 +98,11 @@ public SendGridClient(SendGridClientOptions options)
         /// <returns>Interface to the SendGrid REST API</returns>
         public SendGridClient(HttpClient httpClient, SendGridClientOptions options)
         {
+            if (options == null)
+            {
+                throw new ArgumentNullException(nameof(options));
+            }
+
             this.options = options;
             client = (httpClient == null) ? new HttpClient(new RetryDelegatingHandler(options.ReliabilitySettings)) : httpClient;
 

src/SendGrid/SendGridClientOptions.cs

@@ -36,7 +36,7 @@ public SendGridClientOptions()
         public Dictionary<string, string> RequestHeaders { get; set; }
 
         /// <summary>
-        /// Base url (e.g. https://api.sendgrid.com, this is the default)
+        /// Gets or sets base url (e.g. https://api.sendgrid.com, this is the default)
         /// </summary>
         public string Host { get; set; }
 

tests/SendGrid.Tests/Integration.cs

@@ -1,4 +1,6 @@
-namespace SendGrid.Tests
+using SendGrid.Reliability;
+
+namespace SendGrid.Tests
 {
     using Helpers.Mail;
     using Newtonsoft.Json;
@@ -6050,21 +6052,32 @@ public void TestJsonNetReferenceHandling(string referenceHandlingProperty)
 
 
         [Fact]
-        public async Task TestRetryBehaviour()
+        public async Task TestRetryBehaviourThrowsTimeoutException()
         {
-            var host = "http://localhost:4010";
-            var headers = new Dictionary<string, string> { { "X-Mock", "200" } };
-            var options = new SendGridClientOptions() { ApiKey = fixture.apiKey, Host = host, RequestHeaders = headers };
-            options.ReliabilitySettings.UseRetryPolicy = true;
-            options.ReliabilitySettings.RetryCount = 2;
-            var sg = new SendGridClient(options);
+            var msg = new SendGridMessage();
+            msg.SetFrom(new EmailAddress("[email protected]"));
+            msg.AddTo(new EmailAddress("[email protected]"));
+            msg.SetSubject("Hello World from the SendGrid CSharp Library");
+            msg.AddContent(MimeType.Html, "HTML content");
+
+            var options = new SendGridClientOptions
+            {
+                ApiKey = fixture.apiKey,
+                ReliabilitySettings = {RetryCount = 2}
+            };
+
             var id = "test_url_param";
 
-            var response = await sg.RequestAsync(method: SendGridClient.Method.POST, urlPath: "whitelabel/links/" + id + "/validate");
+            var httpMessageHandler = new TimeOutExceptionThrowingHttpMessageHandler(20, "The operation timed out");
+            var retryHandler = new RetryDelegatingHandler(httpMessageHandler, options.ReliabilitySettings);
+            
+            HttpClient clientToInject = new HttpClient(retryHandler);
+            var sg = new SendGridClient(clientToInject, options);
 
-            Assert.True(HttpStatusCode.OK == response.StatusCode);
-        }
+            var exception = await Assert.ThrowsAsync<TimeoutException>(() => sg.SendEmailAsync(msg));
 
+            Assert.NotNull(exception);
+        }
     }
 
     public class FakeHttpMessageHandler : HttpMessageHandler

tests/SendGrid.Tests/Reliability/RetryDelegatingHandlerTests.cs

@@ -19,8 +19,7 @@ public RetryDelegatingHandlerTests()
         {
             reliabilitySettings = new ReliabilitySettings
             {
-                RetryCount = 2,
-                UseRetryPolicy = true
+                RetryCount = 2
             };
             innerHandler = new RetryTestBehaviourDelegatingHandler();
             client = new HttpClient(new RetryDelegatingHandler(innerHandler, reliabilitySettings))
@@ -30,12 +29,13 @@ public RetryDelegatingHandlerTests()
         }
 
         [Fact]
-        public async Task Invoke_ShouldReturnNoErrorWhenOK()
+        public async Task Invoke_ShouldReturnHttpResponseAndNotRetryWhenSuccessful()
         {
             innerHandler.ConfigureBehaviour(innerHandler.OK);
 
-            await client.SendAsync(new HttpRequestMessage());
+            var result = await client.SendAsync(new HttpRequestMessage());
 
+            Assert.Equal(result.StatusCode, HttpStatusCode.OK);
             Assert.Equal(1, innerHandler.InvocationCount);
         }