Add gRPC JSON transcoding option for case insensitive field names (#62868)

Author: JamesNK

src/Grpc/JsonTranscoding/src/Microsoft.AspNetCore.Grpc.JsonTranscoding/GrpcJsonSettings.cs

@@ -11,25 +11,41 @@ public sealed class GrpcJsonSettings
     /// <summary>
     /// Gets or sets a value that indicates whether fields with default values are ignored during serialization.
     /// This setting only affects fields which don't support "presence", such as singular non-optional proto3 primitive fields.
-    /// Default value is false.
+    /// Default value is <see langword="false"/>.
     /// </summary>
     public bool IgnoreDefaultValues { get; set; }
 
     /// <summary>
     /// Gets or sets a value that indicates whether <see cref="Enum"/> values are written as integers instead of strings.
-    /// Default value is false.
+    /// Default value is <see langword="false"/>.
     /// </summary>
     public bool WriteEnumsAsIntegers { get; set; }
 
     /// <summary>
     /// Gets or sets a value that indicates whether <see cref="long"/> and <see cref="ulong"/> values are written as strings instead of numbers.
-    /// Default value is false.
+    /// Default value is <see langword="false"/>.
     /// </summary>
     public bool WriteInt64sAsStrings { get; set; }
 
     /// <summary>
     /// Gets or sets a value that indicates whether JSON should use pretty printing.
-    /// Default value is false.
+    /// Default value is <see langword="false"/>.
     /// </summary>
     public bool WriteIndented { get; set; }
+
+    /// <summary>
+    /// Gets or sets a value that indicates whether property names are compared using case-insensitive matching during deserialization.
+    /// The default value is <see langword="false"/>.
+    /// </summary>
+    /// <remarks>
+    /// <para>
+    /// The Protobuf JSON specification requires JSON property names to match message field names exactly, including case.
+    /// Enabling this option may reduce interoperability, as case-insensitive property matching might not be supported
+    /// by other JSON transcoding implementations.
+    /// </para>
+    /// <para>
+    /// For more information, see <see href="https://protobuf.dev/programming-guides/json/"/>.
+    /// </para>
+    /// </remarks>
+    public bool PropertyNameCaseInsensitive { get; set; }
 }

src/Grpc/JsonTranscoding/src/Microsoft.AspNetCore.Grpc.JsonTranscoding/Internal/Json/JsonConverterHelper.cs

@@ -46,7 +46,8 @@ internal static JsonSerializerOptions CreateSerializerOptions(JsonContext contex
             WriteIndented = writeIndented,
             NumberHandling = JsonNumberHandling.AllowNamedFloatingPointLiterals,
             Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping,
-            TypeInfoResolver = typeInfoResolver
+            TypeInfoResolver = typeInfoResolver,
+            PropertyNameCaseInsensitive = context.Settings.PropertyNameCaseInsensitive,
         };
         options.Converters.Add(new NullValueConverter());
         options.Converters.Add(new ByteStringConverter());

src/Grpc/JsonTranscoding/src/Microsoft.AspNetCore.Grpc.JsonTranscoding/PublicAPI.Unshipped.txt

@@ -1 +1,3 @@
 #nullable enable
+Microsoft.AspNetCore.Grpc.JsonTranscoding.GrpcJsonSettings.PropertyNameCaseInsensitive.get -> bool
+Microsoft.AspNetCore.Grpc.JsonTranscoding.GrpcJsonSettings.PropertyNameCaseInsensitive.set -> void

src/Grpc/JsonTranscoding/test/Microsoft.AspNetCore.Grpc.JsonTranscoding.Tests/ConverterTests/JsonConverterReadTests.cs

@@ -60,6 +60,40 @@ public void JsonCustomizedName()
         Assert.Equal("A field name", m.FieldName);
     }
 
