add new LogLevelJsonConverter and remove generic JsonEnumConverter

Author: hjgraca

libraries/src/AWS.Lambda.Powertools.Logging/Serializers/LogLevelJsonConverter.cs

@@ -0,0 +1,19 @@
+using System;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+using Microsoft.Extensions.Logging;
+
+namespace AWS.Lambda.Powertools.Logging.Serializers;
+
+internal class LogLevelJsonConverter : JsonConverter<LogLevel>
+{
+    public override LogLevel Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
+    {
+        return Enum.TryParse<LogLevel>(reader.GetString(),true, out var val) ? val : default;
+    }
+
+    public override void Write(Utf8JsonWriter writer, LogLevel value, JsonSerializerOptions options)
+    {
+        writer.WriteStringValue(value.ToString());
+    }
+}

libraries/src/AWS.Lambda.Powertools.Logging/Serializers/PowertoolsLoggingSerializer.cs

@@ -153,9 +153,9 @@ private static JsonSerializerOptions BuildJsonSerializerOptions()
         _jsonOptions.Converters.Add(new TimeOnlyConverter());
 
 #if NET8_0_OR_GREATER
-        _jsonOptions.Converters.Add(new JsonStringEnumConverter<LogLevel>());
+        _jsonOptions.Converters.Add(new LogLevelJsonConverter());
 #elif NET6_0
-        _jsonOptions.Converters.Add(new JsonStringEnumConverter());
+        _jsonOptions.Converters.Add(new LogLevelJsonConverter());
 #endif
 
         _jsonOptions.Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping;

libraries/tests/AWS.Lambda.Powertools.Logging.Tests/Formatter/LogFormatterTest.cs

@@ -19,6 +19,7 @@
 using System.Linq;
 using System.Reflection;
 using System.Text.Json;
+using System.Text.Json.Serialization;
 using Amazon.Lambda.Core;
 using Amazon.Lambda.TestUtilities;
 using AWS.Lambda.Powertools.Common;
@@ -42,7 +43,50 @@ public LogFormatterTest()
         {
             _testHandler = new TestHandlers();
         }
-        
+
+        [Fact]
+        public void Serialize_ShouldHandleEnumValues()
+        {
+            var consoleOut = Substitute.For<StringWriter>();
+            SystemWrapper.Instance.SetOut(consoleOut);
+            var lambdaContext = new TestLambdaContext
+            {
+                FunctionName = "funtionName",
+                FunctionVersion = "version",
+                InvokedFunctionArn = "function::arn",
+                AwsRequestId = "requestId",
+                MemoryLimitInMB = 128
+            };
+
+            var handler = new TestHandlers();
+            handler.TestEnums("fake", lambdaContext);
+
+            consoleOut.Received(1).WriteLine(Arg.Is<string>(i =>
+                i.Contains("\"message\":5")
+            ));
+            consoleOut.Received(1).WriteLine(Arg.Is<string>(i =>
+                i.Contains("\"message\":\"Dog\"")
+            ));
+
+            var json = JsonSerializer.Serialize(Pet.Dog, PowertoolsLoggingSerializer.GetSerializerOptions());
+            Assert.Contains("Dog", json);
+        }
+
+        [JsonConverter(typeof(JsonStringEnumConverter))]
+        public enum Pet
+        {
+            Cat = 1,
+            Dog = 3,
+            Lizard = 5
+        }
+
+        public enum Thing
+        {
+            One = 1,
+            Three = 3,
+            Five = 5
+        }
+
         [Fact]
         public void Log_WhenCustomFormatter_LogsCustomFormat()
         {
@@ -204,7 +248,7 @@ public void Should_Log_CustomFormatter_When_Decorated()
             consoleOut.Received(1).WriteLine(
                 Arg.Is<string>(i =>
                     i.Contains(
-                    "\"correlation_ids\":{\"aws_request_id\":\"requestId\"},\"lambda_function\":{\"name\":\"funtionName\",\"arn\":\"function::arn\",\"memory_limit_in_mb\":128,\"version\":\"version\",\"cold_start\":true},\"level\":\"Information\""))
+                        "\"correlation_ids\":{\"aws_request_id\":\"requestId\"},\"lambda_function\":{\"name\":\"funtionName\",\"arn\":\"function::arn\",\"memory_limit_in_mb\":128,\"version\":\"version\",\"cold_start\":true},\"level\":\"Information\""))
             );
 #else
             consoleOut.Received(1).WriteLine(

libraries/tests/AWS.Lambda.Powertools.Logging.Tests/Handlers/TestHandlers.cs

@@ -13,6 +13,7 @@
  * permissions and limitations under the License.
  */
 
+using System.Text.Json.Serialization;
 using Amazon.Lambda.APIGatewayEvents;
 using Amazon.Lambda.ApplicationLoadBalancerEvents;
 using Amazon.Lambda.CloudWatchEvents;
@@ -158,4 +159,26 @@ public void TestLogNoDecorator()
     {
         Logger.LogInformation("test");
     }
+    
+    [Logging(Service = "test", LoggerOutputCase = LoggerOutputCase.SnakeCase)]
+    public void TestEnums(string input, ILambdaContext context)
+    {
+        Logger.LogInformation(Pet.Dog);
+        Logger.LogInformation(Thing.Five);
+    }
+    
+    public enum Thing
+    {
+        One = 1,
+        Three = 3,
+        Five = 5
+    }
+    
+    [JsonConverter(typeof(JsonStringEnumConverter))]
+    public enum Pet
+    {
+        Cat = 1,
+        Dog = 3,
+        Lizard = 5
+    }
 }

libraries/tests/AWS.Lambda.Powertools.Logging.Tests/Serializers/PowertoolsLoggingSerializerTests.cs

@@ -62,9 +62,9 @@ public void SerializerOptions_ShouldHaveCorrectDefaultSettings()
             converter => Assert.IsType<DateOnlyConverter>(converter),
             converter => Assert.IsType<TimeOnlyConverter>(converter),
 #if NET8_0_OR_GREATER
-            converter => Assert.IsType<JsonStringEnumConverter<LogLevel>>(converter));
+            converter => Assert.IsType<LogLevelJsonConverter>(converter));
 #elif NET6_0
-            converter => Assert.IsType<JsonStringEnumConverter>(converter));
+            converter => Assert.IsType<LogLevelJsonConverter>(converter));
 #endif
 
         Assert.Equal(JavaScriptEncoder.UnsafeRelaxedJsonEscaping, options.Encoder);
@@ -90,9 +90,9 @@ public void SerializerOptions_ShouldHaveCorrectDefaultSettings_WhenDynamic()
             converter => Assert.IsType<DateOnlyConverter>(converter),
             converter => Assert.IsType<TimeOnlyConverter>(converter),
 #if NET8_0_OR_GREATER
-            converter => Assert.IsType<JsonStringEnumConverter<LogLevel>>(converter));
+            converter => Assert.IsType<LogLevelJsonConverter>(converter));
 #elif NET6_0
-            converter => Assert.IsType<JsonStringEnumConverter>(converter));
+            converter => Assert.IsType<LogLevelJsonConverter>(converter));
 #endif
 
         Assert.Equal(JavaScriptEncoder.UnsafeRelaxedJsonEscaping, options.Encoder);