Compression Handler Header Handling (#123)

georgend · web-flow · commit 928cc9909865 · 2020-07-28T11:57:53.000-07:00
* Support native platform Http handlers for Xamarin.Mac * Update macOS to use NSUrlSessionHandler in foundation namespace - support for Xamarin.Mac20 * Compression header handling (#118)
diff --git a/scripts/IncrementPreviewVersion.ps1 b/scripts/IncrementPreviewVersion.ps1
@@ -15,12 +15,13 @@
 
 #>
 
+[CmdletBinding()]
 Param(
-    [parameter(Mandatory = $true)]
-    [string]$packageName,
+    [parameter(Mandatory = $false)]
+    [string]$packageName = 'microsoft.graph.core',
 
-    [parameter(Mandatory = $true)]
-    [string]$projectPath
+    [parameter(Mandatory = $false)]
+    [string]$projectPath = '.\src\Microsoft.Graph.Core\Microsoft.Graph.Core.csproj'
 )
 
 $xmlDoc = New-Object System.Xml.XmlDocument
@@ -31,9 +32,9 @@ $versionSuffixString = $xmlDoc.Project.PropertyGroup[0].VersionSuffix
 
 # Don't do anything if a VersionSuffix has been set in the .csproj.
 if ($versionSuffixString -ne '' -and $versionSuffixString -ne $null) {
-    Write-Host "The VersionSuffix has been set as $versionSuffixString in the csproj file. `
-    Skip the automatic setting or incrementing of the version suffix. Delete the value in `
-    VersionSuffix to enable auto-incrementing the preview version." -ForegroundColor Yellow
+    Write-Host "`tThe VersionSuffix has been set as $versionSuffixString in the csproj file. `
+`tSkip the automatic setting or incrementing of the version suffix. Delete the value in `
+`tVersionSuffix to enable auto-incrementing the preview version." -ForegroundColor Yellow
 
     Exit 0
 }
@@ -51,19 +52,31 @@ $url = "https://api.nuget.org/v3-flatcontainer/$packageName/index.json"
 # Call the NuGet API for the package and get the highest SemVer 2.0.0 version for the package.
 # Per rules https://semver.org/spec/v2.0.0.html#spec-item-11
 $nugetIndex = Invoke-RestMethod -Uri $url -Method Get
-$highestPublishedVersion = $nugetIndex.versions[$nugetIndex.versions.Length - 1]
 
-# We do need to make sure it is listed. For example, we didn't properly suffix M.G.A so the
-# highest reported version is incorrect.
+# We need the versionPrefix from the csproj so that we target the 
+# the highest version. This enables us to support v1.x.x and vNext.x.x
+$versionPrefix = $xmlDoc.Project.PropertyGroup[0].VersionPrefix
 
-# We assume that the Version takes the form of 'x.y.z' with an optional '-preview.n' appended for preview releases.
-Write-Host "The highest published version of $packageName is $highestPublishedVersion"
-
-# Set or increment the VersionSuffix.
-if ($highestPublishedVersion.Indexof('-preview') -eq -1) {
+# Only consider versions that match the version prefix in the csproj.
+$versionmatches = $nugetIndex.versions -match $versionPrefix
+if ($versionmatches.Count -eq 0) {
+    # if the version hasn't been published, we need to add a preview versionSuffix.
+    # Add an initial preview versionSuffix
     $versionSuffixString = 'preview.1' # Build applies the hyphen
 }
-else {
+else { 
+    # We have published preview versions for this version prefix.
+
+    # Only look at preview versions, also to referred to as versionSuffix
+    $versionmatches = $versionmatches -match 'preview'
+
+    # Assumption: the API returns the versions in order.
+    $highestPublishedVersion = $versionmatches[$versionmatches.Count - 1]
+
+    # We assume that the Version takes the form of 'x.y.z' with an optional '-preview.n' appended for preview releases.
+    Write-Host "The highest published version of $packageName is $highestPublishedVersion"
+
+    # if the version has been published with a versionSuffix, then increment the suffix.    
     # A preview has been previously released. Let's increment the VersionSuffix.
     $currentPreviewVersion = [int]$highestPublishedVersion.Split('-')[1].Split('.')[1]
 
@@ -72,7 +85,7 @@ else {
     $versionSuffixString = "preview.{0}" -f $incrementedPreviewVersion
 }
 
-Write-Host "The preview version is now $versionSuffixString" -ForegroundColor Green
+Write-Host "The preview version is now $versionPrefix-$versionSuffixString" -ForegroundColor Green
 
 $xmlDoc.Project.PropertyGroup[0].VersionSuffix = $versionSuffixString
 $xmlDoc.Save($projectPath)
diff --git a/src/Microsoft.Graph.Core/Microsoft.Graph.Core.csproj b/src/Microsoft.Graph.Core/Microsoft.Graph.Core.csproj
@@ -4,7 +4,7 @@
     <Copyright>© Microsoft Corporation. All rights reserved.</Copyright>
     <AssemblyTitle>Microsoft Graph Core Client Library</AssemblyTitle>
     <Authors>Microsoft</Authors>
-    <TargetFrameworks>netstandard1.1;net45;Xamarin.iOS10;MonoAndroid70</TargetFrameworks>
+    <TargetFrameworks>netstandard1.1;net45;Xamarin.iOS10;Xamarin.Mac20;MonoAndroid70</TargetFrameworks>
     <PreserveCompilationContext>false</PreserveCompilationContext>
     <AssemblyName>Microsoft.Graph.Core</AssemblyName>
     <PackageId>Microsoft.Graph.Core</PackageId>
@@ -19,10 +19,11 @@
     <DelaySign>false</DelaySign>
     <AssemblyOriginatorKeyFile>35MSSharedLib1024.snk</AssemblyOriginatorKeyFile>
     <AutoGenerateBindingRedirects>true</AutoGenerateBindingRedirects>
-    <VersionPrefix>1.20.1</VersionPrefix>
+    <VersionPrefix>1.21.0</VersionPrefix>
     <VersionSuffix></VersionSuffix>
     <PackageReleaseNotes>
-      - Fix for DeltaResponseHandler not handling array of primitives. #93
+      - Support Xamarin.Mac20.
+      - Fix CompressionHandler feature.
     </PackageReleaseNotes>
   </PropertyGroup>
   <!--We manually configure LanguageTargets for Xamarin due to .Net SDK TFMs limitation https://github.com/dotnet/sdk/issues/491 -->
@@ -33,6 +34,13 @@
     <DebugType>full</DebugType>
     <LanguageTargets>$(MSBuildExtensionsPath)\Xamarin\iOS\Xamarin.iOS.CSharp.targets</LanguageTargets>
   </PropertyGroup>
+  <PropertyGroup Condition="'$(TargetFramework)' == 'Xamarin.Mac20'">
+    <TargetFrameworkIdentifier>Xamarin.Mac</TargetFrameworkIdentifier>
+    <TargetFrameworkVersion>v2.0</TargetFrameworkVersion>
+    <DefineConstants>$(DefineConstants);macOS</DefineConstants>
+    <DebugType>full</DebugType>
+    <LanguageTargets>$(MSBuildExtensionsPath)\Xamarin\Mac\Xamarin.Mac.CSharp.targets</LanguageTargets>
+  </PropertyGroup>
   <PropertyGroup Condition="'$(TargetFramework)' == 'MonoAndroid70'">
     <TargetFrameworkIdentifier>MonoAndroid</TargetFrameworkIdentifier>
     <TargetFrameworkVersion>v7.0</TargetFrameworkVersion>
@@ -77,6 +85,15 @@
 	<PackageReference Include="Newtonsoft.Json" Version="11.0.1" />
 	<PackageReference Include="System.Net.Http" Version="4.3.3" />
   </ItemGroup>
+  <ItemGroup Condition=" '$(TargetFramework)' == 'Xamarin.Mac20' ">
+	<Reference Include="Xamarin.Mac" />
+	<Reference Include="System" />
+	<Reference Include="System.Core" />
+	<Reference Include="System.Xml" />
+	<Reference Include="Microsoft.CSharp" />
+	<PackageReference Include="Newtonsoft.Json" Version="11.0.1" />
+	<PackageReference Include="System.Net.Http" Version="4.3.3" />
+  </ItemGroup>
   <ItemGroup Condition=" '$(TargetFramework)' == 'MonoAndroid70' ">
 	<Reference Include="Mono.Android" />
 	<Reference Include="System" />
diff --git a/src/Microsoft.Graph.Core/Requests/GraphClientFactory.cs b/src/Microsoft.Graph.Core/Requests/GraphClientFactory.cs
@@ -179,15 +179,20 @@ internal static (HttpMessageHandler Pipeline, FeatureFlag FeatureFlags) CreatePi
                     throw new ArgumentNullException(nameof(handlers), "DelegatingHandler array contains null item.");
                 }
 
+#if iOS || macOS
 #if iOS
-                // Skip CompressionHandler since NSUrlSessionHandler automatically handles decompression on iOS and it can't be turned off.
+                // Skip CompressionHandler since NSUrlSessionHandler automatically handles decompression on iOS and macOS and it can't be turned off.
                 // See issue https://github.com/microsoftgraph/msgraph-sdk-dotnet/issues/481 for more details.
                 if (finalHandler.GetType().Equals(typeof(NSUrlSessionHandler)) && handler.GetType().Equals(typeof(CompressionHandler)))
+#elif macOS
+                 if (finalHandler.GetType().Equals(typeof(Foundation.NSUrlSessionHandler)) && handler.GetType().Equals(typeof(CompressionHandler)))
+#endif
                 {
                     // Skip chaining of CompressionHandler.
                     continue;
                 }
 #endif
+
                 // Check for duplicate handler by type.
                 if (!existingHandlerTypes.Add(handler.GetType()))
                 {
@@ -206,18 +211,20 @@ internal static (HttpMessageHandler Pipeline, FeatureFlag FeatureFlags) CreatePi
         }
 
         /// <summary>
-        /// Gets a platform's native http handler i.e. NSUrlSessionHandler for Xamarin.iOS, AndroidClientHandler for Xamarin.Android and HttpClientHandler for others.
+        /// Gets a platform's native http handler i.e. NSUrlSessionHandler for Xamarin.iOS and Xamarin.Mac, AndroidClientHandler for Xamarin.Android and HttpClientHandler for others.
         /// </summary>
         /// <param name="proxy">The proxy to be used with created client.</param>
         /// <returns>
-        /// 1. NSUrlSessionHandler for Xamarin.iOS 
+        /// 1. NSUrlSessionHandler for Xamarin.iOS and Xamarin.Mac
         /// 2. AndroidClientHandler for Xamarin.Android.
         /// 3. HttpClientHandler for other platforms.
         /// </returns>
         internal static HttpMessageHandler GetNativePlatformHttpHandler(IWebProxy proxy = null)
         {
 #if iOS
             return new NSUrlSessionHandler { AllowAutoRedirect = false };
+#elif macOS
+            return new Foundation.NSUrlSessionHandler { AllowAutoRedirect = false };
 #elif ANDROID
             return new Xamarin.Android.Net.AndroidClientHandler { Proxy = proxy, AllowAutoRedirect = false, AutomaticDecompression = DecompressionMethods.None };
 #else
diff --git a/src/Microsoft.Graph.Core/Requests/Middleware/CompressionHandler.cs b/src/Microsoft.Graph.Core/Requests/Middleware/CompressionHandler.cs
@@ -9,6 +9,7 @@ namespace Microsoft.Graph
     using System.Threading.Tasks;
     using System.Net.Http.Headers;
     using System.IO.Compression;
+    using System.Collections.Generic;
 
     /// <summary>
     /// A <see cref="DelegatingHandler"/> implementation that handles compression.
@@ -53,7 +54,13 @@ protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage
             // Decompress response content when Content-Encoding: gzip header is present.
             if (ShouldDecompressContent(response))
             {
-                response.Content = new StreamContent(new GZipStream(await response.Content.ReadAsStreamAsync(), CompressionMode.Decompress));
+                StreamContent streamContent = new StreamContent(new GZipStream(await response.Content.ReadAsStreamAsync(), CompressionMode.Decompress));
+                // Copy Content Headers to the destination stream content
+                foreach (var httpContentHeader in response.Content.Headers)
+                {
+                    streamContent.Headers.TryAddWithoutValidation(httpContentHeader.Key, httpContentHeader.Value);
+                }
+                response.Content = streamContent;
             }
 
             return response;
diff --git a/tests/Microsoft.Graph.DotnetCore.Core.Test/Microsoft.Graph.DotnetCore.Core.Test.csproj b/tests/Microsoft.Graph.DotnetCore.Core.Test/Microsoft.Graph.DotnetCore.Core.Test.csproj
@@ -1,6 +1,6 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
 	<PropertyGroup>
-		<TargetFrameworks>netcoreapp3.1;Xamarin.iOS10;MonoAndroid70</TargetFrameworks>
+		<TargetFrameworks>netcoreapp3.1;Xamarin.iOS10;Xamarin.Mac20;MonoAndroid70;</TargetFrameworks>
 		<AssemblyName>Microsoft.Graph.DotnetCore.Core.Test</AssemblyName>
 		<PackageId>Microsoft.Graph.DotnetCore.Core.Test</PackageId>
 		<GenerateRuntimeConfigurationFiles>true</GenerateRuntimeConfigurationFiles>
@@ -21,6 +21,14 @@
 		<DebugType>full</DebugType>
 		<LanguageTargets>$(MSBuildExtensionsPath)\Xamarin\iOS\Xamarin.iOS.CSharp.targets</LanguageTargets>
 	</PropertyGroup>
+   
+  <PropertyGroup Condition="'$(TargetFramework)' == 'Xamarin.Mac20'">
+	  <TargetFrameworkIdentifier>Xamarin.Mac</TargetFrameworkIdentifier>
+	  <TargetFrameworkVersion>v2.0</TargetFrameworkVersion>
+	  <DefineConstants>$(DefineConstants);macOS</DefineConstants>
+	  <DebugType>full</DebugType>
+	  <LanguageTargets>$(MSBuildExtensionsPath)\Xamarin\Mac\Xamarin.Mac.CSharp.targets</LanguageTargets>
+  </PropertyGroup> 
 
 	<PropertyGroup Condition="'$(TargetFramework)' == 'MonoAndroid70'">
 		<TargetFrameworkIdentifier>MonoAndroid</TargetFrameworkIdentifier>
@@ -58,6 +66,16 @@
 		<Reference Include="System.Runtime.Serialization" />
 		<PackageReference Include="System.Net.Http" Version="4.3.3" />
 	</ItemGroup>
+   
+  <ItemGroup Condition=" '$(TargetFramework)' == 'Xamarin.Mac20' ">
+	  <Reference Include="Microsoft.CSharp" />
+	  <Reference Include="Xamarin.Mac" />
+	  <Reference Include="System" />
+	  <Reference Include="System.Core" />
+	  <Reference Include="System.Xml" />
+	  <Reference Include="System.Runtime.Serialization" />
+	  <PackageReference Include="System.Net.Http" Version="4.3.3" />
+  </ItemGroup>
 
 	<ItemGroup Condition=" '$(TargetFramework)' == 'MonoAndroid70' ">
 		<Reference Include="Microsoft.CSharp" />
@@ -69,7 +87,7 @@
 		<PackageReference Include="System.Net.Http" Version="4.3.3" />
 	</ItemGroup>
 
-	<ItemGroup>
+   <ItemGroup>
 		<Service Include="{82a7f48d-3b50-4b1e-b82e-3ada8210c358}" />
 	</ItemGroup>
 </Project>
diff --git a/tests/Microsoft.Graph.DotnetCore.Core.Test/Requests/GraphClientFactoryTests.cs b/tests/Microsoft.Graph.DotnetCore.Core.Test/Requests/GraphClientFactoryTests.cs
@@ -41,14 +41,18 @@ public void Dispose()
         // and 'GraphClientFactory.DefaultHttpHandler' can easily be modified
         // by other tests since it's a static delegate.
 
-#if iOS
+#if iOS || macOS
         [Fact]
         public void Should_CreatePipeline_Without_CompressionHandler()
         {
             using (AuthenticationHandler authenticationHandler = (AuthenticationHandler)GraphClientFactory.CreatePipeline(handlers))
             using (RetryHandler retryHandler = (RetryHandler)authenticationHandler.InnerHandler)
             using (RedirectHandler redirectHandler = (RedirectHandler)retryHandler.InnerHandler)
+#if iOS
             using (NSUrlSessionHandler innerMost = (NSUrlSessionHandler)redirectHandler.InnerHandler)
+#elif macOS
+            using (Foundation.NSUrlSessionHandler innerMost = (Foundation.NSUrlSessionHandler)redirectHandler.InnerHandler)
+#endif
             {
                 Assert.NotNull(authenticationHandler);
                 Assert.NotNull(retryHandler);
@@ -57,7 +61,11 @@ public void Should_CreatePipeline_Without_CompressionHandler()
                 Assert.IsType<AuthenticationHandler>(authenticationHandler);
                 Assert.IsType<RetryHandler>(retryHandler);
                 Assert.IsType<RedirectHandler>(redirectHandler);
+#if iOS
                 Assert.IsType<NSUrlSessionHandler>(innerMost);
+#elif macOS
+                Assert.IsType<Foundation.NSUrlSessionHandler>(innerMost);
+#endif
             }
         }
 #else
diff --git a/tests/Microsoft.Graph.DotnetCore.Core.Test/Requests/HttpProviderTests.cs b/tests/Microsoft.Graph.DotnetCore.Core.Test/Requests/HttpProviderTests.cs
@@ -115,6 +115,9 @@ public void HttpProvider_DefaultConstructor()
 #elif iOS
                 Assert.IsType<NSUrlSessionHandler>(defaultHttpProvider.httpMessageHandler);
                 Assert.False((defaultHttpProvider.httpMessageHandler as NSUrlSessionHandler).AllowAutoRedirect);
+#elif macOS
+                Assert.IsType<Foundation.NSUrlSessionHandler>(defaultHttpProvider.httpMessageHandler);
+                Assert.False((defaultHttpProvider.httpMessageHandler as Foundation.NSUrlSessionHandler).AllowAutoRedirect);
 #else
                 Assert.IsType<HttpClientHandler>(defaultHttpProvider.httpMessageHandler);
                 Assert.False((defaultHttpProvider.httpMessageHandler as HttpClientHandler).AllowAutoRedirect);
@@ -554,12 +557,16 @@ public void HttpProvider_CustomAndroidClientHandler()
 #endif
         #endregion
 
-        #region iOS
-#if iOS
+        #region iOS_macOS
+#if iOS || macOS
         [Fact]
         public void HttpProvider_CustomNSUrlSessionHandler()
         {
+#if iOS
             using (var httpClientHandler = new NSUrlSessionHandler())
+#elif macOS
+            using (var httpClientHandler = new Foundation.NSUrlSessionHandler())
+#endif
             using (var httpProvider = new HttpProvider(httpClientHandler, false, null))
             {
                 Assert.Equal(httpClientHandler, httpProvider.httpMessageHandler);
@@ -568,6 +575,6 @@ public void HttpProvider_CustomNSUrlSessionHandler()
             }
         }
 #endif
-        #endregion
-    }
-}
+#endregion
+        }
+    }
diff --git a/tests/Microsoft.Graph.DotnetCore.Core.Test/Requests/Middleware/CompressionHandlerTests.cs b/tests/Microsoft.Graph.DotnetCore.Core.Test/Requests/Middleware/CompressionHandlerTests.cs
@@ -12,6 +12,9 @@ namespace Microsoft.Graph.DotnetCore.Core.Test.Requests.Middleware
     using System.Threading.Tasks;
     using System.Threading;
     using System.Net.Http.Headers;
+    using System.Linq;
+    using System.Collections.Generic;
+    using Xunit.Abstractions;
 
     public class CompressionHandlerTests : IDisposable
     {
@@ -94,5 +97,57 @@ public async Task CompressionHandler_should_not_decompress_response_without_cont
             Assert.Same(httpRequestMessage, compressedResponse.RequestMessage);
             Assert.NotEqual(stringToCompress, responseContentString);
         }
+
+        /// <summary>
+        /// Compression Handler should keep content headers after decompression
+        /// </summary>
+        /// <returns></returns>
+        [Fact]
+        public async Task CompressionHandler_should_keep_headers_after_decompression()
+        {
+            HttpRequestMessage httpRequestMessage = new HttpRequestMessage(HttpMethod.Get, "http://example.org/foo");
+
+            string stringToCompress = "Microsoft Graph";
+            StringContent stringContent = new StringContent(stringToCompress);
+            stringContent.Headers.ContentType = new MediaTypeHeaderValue(CoreConstants.MimeTypeNames.Application.Json);
+
+            HttpResponseMessage httpResponse = new HttpResponseMessage(HttpStatusCode.OK)
+            {
+                Content = new MockCompressedContent(stringContent)
+            };
+            httpResponse.Content.Headers.ContentEncoding.Add(CoreConstants.Encoding.GZip);
+            httpResponse.Headers.CacheControl = new CacheControlHeaderValue { Private = true };
+            // Examples of Custom Headers returned by Microsoft Graph
+            httpResponse.Headers.Add(CoreConstants.Headers.ClientRequestId, Guid.NewGuid().ToString());
+            httpResponse.Headers.Add("request-id", Guid.NewGuid().ToString());
+            httpResponse.Headers.Add("OData-Version", "4.0");
+
+            this.testHttpMessageHandler.SetHttpResponse(httpResponse);
+
+            HttpResponseMessage compressedResponse = await this.invoker.SendAsync(httpRequestMessage, new CancellationToken());
+            string decompressedResponseString = await compressedResponse.Content.ReadAsStringAsync();
+
+            Assert.Equal(decompressedResponseString, stringToCompress);
+
+            // Ensure that headers in the compressedResponse are the same as in the original, expected response.
+            Assert.NotEmpty(compressedResponse.Headers);
+            Assert.NotEmpty(compressedResponse.Content.Headers);
+            Assert.Equal(httpResponse.Headers, compressedResponse.Headers, new HttpHeaderComparer());
+            Assert.Equal(httpResponse.Content.Headers, compressedResponse.Content.Headers, new HttpHeaderComparer());
+        }
+
+        internal class HttpHeaderComparer : IEqualityComparer<KeyValuePair<string, IEnumerable<string>>>
+        {
+            public bool Equals(KeyValuePair<string, IEnumerable<string>> x, KeyValuePair<string, IEnumerable<string>> y)
+            {
+                // For each key, the collection of header values should be equal.
+                return x.Key == y.Key && x.Value.SequenceEqual(y.Value);
+            }
+
+            public int GetHashCode(KeyValuePair<string, IEnumerable<string>> obj)
+            {
+                return obj.Key.GetHashCode();
+            }
+        }
     }
 }
