Ignore casing on property names by default (#261)

* Ignore casing on property names by default

change tests to check for case insensitivity

more message docs

only configure serializer if user has not

* fix merge

* make sure we always have a serializer

* remove unused using statements

* configure jsonserializeroptions

* updates to test

Author: mhoeger

src/DotNetWorker.Core/Hosting/ServiceCollectionExtensions.cs

@@ -2,7 +2,8 @@
 // Licensed under the MIT License. See License.txt in the project root for license information.
 
 using System;
-using System.Threading.Channels;
+using System.Text.Json;
+using Azure.Core.Serialization;
 using Microsoft.Azure.Functions.Worker;
 using Microsoft.Azure.Functions.Worker.Configuration;
 using Microsoft.Azure.Functions.Worker.Context.Features;
@@ -12,6 +13,7 @@
 using Microsoft.Azure.Functions.Worker.Pipeline;
 using Microsoft.Extensions.DependencyInjection.Extensions;
 using Microsoft.Extensions.Hosting;
+using Microsoft.Extensions.Options;
 
 namespace Microsoft.Extensions.DependencyInjection
 {
@@ -56,6 +58,16 @@ public static IFunctionsWorkerApplicationBuilder AddFunctionsWorkerCore(this ISe
             // Worker initialization service
             services.AddSingleton<IHostedService, WorkerHostedService>();
 
+            // Default serializer settings
+            services.AddOptions<WorkerOptions>()
+                .PostConfigure<IOptions<JsonSerializerOptions>>((workerOptions, serializerOptions) =>
+                {
+                    if (workerOptions.Serializer is null)
+                    {
+                        workerOptions.Serializer = new JsonObjectSerializer(serializerOptions.Value);
+                    }
+                });
+
             if (configure != null)
             {
                 services.Configure(configure);

src/DotNetWorker.Core/Hosting/WorkerOptions.cs

@@ -11,16 +11,10 @@ namespace Microsoft.Azure.Functions.Worker
     /// </summary>    
     public class WorkerOptions
     {
-        private ObjectSerializer? _serializer;
-
         /// <summary>
         /// The <see cref="ObjectSerializer"/> to use for all JSON serialization and deserialization. By default,
         /// this is a default <see cref="JsonObjectSerializer"/> with default <see cref="JsonSerializerOptions"/>.
         /// </summary>
-        public ObjectSerializer Serializer
-        {
-            get => _serializer ??= new JsonObjectSerializer();
-            set => _serializer = value;
-        }
+        public ObjectSerializer? Serializer { get; set; }
     }
 }

src/DotNetWorker/Hosting/ServiceCollectionExtensions.cs

@@ -2,6 +2,7 @@
 // Licensed under the MIT License. See License.txt in the project root for license information.
 
 using System;
+using System.Text.Json;
 using Microsoft.Azure.Functions.Worker;
 
 namespace Microsoft.Extensions.DependencyInjection
@@ -14,6 +15,7 @@ public static class ServiceCollectionExtensions
         /// <summary>
         /// Adds the core set of services for the Azure Functions worker.
         /// This call also adds the default set of binding converters and gRPC support.
+        /// This call also adds a default ObjectSerializer that treats property names as case insensitive.
         /// </summary>
         /// <param name="services">The <see cref="IServiceCollection"/>.</param>
         /// <param name="configure">The action used to configure <see cref="WorkerOptions"/>.</param>
@@ -28,6 +30,12 @@ public static IFunctionsWorkerApplicationBuilder AddFunctionsWorkerDefaults(this
             // Converters
             services.RegisterDefaultConverters();
 
+            // Default Json serialization should ignore casing on property names
+            services.Configure<JsonSerializerOptions>(options =>
+            {
+                options.PropertyNameCaseInsensitive = true;
+            });
+
             // Core services registration
             var builder = services.AddFunctionsWorkerCore(configure);
 

src/DotNetWorker/Hosting/WorkerHostBuilderExtensions.cs

@@ -17,6 +17,7 @@ public static class WorkerHostBuilderExtensions
         /// The following defaults are configured:
         /// <list type="bullet">
         ///     <item><description>A default set of converters.</description></item>
+        ///     <item><description>Set default serializer to ignore casing on property names.</description></item>
         ///     <item><description>Integration with Azure Functions logging.</description></item>
         ///     <item><description>Output binding middleware and features.</description></item>
         ///     <item><description>Function execution middleware.</description></item>

test/DotNetWorkerTests/Configuration/WorkerOptionsTests.cs

@@ -4,6 +4,7 @@
 using System;
 using System.Collections.Generic;
 using System.Text;
+using System.Text.Json;
 using Azure.Core.Serialization;
 using Microsoft.Azure.Functions.Worker.Converters;
 using Microsoft.Extensions.Options;
@@ -19,6 +20,10 @@ public class JsonPocoConverterTests
         public JsonPocoConverterTests()
         {
             var options = new WorkerOptions();
+            options.Serializer = new JsonObjectSerializer(new JsonSerializerOptions()
+            {
+                PropertyNameCaseInsensitive = true
+            });
             var wrapper = new OptionsWrapper<WorkerOptions>(options);
             _jsonPocoConverter = new JsonPocoConverter(wrapper);
         }

test/DotNetWorkerTests/Converters/JsonPocoConverterTests.cs

@@ -27,4 +27,8 @@
     <ProjectReference Include="..\..\src\DotNetWorker\DotNetWorker.csproj" />
   </ItemGroup>
 
+  <ItemGroup>
+    <Folder Include="Configuration\" />
+  </ItemGroup>
+
 </Project>

test/DotNetWorkerTests/DotNetWorkerTests.csproj

@@ -57,6 +57,7 @@ private FunctionContext CreateContext(ObjectSerializer serializer = null)
 
             var services = new ServiceCollection();
             services.AddOptions();
+            services.AddFunctionsWorkerDefaults();
 
             if (serializer != null)
             {

test/DotNetWorkerTests/HttpRequestDataExtensionsTests.cs

@@ -120,14 +120,12 @@ private FunctionContext CreateContext(ObjectSerializer serializer = null)
 
             var services = new ServiceCollection();
             services.AddOptions();
+            services.AddFunctionsWorkerCore();
 
-            if (serializer != null)
+            services.Configure<WorkerOptions>(c =>
             {
-                services.Configure<WorkerOptions>(c =>
-                {
-                    c.Serializer = serializer;
-                });
-            }
+                c.Serializer = serializer;
+            });
 
             context.InstanceServices = services.BuildServiceProvider();
 

test/DotNetWorkerTests/HttpResponseDataExtensionsTests.cs

@@ -38,16 +38,12 @@ public static object CosmosTrigger([CosmosDBTrigger(
 
         public class MyDocument
         {
-            [JsonPropertyName("id")]
             public string Id { get; set; }
 
-            [JsonPropertyName("text")]
             public string Text { get; set; }
 
-            [JsonPropertyName("number")]
             public int Number { get; set; }
 
-            [JsonPropertyName("boolean")]
             public bool Boolean { get; set; }
         }
     }