Contentful client tweaks (#351)

* Avoid waiting for complete response, if we are just checking if for success status code. Avoid evaluating OS & Version for every request. Avoid a possible MemoryStream leak. Other minor tweaks * Dispose responses & requests, pass cancellationToken & avoid an array allocation * Dispose cloned request, add sealed & readonly * Avoid deserializing into a string by deserializing directly from the response stream. Then deserialization can start immediately instead of waiting for the entire response. Reuse JsonSerializerSettings. Avoid async Task methods where it adds no value. * Use HTTP/2 * Allow HTTP response connection * Update package and dependency --------- Co-authored-by: Henrik Gedionsen <[email protected]>
contentful · Oct 2, 2024 · 60f9e57 · 60f9e57
1 parent b3ec71c
commit 60f9e57
Show file tree

Hide file tree

Showing 11 changed files with 393 additions and 632 deletions.
diff --git a/Contentful.AspNetCore/Contentful.AspNetCore.csproj b/Contentful.AspNetCore/Contentful.AspNetCore.csproj
@@ -3,7 +3,7 @@
     <Description>Official .NET SDK for the Contentful Content Delivery and Management API for ASP.NET core.</Description>
     <PackageId>contentful.aspnetcore</PackageId>
     <NeutralLanguage>en-US</NeutralLanguage>
-    <VersionPrefix>8.1.0</VersionPrefix>
+    <VersionPrefix>8.2.0</VersionPrefix>
     <TargetFramework>netstandard2.0</TargetFramework>
     <Authors>Contentful</Authors>
     <Copyright>Contentful GmbH.</Copyright>
@@ -13,10 +13,10 @@
     <PackageProjectUrl>https://github.com/contentful/contentful.net</PackageProjectUrl>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <RepositoryType>git</RepositoryType>
-    <Version>8.1.0</Version>
-    <AssemblyVersion>8.1.0.0</AssemblyVersion>
+    <Version>8.2.0</Version>
+    <AssemblyVersion>8.2.0.0</AssemblyVersion>
     <RepositoryUrl>https://github.com/contentful/contentful.net</RepositoryUrl>
-    <FileVersion>8.1.0.0</FileVersion>
+    <FileVersion>8.2.0.0</FileVersion>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
     <DocumentationFile>bin\Release\netstandard1.5\Contentful.AspNetCore.xml</DocumentationFile>
@@ -25,7 +25,7 @@
     <AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
   </PropertyGroup>
   <ItemGroup>
-    <PackageReference Include="contentful.csharp" Version="8.1.0" />
+    <PackageReference Include="contentful.csharp" Version="8.2.0" />
     <PackageReference Include="Microsoft.AspNetCore.Http" Version="2.2.2" />
     <PackageReference Include="Microsoft.AspNetCore.Http.Abstractions" Version="2.2.0" />
     <PackageReference Include="Microsoft.AspNetCore.Mvc.Razor" Version="2.2.0" />

diff --git a/Contentful.AspNetCore/IServiceCollectionExtensions.cs b/Contentful.AspNetCore/IServiceCollectionExtensions.cs
@@ -1,14 +1,11 @@
-using System;
-using System.Collections.Generic;
-using System.Text;
+using System.Net;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.DependencyInjection.Extensions;
 using Contentful.Core.Configuration;
 using Microsoft.Extensions.Configuration;
 using System.Net.Http;
 using Contentful.Core;
 using Microsoft.Extensions.Options;
-using Microsoft.Extensions.Http;
 using Contentful.Core.Models;
 
 namespace Contentful.AspNetCore
@@ -31,7 +28,16 @@ public static IServiceCollection AddContentful(this IServiceCollection services,
             services.AddOptions();
             services.Configure<ContentfulOptions>(configuration.GetSection("ContentfulOptions"));
             services.TryAddSingleton<HttpClient>();
-            services.AddHttpClient(HttpClientName);
+            services.AddHttpClient(HttpClientName).ConfigurePrimaryHttpMessageHandler(sp =>
+            {
+                var options = sp.GetService<IOptions<ContentfulOptions>>().Value;
+                var handler = new HttpClientHandler();
+                if (options.AllowHttpResponseCompression && handler.SupportsAutomaticDecompression)
+                {
+                    handler.AutomaticDecompression = DecompressionMethods.GZip | DecompressionMethods.Deflate;
+                }
+                return handler;
+            });
             services.TryAddTransient<IContentfulClient>((sp) => {
                 var options = sp.GetService<IOptions<ContentfulOptions>>().Value;
                 var factory = sp.GetService<IHttpClientFactory>();

diff --git a/Contentful.Core/Configuration/ContentfulOptions.cs b/Contentful.Core/Configuration/ContentfulOptions.cs
@@ -56,5 +56,11 @@ public class ContentfulOptions
         /// Default is "https://cdn.contentful.com/spaces/".
         /// </summary>
         public string BaseUrl { get; set; } = "https://cdn.contentful.com/spaces/";
+
+        /// <summary>
+        /// Whether to use HTTP compression for responses. Only disable if you are hosting in the same datacenter as contentful
+        /// Default is true
+        /// </summary>
+        public bool AllowHttpResponseCompression { get; set; } = true;
     }
 }
diff --git a/Contentful.Core/Configuration/ExtensionJsonConverter.cs b/Contentful.Core/Configuration/ExtensionJsonConverter.cs
@@ -4,9 +4,7 @@
 using Newtonsoft.Json.Linq;
 using Newtonsoft.Json.Serialization;
 using System;
-using System.Collections.Generic;
 using System.Linq;
-using System.Text;
 
 namespace Contentful.Core.Configuration
 {
@@ -15,6 +13,17 @@ namespace Contentful.Core.Configuration
     /// </summary>
     public class ExtensionJsonConverter : JsonConverter
     {
+        private static readonly JsonSerializerSettings JsonSerializerSettings = new()
+        {
+            ContractResolver = new CamelCasePropertyNamesContractResolver
+            {
+                NamingStrategy =
+                {
+                    OverrideSpecifiedNames = false
+                }
+            },
+        };
+
         /// <summary>
         /// Determines whether this instance can convert the specified object type.
         /// </summary>
@@ -75,15 +84,7 @@ public override void WriteJson(JsonWriter writer, object value, JsonSerializer s
                 extension
             };
 
-            var resolver = new CamelCasePropertyNamesContractResolver();
-            resolver.NamingStrategy.OverrideSpecifiedNames = false;
-
-            var settings = new JsonSerializerSettings
-            {
-                ContractResolver = resolver,
-            };
-
-            var jObject = JObject.FromObject(extensionStructure, JsonSerializer.Create(settings));
+            var jObject = JObject.FromObject(extensionStructure, JsonSerializer.Create(JsonSerializerSettings));
 
             serializer.Serialize(writer, jObject);
         }

diff --git a/Contentful.Core/Contentful.Core.csproj b/Contentful.Core/Contentful.Core.csproj
@@ -4,7 +4,7 @@
     <PackageId>contentful.csharp</PackageId>
     <AssemblyTitle>contentful.net</AssemblyTitle>
     <NeutralLanguage>en-US</NeutralLanguage>
-    <VersionPrefix>8.1.0</VersionPrefix>
+    <VersionPrefix>8.2.0</VersionPrefix>
     <TargetFramework>netstandard2.0</TargetFramework>
     <Authors>Contentful</Authors>
     <Copyright>Contentful GmbH.</Copyright>