add lambda serlialization json converters to support lambda event logging

Author: amirkaws

libraries/src/AWS.Lambda.Powertools.Logging/Internal/Converters/ByteArrayConverter.cs

@@ -0,0 +1,64 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ * 
+ *  http://aws.amazon.com/apache2.0
+ * 
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+using System;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+
+namespace AWS.Lambda.Powertools.Logging.Internal.Converters;
+
+/// <summary>
+///     Converts an byte[] to JSON.
+/// </summary>
+internal class ByteArrayConverter : JsonConverter<byte[]>
+{
+    /// <summary>
+    ///     Converter throws NotSupportedException. Deserializing ByteArray is not allowed.
+    /// </summary>
+    /// <param name="reader">Reference to the JsonReader</param>
+    /// <param name="typeToConvert">The type which should be converted.</param>
+    /// <param name="options">The Json serializer options.</param>
+    /// <returns></returns>
+    /// <exception cref="NotSupportedException"></exception>
+    public override byte[] Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
+    {
+        throw new NotSupportedException("Deserializing ByteArray is not allowed");
+    }
+
+    /// <summary>
+    ///     Write the exception value as JSON. 
+    /// </summary>
+    /// <param name="writer">The unicode JsonWriter.</param>
+    /// <param name="values">The byte array.</param>
+    /// <param name="options">The JsonSerializer options.</param>
+    public override void Write(Utf8JsonWriter writer, byte[] values, JsonSerializerOptions options)
+    {
+        if (values == null)
+        {
+            writer.WriteNullValue();
+        }
+        else
+        {
+            writer.WriteStartArray();
+
+            foreach (var value in values)
+            {
+                writer.WriteNumberValue(value);
+            }
+
+            writer.WriteEndArray();
+        }
+    }
+}

libraries/src/AWS.Lambda.Powertools.Logging/Internal/Converters/ConstantClassConverter.cs

@@ -0,0 +1,68 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ * 
+ *  http://aws.amazon.com/apache2.0
+ * 
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+using System;
+using System.Collections.Generic;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+
+namespace AWS.Lambda.Powertools.Logging.Internal.Converters;
+
+/// <summary>
+///     JsonConvert to handle the AWS SDK for .NET custom enum classes that derive from the class called ConstantClass.
+/// </summary>
+public class ConstantClassConverter : JsonConverter<object>
+{
+    private static readonly HashSet<string> ConstantClassNames = new()
+    {
+        "Amazon.S3.EventType",
+        "Amazon.DynamoDBv2.OperationType",
+        "Amazon.DynamoDBv2.StreamViewType"
+    };
+
+    /// <summary>
+    ///     Check to see if the type is derived from ConstantClass.
+    /// </summary>
+    /// <param name="typeToConvert">The type which should be converted.</param>
+    /// <returns>True if the type is derived from ConstantClass, False otherwise.</returns>
+    public override bool CanConvert(Type typeToConvert)
+    {
+        return ConstantClassNames.Contains(typeToConvert.FullName);
+    }
+
+    /// <summary>
+    ///     Converter throws NotSupportedException. Deserializing ConstantClass is not allowed.
+    /// </summary>
+    /// <param name="reader">Reference to the JsonReader</param>
+    /// <param name="typeToConvert">The type which should be converted.</param>
+    /// <param name="options">The Json serializer options.</param>
+    /// <returns></returns>
+    /// <exception cref="NotSupportedException"></exception>
+    public override object Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
+    {
+        throw new NotSupportedException("Deserializing ConstantClass is not allowed");
+    }
+    
+    /// <summary>
+    ///     Write the ConstantClass instance as JSON. 
+    /// </summary>
+    /// <param name="writer">The unicode JsonWriter.</param>
+    /// <param name="value">The exception instance.</param>
+    /// <param name="options">The JsonSerializer options.</param>
+    public override void Write(Utf8JsonWriter writer, object value, JsonSerializerOptions options)
+    {
+        writer.WriteStringValue(value.ToString());
+    }
+}

libraries/src/AWS.Lambda.Powertools.Logging/Internal/ExceptionConverter.cs renamed to libraries/src/AWS.Lambda.Powertools.Logging/Internal/Converters/ExceptionConverter.cs

@@ -18,7 +18,7 @@
 using System.Text.Json;
 using System.Text.Json.Serialization;
 
-namespace AWS.Lambda.Powertools.Logging.Internal;
+namespace AWS.Lambda.Powertools.Logging.Internal.Converters;
 
 /// <summary>
 ///     Converts an exception to JSON.
@@ -36,7 +36,7 @@ public override bool CanConvert(Type typeToConvert)
     }
 
     /// <summary>
-    ///     Converter throws NotSupportedException. Deserializing exception is not allowed.
+    ///     Converter throws NotSupportedException. Deserializing Exception is not allowed.
     /// </summary>
     /// <param name="reader">Reference to the JsonReader</param>
     /// <param name="typeToConvert">The type which should be converted.</param>
@@ -45,7 +45,7 @@ public override bool CanConvert(Type typeToConvert)
     /// <exception cref="NotSupportedException"></exception>
     public override Exception Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
     {
-        throw new NotSupportedException("Deserializing exception is not allowed");
+        throw new NotSupportedException("Deserializing Exception is not allowed");
     }
 
     /// <summary>

