Added base class for all HTTP error handling

Author: hiranya911

FirebaseAdmin/FirebaseAdmin.Tests/HttpErrorHandlerTest.cs

@@ -0,0 +1,81 @@
+// Copyright 2019, Google Inc. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+using System.Collections.Generic;
+using System.Net;
+using System.Net.Http;
+using System.Text;
+using Xunit;
+
+namespace FirebaseAdmin.Tests
+{
+    public class HttpErrorHandlerTest
+    {
+        public static readonly IEnumerable<object[]> HttpErrorCodes =
+            new List<object[]>()
+            {
+                new object[] { HttpStatusCode.BadRequest, ErrorCode.InvalidArgument },
+                new object[] { HttpStatusCode.Unauthorized, ErrorCode.Unauthenticated },
+                new object[] { HttpStatusCode.Forbidden, ErrorCode.PermissionDenied },
+                new object[] { HttpStatusCode.NotFound, ErrorCode.NotFound },
+                new object[] { HttpStatusCode.Conflict, ErrorCode.Conflict },
+                new object[] { (HttpStatusCode)429, ErrorCode.ResourceExhausted },
+                new object[] { HttpStatusCode.InternalServerError, ErrorCode.Internal },
+                new object[] { HttpStatusCode.ServiceUnavailable, ErrorCode.Unavailable },
+            };
+
+        [Theory]
+        [MemberData(nameof(HttpErrorCodes))]
+        public void KnownHttpStatusCode(HttpStatusCode statusCode, ErrorCode expected)
+        {
+            var json = "{}";
+            var resp = new HttpResponseMessage()
+            {
+                StatusCode = statusCode,
+                Content = new StringContent(json, Encoding.UTF8, "application/json"),
+            };
+
+            var handler = new HttpErrorHandler();
+            var error = Assert.Throws<FirebaseException>(() => handler.ThrowIfError(resp, json));
+
+            Assert.Equal(expected, error.ErrorCode);
+            Assert.Equal(
+                $"Unexpected HTTP response with status: {(int)statusCode} ({statusCode})\n{json}",
+                error.Message);
+            Assert.Same(resp, error.HttpResponse);
+            Assert.Null(error.InnerException);
+        }
+
+        [Fact]
+        public void UnknownHttpStatusCode()
+        {
+            var json = "{}";
+            var resp = new HttpResponseMessage()
+            {
+                StatusCode = HttpStatusCode.MethodNotAllowed,
+                Content = new StringContent(json, Encoding.UTF8, "application/json"),
+            };
+
+            var handler = new HttpErrorHandler();
+            var error = Assert.Throws<FirebaseException>(() => handler.ThrowIfError(resp, json));
+
+            Assert.Equal(ErrorCode.Unknown, error.ErrorCode);
+            Assert.Equal(
+                $"Unexpected HTTP response with status: 405 (MethodNotAllowed)\n{json}",
+                error.Message);
+            Assert.Same(resp, error.HttpResponse);
+            Assert.Null(error.InnerException);
+        }
+    }
+}

FirebaseAdmin/FirebaseAdmin/HttpErrorHandler.cs

@@ -0,0 +1,96 @@
+// Copyright 2019, Google Inc. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+using System;
+using System.Collections.Generic;
+using System.Net;
+using System.Net.Http;
+
+namespace FirebaseAdmin
+{
+    internal class HttpErrorHandler
+    {
+        private static readonly IReadOnlyDictionary<HttpStatusCode, ErrorCode> HttpErrorCodes =
+            new Dictionary<HttpStatusCode, ErrorCode>()
+            {
+                { HttpStatusCode.BadRequest, ErrorCode.InvalidArgument },
+                { HttpStatusCode.Unauthorized, ErrorCode.Unauthenticated },
+                { HttpStatusCode.Forbidden, ErrorCode.PermissionDenied },
+                { HttpStatusCode.NotFound, ErrorCode.NotFound },
+                { HttpStatusCode.Conflict, ErrorCode.Conflict },
+                { (HttpStatusCode)429, ErrorCode.ResourceExhausted },
+                { HttpStatusCode.InternalServerError, ErrorCode.Internal },
+                { HttpStatusCode.ServiceUnavailable, ErrorCode.Unavailable },
+            };
+
+        internal void ThrowIfError(HttpResponseMessage response, string json)
+        {
+            if (response.IsSuccessStatusCode)
+            {
+                return;
+            }
+
+            var info = this.ExtractErrorInfo(response, json);
+            var args = new FirebaseExceptionArgs()
+            {
+                Code = info.Code,
+                Message = info.Message,
+                HttpResponse = response,
+                ResponseBody = json,
+            };
+            throw this.CreateException(args);
+        }
+
+        protected virtual ErrorInfo ExtractErrorInfo(HttpResponseMessage response, string json)
+        {
+            ErrorCode code;
+            if (!HttpErrorCodes.TryGetValue(response.StatusCode, out code))
+            {
+                code = ErrorCode.Unknown;
+            }
+
+            var message = "Unexpected HTTP response with status: "
+                + $"{(int)response.StatusCode} ({response.StatusCode})"
+                + $"{Environment.NewLine}{json}";
+            return new ErrorInfo()
+            {
+                Code = code,
+                Message = message,
+            };
+        }
+
+        protected virtual FirebaseException CreateException(FirebaseExceptionArgs args)
+        {
+            return new FirebaseException(args.Code, args.Message, response: args.HttpResponse);
+        }
+
+        internal sealed class ErrorInfo
+        {
+            internal ErrorCode Code { get; set; }
+
+            internal string Message { get; set; }
+        }
+
+        internal sealed class FirebaseExceptionArgs
+        {
+            internal ErrorCode Code { get; set; }
+
+            internal string Message { get; set; }
+
+            internal HttpResponseMessage HttpResponse { get; set; }
+
+            internal string ResponseBody { get; set; }
+        }
+    }
+}

