Support for parsing OP error responses

Author: hiranya911

FirebaseAdmin/FirebaseAdmin.Tests/FirebaseExceptionTest.cs

@@ -14,8 +14,10 @@
 
 using System;
 using System.Collections.Generic;
+using System.Net;
 using System.Net.Http;
 using System.Net.Sockets;
+using System.Text;
 using Xunit;
 
 namespace FirebaseAdmin.Tests
@@ -30,6 +32,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 +44,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 +71,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 +96,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 +111,100 @@ 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);
+        }
+
+        [Fact]
+        public void PlatformError()
+        {
+            var json = @"{
+                ""error"": {
+                    ""status"": ""UNAVAILABLE"",
+                    ""message"": ""Test error message""
+                }
+            }";
+            var resp = new HttpResponseMessage()
+            {
+                StatusCode = HttpStatusCode.ServiceUnavailable,
+                Content = new StringContent(json, Encoding.UTF8, "application/json"),
+            };
+
+            var handler = new PlatformErrorHandler();
+            var error = Assert.Throws<FirebaseException>(() => handler.ThrowIfError(resp, json));
+
+            Assert.Equal(ErrorCode.Unavailable, error.ErrorCode);
+            Assert.Equal("Test error message", error.Message);
+            Assert.Same(resp, error.HttpResponse);
+            Assert.Null(error.InnerException);
+        }
+
+        [Fact]
+        public void PlatformErrorWithoutCode()
+        {
+            var json = @"{
+                ""error"": {
+                    ""message"": ""Test error message""
+                }
+            }";
+            var resp = new HttpResponseMessage()
+            {
+                StatusCode = HttpStatusCode.ServiceUnavailable,
+                Content = new StringContent(json, Encoding.UTF8, "application/json"),
+            };
+
+            var handler = new PlatformErrorHandler();
+            var error = Assert.Throws<FirebaseException>(() => handler.ThrowIfError(resp, json));
+
+            Assert.Equal(ErrorCode.Unavailable, error.ErrorCode);
+            Assert.Equal("Test error message", error.Message);
+            Assert.Same(resp, error.HttpResponse);
+            Assert.Null(error.InnerException);
+        }
+
+        [Fact]
+        public void PlatformErrorWithoutMessage()
+        {
+            var json = @"{
+                ""error"": {
+                    ""status"": ""INVALID_ARGUMENT"",
+                }
+            }";
+            var resp = new HttpResponseMessage()
+            {
+                StatusCode = HttpStatusCode.ServiceUnavailable,
+                Content = new StringContent(json, Encoding.UTF8, "application/json"),
+            };
+
+            var handler = new PlatformErrorHandler();
+            var error = Assert.Throws<FirebaseException>(() => handler.ThrowIfError(resp, json));
+
+            Assert.Equal(ErrorCode.InvalidArgument, error.ErrorCode);
+            Assert.Equal(
+                $"Unexpected HTTP response with status: 503 (ServiceUnavailable)\n{json}",
+                error.Message);
+            Assert.Same(resp, error.HttpResponse);
+            Assert.Null(error.InnerException);
+        }
+
+        [Fact]
+        public void PlatformErrorWithoutCodeOrMessage()
+        {
+            var json = @"{}";
+            var resp = new HttpResponseMessage()
+            {
+                StatusCode = HttpStatusCode.ServiceUnavailable,
+                Content = new StringContent(json, Encoding.UTF8, "application/json"),
+            };
+
+            var handler = new PlatformErrorHandler();
+            var error = Assert.Throws<FirebaseException>(() => handler.ThrowIfError(resp, json));
+
+            Assert.Equal(ErrorCode.Unavailable, error.ErrorCode);
+            Assert.Equal(
+                "Unexpected HTTP response with status: 503 (ServiceUnavailable)\n{}",
+                error.Message);
+            Assert.Same(resp, error.HttpResponse);
+            Assert.Null(error.InnerException);
         }
     }
 }

FirebaseAdmin/FirebaseAdmin/FirebaseException.cs

@@ -13,29 +13,37 @@
 // limitations under the License.
 
 using System;
+using System.Net.Http;
 
 namespace FirebaseAdmin
 {
     /// <summary>
     /// Common error type for all exceptions raised by Firebase APIs.
     /// </summary>
-    public sealed class FirebaseException : Exception
+    public class FirebaseException : Exception
     {
         internal FirebaseException(string message)
         : base(message) { } // TODO: Remove this constructor
 
         internal FirebaseException(string message, Exception inner)
         : base(message, inner) { } // TODO: Remove this constructor
 
-        internal FirebaseException(ErrorCode code, string message, Exception inner = null)
+        internal FirebaseException(
+            ErrorCode code,
+            string message,
+            Exception inner = null,
+            HttpResponseMessage response = null)
         : base(message, inner)
         {
             this.ErrorCode = code;
+            this.HttpResponse = response;
         }
 
         /// <summary>
         /// Gets the platform-wide error code associated with this exception.
         /// </summary>
         internal ErrorCode ErrorCode { get; private set; } // TODO: Expose this as public
+
+        internal HttpResponseMessage HttpResponse { get; private set; }
     }
 }

FirebaseAdmin/FirebaseAdmin/Messaging/FirebaseMessagingException.cs

@@ -0,0 +1,39 @@
+// 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;
+
+namespace FirebaseAdmin.Messaging
+{
+    /// <summary>
+    /// Exception type raised by Firebase Cloud Messaging APIs.
+    /// </summary>
+    public sealed class FirebaseMessagingException : FirebaseException
+    {
+        internal FirebaseMessagingException(
+          ErrorCode code,
+          string message,
+          MessagingErrorCode? fcmCode = null,
+          Exception inner = null)
+        : base(code, message, inner)
+        {
+            this.MessagingErrorCode = fcmCode;
+        }
+
+        /// <summary>
+        /// Gets the Cloud Messaging error code associated with this exception. May be null.
+        /// </summary>
+        public MessagingErrorCode? MessagingErrorCode { get; private set; }
+    }
+}

FirebaseAdmin/FirebaseAdmin/Messaging/MessagingErrorCode.cs

@@ -0,0 +1,58 @@
+// 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.
+
+namespace FirebaseAdmin.Messaging
+{
+    /// <summary>
+    /// Error codes that can be raised by the Cloud Messaging APIs.
+    /// </summary>
+    public enum MessagingErrorCode
+    {
+        /// <summary>
+        /// APNs certificate or web push auth key was invalid or missing.
+        /// </summary>
+        ThirdPartyAuthError,
+
+        /// <summary>
+        /// One or more argument specified in the request was invalid.
+        /// </summary>
+        InvalidArgument,
+
+        /// <summary>
+        /// Internal server error.
+        /// </summary>
+        Internal,
+
+        /// <summary>
+        /// Sending limit exceeded for the message target.
+        /// </summary>
+        QuotaExceeded,
+
+        /// <summary>
+        /// The authenticated sender ID is different from the sender ID for the registration token.
+        /// </summary>
+        SenderIdMismatch,
+
+        /// <summary>
+        /// Cloud Messaging service is temporarily unavailable.
+        /// </summary>
+        Unavailable,
+
+        /// <summary>
+        /// App instance was unregistered from FCM. This usually means that the token used is no
+        /// longer valid and a new one must be used.
+        /// </summary>
+        Unregistered,
+    }
+}