libraries/src/AWS.Lambda.Powertools.Logging/Internal/Converters/MemoryStreamConverter.cs

@@ -0,0 +1,51 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ * 
+ *  http://aws.amazon.com/apache2.0
+ * 
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+using System;
+using System.IO;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+
+namespace AWS.Lambda.Powertools.Logging.Internal.Converters;
+
+/// <summary>
+///     Handles converting MemoryStreams to base 64 strings.
+/// </summary>
+internal class MemoryStreamConverter : JsonConverter<MemoryStream>
+{
+    /// <summary>
+    ///     Converter throws NotSupportedException. Deserializing MemoryStream is not allowed.
+    /// </summary>
+    /// <param name="reader">Reference to the JsonReader</param>
+    /// <param name="typeToConvert">The type which should be converted.</param>
+    /// <param name="options">The Json serializer options.</param>
+    /// <returns></returns>
+    /// <exception cref="NotSupportedException"></exception>
+    public override MemoryStream Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
+    {
+        throw new NotSupportedException("Deserializing MemoryStream is not allowed");
+    }
+    
+    /// <summary>
+    ///     Write the MemoryStream as a base 64 string.
+    /// </summary>
+    /// <param name="writer">The unicode JsonWriter.</param>
+    /// <param name="value">The MemoryStream instance.</param>
+    /// <param name="options">The JsonSerializer options.</param>
+    public override void Write(Utf8JsonWriter writer, MemoryStream value, JsonSerializerOptions options)
+    {
+        writer.WriteStringValue(Convert.ToBase64String(value.ToArray()));
+    }
+}

libraries/src/AWS.Lambda.Powertools.Logging/Internal/LoggingAspectHandler.cs

@@ -17,7 +17,9 @@
 using System.IO;
 using System.Linq;
 using System.Text.Json;
+using System.Text.Json.Serialization;
 using AWS.Lambda.Powertools.Common;
+using AWS.Lambda.Powertools.Logging.Internal.Converters;
 using Microsoft.Extensions.Logging;
 
 namespace AWS.Lambda.Powertools.Logging.Internal;
@@ -93,6 +95,18 @@ internal class LoggingAspectHandler : IMethodAspectHandler
     ///     Specify to clear Lambda Context on exit
     /// </summary>
     private bool _clearLambdaContext;
+    
+    /// <summary>
+    ///     The JsonSerializer options
+    /// </summary>
+    private static JsonSerializerOptions _jsonSerializerOptions;
+    
+    /// <summary>
+    ///     Get JsonSerializer options.
+    /// </summary>
+    /// <value>The current configuration.</value>
+    private static JsonSerializerOptions JsonSerializerOptions =>
+        _jsonSerializerOptions ??= BuildJsonSerializerOptions();
 
     /// <summary>
     ///     Initializes a new instance of the <see cref="LoggingAspectHandler" /> class.
@@ -259,6 +273,22 @@ private void CaptureLambdaContext(AspectEventArgs eventArgs)
             _systemWrapper.LogLine(
                 "Skipping Lambda Context injection because ILambdaContext context parameter not found.");
     }
+    
+    /// <summary>
+    ///     Builds JsonSerializer options.
+    /// </summary>
+    private static JsonSerializerOptions BuildJsonSerializerOptions()
+    {
+        var jsonOptions = new JsonSerializerOptions
+        {
+            DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,
+        };
+        jsonOptions.Converters.Add(new ByteArrayConverter());
+        jsonOptions.Converters.Add(new ExceptionConverter());
+        jsonOptions.Converters.Add(new MemoryStreamConverter());
+        jsonOptions.Converters.Add(new ConstantClassConverter());
+        return jsonOptions;
+    }
 
     /// <summary>
     ///     Captures the correlation identifier.
@@ -286,7 +316,7 @@ private void CaptureCorrelationId(object eventArg)
         try
         {
             var correlationId = string.Empty;
-            var jsonDoc = JsonDocument.Parse(JsonSerializer.Serialize(eventArg));
+            var jsonDoc = JsonDocument.Parse(JsonSerializer.Serialize(eventArg, JsonSerializerOptions));
             var element = jsonDoc.RootElement;
 
             for (var i = 0; i < correlationIdPaths.Length; i++)

libraries/src/AWS.Lambda.Powertools.Logging/Internal/PowertoolsLogger.cs

@@ -18,6 +18,7 @@
 using System.Linq;
 using System.Text.Json;
 using AWS.Lambda.Powertools.Common;
+using AWS.Lambda.Powertools.Logging.Internal.Converters;
 using Microsoft.Extensions.Logging;
 
 namespace AWS.Lambda.Powertools.Logging.Internal;
@@ -350,7 +351,10 @@ private JsonSerializerOptions BuildJsonSerializerOptions()
                 DictionaryKeyPolicy = SnakeCaseNamingPolicy.Instance
             }
         };
+        jsonOptions.Converters.Add(new ByteArrayConverter());
         jsonOptions.Converters.Add(new ExceptionConverter());
+        jsonOptions.Converters.Add(new MemoryStreamConverter());
+        jsonOptions.Converters.Add(new ConstantClassConverter());
         return jsonOptions;
     }
 }