Merge pull request #102 from microsoftgraph/exposeHeaders

Expose response headers and http status code on the ServiceException …

Author: MIchaelMainer

src/Microsoft.Graph.Core/Exceptions/ServiceException.cs

@@ -16,6 +16,11 @@ public ServiceException(Error error, Exception innerException = null)
 
         public Error Error { get; private set; }
 
+        // ResponseHeaders and StatusCode exposed as pass-through.
+        public System.Net.Http.Headers.HttpResponseHeaders ResponseHeaders { get; internal set; }
+
+        public System.Net.HttpStatusCode StatusCode { get; internal set; }
+
         public bool IsMatch(string errorCode)
         {
             if (string.IsNullOrEmpty(errorCode))
@@ -48,4 +53,4 @@ public override string ToString()
             return null;
         }
     }
-}
+}

src/Microsoft.Graph.Core/Microsoft.Graph.Core.nuspec

@@ -13,16 +13,11 @@
     <projectUrl>https://graph.microsoft.io</projectUrl>
     <licenseUrl>http://aka.ms/devservicesagreement</licenseUrl>
     <releaseNotes>
-      November 2016 Release Summary (version 1.3.0)
+      April 2017 Release Summary (version 1.3.1)
 
       New features
 
-      * Added LINQ support for $select and $expand query options.
-
-      Bug fixes
-
-      * Fixed an issue in BaseRequest.cs so that query options can support a sub-query option.
-      * Added missing configureAwait(false) in BaseRequest.cs to address potential deadlock scenario.
+      * Expose HTTP status codes and the response header collection on the ServiceException class.
     </releaseNotes>
     <tags>Microsoft Office365 Graph GraphServiceClient Outlook OneDrive AzureAD GraphAPI Productivity SharePoint SDK</tags>
     <dependencies>

src/Microsoft.Graph.Core/Properties/AssemblyInfo.cs

@@ -24,8 +24,8 @@
 //
 // You can specify all the values or you can default the Build and Revision Numbers
 // by using the '*' as shown below:
-[assembly: AssemblyVersion("1.3.0")]
-[assembly: AssemblyFileVersion("1.3.0.0")]
+[assembly: AssemblyVersion("1.3.1")]
+[assembly: AssemblyFileVersion("1.3.1.0")]
 
 #if DEBUG
 [assembly: InternalsVisibleTo("Microsoft.Graph.Core.Test")]

src/Microsoft.Graph.Core/Requests/HttpProvider.cs

@@ -204,7 +204,15 @@ public async Task<HttpResponseMessage> SendAsync(
                         }
                     }
 
-                    throw new ServiceException(error);
+                    throw new ServiceException(error)
+                    {
+                        // Pass through the response headers to the ServiceException.
+                        ResponseHeaders = response.Headers,
+
+                        // System.Net.HttpStatusCode does not support RFC 6585, Additional HTTP Status Codes.
+                        // Throttling status code 429 is in RFC 6586. The status code 429 will be passed through.
+                        StatusCode = response.StatusCode
+                    };
                 }
             }
 

tests/Microsoft.Graph.Test/Microsoft.Graph.Test.csproj

@@ -92,6 +92,7 @@
     <Compile Include="Requests\Functional\GraphTestBase.cs" />
     <Compile Include="Requests\Functional\MailTests.cs" />
     <Compile Include="Requests\Functional\OneDriveTests.cs" />
+    <Compile Include="Requests\Functional\ErrorTests.cs" />
     <Compile Include="Requests\Functional\UsersTests.cs" />
     <Compile Include="Requests\Generated\EntityWithReferenceRequestTests.cs" />
     <Compile Include="Requests\Generated\EntityReferenceRequestTests.cs" />

tests/Microsoft.Graph.Test/Requests/Functional/ErrorTests.cs

@@ -0,0 +1,50 @@
+using System;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using System.Collections.Generic;
+using System.IO;
+using System.Threading.Tasks;
+
+namespace Microsoft.Graph.Test.Requests.Functional
+{
+    [Ignore]
+    [TestClass]
+    public class ErrorTests : GraphTestBase
+    {
+        [Ignore] // Setup Fiddler autoresponder 
+        [TestMethod]
+        public async Task ErrorThrottlingError()
+        {
+            try
+            {
+                // All requests should have a client-request-id set so that the client can correlate a 
+                // request with a response. 
+                var headerOptions = new List<HeaderOption>()
+                {
+                    new HeaderOption("client-request-id", "dddddddd-dddd-dddd-dddd-dddddddddddd")
+                };
+
+                // To get a throttling error, I mocked up a 429 response in a text file and turned on the Fiddler
+                // autoresponder to return the text file as the response envelope. The autoresponder for this 
+                // scenario responds to EXACT:https://graph.microsoft.com/v1.0/groups/036bd54c-c6e5-43eb-b8b5-03e019e75bd1
+                var group = await graphClient.Groups["036bd54c-c6e5-43eb-b8b5-03e019e75bd1"].Request(headerOptions).GetAsync();
+            }
+            catch (Microsoft.Graph.ServiceException e)
+            {
+                if ((int)e.StatusCode == 429) // Too Many Requests
+                {
+                    // We have the client-request-id for correlating the response to the request that failed.
+                    IEnumerable<string> clientrequestidvalues;
+                    Assert.IsTrue(e.ResponseHeaders.TryGetValues("client-request-id", out clientrequestidvalues), "client-request-id not found");
+
+                    // We have the Retry-After that the client can use to wait and resubmit the rejected request.
+                    IEnumerable<string> retryaftervalues;
+                    Assert.IsTrue(e.ResponseHeaders.TryGetValues("Retry-After", out retryaftervalues), "Retry-After not found");
+                }
+                else
+                {
+                    Assert.Fail("Something happened, check out a trace. Error code: {0}", e.Error.Code);
+                }
+            }
+        }
+    }
+}