FirebaseAdmin/FirebaseAdmin/PlatformErrorHandler.cs

@@ -12,16 +12,14 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-using System;
 using System.Collections.Generic;
-using System.Net;
 using System.Net.Http;
 using Google.Apis.Json;
 using Newtonsoft.Json;
 
 namespace FirebaseAdmin
 {
-    internal class PlatformErrorHandler
+    internal class PlatformErrorHandler : HttpErrorHandler
     {
         private static readonly IReadOnlyDictionary<string, ErrorCode> PlatformErrorCodes =
             new Dictionary<string, ErrorCode>()
@@ -33,56 +31,29 @@ internal class PlatformErrorHandler
                 { "UNAVAILABLE", ErrorCode.Unavailable },
             };
 
-        private static readonly IReadOnlyDictionary<HttpStatusCode, ErrorCode> HttpErrorCodes =
-            new Dictionary<HttpStatusCode, ErrorCode>()
-            {
-                { HttpStatusCode.BadRequest, ErrorCode.InvalidArgument },
-                { HttpStatusCode.InternalServerError, ErrorCode.Internal },
-                { HttpStatusCode.Forbidden, ErrorCode.PermissionDenied },
-                { HttpStatusCode.Unauthorized, ErrorCode.Unauthenticated },
-                { HttpStatusCode.ServiceUnavailable, ErrorCode.Unavailable },
-            };
-
-        internal void ThrowIfError(HttpResponseMessage response, string json)
+        protected override ErrorInfo ExtractErrorInfo(HttpResponseMessage response, string json)
         {
-            if (response.IsSuccessStatusCode)
-            {
-                return;
-            }
-
             var parsedResponse = NewtonsoftJsonSerializer.Instance.Deserialize<PlatformErrorResponse>(json);
             var status = parsedResponse.Error?.Status ?? string.Empty;
+            var defaults = base.ExtractErrorInfo(response, json);
 
             ErrorCode code;
             if (!PlatformErrorCodes.TryGetValue(status, out code))
             {
-                if (!HttpErrorCodes.TryGetValue(response.StatusCode, out code))
-                {
-                    code = ErrorCode.Unknown;
-                }
+                code = defaults.Code;
             }
 
             var message = parsedResponse.Error?.Message;
             if (string.IsNullOrEmpty(message))
             {
-                message = "Unexpected HTTP response with status: "
-                    + $"{(int)response.StatusCode} ({response.StatusCode})"
-                    + $"{Environment.NewLine}{json}";
+                message = defaults.Message;
             }
 
-            var args = new FirebaseExceptionArgs()
+            return new ErrorInfo()
             {
                 Code = code,
                 Message = message,
-                HttpResponse = response,
-                ResponseBody = json,
             };
-            throw this.CreateException(args);
-        }
-
-        protected virtual FirebaseException CreateException(FirebaseExceptionArgs args)
-        {
-            return new FirebaseException(args.Code, args.Message, response: args.HttpResponse);
         }
 
         internal class PlatformErrorResponse
@@ -99,16 +70,5 @@ internal class PlatformError
             [JsonProperty("message")]
             public string Message { get; set; }
         }
-
-        internal class FirebaseExceptionArgs
-        {
-            internal ErrorCode Code { get; set; }
-
-            internal string Message { get; set; }
-
-            internal HttpResponseMessage HttpResponse { get; set; }
-
-            internal string ResponseBody { get; set; }
-        }
     }
 }