Merge pull request #187 from fullstaq-labs/master

Throw GatewayTimeoutException upon receiving 504 Gateway Timeout responses

Author: Roblinde

Diff for: Contentful.Core.Tests/ContentfulClientTests.cs

@@ -210,6 +210,18 @@ public async Task RateLimitWithRetryShouldStopCallingOnSuccess()
             Assert.Equal("SoSo Wall Clock", res.ProductName);
         }
 
+        [Fact]
+        public async Task GatewayTimeoutExceptionShouldBeThrownCorrectly()
+        {
+            //Arrange
+            var response = new HttpResponseMessage();
+            response.Content = new StringContent("");
+            response.StatusCode = (HttpStatusCode)504;
+            _handler.Response = response;
+            //Act
+            await Assert.ThrowsAsync<GatewayTimeoutException>(async () => await _client.GetEntry<TestEntryModel>("12"));
+        }
+
         [Fact]
         public async Task SettingPreviewApiShouldUseCorrectApiKey()
         {

Diff for: Contentful.Core/ContentfulClientBase.cs

@@ -89,15 +89,16 @@ private static bool IsMacOS
         /// <returns></returns>
         protected async Task CreateExceptionForFailedRequest(HttpResponseMessage res)
         {
-            var jsonError = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
-            var sys = jsonError.SelectToken("$.sys").ToObject<SystemProperties>();
-            var errorDetails = jsonError.SelectToken("$.details")?.ToObject<ErrorDetails>();
-            var message = jsonError.SelectToken("$.message")?.ToString();
+            var responseContent = await res.Content.ReadAsStringAsync().ConfigureAwait(false);
+            var jsonError = string.IsNullOrEmpty(responseContent) ? null : JObject.Parse(responseContent);
+            var sys = jsonError?.SelectToken("$.sys").ToObject<SystemProperties>();
+            var errorDetails = jsonError?.SelectToken("$.details")?.ToObject<ErrorDetails>();
+            var message = jsonError?.SelectToken("$.message")?.ToString();
             var statusCode = (int)res.StatusCode;
 
             if (string.IsNullOrEmpty(message))
             {
-                message = GetGenericErrorMessageForStatusCode(statusCode, sys.Id);
+                message = GetGenericErrorMessageForStatusCode(statusCode, sys?.Id);
             }
 
             if(errorDetails != null)
@@ -120,6 +121,18 @@ protected async Task CreateExceptionForFailedRequest(HttpResponseMessage res)
                 throw rateLimitException;
             }
 
+            if(statusCode == 504)
+            {
+                var gatewayTimeoutException = new GatewayTimeoutException()
+                {
+                    RequestId = jsonError?.SelectToken("$.requestId")?.ToString(),
+                    ErrorDetails = errorDetails,
+                    SystemProperties = sys
+                };
+
+                throw gatewayTimeoutException;
+            }
+
             var ex = new ContentfulException(statusCode, message)
             {
                 RequestId = jsonError.SelectToken("$.requestId")?.ToString(),
@@ -186,6 +199,11 @@ private string GetGenericErrorMessageForStatusCode(int statusCode, string id)
                 return "The requested space is hibernated.";
             }
 
+            if(statusCode == 504)
+            {
+                return "Gateway timeout.";
+            }
+
             return "An error occurred.";
         }
 

Diff for: Contentful.Core/Errors/GatewayTimeoutException.cs

@@ -0,0 +1,19 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace Contentful.Core.Errors
+{
+    /// <summary>
+    /// Represents errors that occurr when the Contentful API returns 504 Gateway Timeout responses.
+    /// </summary>
+    public class GatewayTimeoutException : ContentfulException
+    {
+        /// <summary>
+        /// Initializes a new instance of <see cref="Contentful.Core.Errors.GatewayTimeoutException"/>.
+        /// </summary>
+        public GatewayTimeoutException() : base(429, "Gateway Timeout")
+        {
+        }
+    }
+}