+    [Fact]
+    public void NonJsonName_CaseInsensitive()
+    {
+        var json = @"{
+  ""HIDING_FIELD_NAME"": ""A field name""
+}";
+
+        var m = AssertReadJson<HelloRequest>(json, serializeOld: false, settings: new GrpcJsonSettings { PropertyNameCaseInsensitive = true });
+        Assert.Equal("A field name", m.HidingFieldName);
+    }
+
+    [Fact]
+    public void HidingJsonName_CaseInsensitive()
+    {
+        var json = @"{
+  ""FIELD_NAME"": ""A field name""
+}";
+
+        var m = AssertReadJson<HelloRequest>(json, serializeOld: false, settings: new GrpcJsonSettings { PropertyNameCaseInsensitive = true });
+        Assert.Equal("", m.FieldName);
+        Assert.Equal("A field name", m.HidingFieldName);
+    }
+
+    [Fact]
+    public void JsonCustomizedName_CaseInsensitive()
+    {
+        var json = @"{
+  ""JSON_CUSTOMIZED_NAME"": ""A field name""
+}";
+
+        var m = AssertReadJson<HelloRequest>(json, serializeOld: false, settings: new GrpcJsonSettings { PropertyNameCaseInsensitive = true });
+        Assert.Equal("A field name", m.FieldName);
+    }
+
     [Fact]
     public void ReadObjectProperties()
     {
@@ -439,6 +473,23 @@ public void MapMessages()
         AssertReadJson<HelloRequest>(json);
     }
 
+    [Fact]
+    public void MapMessages_CaseInsensitive()
+    {
+        var json = @"{
+  ""mapMessage"": {
+    ""name1"": {
+      ""SUBFIELD"": ""value1""
+    },
+    ""name2"": {
+      ""SUBFIELD"": ""value2""
+    }
+  }
+}";
+
+        AssertReadJson<HelloRequest>(json, serializeOld: false, settings: new GrpcJsonSettings { PropertyNameCaseInsensitive = true });
+    }
+
     [Fact]
     public void MapKeyBool()
     {
@@ -452,6 +503,21 @@ public void MapKeyBool()
         AssertReadJson<HelloRequest>(json);
     }
 
+    [Fact]
+    public void MapKeyBool_CaseInsensitive()
+    {
+        var json = @"{
+  ""mapKeybool"": {
+    ""TRUE"": ""value1"",
+    ""FALSE"": ""value2""
+  }
+}";
+
+        // Note: JSON property names here are keys in a dictionary, not fields. So FieldNamesCaseInsensitive doesn't apply.
+        // The new serializer supports converting true/false to boolean keys while ignoring case.
+        AssertReadJson<HelloRequest>(json, serializeOld: false);
+    }
+
     [Fact]
     public void MapKeyInt()
     {
@@ -475,6 +541,16 @@ public void OneOf_Success()
         AssertReadJson<HelloRequest>(json);
     }
 
+    [Fact]
+    public void OneOf_CaseInsensitive_Success()
+    {
+        var json = @"{
+  ""ONEOFNAME1"": ""test""
+}";
+
+        AssertReadJson<HelloRequest>(json, serializeOld: false, settings: new GrpcJsonSettings { PropertyNameCaseInsensitive = true });
+    }
+
     [Fact]
     public void OneOf_Failure()
     {
@@ -486,6 +562,17 @@ public void OneOf_Failure()
         AssertReadJsonError<HelloRequest>(json, ex => Assert.Equal("Multiple values specified for oneof oneof_test", ex.Message.TrimEnd('.')));
     }
 
+    [Fact]
+    public void OneOf_CaseInsensitive_Failure()
+    {
+        var json = @"{
+  ""ONEOFNAME1"": ""test"",
+  ""ONEOFNAME2"": ""test""
+}";
+
+        AssertReadJsonError<HelloRequest>(json, ex => Assert.Equal("Multiple values specified for oneof oneof_test", ex.Message.TrimEnd('.')), deserializeOld: false, settings: new GrpcJsonSettings { PropertyNameCaseInsensitive = true });
+    }
+
     [Fact]
     public void NullableWrappers_NaN()
     {
@@ -529,7 +616,27 @@ public void NullableWrappers()
   ""bytesValue"": ""SGVsbG8gd29ybGQ=""
 }";
 
