Merge pull request #90 from firebase/hkj-fcm-errors

Introducing FirebaseMessagingException and FCM error handling support

Author: hiranya911

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Unreleased
 
--
+- [added] Added `FirebaseMessagingException` class and improved FCM error
+  handling logic.
 
 # v1.7.0
 

FirebaseAdmin/FirebaseAdmin.Tests/FirebaseExceptionTest.cs

@@ -30,6 +30,7 @@ public void ErrorCodeAndMessage()
             Assert.Equal(ErrorCode.Internal, exception.ErrorCode);
             Assert.Equal("Test error message", exception.Message);
             Assert.Null(exception.InnerException);
+            Assert.Null(exception.HttpResponse);
         }
 
         [Fact]
@@ -41,6 +42,20 @@ public void InnerException()
             Assert.Equal(ErrorCode.Internal, exception.ErrorCode);
             Assert.Equal("Test error message", exception.Message);
             Assert.Same(inner, exception.InnerException);
+            Assert.Null(exception.HttpResponse);
+        }
+
+        [Fact]
+        public void HttpResponse()
+        {
+            var inner = new Exception("Inner exception");
+            var resp = new HttpResponseMessage();
+            var exception = new FirebaseException(ErrorCode.Internal, "Test error message", inner, resp);
+
+            Assert.Equal(ErrorCode.Internal, exception.ErrorCode);
+            Assert.Equal("Test error message", exception.Message);
+            Assert.Same(inner, exception.InnerException);
+            Assert.Same(resp, exception.HttpResponse);
         }
 
         [Fact]
@@ -54,6 +69,7 @@ public void TimeOutError()
             Assert.Equal(
                 "Timed out while making an API call: Test error message", exception.Message);
             Assert.Same(httpError, exception.InnerException);
+            Assert.Null(exception.HttpResponse);
         }
 
         [Fact]
@@ -78,6 +94,7 @@ public void NetworkUnavailableError()
                 Assert.Equal(
                     "Failed to establish a connection: Test error message", exception.Message);
                 Assert.Same(httpError, exception.InnerException);
+                Assert.Null(exception.HttpResponse);
             }
         }
 
@@ -92,6 +109,7 @@ public void UnknownLowLevelError()
                 "Unknown error while making a remote service call: Test error message",
                 exception.Message);
             Assert.Same(httpError, exception.InnerException);
+            Assert.Null(exception.HttpResponse);
         }
     }
 }

FirebaseAdmin/FirebaseAdmin.Tests/HttpErrorHandlerTest.cs

@@ -0,0 +1,103 @@
+// 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);
+        }
+
+        [Theory]
+        [MemberData(nameof(HttpErrorCodes))]
+        public void NonJsonResponse(HttpStatusCode statusCode, ErrorCode expected)
+        {
+            var text = "not json";
+            var resp = new HttpResponseMessage()
+            {
+                StatusCode = statusCode,
+                Content = new StringContent(text, Encoding.UTF8, "text/plain"),
+            };
+
+            var handler = new HttpErrorHandler();
+            var error = Assert.Throws<FirebaseException>(() => handler.ThrowIfError(resp, text));
+
+            Assert.Equal(expected, error.ErrorCode);
+            Assert.Equal(
+                $"Unexpected HTTP response with status: {(int)statusCode} ({statusCode})\n{text}",
+                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.Tests/Messaging/BatchResponseTest.cs

@@ -42,9 +42,7 @@ public void SomeResponse()
                 SendResponse.FromMessageId("message1"),
                 SendResponse.FromMessageId("message2"),
                 SendResponse.FromException(
-                    new FirebaseException(
-                        "error-message",
-                        null)),
+                    new FirebaseMessagingException(ErrorCode.Unknown, "error-message")),
             };
 
             var batchResponse = new BatchResponse(responses);