-        AssertReadJson<HelloRequest.Types.Wrappers>(json);
+        var result = AssertReadJson<HelloRequest.Types.Wrappers>(json);
+        Assert.Equal("A string", result.StringValue);
+    }
+
+    [Fact]
+    public void NullableWrappers_CaseInsensitive()
+    {
+        var json = @"{
+  ""STRINGVALUE"": ""A string"",
+  ""INT32VALUE"": 1,
+  ""INT64VALUE"": ""2"",
+  ""FLOATVALUE"": 1.2,
+  ""DOUBLEVALUE"": 1.1,
+  ""BOOLVALUE"": true,
+  ""UINT32VALUE"": 3,
+  ""UINT64VALUE"": ""4"",
+  ""BYTESVALUE"": ""SGVsbG8gd29ybGQ=""
+}";
+
+        var result = AssertReadJson<HelloRequest.Types.Wrappers>(json, serializeOld: false, settings: new GrpcJsonSettings { PropertyNameCaseInsensitive = true });
+        Assert.Equal("A string", result.StringValue);
     }
 
     [Fact]
@@ -629,8 +736,19 @@ public void JsonNamePriority_JsonName()
     {
         var json = @"{""b"":10,""a"":20,""d"":30}";
 
-        // TODO: Current Google.Protobuf version doesn't have fix. Update when available. 3.23.0 or later?
-        var m = AssertReadJson<Issue047349Message>(json, serializeOld: false);
+        var m = AssertReadJson<Issue047349Message>(json);
+
+        Assert.Equal(10, m.A);
+        Assert.Equal(20, m.B);
+        Assert.Equal(30, m.C);
+    }
+
+    [Fact]
+    public void JsonNamePriority_CaseInsensitive_JsonName()
+    {
+        var json = @"{""B"":10,""A"":20,""D"":30}";
+
+        var m = AssertReadJson<Issue047349Message>(json, serializeOld: false, settings: new GrpcJsonSettings { PropertyNameCaseInsensitive = true });
 
         Assert.Equal(10, m.A);
         Assert.Equal(20, m.B);
@@ -642,14 +760,44 @@ public void JsonNamePriority_FieldNameFallback()
     {
         var json = @"{""b"":10,""a"":20,""c"":30}";
 
-        // TODO: Current Google.Protobuf version doesn't have fix. Update when available. 3.23.0 or later?
-        var m = AssertReadJson<Issue047349Message>(json, serializeOld: false);
+        var m = AssertReadJson<Issue047349Message>(json);
 
         Assert.Equal(10, m.A);
         Assert.Equal(20, m.B);
         Assert.Equal(30, m.C);
     }
 
+    [Fact]
+    public void JsonNamePriority_CaseInsensitive_FieldNameFallback()
+    {
+        var json = @"{""B"":10,""A"":20,""C"":30}";
+
+        var m = AssertReadJson<Issue047349Message>(json, serializeOld: false, settings: new GrpcJsonSettings { PropertyNameCaseInsensitive = true });
+
+        Assert.Equal(10, m.A);
+        Assert.Equal(20, m.B);
+        Assert.Equal(30, m.C);
+    }
+
+    [Fact]
+    public void FieldNameCase_Success()
+    {
+        var json = @"{""a"":10,""A"":20}";
+
+        var m = AssertReadJson<FieldNameCaseMessage>(json);
+
+        Assert.Equal(10, m.A);
+        Assert.Equal(20, m.B);
+    }
+
+    [Fact]
+    public void FieldNameCase_CaseInsensitive_Failure()
+    {
+        var json = @"{""a"":10,""A"":20}";
+
+        AssertReadJsonError<FieldNameCaseMessage>(json, ex => Assert.Equal("The JSON property name for 'Transcoding.FieldNameCaseMessage.A' collides with another property.", ex.Message), deserializeOld: false, settings: new GrpcJsonSettings { PropertyNameCaseInsensitive = true });
+    }
+
     private TValue AssertReadJson<TValue>(string value, GrpcJsonSettings? settings = null, DescriptorRegistry? descriptorRegistry = null, bool serializeOld = true) where TValue : IMessage, new()
     {
         var typeRegistery = TypeRegistry.FromFiles(

src/Grpc/JsonTranscoding/test/Microsoft.AspNetCore.Grpc.JsonTranscoding.Tests/Proto/transcoding.proto

@@ -235,3 +235,8 @@ message HelloReply {
 message NullValueContainer {
   google.protobuf.NullValue null_value = 1;
 }
+
+message FieldNameCaseMessage {
+  int32 a = 1;
+  int32 b = 2  [json_name="A"];
+}